Add stricter types for Breakpoint and AST actions (#5843)

Author: ryanjduffy

src/actions/ast.js

@@ -24,7 +24,7 @@ import { PROMISE } from "./utils/middleware/promise";
 import { isGeneratedId } from "devtools-source-map";
 
 import type { SourceId } from "../types";
-import type { ThunkArgs } from "./types";
+import type { ThunkArgs, Action } from "./types";
 
 export function setSourceMetaData(sourceId: SourceId) {
   return async ({ dispatch, getState }: ThunkArgs) => {
@@ -34,13 +34,16 @@ export function setSourceMetaData(sourceId: SourceId) {
     }
 
     const framework = await getFramework(source.id);
-    dispatch({
-      type: "SET_SOURCE_METADATA",
-      sourceId: source.id,
-      sourceMetaData: {
-        framework
-      }
-    });
+
+    dispatch(
+      ({
+        type: "SET_SOURCE_METADATA",
+        sourceId: source.id,
+        sourceMetaData: {
+          framework
+        }
+      }: Action)
+    );
   };
 }
 
@@ -56,11 +59,13 @@ export function setSymbols(sourceId: SourceId) {
       return;
     }
 
-    await dispatch({
-      type: "SET_SYMBOLS",
-      source: source.toJS(),
-      [PROMISE]: getSymbols(source.id)
-    });
+    await dispatch(
+      ({
+        type: "SET_SYMBOLS",
+        source: source.toJS(),
+        [PROMISE]: getSymbols(source.id)
+      }: Action)
+    );
 
     if (isPaused(getState())) {
       await dispatch(mapFrames());
@@ -85,11 +90,12 @@ export function setOutOfScopeLocations() {
       locations = await findOutOfScopeLocations(source.get("id"), location);
     }
 
-    dispatch({
-      type: "OUT_OF_SCOPE_LOCATIONS",
-      locations
-    });
-
+    dispatch(
+      ({
+        type: "OUT_OF_SCOPE_LOCATIONS",
+        locations
+      }: Action)
+    );
     dispatch(setInScopeLines());
   };
 }
@@ -107,10 +113,12 @@ export function setPausePoints(sourceId: SourceId) {
       await client.setPausePoints(source.id, pausePoints);
     }
 
-    dispatch({
-      type: "SET_PAUSE_POINTS",
-      source: source.toJS(),
-      pausePoints
-    });
+    dispatch(
+      ({
+        type: "SET_PAUSE_POINTS",
+        source: source.toJS(),
+        pausePoints
+      }: Action)
+    );
   };
 }

src/actions/breakpoints.js

@@ -24,7 +24,7 @@ import { isEmptyLineInSource } from "../reducers/ast";
 // this will need to be changed so that addCLientBreakpoint is removed
 import { syncClientBreakpoint } from "./breakpoints/syncBreakpoint";
 
-import type { ThunkArgs } from "./types";
+import type { ThunkArgs, Action } from "./types";
 import type { SourceId, PendingBreakpoint, Location } from "../types";
 import type { BreakpointsMap } from "../reducers/types";
 
@@ -55,11 +55,13 @@ export function syncBreakpoint(
       pendingBreakpoint
     );
 
-    return dispatch({
-      type: "SYNC_BREAKPOINT",
-      breakpoint,
-      previousLocation
-    });
+    return dispatch(
+      ({
+        type: "SYNC_BREAKPOINT",
+        breakpoint,
+        previousLocation
+      }: Action)
+    );
   };
 }
 
@@ -78,9 +80,18 @@ export function addBreakpoint(
 ) {
   const breakpoint = createBreakpoint(location, { condition, hidden });
   return ({ dispatch, getState, sourceMaps, client }: ThunkArgs) => {
-    const action = { type: "ADD_BREAKPOINT", breakpoint };
-    const promise = addBreakpointPromise(getState, client, sourceMaps, action);
-    return dispatch({ ...action, [PROMISE]: promise });
+    return dispatch(
+      ({
+        type: "ADD_BREAKPOINT",
+        breakpoint,
+        [PROMISE]: addBreakpointPromise(
+          getState,
+          client,
+          sourceMaps,
+          breakpoint
+        )
+      }: Action)
+    );
   };
 }
 
@@ -114,18 +125,23 @@ export function removeBreakpoint(location: Location) {
     // with the server. We just need to dispatch an action
     // simulating a successful server request
     if (bp.disabled) {
-      return dispatch({
-        type: "REMOVE_BREAKPOINT",
-        breakpoint: bp,
-        status: "done"
-      });
+      return dispatch(
+        ({
+          type: "REMOVE_BREAKPOINT",
+          breakpoint: bp,
+          status: "done"
+        }: Action)
+      );
     }
 
-    return dispatch({
-      type: "REMOVE_BREAKPOINT",
-      breakpoint: bp,
-      [PROMISE]: client.removeBreakpoint(bp.generatedLocation)
-    });
+    return dispatch(
+      ({
+        type: "REMOVE_BREAKPOINT",
+        breakpoint: bp,
+        disabled: false,
+        [PROMISE]: client.removeBreakpoint(bp.generatedLocation)
+      }: Action)
+    );
   };
 }
 
@@ -144,13 +160,13 @@ export function enableBreakpoint(location: Location) {
       return;
     }
 
