fix(app): Run timer stays at 00:00:00 if you reconnect in the middle of a delay

app/src/redux/robot/reducer/session.js

@@ -57,6 +57,18 @@ export type SessionState = {
   remoteTimeCompensation: number | null,
   startTime: ?number,
   runTime: number,
+  /**
+   * The total number of seconds that this protocol has spent paused, across all steps executed so far.
+   * todo: hacky in that it is managed locally. Not part of the start-time fix,
+   *  but partially fixes issue of pausing without pausing the timer. Keep?
+   */
+  pausedDuration: number,
+  /**
+   * When paused it is the time at which protocol execution pause was started. When not paused it is null.
+   * todo: hacky in that it is managed locally. Not part of the start-time fix,
+   *  but partially fixes issue of pausing without pausing the timer. Keep?
+   */
+  pausedTime: number | null,
   apiLevel: [number, number] | null,
   capabilities: Array<string>,
 }
@@ -104,6 +116,8 @@ const INITIAL_STATE: SessionState = {
   remoteTimeCompensation: null,
   startTime: null,
   runTime: 0,
+  pausedTime: null,
+  pausedDuration: 0,
   apiLevel: null,
 }
 
@@ -222,6 +236,7 @@ function handleSessionUpdate(
 function handleSessionInProgress(state: SessionState): SessionState {
   return {
     ...state,
+    pausedDuration: 0,
     runTime: 0,
     startTime: null,
     remoteTimeCompensation: null,
@@ -262,7 +277,11 @@ function handleInvalidFile(
 }
 
 function handleRun(state: SessionState, action: any): SessionState {
-  return { ...state, runTime: 0, runRequest: { inProgress: true, error: null } }
+  return {
+    ...state,
+    runTime: Date.now(),
+    runRequest: { inProgress: true, error: null },
+  }
 }
 
 function handleRunResponse(state: SessionState, action: any): SessionState {
@@ -280,7 +299,12 @@ function handleTickRunTime(state: SessionState, action: any): SessionState {
 }
 
 function handlePause(state: SessionState, action: any): SessionState {
-  return { ...state, pauseRequest: { inProgress: true, error: null } }
+  return {
+    ...state,
+    pausedTime: Date.now(),
+    pauseRequest: { inProgress: true, error: null },
+    runTime: Date.now(),
+  }
 }
 
 function handlePauseResponse(state: SessionState, action: any): SessionState {
@@ -294,7 +318,15 @@ function handlePauseResponse(state: SessionState, action: any): SessionState {
 }
 
 function handleResume(state: SessionState, action: any): SessionState {
-  return { ...state, resumeRequest: { inProgress: true, error: null } }
+  const pausedDuration =
+    state.pausedTime === null ? 0 : Date.now() - Number(state.pausedTime)
+  return {
+    ...state,
+    pausedDuration: state.pausedDuration + pausedDuration,
+    pausedTime: null,
+    resumeRequest: { inProgress: true, error: null },
+    runTime: Date.now(),
+  }
 }
 
 function handleResumeResponse(state: SessionState, action: any): SessionState {

app/src/redux/robot/selectors.js

@@ -203,12 +203,13 @@ export const getSessionError: State => string | null = createSelector(
 
 const getStartTimeMs = (state: State): number | null => {
   const { startTime, remoteTimeCompensation } = session(state)
-
-  if (startTime == null || remoteTimeCompensation === null) {
+  if (startTime == null) {
     return null
   }
-
-  return startTime + remoteTimeCompensation
+  // [7740] ce: 5/26/2021 - upon reload `remoteTimeCompensation` is null.
+  // will look to see why, but in the meantime this solves the start-time
+  // issue on reload but may create other issues?
+  return startTime + remoteTimeCompensation || 0
 }
 
 export const getStartTime: (state: State) => string | null = createSelector(
@@ -218,15 +219,13 @@ export const getStartTime: (state: State) => string | null = createSelector(
   }
 )
 
-export const getRunSeconds: State => number = createSelector(
-  getStartTimeMs,
-  (state: State) => session(state).runTime,
-  (startTime: ?number, runTime: ?number): number => {
-    return runTime && startTime && runTime > startTime
-      ? Math.floor((runTime - startTime) / 1000)
-      : 0
-  }
-)
+export function getRunSeconds(state: State): number {
+  const startTime = getStartTimeMs(state)
+  const { runTime, pausedDuration } = session(state)
+  return runTime && startTime
+    ? Math.max(0, Math.floor((runTime - startTime - pausedDuration) / 1000))
+    : 0
+}
 
 export function formatSeconds(runSeconds: number): string {
   const hours = padStart(`${Math.floor(runSeconds / 3600)}`, 2, '0')

app/src/redux/robot/test/selectors.test.js

@@ -218,6 +218,7 @@ describe('robot selectors', () => {
     const state = {
       robot: {
         session: {
+          pausedDuration: 0,
           startTime: null,
           runTime: 42,
         },
@@ -227,28 +228,41 @@ describe('robot selectors', () => {
     expect(getRunTime(state)).toEqual('00:00:00')
   })
 
-  it('getRunTime with no remoteTimeCompensation', () => {
-    const state = {
-      robot: {
-        session: {
-          remoteTimeCompensation: null,
-          startTime: 40,
-          runTime: 42,
+  it('getRunTime without remoteTimeCompensation', () => {
+    const testGetRunTime = (seconds, expected) => {
+      const stateWithRunTime = {
+        robot: {
+          session: {
+            pausedDuration: 0,
+            remoteTimeCompensation: null,
+            startTime: 40,
+            runTime: 42 + 1000 * seconds,
+          },
         },
-      },
+      }
+
+      expect(getRunTime(stateWithRunTime)).toEqual(expected)
     }
 
-    expect(getRunTime(state)).toEqual('00:00:00')
+    testGetRunTime(0, '00:00:00')
+    testGetRunTime(1, '00:00:01')
+    testGetRunTime(59, '00:00:59')
+    testGetRunTime(60, '00:01:00')
+    testGetRunTime(61, '00:01:01')
+    testGetRunTime(3599, '00:59:59')
+    testGetRunTime(3600, '01:00:00')
+    testGetRunTime(3601, '01:00:01')
   })
 
-  it('getRunTime', () => {
+  it('getRunTime with remoteTimeCompensation', () => {
     const testGetRunTime = (seconds, expected) => {
       const stateWithRunTime = {
         robot: {
           session: {
-            remoteTimeCompensation: 0,
-            startTime: 42,
-            runTime: 42 + 1000 * seconds,
+            pausedDuration: 0,
+            remoteTimeCompensation: 1000,
+            startTime: 40,
+            runTime: 1042 + 1000 * seconds,
           },
         },
       }

app/src/redux/robot/test/session-reducer.test.js

@@ -43,6 +43,8 @@ describe('robot reducer - session', () => {
       startTime: null,
       runTime: 0,
       apiLevel: null,
+      pausedDuration: 0,
+      pausedTime: null,
     })
   })
 
@@ -113,6 +115,7 @@ describe('robot reducer - session', () => {
       remoteTimeCompensation: null,
       startTime: null,
       runTime: 0,
+      pausedDuration: 0,
     })
   })
 
@@ -198,15 +201,14 @@ describe('robot reducer - session', () => {
   it('handles RUN action', () => {
     const state = {
       session: {
-        runTime: now,
         runRequest: { inProgress: false, error: new Error('AH') },
       },
     }
     const action = { type: actionTypes.RUN }
 
     expect(reducer(state, action).session).toEqual({
       runRequest: { inProgress: true, error: null },
-      runTime: 0,
+      runTime: now,
     })
   })
 
@@ -248,7 +250,9 @@ describe('robot reducer - session', () => {
     const action = { type: actionTypes.PAUSE }
 
     expect(reducer(state, action).session).toEqual({
+      pausedTime: now,
       pauseRequest: { inProgress: true, error: null },
+      runTime: now,
     })
   })
 
@@ -281,13 +285,18 @@ describe('robot reducer - session', () => {
   it('handles RESUME action', () => {
     const state = {
       session: {
+        pausedDuration: 0,
+        pausedTime: now - 1000,
         resumeRequest: { inProgress: false, error: new Error('AH') },
       },
     }
     const action = { type: actionTypes.RESUME }
 
     expect(reducer(state, action).session).toEqual({
+      pausedDuration: 1000,
+      pausedTime: null,
       resumeRequest: { inProgress: true, error: null },
+      runTime: now,
     })
   })