Revert "Revert "Improve Breakpoint Syncing (#5160)"" (#5230)

This reverts commit f253328.

Author: jasonLaster

src/actions/breakpoints/syncBreakpoint.js

@@ -23,8 +23,8 @@ import type {
 } from "debugger-html";
 
 type BreakpointSyncData = {
-  previousLocation: Location | null,
-  breakpoint: Breakpoint
+  previousLocation: Location,
+  breakpoint: ?Breakpoint
 };
 
 async function makeScopedLocation(
@@ -50,7 +50,7 @@ function createSyncData(
   pendingBreakpoint: PendingBreakpoint,
   location: Location,
   generatedLocation: Location,
-  previousLocation: Location | null = null
+  previousLocation: Location
 ): BreakpointSyncData {
   const overrides = { ...pendingBreakpoint, generatedLocation, id };
   const breakpoint = createBreakpoint(location, overrides);
@@ -127,6 +127,11 @@ export async function syncClientBreakpoint(
   /** ******* Case 2: Add New Breakpoint ***********/
   // If we are not disabled, set the breakpoint on the server and get
   // that info so we can set it on our breakpoints.
+
+  if (!scopedGeneratedLocation.line) {
+    return { previousLocation, breakpoint: null };
+  }
+
   const { id, actualLocation } = await client.setBreakpoint(
     scopedGeneratedLocation,
     pendingBreakpoint.condition,

src/reducers/breakpoints.js

@@ -94,14 +94,16 @@ function addBreakpoint(state, action) {
 
 function syncBreakpoint(state, data) {
   const { breakpoint, previousLocation } = data;
-  const locationId = makeLocationId(breakpoint.location);
 
   if (previousLocation) {
-    return state
-      .deleteIn(["breakpoints", makeLocationId(previousLocation)])
-      .setIn(["breakpoints", locationId], breakpoint);
+    state = state.deleteIn(["breakpoints", makeLocationId(previousLocation)]);
+  }
+
+  if (!breakpoint) {
+    return state;
   }
 
+  const locationId = makeLocationId(breakpoint.location);
   return state.setIn(["breakpoints", locationId], breakpoint);
 }
 

src/reducers/pending-breakpoints.js

@@ -90,15 +90,21 @@ function addBreakpoint(state, action) {
 
 function syncBreakpoint(state, action) {
   const { breakpoint, previousLocation } = action;
-  const locationId = makePendingLocationId(breakpoint.location);
-  const pendingBreakpoint = createPendingBreakpoint(breakpoint);
 
   if (previousLocation) {
-    return state
-      .deleteIn(["pendingBreakpoints", makePendingLocationId(previousLocation)])
-      .setIn(["pendingBreakpoints", locationId], pendingBreakpoint);
+    state = state.deleteIn([
+      "pendingBreakpoints",
+      makePendingLocationId(previousLocation)
+    ]);
+  }
+
+  if (!breakpoint) {
+    return state;
   }
 
+  const locationId = makePendingLocationId(breakpoint.location);
+  const pendingBreakpoint = createPendingBreakpoint(breakpoint);
+
   return state.setIn(["pendingBreakpoints", locationId], pendingBreakpoint);
 }
 

src/test/mochitest/browser.ini

@@ -15,6 +15,14 @@ support-files =
   examples/sourcemaps3/bundle.js.map
   examples/sourcemaps3/sorted.js
   examples/sourcemaps3/test.js
+  examples/sourcemaps-reload/v1.bundle.js
+  examples/sourcemaps-reload/v1.bundle.js.map
+  examples/sourcemaps-reload/v2.bundle.js
+  examples/sourcemaps-reload/v2.bundle.js.map
+  examples/sourcemaps-reload/v3.bundle.js
+  examples/sourcemaps-reload/v3.bundle.js.map
+  examples/sourcemaps-reload/doc-sourcemaps-reload.html
+  examples/sourcemaps-reload/sjs_code_reload.sjs
   examples/wasm-sourcemaps/average.js
   examples/wasm-sourcemaps/average.wasm
   examples/wasm-sourcemaps/average.wasm.map
@@ -25,7 +33,8 @@ support-files =
   examples/sum/sum.min.js.map
   examples/reload/code_reload_1.js
   examples/reload/code_reload_2.js
-  examples/reload/doc_reload.html
+  examples/reload/doc-reload.html
+  examples/reload/sjs_code_reload.sjs
   examples/doc-async.html
   examples/doc-asm.html
   examples/doc-content-script-sources.html
@@ -63,7 +72,6 @@ support-files =
   examples/script-switching-02.js
   examples/script-switching-01.js
   examples/times2.js
-  examples/reload/sjs_code_reload.sjs
 
 [browser_dbg-asm.js]
 [browser_dbg-async-stepping.js]
@@ -115,6 +123,7 @@ skip-if = os == "win" # Bug 1393121
 skip-if = true # regular failures during release in Bug 1415300
 [browser_dbg-search-project.js]
 [browser_dbg-sourcemaps.js]
+[browser_dbg-sourcemaps-reload.js]
 [browser_dbg-sourcemaps-reloading.js]
 [browser_dbg-sourcemaps2.js]
 [browser_dbg-sourcemaps3.js]

src/test/mochitest/browser_dbg-reload.js

@@ -18,10 +18,13 @@ async function waitForBreakpoint(dbg, location) {
 }
 
 add_task(async function() {
-  const dbg = await initDebugger("reload/doc_reload.html", "sjs_code_reload");
+
+  const dbg = await initDebugger("reload/doc-reload.html");
+  await waitForSource(dbg, "sjs_code_reload");
 
   await selectSource(dbg, "sjs_code_reload");
   await waitForSelectedSource(dbg, "sjs_code_reload");
+
   await addBreakpoint(dbg, "sjs_code_reload", 2);
 
   await reload(dbg, "sjs_code_reload");

src/test/mochitest/browser_dbg-sourcemaps-reload.js

@@ -0,0 +1,59 @@
+/* Any copyright is dedicated to the Public Domain.
+ http://creativecommons.org/publicdomain/zero/1.0/ */
+
+/*
+ * Test reloading:
+ * 1. reload the source
+ * 2. re-sync breakpoints
+ */
+
+async function waitForBreakpoint(dbg, location) {
+  return waitForState(
+    dbg,
+    state => {
+      return dbg.selectors.getBreakpoint(dbg.getState(), location);
+    },
+    "Waiting for breakpoint"
+  );
+}
+
+function getBreakpoints(dbg) {
+  const breakpoints = dbg.selectors.getBreakpoints(dbg.getState());
+  return breakpoints.valueSeq().toJS();
+}
+
+add_task(async function() {
+  const dbg = await initDebugger("doc-minified.html");
+
+  await navigate(dbg, "sourcemaps-reload/doc-sourcemaps-reload.html", "v1");
+
+  await waitForSource(dbg, "v1");
+  await selectSource(dbg, "v1");
+
+  await addBreakpoint(dbg, "v1", 6);
+  let breakpoint = getBreakpoints(dbg)[0];
+  is(breakpoint.location.line, 6);
+
+  let syncBp = waitForDispatch(dbg, "SYNC_BREAKPOINT");
+  await reload(dbg);
+
+  await waitForPaused(dbg);
+  await syncBp;
+  assertDebugLine(dbg, 72);
+  breakpoint = getBreakpoints(dbg)[0];
+
+  is(breakpoint.location.line, 9);
+  is(breakpoint.generatedLocation.line, 73);
+
+  await resume(dbg);
+  syncBp = waitForDispatch(dbg, "SYNC_BREAKPOINT", 2);
+  await selectSource(dbg, "v1");
+  await addBreakpoint(dbg, "v1", 13);
+
+  await reload(dbg);
+  await waitForSource(dbg, "v1");
+  await syncBp;
+  await waitForSelectedSource(dbg, "v1");
+
+  is(getBreakpoints(dbg).length, 0, "No breakpoints");
+});

…ochitest/examples/reload/doc_reload.html …ochitest/examples/reload/doc-reload.htmlsrc/test/mochitest/examples/reload/doc_reload.html renamed to src/test/mochitest/examples/reload/doc-reload.html src/test/mochitest/examples/reload/doc_reload.html renamed to src/test/mochitest/examples/reload/doc-reload.html

@@ -0,0 +1,3 @@
+{
+  "plugins": ["transform-async-to-generator"]
+}

src/test/mochitest/examples/sourcemaps-reload/.babelrc

@@ -0,0 +1,7 @@
+### Steps to Rebuild
+
+1. make changes to v1.js, v2.js, v3.js
+2. run `yarn` to install webpack & babel
+3. run `webpack`
+4. change `sources` reference in `v2.bundle.js.map` to `v1.js`
+5. change `sources` reference in `v3.bundle.js.map` to `v1.js`

src/test/mochitest/examples/sourcemaps-reload/README.md

@@ -0,0 +1,15 @@
+<!-- Any copyright is dedicated to the Public Domain.
+     http://creativecommons.org/publicdomain/zero/1.0/ -->
+<!doctype html>
+
+<html>
+  <script src="sjs_code_reload.sjs?foo"></script>
+  <head>
+    <meta charset="utf-8"/>
+    <title>Empty test page 1</title>
+  </head>
+
+  <body>
+  </body>
+
+</html>