-    const action = { type: "ENABLE_BREAKPOINT", breakpoint };
-    const promise = addBreakpointPromise(getState, client, sourceMaps, action);
-    return dispatch({
+    const action: Action = {
       type: "ENABLE_BREAKPOINT",
       breakpoint,
-      [PROMISE]: promise
-    });
+      [PROMISE]: addBreakpointPromise(getState, client, sourceMaps, breakpoint)
+    };
+
+    return dispatch(action);
   };
 }
 
@@ -171,10 +187,12 @@ export function disableBreakpoint(location: Location) {
     await client.removeBreakpoint(bp.generatedLocation);
     const newBreakpoint = { ...bp, disabled: true };
 
-    return dispatch({
+    const action: Action = {
       type: "DISABLE_BREAKPOINT",
       breakpoint: newBreakpoint
-    });
+    };
+
+    return dispatch(action);
   };
 }
 
@@ -201,12 +219,21 @@ export function toggleAllBreakpoints(shouldDisableBreakpoints: boolean) {
       }
     }
 
-    return dispatch({
-      type: shouldDisableBreakpoints
-        ? "DISABLE_ALL_BREAKPOINTS"
-        : "ENABLE_ALL_BREAKPOINTS",
-      breakpoints: modifiedBreakpoints
-    });
+    if (shouldDisableBreakpoints) {
+      return dispatch(
+        ({
+          type: "DISABLE_ALL_BREAKPOINTS",
+          breakpoints: modifiedBreakpoints
+        }: Action)
+      );
+    }
+
+    return dispatch(
+      ({
+        type: "ENABLE_ALL_BREAKPOINTS",
+        breakpoints: modifiedBreakpoints
+      }: Action)
+    );
   };
 }
 
@@ -269,10 +296,12 @@ export function remapBreakpoints(sourceId: string) {
       sourceMaps
     );
 
-    return dispatch({
-      type: "REMAP_BREAKPOINTS",
-      breakpoints: newBreakpoints
-    });
+    return dispatch(
+      ({
+        type: "REMAP_BREAKPOINTS",
+        breakpoints: newBreakpoints
+      }: Action)
+    );
   };
 }
 
@@ -318,10 +347,12 @@ export function setBreakpointCondition(
 
     assertBreakpoint(newBreakpoint);
 
-    return dispatch({
-      type: "SET_BREAKPOINT_CONDITION",
-      breakpoint: newBreakpoint
-    });
+    return dispatch(
+      ({
+        type: "SET_BREAKPOINT_CONDITION",
+        breakpoint: newBreakpoint
+      }: Action)
+    );
   };
 }
 

src/actions/breakpoints/addBreakpoint.js

@@ -16,7 +16,7 @@ export default async function addBreakpoint(
   getState,
   client,
   sourceMaps,
-  { breakpoint }
+  breakpoint
 ) {
   const state = getState();
 

src/actions/preview.js

@@ -23,7 +23,7 @@ import {
 import { getMappedExpression } from "./expressions";
 import { isEqual } from "lodash";
 
-import type { ThunkArgs } from "./types";
+import type { Action, ThunkArgs } from "./types";
 import type { Frame, ColumnPosition } from "../types";
 import type { AstLocation } from "../workers/parser";
 
@@ -165,44 +165,46 @@ export function setPreview(
   cursorPos: any
 ) {
   return async ({ dispatch, getState, client, sourceMaps }: ThunkArgs) => {
-    await dispatch({
-      type: "SET_PREVIEW",
-      [PROMISE]: (async function() {
-        const source = getSelectedSource(getState());
-
-        const sourceId = source.get("id");
-        if (location && !isGeneratedId(sourceId)) {
-          expression = await dispatch(getMappedExpression(expression));
-        }
-
-        const selectedFrame = getSelectedFrame(getState());
-        if (!selectedFrame) {
-          return;
-        }
-
-        const { result } = await client.evaluateInFrame(
-          selectedFrame.id,
-          expression
-        );
-
-        if (result === undefined) {
-          return;
-        }
-
-        const extra = await dispatch(
-          getExtra(expression, result, selectedFrame)
-        );
-
-        return {
-          expression,
-          result,
-          location,
-          tokenPos,
-          cursorPos,
-          extra
-        };
-      })()
-    });
+    await dispatch(
+      ({
+        type: "SET_PREVIEW",
+        [PROMISE]: (async function() {
+          const source = getSelectedSource(getState());
+
+          const sourceId = source.get("id");
+          if (location && !isGeneratedId(sourceId)) {
+            expression = await dispatch(getMappedExpression(expression));
+          }
+
+          const selectedFrame = getSelectedFrame(getState());
+          if (!selectedFrame) {
+            return;
+          }
+
+          const { result } = await client.evaluateInFrame(
+            selectedFrame.id,
+            expression
+          );
+
+          if (result === undefined) {
+            return;
+          }
+
+          const extra = await dispatch(
+            getExtra(expression, result, selectedFrame)
+          );
+
+          return {
+            expression,
+            result,
+            location,
+            tokenPos,
+            cursorPos,
+            extra
+          };
+        })()
+      }: Action)
+    );
   };
 }
 
@@ -213,8 +215,10 @@ export function clearPreview() {
       return;
     }
 
-    return dispatch({
-      type: "CLEAR_SELECTION"
-    });
+    return dispatch(
+      ({
+        type: "CLEAR_SELECTION"
+      }: Action)
+    );
   };
 }