Pause Points (#5537)

Author: jasonLaster

src/actions/ast.js

@@ -14,9 +14,9 @@ import {
 import { setInScopeLines } from "./ast/setInScopeLines";
 import {
   getSymbols,
-  getEmptyLines,
   findOutOfScopeLocations,
-  getFramework
+  getFramework,
+  getPausePoints
 } from "../workers/parser";
 import { PROMISE } from "./utils/middleware/promise";
 
@@ -64,30 +64,8 @@ export function setSymbols(sourceId: SourceId) {
       [PROMISE]: getSymbols(source.id)
     });
 
-    dispatch(setEmptyLines(sourceId));
-    dispatch(setSourceMetaData(sourceId));
-  };
-}
-
-export function setEmptyLines(sourceId: SourceId) {
-  return async ({ dispatch, getState }: ThunkArgs) => {
-    const sourceRecord = getSource(getState(), sourceId);
-    if (!sourceRecord) {
-      return;
-    }
-
-    const source = sourceRecord.toJS();
-    if (!source.text || source.isWasm) {
-      return;
-    }
-
-    const emptyLines = await getEmptyLines(source.id);
-
-    dispatch({
-      type: "SET_EMPTY_LINES",
-      source,
-      emptyLines
-    });
+    await dispatch(setPausePoints(sourceId));
+    await dispatch(setSourceMetaData(sourceId));
   };
 }
 
@@ -113,3 +91,24 @@ export function setOutOfScopeLocations() {
     dispatch(setInScopeLines());
   };
 }
+
+export function setPausePoints(sourceId: SourceId) {
+  return async ({ dispatch, getState }: ThunkArgs) => {
+    const sourceRecord = getSource(getState(), sourceId);
+    if (!sourceRecord) {
+      return;
+    }
+
+    const source = sourceRecord.toJS();
+    if (!source.text || source.isWasm) {
+      return;
+    }
+
+    const pausePoints = await getPausePoints(source.id);
+    dispatch({
+      type: "SET_PAUSE_POINTS",
+      source,
+      pausePoints
+    });
+  };
+}

src/actions/sources/prettyPrint.js

@@ -7,7 +7,7 @@
 import assert from "../../utils/assert";
 import { remapBreakpoints } from "../breakpoints";
 
-import { setEmptyLines, setSymbols } from "../ast";
+import { setPausePoints, setSymbols } from "../ast";
 import { prettyPrint } from "../../workers/pretty-print";
 import { setSource } from "../../workers/parser";
 import { getPrettySourceURL, isLoaded } from "../../utils/source";
