[RPP] Display final redirect/history URL for insight sets

Adds `finalDisplayUrlByNavigationId` to MetaHandler, which resolves a
navigation id to the final redirect / history push state URL. This
matches the `finalDisplayedUrl` semantics from Lighthouse.

Fixed: 402743677
Change-Id: I30e223c14a95b628780097de0be0b7b79969b2a4
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6353987
Auto-Submit: Connor Clark <[email protected]>
Commit-Queue: Paul Irish <[email protected]>
Reviewed-by: Paul Irish <[email protected]>

Author: Connor Clark

front_end/models/trace/Processor.ts

@@ -450,11 +450,12 @@ export class TraceProcessor extends EventTarget {
     let id, urlString, navigation;
     if (context.navigation) {
       id = context.navigationId;
-      urlString = context.navigation.args.data?.documentLoaderURL ?? parsedTrace.Meta.mainFrameURL;
+      urlString =
+          parsedTrace.Meta.finalDisplayUrlByNavigationId.get(context.navigationId) ?? parsedTrace.Meta.mainFrameURL;
       navigation = context.navigation;
     } else {
       id = Types.Events.NO_NAVIGATION;
-      urlString = parsedTrace.Meta.mainFrameURL;
+      urlString = parsedTrace.Meta.finalDisplayUrlByNavigationId.get('') ?? parsedTrace.Meta.mainFrameURL;
     }
 
     const model = {} as Insights.Types.InsightSet['model'];

front_end/models/trace/handlers/MetaHandler.test.ts

@@ -604,4 +604,35 @@ describe('MetaHandler', function() {
        // But they are not in the primary page.
        assert.strictEqual(data.mainFrameId, '07B7D55F5BE0ADB8AAD6502F2D3859FF');
      });
+
+  it('will detect the final redirect URL for a main frame navigation', async function() {
+    // See crbug.com/402743677 for context.
+    const events = await TraceLoader.rawEvents(this, 'redirects-http-to-https.json.gz');
+    for (const event of events) {
+      Trace.Handlers.ModelHandlers.Meta.handleEvent(event);
+    }
+    await Trace.Handlers.ModelHandlers.Meta.finalize();
+    const data = Trace.Handlers.ModelHandlers.Meta.data();
+
+    assert.strictEqual(data.mainFrameURL, 'https://example.com/');
+    assert.strictEqual(data.mainFrameNavigations[0].args.data?.documentLoaderURL, 'http://paulirish.com/');
+    assert.deepEqual([...data.finalDisplayUrlByNavigationId], [
+      ['832038B69FE671709DE9655B8161EB9A', 'https://www.paulirish.com/'],
+    ]);
+  });
+
+  it('will detect history API navigations for the start of the trace even w/o any navigation', async function() {
+    // See crbug.com/402743677 for context.
+    const events = await TraceLoader.rawEvents(this, 'history-api-no-nav.json.gz');
+    for (const event of events) {
+      Trace.Handlers.ModelHandlers.Meta.handleEvent(event);
+    }
+    await Trace.Handlers.ModelHandlers.Meta.finalize();
+    const data = Trace.Handlers.ModelHandlers.Meta.data();
+
+    assert.strictEqual(data.mainFrameURL, 'http://localhost:10325/test.html');
+    assert.deepEqual([...data.finalDisplayUrlByNavigationId], [
+      ['', 'http://localhost:10325/testing/me?0.7574185139653986'],
+    ]);
+  });
 });

front_end/models/trace/handlers/MetaHandler.ts

