Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistencies in the comments and some spaces #42

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+22 −21
Open

Fix inconsistencies in the comments and some spaces #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e4fa34
Fix some typos, missing spaces.
DaniyelMe Jun 24, 2020
4b488c1
Fix inconsistencies in the comments and some spaces.
DaniyelMe Jul 4, 2020
2e69674
reverts some mistakes. Fix some inconsistencies.
DaniyelMe Jul 5, 2020
ea454bf
Update to remote current state
DaniyelMe Jul 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions src/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,15 @@ export default class Auth {
// we need to check if this environment supports `addEventListener` on the window.
'addEventListener' in window &&
window.addEventListener('storage', e => {
// This code will run if localStorage for this user
// data was updated from a different browser window.
// This code will run if the local storage for this user
// was updated from a different browser window.
if (e.key !== this.sKey('User')) return;
this.setState(JSON.parse(e.newValue), false);
});
}

/**
* Emits an event and triggers all the listeners.
* Emits an event and triggers all of the listeners.
* @param {string} name Name of the event to trigger.
* @param {any} data Data you want to pass to the event listeners.
Expand Down Expand Up @@ -104,8 +105,8 @@ export default class Auth {
}

/**
* Makes a post request to a specific endpoint and returns the response.
* @param {string} endpoint Name of the endpoint.
* Makes post request to a specific endpoint and return the response.
* @param {any} request Body to pass to the request.
* @private
*/
Expand All @@ -122,7 +123,7 @@ export default class Auth {
let data = await response.json();

// If the response returned an error, try to get a Firebase error code/message.
// Sometimes the error codes are joined with an explanation, we don't need that(its a bug).
// Sometimes the error codes are joined with an explanation, we don't need that.
// So we remove the unnecessary part.
if (!response.ok) {
const code = data.error.message.replace(/: [\w ,.'"()]+$/, '');
Expand All @@ -149,7 +150,7 @@ export default class Auth {
/**
* Updates the user data in localStorage.
* @param {Object} userData New user data.
* @param {boolean} [updateStorage = true] Check whether to update localStorage or not.
* @param {boolean} [persist = true] Whether to update local storage or not.
* @private
*/
async setState(userData, persist = true, emit = true) {
Expand Down Expand Up @@ -199,7 +200,7 @@ export default class Auth {
}

/**
* Uses native fetch, but adds authorization headers, otherwise, the API is exactly the same as native fetch.
* Uses native fetch but adds authorization headers, otherwise the API is exactly the same as native fetch.
* @param {Request|Object|string} resource A request to send. It can be a resource or an options object.
* @param {Object} init An options object.
*/
Expand Down Expand Up @@ -244,8 +245,8 @@ export default class Auth {
const { provider, oauthScope, context, linkAccount } =
typeof options === 'string' ? { provider: options } : options;

// Make sure the user is logged in when an "account link" was requested.
linkAccount && (await this.enforceAuth());
// Makes sure the user is signed-in when an "account link" was requested.

// Get the url and other data necessary for the authentication.
const { authUri, sessionId } = await this.api('createAuthUri', {
Expand All @@ -260,7 +261,7 @@ export default class Auth {
// Is required to finish the auth flow, I believe this is used to mitigate CSRF attacks.
// (No docs on this...)
await this.storage.set(this.sKey('SessionId'), sessionId);
// Save if this is a fresh log-in or a "link account" request.
// Save if this is a fresh signed-in or a "link account" request.
linkAccount && (await this.storage.set(this.sKey('LinkAccount'), true));

// Finally - redirect the page to the auth endpoint.
Expand All @@ -278,7 +279,6 @@ export default class Auth {
const sessionId = await this.storage.get(this.sKey('SessionId'));
// Get the indication if this was a "link account" request.
const linkAccount = await this.storage.get(this.sKey('LinkAccount'));

// Check for the edge case in which the user signed-out
// before completing the linkAccount request.
if (linkAccount && !this.user) throw Error('Request to "Link account" was made, but user is no longer signed-in');
Expand Down Expand Up @@ -362,7 +362,8 @@ export default class Auth {
/**
* Sends an out-of-band confirmation code for an account.
* It can be used to reset a password, to verify an email address and send a sign-in email link.
* The email argument is not needed if verifying an email (the argument is ignored). Otherwise, it is required.
* The `email` argument is not needed only when verifying an email (In that case it will be completely ignored, even if specified), otherwise it is required.
* Can be used to reset a password, to verify an email address and send a Sign-in email link.
* @param {'PASSWORD_RESET'|'VERIFY_EMAIL'|'EMAIL_SIGNIN'} requestType The type of out-of-band (OOB) code to send.
* @param {string} [email] When the `requestType` is `PASSWORD_RESET` or `EMAIL_SIGNIN` you need to provide an email address.
* @returns {Promise}
Expand Down Expand Up @@ -404,9 +405,9 @@ export default class Auth {
}

/**
* Gets the user data from the server, and updates the local caches.
* @param {Object} [tokenManager] Only when not signed-in.
* @throws Will throw if the user is not signed-in.
* Gets the user data from the server and updates the local caches.
*/
async fetchProfile(tokenManager = this.user && this.user.tokenManager) {
if (!tokenManager) await this.enforceAuth();
Expand All @@ -420,9 +421,9 @@ export default class Auth {
}

/**
* Updates the user's profile.
* @param {Object} newData An object with the new data.
* @throws Will throw if the user is not signed-in.
* Update user's profile.
*/
async updateProfile(newData) {
await this.enforceAuth();
Expand Down
18 changes: 9 additions & 9 deletions test/main.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,15 @@ describe('Auth', () => {
email: '[email protected]',
tokenManager: {
idToken: 'idTokenString',
expiresAt: Date.now() - 3600 * 1000 // one hour ago.
expiresAt: Date.now() - 3600 * 1000 // One hour ago.
}
})
);

const auth = new Auth({ apiKey: 'key' });

// Await for the second update to happen.
// the first one is from local storage.
// The first one is from local storage.
await new Promise(resolve => {
auth.listen(resolve);
});
Expand Down Expand Up @@ -166,10 +166,10 @@ describe('Auth', () => {
expect(fetch.mock.calls.length).toEqual(0);
});

test('Signs out a previously signed in user when their token has expired', async () => {
test('Signs-out a previously signed-in user when their token has expired', async () => {
fetch.mockResponse('{"error": {"message": "TOKEN_EXPIRED"}}', { status: 403 });

// Previously signed in user
// Previously signed-in user
localStorage.setItem(
'Auth:User:key:default',
JSON.stringify({
Expand All @@ -186,7 +186,7 @@ describe('Auth', () => {
// First call to the listener will be done after reading the local storage.
// After that a request to update the user data will be made, and it will return
// the fetch error "TOKEN_EXPIRED", the constructor will catch that, then
// sign out the user and call the listener a second time.
// sign-out the user and call the listener a second time.
let calls = 0;
const userData = await new Promise(resolve => {
auth.listen(user => {
Expand All @@ -199,10 +199,10 @@ describe('Auth', () => {
expect(userData).toBe(null);
});

test('Signs out a previously signed in user when their token is invalid', async () => {
test('Signs-out a previously signed-in user when their token is invalid', async () => {
fetch.mockResponse('{"error": {"message": "INVALID_ID_TOKEN"}}', { status: 403 });

// Previously signed in user
// Previously signed-in user
localStorage.setItem(
'Auth:User:key:default',
JSON.stringify({
Expand All @@ -219,7 +219,7 @@ describe('Auth', () => {
// First call to the listener will be done after reading the local storage.
// After that a request to update the user data will be made, and it will return
// the fetch error "INVALID_ID_TOKEN", the constructor will catch that, then
// sign out the user and call the listener a second time.
// sign-out the user and call the listener a second time.
let calls = 0;
const userData = await new Promise(resolve => {
auth.listen(user => {
Expand Down Expand Up @@ -382,7 +382,7 @@ describe('Auth', () => {

test("Doesn't make any requests when the user is not signed-in", async () => {
// The constructor makes some requests.
// We have to mock them for this not to throw
// We must mock them, to prevent a throw
fetch.mockResponse('{}');

try {
Expand Down