10349 Bug: Idle Logout Issues (with automated tests)

shared/src/business/entities/EntityConstants.ts

@@ -1648,3 +1648,23 @@ export type CreatedCaseType = {
     name: string;
   };
 };
+
+export const LOGOUT_BROADCAST_MESSAGES = {
+  userLogout: 'userLogout',
+  idleLogout: 'idleLogout',
+  idleStatusActive: 'idleStatusActive',
+  stayLoggedIn: 'stayLoggedIn',
+};
+
+export const IDLE_LOGOUT_STATES = {
+  INITIAL: 'INITIAL',
+  MONITORING: 'MONITORING',
+  COUNTDOWN: 'COUNTDOWN',
+};
+
+export type IdleLogoutStateType =
+  (typeof IDLE_LOGOUT_STATES)[keyof typeof IDLE_LOGOUT_STATES];
+
+export type IdleLogoutType =
+  | (typeof LOGOUT_BROADCAST_MESSAGES)['idleLogout']
+  | (typeof LOGOUT_BROADCAST_MESSAGES)['userLogout'];

web-client/src/AppInstanceManager.tsx

@@ -1,3 +1,4 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
 import { connect } from '@web-client/presenter/shared.cerebral';
 import { sequences } from '@web-client/presenter/app.cerebral';
 import { state } from '@web-client/presenter/app.cerebral';