@@ -51,6 +51,7 @@ const traceBounds: Types.Timing.TraceWindowMicro = {
  */
 const navigationsByFrameId = new Map<string, Types.Events.NavigationStart[]>();
 const navigationsByNavigationId = new Map<string, Types.Events.NavigationStart>();
+const finalDisplayUrlByNavigationId = new Map<string, string>();
 const mainFrameNavigations: Types.Events.NavigationStart[] = [];
 
 // Represents all the threads in the trace, organized by process. This is mostly for internal
@@ -82,6 +83,7 @@ const CHROME_WEB_TRACE_EVENTS = new Set([
 export function reset(): void {
   navigationsByFrameId.clear();
   navigationsByNavigationId.clear();
+  finalDisplayUrlByNavigationId.clear();
   processNames.clear();
   mainFrameNavigations.length = 0;
 
@@ -303,6 +305,7 @@ export function handleEvent(event: Types.Events.Event): void {
       return;
     }
     navigationsByNavigationId.set(navigationId, event);
+    finalDisplayUrlByNavigationId.set(navigationId, event.args.data.documentLoaderURL);
 
     const frameId = event.args.frame;
     const existingFrameNavigations = navigationsByFrameId.get(frameId) || [];
@@ -313,6 +316,34 @@ export function handleEvent(event: Types.Events.Event): void {
     }
     return;
   }
+
+  // Update `finalDisplayUrlByNavigationId` to reflect the latest redirect for each navigation.
+  if (Types.Events.isResourceSendRequest(event)) {
+    if (event.args.data.resourceType !== 'Document') {
+      return;
+    }
+
+    const maybeNavigationId = event.args.data.requestId;
+    const navigation = navigationsByNavigationId.get(maybeNavigationId);
+    if (!navigation) {
+      return;
+    }
+
+    finalDisplayUrlByNavigationId.set(maybeNavigationId, event.args.data.url);
+    return;
+  }
+
+  // Update `finalDisplayUrlByNavigationId` to reflect history API navigations.
+  if (Types.Events.isDidCommitSameDocumentNavigation(event)) {
+    if (event.args.render_frame_host.frame_type !== 'PRIMARY_MAIN_FRAME') {
+      return;
+    }
+
+    const navigation = mainFrameNavigations.at(-1);
+    const key = navigation?.args.data?.navigationId ?? '';
+    finalDisplayUrlByNavigationId.set(key, event.args.url);
+    return;
+  }
 }
 
 export async function finalize(): Promise<void> {
@@ -405,6 +436,19 @@ export interface MetaHandlerData {
   gpuProcessId: Types.Events.ProcessID;
   navigationsByFrameId: Map<string, Types.Events.NavigationStart[]>;
   navigationsByNavigationId: Map<string, Types.Events.NavigationStart>;
+  /**
+   * The user-visible URL displayed to users in the address bar.
+   * This captures:
+   *  - resolving all redirects
+   *  - history API pushState
+   *
+   * Given no redirects or history API usages, this is just the navigation event's documentLoaderURL.
+   *
+   * Note: empty string special case denotes the duration of the trace between the start
+   * and the first navigation. If there is no history API navigation during this time,
+   * there will be no value for empty string.
+   **/
+  finalDisplayUrlByNavigationId: Map<string, string>;
   threadsInProcess: Map<Types.Events.ProcessID, Map<Types.Events.ThreadID, Types.Events.ThreadName>>;
   mainFrameId: string;
   mainFrameURL: string;
@@ -457,6 +501,7 @@ export function data(): MetaHandlerData {
     mainFrameURL,
     navigationsByFrameId,
     navigationsByNavigationId,
+    finalDisplayUrlByNavigationId,
     threadsInProcess,
     rendererProcessesByFrame: rendererProcessesByFrameId,
     topLevelRendererIds,

front_end/models/trace/types/TraceEvents.ts

@@ -2248,6 +2248,20 @@ export function isNavigationStart(event: Event): event is NavigationStart {
   return event.name === 'navigationStart' && (event as NavigationStart).args?.data?.documentLoaderURL !== '';
 }
 
+export interface DidCommitSameDocumentNavigation extends Complete {
+  name: 'RenderFrameHostImpl::DidCommitSameDocumentNavigation';
+  args: Args&{
+    url: string,
+    render_frame_host: {
+      frame_type: string,
+    },
+  };
+}
+
+export function isDidCommitSameDocumentNavigation(event: Event): event is DidCommitSameDocumentNavigation {
+  return event.name === 'RenderFrameHostImpl::DidCommitSameDocumentNavigation';
+}
+
 export function isMainFrameViewport(
     event: Event,
     ): event is MainFrameViewport {

front_end/panels/timeline/fixtures/traces/BUILD.gn

@@ -34,6 +34,7 @@ copy_to_gen("traces") {
     "forced-layouts-and-no-gpu.json.gz",
     "forced-reflow.json.gz",
     "generic-about-tracing.json.gz",
+    "history-api-no-nav.json.gz",
     "idle-callback.json.gz",
     "idle-tasks.json.gz",
     "iframe-shift.json.gz",
@@ -86,6 +87,7 @@ copy_to_gen("traces") {
     "react-hello-world.json.gz",
     "recursive-blocking-js.json.gz",
     "recursive-counting-js.json.gz",
+    "redirects-http-to-https.json.gz",
     "redirects-subresource-multiple.json.gz",
     "redirects.json.gz",
     "reload-and-trace-page.json.gz",

front_end/panels/timeline/fixtures/traces/history-api-no-nav.json.gz

@@ -630,6 +630,7 @@ export function getBaseTraceParseModelData(overrides: Partial<ParsedTrace> = {})
       threadsInProcess: new Map(),
       navigationsByFrameId: new Map(),
       navigationsByNavigationId: new Map(),
+      finalDisplayUrlByNavigationId: new Map(),
       mainFrameId: '',
       mainFrameURL: '',
       rendererProcessesByFrame: new Map(),