[RPP] Remove TimelineLoader.loadFromFile

Bug: none
Change-Id: Ifa3b7f8b099454f6642466820db55dd2a21fd13d
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6912404
Auto-Submit: Connor Clark <cjamcl@chromium.org>
Commit-Queue: Connor Clark <cjamcl@chromium.org>
Reviewed-by: Paul Irish <paulirish@chromium.org>

Author: Connor Clark

front_end/panels/timeline/TimelineLoader.test.ts

@@ -2,31 +2,24 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import * as Platform from '../../core/platform/platform.js';
 import type * as Protocol from '../../generated/protocol.js';
 import * as Trace from '../../models/trace/trace.js';
 import {describeWithEnvironment} from '../../testing/EnvironmentHelpers.js';
 import {makeInstantEvent} from '../../testing/TraceHelpers.js';
 
 import * as Timeline from './timeline.js';
 
-async function loadWebDevTraceAsFile(): Promise<File> {
-  const file = new URL('./fixtures/traces/web-dev.json.gz', import.meta.url);
-  const response = await fetch(file);
-  const asBlob = await response.blob();
-  const asFile = new File([asBlob], 'web-dev.json.gz', {
-    type: 'application/gzip',
-  });
-  return asFile;
+const {urlString} = Platform.DevToolsPath;
+
+function getWebDevTraceUrl(): Platform.DevToolsPath.UrlString {
+  const href = new URL('./fixtures/traces/web-dev.json.gz', import.meta.url).href;
+  return urlString`${href}`;
 }
 
-async function loadBasicCpuProfileAsFile(): Promise<File> {
-  const file = new URL('./fixtures/traces/node-fibonacci-website.cpuprofile.gz', import.meta.url);
-  const response = await fetch(file);
-  const asBlob = await response.blob();
-  const asFile = new File([asBlob], 'node-fibonacci-website.cpuprofile.gz', {
-    type: 'application/gzip',
-  });
-  return asFile;
+function getBasicCpuProfileUrl(): Platform.DevToolsPath.UrlString {
+  const href = new URL('./fixtures/traces/node-fibonacci-website.cpuprofile.gz', import.meta.url).href;
+  return urlString`${href}`;
 }
 
 describeWithEnvironment('TimelineLoader', () => {
@@ -72,14 +65,12 @@ describeWithEnvironment('TimelineLoader', () => {
   });
 
   it('can load a saved trace file', async () => {
-    const file = await loadWebDevTraceAsFile();
-    const loader = await Timeline.TimelineLoader.TimelineLoader.loadFromFile(file, client);
+    const url = getWebDevTraceUrl();
+    const loader = await Timeline.TimelineLoader.TimelineLoader.loadFromURL(url, client);
     await loader.traceFinalizedForTest();
     sinon.assert.calledOnce(loadingStartedSpy);
-    // Exact number is deterministic so we can assert, but the fact it was 29
-    // calls doesn't really matter. We just want to check it got called "a
-    // bunch of times".
-    sinon.assert.callCount(loadingProgressSpy, 29);
+    // Not called for loadFromURL. Maybe it should be.
+    sinon.assert.callCount(loadingProgressSpy, 0);
     sinon.assert.calledOnce(processingStartedSpy);
     sinon.assert.calledOnce(loadingCompleteSpy);
 
@@ -96,13 +87,12 @@ describeWithEnvironment('TimelineLoader', () => {
   });
 
   it('can load a saved CPUProfile file', async () => {
-    const file = await loadBasicCpuProfileAsFile();
-    const loader = await Timeline.TimelineLoader.TimelineLoader.loadFromFile(file, client);
+    const url = getBasicCpuProfileUrl();
+    const loader = await Timeline.TimelineLoader.TimelineLoader.loadFromURL(url, client);
     await loader.traceFinalizedForTest();
     sinon.assert.calledOnce(loadingStartedSpy);
-    // For the CPU Profile we are testing, loadingProgress will be called three times, because the
-    // file is not that big.
-    sinon.assert.callCount(loadingProgressSpy, 3);
+    // Not called for loadFromURL. Maybe it should be.
+    sinon.assert.callCount(loadingProgressSpy, 0);
     sinon.assert.calledOnce(processingStartedSpy);
     sinon.assert.calledOnce(loadingCompleteSpy);
 

front_end/panels/timeline/TimelineLoader.ts

@@ -8,7 +8,6 @@ import * as i18n from '../../core/i18n/i18n.js';
 import type * as Platform from '../../core/platform/platform.js';
 import * as SDK from '../../core/sdk/sdk.js';
 import type * as Protocol from '../../generated/protocol.js';
-import * as Bindings from '../../models/bindings/bindings.js';
 import * as Trace from '../../models/trace/trace.js';
 
 import * as RecordingMetadata from './RecordingMetadata.js';
@@ -25,18 +24,12 @@ const str_ = i18n.i18n.registerUIStrings('panels/timeline/TimelineLoader.ts', UI
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
 /**
- * This class handles loading traces from file and URL, and from the Lighthouse panel
- * It also handles loading cpuprofiles from file, url and console.profileEnd()
- *
- * Meanwhile, the normal trace recording flow bypasses TimelineLoader entirely,
- * as it's handled from TracingManager => TimelineController.
+ * This class handles loading traces from URL, and from the Lighthouse panel
+ * It also handles loading cpuprofiles from url and console.profileEnd()
  */
-export class TimelineLoader implements Common.StringOutputStream.OutputStream {
+export class TimelineLoader {
   private client: Client|null;
   private canceledCallback: (() => void)|null;
-  private buffer: string;
-  private firstRawChunk: boolean;
-  private totalSize!: number;
   private filter: Trace.Extras.TraceFilter.TraceFilter|null;
   #traceIsCPUProfile: boolean;
   #collectedEvents: Trace.Types.Events.Event[] = [];
@@ -48,8 +41,6 @@ export class TimelineLoader implements Common.StringOutputStream.OutputStream {
   constructor(client: Client) {
     this.client = client;
     this.canceledCallback = null;
-    this.buffer = '';
-    this.firstRawChunk = true;
     this.filter = null;
     this.#traceIsCPUProfile = false;
     this.#metadata = null;
@@ -59,23 +50,6 @@ export class TimelineLoader implements Common.StringOutputStream.OutputStream {
     });
   }
 
-  static async loadFromFile(file: File, client: Client): Promise<TimelineLoader> {
-    const loader = new TimelineLoader(client);
-    const fileReader = new Bindings.FileUtils.ChunkedFileReader(file);
-    loader.canceledCallback = fileReader.cancel.bind(fileReader);
-    loader.totalSize = file.size;
-    // We'll resolve and return the loader instance before finalizing the trace.
-    setTimeout(async () => {
-      const success = await fileReader.read(loader);
-      if (!success && fileReader.error()) {
-        // TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        loader.reportErrorAndCancelLoading((fileReader.error() as any).message);
-      }
-    });
-    return loader;
-  }
-
   static loadFromParsedJsonFile(contents: ParsedJSONFile, client: Client): TimelineLoader {
     const loader = new TimelineLoader(client);
 
@@ -224,42 +198,6 @@ export class TimelineLoader implements Common.StringOutputStream.OutputStream {
     }
   }
 
-  /**
-   * As TimelineLoader implements `Common.StringOutputStream.OutputStream`, `write()` is called when a
-   * Common.StringOutputStream.StringOutputStream instance has decoded a chunk. This path is only used
-   * by `loadFromFile()`; it's NOT used by `loadFromEvents` or `loadFromURL`.
-   */
-  async write(chunk: string, endOfFile: boolean): Promise<void> {
-    if (!this.client) {
-      return await Promise.resolve();
-    }
-    this.buffer += chunk;
-    if (this.firstRawChunk) {
-      this.client.loadingStarted();
-      // Ensure we paint the loading dialog before continuing
-      await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
-      this.firstRawChunk = false;
-    } else {
-      let progress = undefined;
-      progress = this.buffer.length / this.totalSize;
-      // For compressed traces, we can't provide a definite progress percentage. So, just keep it moving.
-      // For other traces, calculate a loaded part.
-      progress = progress > 1 ? progress - Math.floor(progress) : progress;
-      this.client.loadingProgress(progress);
-    }
-
-    if (endOfFile) {
-      let trace;
-      try {
-        trace = JSON.parse(this.buffer) as ParsedJSONFile;
-        this.#processParsedFile(trace);
-      } catch (e) {
-        this.reportErrorAndCancelLoading(i18nString(UIStrings.malformedTimelineDataS, {PH1: e.toString()}));
-      }
-      return;
-    }
-  }
-
   private reportErrorAndCancelLoading(message?: string): void {
     if (message) {
       Common.Console.Console.instance().error(message);