feat(StoreDevtools): Add support for jumping to a specific action (#703)

Closes #681

Author: brandonroberts

modules/store-devtools/spec/store.spec.ts

@@ -259,6 +259,16 @@ describe('Store Devtools', () => {
       expect(getState()).toBe(2);
     });
 
+    it('should jump to action', () => {
+      store.dispatch({ type: 'INCREMENT' });
+      store.dispatch({ type: 'DECREMENT' });
+      store.dispatch({ type: 'INCREMENT' });
+      expect(getState()).toBe(1);
+
+      devtools.jumpToAction(2);
+      expect(getState()).toBe(0);
+    });
+
     it('should replace the reducer and preserve previous states', () => {
       store.dispatch({ type: 'INCREMENT' });
       store.dispatch({ type: 'DECREMENT' });

modules/store-devtools/src/actions.ts

@@ -8,6 +8,7 @@ export const SWEEP = 'SWEEP';
 export const TOGGLE_ACTION = 'TOGGLE_ACTION';
 export const SET_ACTIONS_ACTIVE = 'SET_ACTIONS_ACTIVE';
 export const JUMP_TO_STATE = 'JUMP_TO_STATE';
+export const JUMP_TO_ACTION = 'JUMP_TO_ACTION';
 export const IMPORT_STATE = 'IMPORT_STATE';
 
 export class PerformAction implements Action {
@@ -67,6 +68,12 @@ export class JumpToState implements Action {
   constructor(public index: number) {}
 }
 
+export class JumpToAction implements Action {
+  readonly type = JUMP_TO_ACTION;
+
+  constructor(public actionId: number) {}
+}
+
 export class ImportState implements Action {
   readonly type = IMPORT_STATE;
 
@@ -82,4 +89,5 @@ export type All =
   | ToggleAction
   | SetActionsActive
   | JumpToState
+  | JumpToAction
   | ImportState;

modules/store-devtools/src/devtools.ts

@@ -133,6 +133,10 @@ export class StoreDevtools implements Observer<any> {
     this.dispatch(new Actions.ToggleAction(id));
   }
 
+  jumpToAction(actionId: number) {
+    this.dispatch(new Actions.JumpToAction(actionId));
+  }
+
   jumpToState(index: number) {
     this.dispatch(new Actions.JumpToState(index));
   }

modules/store-devtools/src/reducer.ts

@@ -259,6 +259,14 @@ export function liftReducerWith(
         minInvalidatedStateIndex = Infinity;
         break;
       }
+      case Actions.JUMP_TO_ACTION: {
+        // Jumps to a corresponding state to a specific action.
+        // Useful when filtering actions.
+        const index = stagedActionIds.indexOf(liftedAction.actionId);
+        if (index !== -1) currentStateIndex = index;
+        minInvalidatedStateIndex = Infinity;
+        break;
+      }
       case Actions.SWEEP: {
         // Forget any actions that are currently being skipped.
         stagedActionIds = difference(stagedActionIds, skippedActionIds);