@@ -18,26 +19,33 @@ export const AppInstanceManager = connect(
     appInstanceManagerHelper: state.appInstanceManagerHelper,
     confirmStayLoggedInSequence: sequences.confirmStayLoggedInSequence,
     resetIdleTimerSequence: sequences.resetIdleTimerSequence,
-    signOutSequence: sequences.signOutSequence,
+    signOutIdleSequence: sequences.signOutIdleSequence,
+    signOutUserInitiatedSequence: sequences.signOutUserInitiatedSequence,
   },
   function AppInstanceManager({
     appInstanceManagerHelper,
     confirmStayLoggedInSequence,
     resetIdleTimerSequence,
-    signOutSequence,
+    signOutIdleSequence,
+    signOutUserInitiatedSequence,
   }) {
     const { channelHandle } = appInstanceManagerHelper;
 
     channelHandle.onmessage = msg => {
       switch (msg.subject) {
-        case 'idleStatusActive':
+        case LOGOUT_BROADCAST_MESSAGES.idleStatusActive:
           resetIdleTimerSequence();
           break;
-        case 'stayLoggedIn':
+        case LOGOUT_BROADCAST_MESSAGES.stayLoggedIn:
           confirmStayLoggedInSequence();
           break;
-        case 'logout':
-          signOutSequence({
+        case LOGOUT_BROADCAST_MESSAGES.idleLogout:
+          signOutIdleSequence({
+            skipBroadcast: true,
+          });
+          break;
+        case LOGOUT_BROADCAST_MESSAGES.userLogout:
+          signOutUserInitiatedSequence({
             skipBroadcast: true,
           });
           break;

web-client/src/presenter/actions/broadcastIdleStatusActiveAction.test.ts

@@ -1,3 +1,4 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
 import { applicationContextForClient as applicationContext } from '@web-client/test/createClientTestApplicationContext';
 import { broadcastIdleStatusActiveAction } from './broadcastIdleStatusActiveAction';
 import { presenter } from '../presenter-mock';
@@ -19,7 +20,7 @@ describe('broadcastIdleStatusActiveAction', () => {
     expect(
       applicationContext.getBroadcastGateway().postMessage.mock.calls[0][0],
     ).toMatchObject({
-      subject: 'idleStatusActive',
+      subject: LOGOUT_BROADCAST_MESSAGES.idleStatusActive,
     });
   });
 });

web-client/src/presenter/actions/broadcastIdleStatusActiveAction.ts

@@ -1,3 +1,4 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
 import { state } from '@web-client/presenter/app.cerebral';
 
 /**
@@ -12,5 +13,7 @@ export const broadcastIdleStatusActiveAction = async ({
 }: ActionProps) => {
   store.set(state.lastIdleAction, Date.now());
   const broadcastChannel = applicationContext.getBroadcastGateway();
-  await broadcastChannel.postMessage({ subject: 'idleStatusActive' });
+  await broadcastChannel.postMessage({
+    subject: LOGOUT_BROADCAST_MESSAGES.idleStatusActive,
+  });
 };

web-client/src/presenter/actions/broadcastLogoutAction.ts

@@ -1,3 +1,5 @@
+import { state } from '@web-client/presenter/app.cerebral';
+
 /**
  * tells all open tabs to also logout
  * @param {object} providers the providers object
@@ -6,11 +8,14 @@
  */
 export const broadcastLogoutAction = async ({
   applicationContext,
+  get,
   props,
 }: ActionProps) => {
   // for some reason this causes jest integration tests to never finish, so don't run in CI
   if (!process.env.CI && !props.skipBroadcast) {
     const broadcastChannel = applicationContext.getBroadcastGateway();
-    await broadcastChannel.postMessage({ subject: 'logout' });
+    await broadcastChannel.postMessage({
+      subject: get(state.logoutType),
+    });
   }
 };

web-client/src/presenter/actions/broadcastStayLoggedInAction.test.ts

@@ -1,3 +1,4 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
 import { applicationContextForClient as applicationContext } from '@web-client/test/createClientTestApplicationContext';
 import { broadcastStayLoggedInAction } from './broadcastStayLoggedInAction';
 import { presenter } from '../presenter-mock';
@@ -19,7 +20,7 @@ describe('broadcastStayLoggedInAction', () => {
     expect(
       applicationContext.getBroadcastGateway().postMessage.mock.calls[0][0],
     ).toMatchObject({
-      subject: 'stayLoggedIn',
+      subject: LOGOUT_BROADCAST_MESSAGES.stayLoggedIn,
     });
   });
 });

web-client/src/presenter/actions/broadcastStayLoggedInAction.ts

@@ -1,3 +1,5 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
+
 /**
  * broadcasts a stay logged in message to all app instances
  * @param {object} providers the providers object
@@ -9,5 +11,7 @@ export const broadcastStayLoggedInAction = async ({
 }: ActionProps) => {
   const broadcastChannel = applicationContext.getBroadcastGateway();
 
-  await broadcastChannel.postMessage({ subject: 'stayLoggedIn' });
+  await broadcastChannel.postMessage({
+    subject: LOGOUT_BROADCAST_MESSAGES.stayLoggedIn,
+  });
 };

web-client/src/presenter/actions/clearIdleTimerAction.test.ts

@@ -0,0 +1,23 @@
+import { IDLE_LOGOUT_STATES } from '@shared/business/entities/EntityConstants';
+import { clearIdleTimerAction } from './clearIdleTimerAction';
+import { runAction } from '@web-client/presenter/test.cerebral';
+
+describe('clearLoginFormAction', () => {
+  it('should reset the idle timer state', async () => {
+    const result = await runAction(clearIdleTimerAction, {
+      state: {
+        idleLogoutState: {
+          logoutAt: Date.now(),
+          state: IDLE_LOGOUT_STATES.COUNTDOWN,
+        },
+        lastIdleAction: Date.now(),
+      },
+    });
+
+    expect(result.state.lastIdleAction).not.toBeDefined();
+    expect(result.state.idleLogoutState).toMatchObject({
+      logoutAt: undefined,
+      state: IDLE_LOGOUT_STATES.INITIAL,
+    });
+  });
+});

web-client/src/presenter/actions/clearIdleTimerAction.ts

@@ -0,0 +1,10 @@
+import { IDLE_LOGOUT_STATES } from '@shared/business/entities/EntityConstants';
+import { state } from '@web-client/presenter/app.cerebral';
+
+export const clearIdleTimerAction = ({ store }: ActionProps) => {
+  store.unset(state.lastIdleAction);
+  store.set(state.idleLogoutState, {
+    logoutAt: undefined,
+    state: IDLE_LOGOUT_STATES.INITIAL,
+  });
+};

web-client/src/presenter/actions/clearLogoutTypeAction.test.ts

@@ -0,0 +1,15 @@
+import { LOGOUT_BROADCAST_MESSAGES } from '@shared/business/entities/EntityConstants';
+import { clearLogoutTypeAction } from './clearLogoutTypeAction';
+import { runAction } from '@web-client/presenter/test.cerebral';
+
+describe('clearLogoutTypeAction', () => {
+  it('should clear the logout type', async () => {
+    const result = await runAction(clearLogoutTypeAction, {
+      state: {
+        logoutType: LOGOUT_BROADCAST_MESSAGES.userLogout,
+      },
+    });
+
+    expect(result.state.logoutType).toBe('');
+  });
+});

web-client/src/presenter/actions/clearLogoutTypeAction.ts

@@ -0,0 +1,5 @@
+import { state } from '@web-client/presenter/app.cerebral';
+
+export const clearLogoutTypeAction = ({ store }: ActionProps) => {
+  store.set(state.logoutType, '');
+};

web-client/src/presenter/actions/handleIdleLogoutAction.test.ts

@@ -1,3 +1,4 @@
+import { IDLE_LOGOUT_STATES } from '@shared/business/entities/EntityConstants';
 import { handleIdleLogoutAction } from './handleIdleLogoutAction';
 import { runAction } from '@web-client/presenter/test.cerebral';
 
@@ -30,7 +31,7 @@ describe('handleIdleLogoutAction', () => {
         },
         idleLogoutState: {
           logoutAt: undefined,
-          state: 'INITIAL',
+          state: IDLE_LOGOUT_STATES.INITIAL,
         },
         lastIdleAction: 0,
         user: undefined,
@@ -39,7 +40,7 @@ describe('handleIdleLogoutAction', () => {
 
     expect(result.state.idleLogoutState).toEqual({
       logoutAt: undefined,
-      state: 'INITIAL',
+      state: IDLE_LOGOUT_STATES.INITIAL,
     });
   });
 
@@ -58,7 +59,7 @@ describe('handleIdleLogoutAction', () => {
         },
         idleLogoutState: {
           logoutAt: undefined,
-          state: 'INITIAL',
+          state: IDLE_LOGOUT_STATES.INITIAL,
         },
         lastIdleAction: 0,
         user: {},
@@ -67,7 +68,7 @@ describe('handleIdleLogoutAction', () => {
 
     expect(result.state.idleLogoutState).toEqual({
       logoutAt: undefined,
-      state: 'INITIAL',
+      state: IDLE_LOGOUT_STATES.INITIAL,
     });
   });
 
@@ -86,7 +87,7 @@ describe('handleIdleLogoutAction', () => {
         },
         idleLogoutState: {
           logoutAt: undefined,
-          state: 'INITIAL',
+          state: IDLE_LOGOUT_STATES.INITIAL,
         },
         lastIdleAction: 0,
         user: {},
@@ -95,7 +96,7 @@ describe('handleIdleLogoutAction', () => {
 
     expect(result.state.idleLogoutState).toEqual({
       logoutAt: expect.any(Number),
-      state: 'MONITORING',
+      state: IDLE_LOGOUT_STATES.MONITORING,
     });
   });
 
@@ -115,7 +116,7 @@ describe('handleIdleLogoutAction', () => {
         },
         idleLogoutState: {
           logoutAt: undefined,
-          state: 'MONITORING',
+          state: IDLE_LOGOUT_STATES.MONITORING,
         },
         lastIdleAction: 0,
         user: {},
@@ -124,7 +125,7 @@ describe('handleIdleLogoutAction', () => {
 
     expect(result.state.idleLogoutState).toEqual({
       logoutAt: expect.any(Number),
-      state: 'COUNTDOWN',
+      state: IDLE_LOGOUT_STATES.COUNTDOWN,
     });
   });
 
@@ -144,7 +145,7 @@ describe('handleIdleLogoutAction', () => {
         },
         idleLogoutState: {
           logoutAt: 15000,
-          state: 'COUNTDOWN',
+          state: IDLE_LOGOUT_STATES.COUNTDOWN,
         },
         lastIdleAction: 0,
         user: {},
@@ -153,7 +154,7 @@ describe('handleIdleLogoutAction', () => {
 
     expect(result.state.idleLogoutState).toEqual({
       logoutAt: undefined,
-      state: 'INITIAL',
+      state: IDLE_LOGOUT_STATES.INITIAL,
     });
     expect(presenter.providers.path.logout).toHaveBeenCalled();
   });

web-client/src/presenter/actions/handleIdleLogoutAction.ts

@@ -1,3 +1,4 @@
+import { IDLE_LOGOUT_STATES } from '@shared/business/entities/EntityConstants';
 import { state } from '@web-client/presenter/app.cerebral';
 
 export const handleIdleLogoutAction = ({ get, path, store }: ActionProps) => {
@@ -7,29 +8,33 @@ export const handleIdleLogoutAction = ({ get, path, store }: ActionProps) => {
   const isUploading = get(state.fileUploadProgress.isUploading);
   const user = get(state.user);
 
-  if (user && !isUploading && idleLogoutState.state === 'INITIAL') {
+  if (
+    user &&
+    !isUploading &&
+    idleLogoutState.state === IDLE_LOGOUT_STATES.INITIAL
+  ) {
     store.set(state.idleLogoutState, {
       logoutAt:
         Date.now() +
         constants.SESSION_MODAL_TIMEOUT +
         constants.SESSION_TIMEOUT,
-      state: 'MONITORING',
+      state: IDLE_LOGOUT_STATES.MONITORING,
     });
-  } else if (idleLogoutState.state === 'MONITORING') {
+  } else if (idleLogoutState.state === IDLE_LOGOUT_STATES.MONITORING) {
     if (Date.now() > lastIdleAction + constants.SESSION_TIMEOUT) {
       store.set(state.idleLogoutState, {
         logoutAt:
           lastIdleAction +
           constants.SESSION_MODAL_TIMEOUT +
           constants.SESSION_TIMEOUT,
-        state: 'COUNTDOWN',
+        state: IDLE_LOGOUT_STATES.COUNTDOWN,
       });
     }
-  } else if (idleLogoutState.state === 'COUNTDOWN') {
+  } else if (idleLogoutState.state === IDLE_LOGOUT_STATES.COUNTDOWN) {
     if (Date.now() > idleLogoutState.logoutAt) {
       store.set(state.idleLogoutState, {
         logoutAt: undefined,
-        state: 'INITIAL',
+        state: IDLE_LOGOUT_STATES.INITIAL,
       });
       return path.logout();
     }

web-client/src/presenter/actions/handlePeerResetIdleTimerAction.test.ts

@@ -1,3 +1,4 @@
+import { IDLE_LOGOUT_STATES } from '@shared/business/entities/EntityConstants';
 import { applicationContextForClient as applicationContext } from '@web-client/test/createClientTestApplicationContext';
 import { handlePeerResetIdleTimerAction } from './handlePeerResetIdleTimerAction';
 import { presenter } from '../presenter-mock';
@@ -15,12 +16,14 @@ describe('handlePeerResetIdleTimerAction', () => {
       },
       state: {
         idleLogoutState: {
-          state: 'COUNTDOWN',
+          state: IDLE_LOGOUT_STATES.COUNTDOWN,
         },
       },
     });
 
-    expect(result.state.idleLogoutState.state).toEqual('COUNTDOWN');
+    expect(result.state.idleLogoutState.state).toEqual(
+      IDLE_LOGOUT_STATES.COUNTDOWN,
+    );
   });
 
   it('should reset the idle logout state when not COUNTDOWN', async () => {
@@ -30,11 +33,13 @@ describe('handlePeerResetIdleTimerAction', () => {
       },
       state: {
         idleLogoutState: {
-          state: 'MONITORING',
+          state: IDLE_LOGOUT_STATES.MONITORING,
         },
       },
     });
 
-    expect(result.state.idleLogoutState.state).toEqual('INITIAL');
+    expect(result.state.idleLogoutState.state).toEqual(
+      IDLE_LOGOUT_STATES.INITIAL,
+    );
   });
 });