@@ -103,7 +103,7 @@ export function togglePrettyPrint(sourceId: string) {
 
     await dispatch(remapBreakpoints(sourceId));
     await dispatch(mapFrames());
-    await dispatch(setEmptyLines(newPrettySource.id));
+    await dispatch(setPausePoints(newPrettySource.id));
     await dispatch(setSymbols(newPrettySource.id));
 
     return dispatch(

src/actions/tests/__snapshots__/ast.spec.js.snap

@@ -40,12 +40,11 @@ Array [
 ]
 `;
 
-exports[`ast setEmptyLines scopes 1`] = `
+exports[`ast setPausePoints scopes 1`] = `
 Array [
   1,
   2,
   7,
-  12,
 ]
 `;
 

src/actions/tests/ast.spec.js

@@ -55,14 +55,14 @@ const evaluationResult = {
 };
 
 describe("ast", () => {
-  describe("setEmptyLines", () => {
+  describe("setPausePoints", () => {
     it("scopes", async () => {
       const store = createStore(threadClient);
       const { dispatch, getState } = store;
       const source = makeSource("scopes.js");
       await dispatch(actions.newSource(source));
       await dispatch(actions.loadSourceText(I.Map({ id: "scopes.js" })));
-      await dispatch(actions.setEmptyLines("scopes.js"));
+      await dispatch(actions.setPausePoints("scopes.js"));
       await waitForState(store, state => {
         const lines = getEmptyLines(state, source);
         return lines && lines.length > 0;

src/actions/types.js

@@ -17,14 +17,19 @@ import type {
 } from "../types";
 
 import type { State } from "../reducers/types";
+
 import type {
   ActiveSearchType,
   OrientationType,
   SelectedPrimaryPaneTabType
 } from "../reducers/ui";
-import type { MatchedLocations } from "../reducers/file-search";
 
-import type { AstLocation, SymbolDeclaration } from "../workers/parser";
+import type { MatchedLocations } from "../reducers/file-search";
+import type {
+  SymbolDeclaration,
+  AstLocation,
+  PausePoint
+} from "../workers/parser";
 import type { SourceMetaDataType } from "../reducers/ast.js";
 
 /**
@@ -318,6 +323,11 @@ type ASTAction =
       source: Source,
       value: SymbolDeclaration[]
     }
+  | {
+      type: "SET_PAUSE_POINTS",
+      source: Source,
+      pausePoints: PausePoint[]
+    }
   | {
       type: "SET_EMPTY_LINES",
       source: Source,

src/actions/utils/middleware/log.js

@@ -7,6 +7,7 @@ import { isTesting } from "devtools-config";
 
 const blacklist = [
   "SET_POPUP_OBJECT_PROPERTIES",
+  "SET_PAUSE_POINTS",
   "SET_SYMBOLS",
   "OUT_OF_SCOPE_LOCATIONS",
   "MAP_SCOPES",

src/components/Editor/GutterMenu.js

@@ -143,7 +143,7 @@ class GutterContextMenuComponent extends Component {
       bp => bp.location.line === line
     );
 
-    if (props.emptyLines.includes(line)) {
+    if (props.emptyLines && props.emptyLines.includes(line)) {
       return;
     }
 
@@ -164,9 +164,7 @@ export default connect(
       breakpoints: getVisibleBreakpoints(state),
       isPaused: getIsPaused(state),
       contextMenu: getContextMenu(state),
-      emptyLines: selectedSource
-        ? getEmptyLines(state, selectedSource.toJS())
-        : []
+      emptyLines: getEmptyLines(state, selectedSource.toJS())
     };
   },
   dispatch => bindActionCreators(actions, dispatch)

src/reducers/ast.js

@@ -12,6 +12,8 @@
 import * as I from "immutable";
 
 import makeRecord from "../utils/makeRecord";
+import { findEmptyLines } from "../utils/ast";
+
 import type { SymbolDeclarations, AstLocation } from "../workers/parser/types";
 
 import type { Map } from "immutable";
@@ -29,6 +31,7 @@ export type SourceMetaDataType = {
 };
 
 export type SourceMetaDataMap = Map<string, SourceMetaDataType>;
+export type PausePointsMap = Map<string, any>;
 
 export type Preview =
   | {| updating: true |}
@@ -49,6 +52,7 @@ export type ASTState = {
   outOfScopeLocations: ?Array<AstLocation>,
   inScopeLines: ?Array<Number>,
   preview: Preview,
+  pausePoints: PausePointsMap,
   sourceMetaData: SourceMetaDataMap
 };
 
@@ -60,6 +64,7 @@ export function initialASTState() {
       outOfScopeLocations: null,
       inScopeLines: null,
       preview: null,
+      pausePoints: I.Map(),
       sourceMetaData: I.Map()
     }: ASTState)
   )();
@@ -77,9 +82,14 @@ function update(
       }
       return state.setIn(["symbols", source.id], action.value);
     }
-    case "SET_EMPTY_LINES": {
-      const { source, emptyLines } = action;
-      return state.setIn(["emptyLines", source.id], emptyLines);
+
+    case "SET_PAUSE_POINTS": {
+      const { source, pausePoints } = action;
+      const emptyLines = findEmptyLines(source, pausePoints);
+
+      return state
+        .setIn(["pausePoints", source.id], pausePoints)
+        .setIn(["emptyLines", source.id], emptyLines);
     }
 
     case "OUT_OF_SCOPE_LOCATIONS": {
@@ -170,15 +180,23 @@ export function isEmptyLineInSource(
   selectedSource: Source
 ) {
   const emptyLines = getEmptyLines(state, selectedSource);
-  return emptyLines.includes(line);
+  return emptyLines && emptyLines.includes(line);
 }
 
 export function getEmptyLines(state: OuterState, source: Source) {
   if (!source) {
-    return [];
+    return null;
+  }
+
+  return state.ast.getIn(["emptyLines", source.id]);
+}
+
+export function getPausePoints(state: OuterState, source: Source) {
+  if (!source) {
+    return null;
   }
 
-  return state.ast.getIn(["emptyLines", source.id]) || [];
+  return state.ast.getIn(["pausePoints", source.id]);
 }
 
 export function getOutOfScopeLocations(state: OuterState) {

src/test/mochitest/browser_dbg-breakpoints-cond.js

@@ -49,6 +49,7 @@ async function setConditionalBreakpoint(dbg, index, condition) {
 add_task(async function() {
   const dbg = await initDebugger("doc-scripts.html");
   await selectSource(dbg, "simple2");
+  await waitForSelectedSource(dbg, "simple2");
 
   await setConditionalBreakpoint(dbg, 5, "1");
   await waitForDispatch(dbg, "ADD_BREAKPOINT");

src/utils/ast.js

@@ -4,8 +4,10 @@
 
 // @flow
 
-import type { Position } from "../types";
-import type { SymbolDeclarations } from "../workers/parser";
+import { without, range } from "lodash";
+
+import type { Source, Position } from "../types";
+import type { PausePoint, SymbolDeclarations } from "../workers/parser";
 
 export function findBestMatchExpression(
   symbols: SymbolDeclarations,
@@ -25,5 +27,24 @@ export function findBestMatchExpression(
     }
 
     return found;
-  }, {});
+  }, null);
+}
+
+export function findEmptyLines(
+  selectedSource: Source,
+  pausePoints: PausePoint[]
+) {
+  if (!pausePoints || !selectedSource) {
+    return [];
+  }
+
+  const breakpoints = pausePoints.filter(point => point.types.breakpoint);
+  const breakpointLines = breakpoints.map(point => point.location.line);
+
+  if (!selectedSource.text) {
+    return [];
+  }
+  const lineCount = selectedSource.text.split("\n").length;
+  const sourceLines = range(1, lineCount);
+  return without(sourceLines, ...breakpointLines);
 }