docs, types, coverage

Author: dplewis

src/CoreManager.ts

@@ -197,7 +197,7 @@ export interface UserController {
   loginAs: (user: ParseUser, userId: string) => Promise<ParseUser>;
   become: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
   hydrate: (user: ParseUser, userJSON: AttributeMap) => Promise<ParseUser>;
-  logOut: (options?: RequestOptions) => Promise<void>;
+  logOut: (options?: RequestOptions & { clearSession?: boolean }) => Promise<void>;
   me: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
   requestPasswordReset: (email: string, options?: RequestOptions) => Promise<void>;
   updateUserOnDisk: (user: ParseUser) => Promise<ParseUser>;

src/ParseUser.ts

@@ -812,11 +812,13 @@ class ParseUser<T extends Attributes = Attributes> extends ParseObject<T> {
    * <code>current</code> will return <code>null</code>.
    *
    * @param {object} options
+   * @param {boolean} [options.clearSession] If true, the session token will be
+   *   removed from the user object when the session token is invalid.
    * @static
    * @returns {Promise} A promise that is resolved when the session is
    *   destroyed on the server.
    */
-  static logOut(options?: RequestOptions): Promise<void> {
+  static logOut(options?: RequestOptions & { clearSession?: boolean }): Promise<void> {
     const controller = CoreManager.getUserController();
     return controller.logOut(options);
   }
@@ -1205,10 +1207,11 @@ const DefaultController = {
     });
   },
 
-  logOut(options?: RequestOptions): Promise<void> {
+  logOut(options?: RequestOptions & { clearSession?: boolean }): Promise<void> {
     const RESTController = CoreManager.getRESTController();
     const promiseCatch = e => {
-      if (e.code === ParseError.INVALID_SESSION_TOKEN && options.clearSession) {
+      console.log(e, options);
+      if (e.code === ParseError.INVALID_SESSION_TOKEN && options?.clearSession) {
         return;
       }
       throw e;

src/__tests__/ParseUser-test.js

@@ -1076,6 +1076,28 @@ describe('ParseUser', () => {
     await ParseUser.logOut({ sessionToken: '1234', clearSession: true });
   });
 
+  it('cannot logout user with invalid session', async () => {
+    expect.assertions(2);
+    ParseUser.disableUnsafeCurrentUser();
+    ParseUser._clearCache();
+    Storage._clear();
+    const RESTController = {
+      request() {
+        const error = new ParseError(ParseError.INVALID_SESSION_TOKEN, 'Invalid session token.');
+        return Promise.reject(error);
+      },
+      ajax() {},
+    };
+    jest.spyOn(RESTController, 'request');
+    CoreManager.setRESTController(RESTController);
+    try {
+      await ParseUser.logOut({ sessionToken: '1234', clearSession: false });
+    } catch (e) {
+      expect(e.code).toBe(ParseError.INVALID_SESSION_TOKEN);
+      expect(e.message).toBe('Invalid session token.');
+    }
+  });
+
   it('can retreive a user with sessionToken (me)', async () => {
     ParseUser.disableUnsafeCurrentUser();
     ParseUser._clearCache();

types/CoreManager.d.ts

@@ -178,7 +178,9 @@ export interface UserController {
     loginAs: (user: ParseUser, userId: string) => Promise<ParseUser>;
     become: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
     hydrate: (user: ParseUser, userJSON: AttributeMap) => Promise<ParseUser>;
-    logOut: (options?: RequestOptions) => Promise<void>;
+    logOut: (options?: RequestOptions & {
+        clearSession?: boolean;
+    }) => Promise<void>;
     me: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
     requestPasswordReset: (email: string, options?: RequestOptions) => Promise<void>;
     updateUserOnDisk: (user: ParseUser) => Promise<ParseUser>;

types/ParseUser.d.ts

@@ -392,11 +392,15 @@ declare class ParseUser<T extends Attributes = Attributes> extends ParseObject<T
      * <code>current</code> will return <code>null</code>.
      *
      * @param {object} options
+     * @param {boolean} [options.clearSession] If true, the session token will be
+     *   removed from the user object when the session token is invalid.
      * @static
      * @returns {Promise} A promise that is resolved when the session is
      *   destroyed on the server.
      */
-    static logOut(options?: RequestOptions): Promise<void>;
+    static logOut(options?: RequestOptions & {
+        clearSession?: boolean;
+    }): Promise<void>;
     /**
      * Requests a password reset email to be sent to the specified email address
      * associated with the user account. This email allows the user to securely