core(tracehouse): modify files for move to tracehouse

patrickhulce · patrickhulce · commit 1af2edd528a4 · 2019-06-04T21:53:20.000-05:00
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -39,7 +39,7 @@ driver.sendCommand('Security.enable');
 
 ## Understanding a Trace
 
-`lighthouse-core/computed/trace-of-tab.js` and `lighthouse-core/lib/traces/tracing-processor.js` provide the core transformation of a trace into more meaningful objects. Each raw trace event has a monotonically increasing timestamp in microseconds, a thread ID, a process ID, a duration in microseconds (potentially), and other applicable metadata properties such as the event type, the task name, the frame, etc. [Learn more about trace events](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview).
+`lighthouse-core/lib/tracehouse/trace-of-tab.js` and `lighthouse-core/lib/tracehouse/tracing-processor.js` provide the core transformation of a trace into more meaningful objects. Each raw trace event has a monotonically increasing timestamp in microseconds, a thread ID, a process ID, a duration in microseconds (potentially), and other applicable metadata properties such as the event type, the task name, the frame, etc. [Learn more about trace events](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview).
 
 ### Example Trace Event
 ```js
diff --git a/lighthouse-core/audits/bootup-time.js b/lighthouse-core/audits/bootup-time.js
@@ -7,7 +7,7 @@
 
 const Audit = require('./audit.js');
 const NetworkRequest = require('../lib/network-request.js');
-const {taskGroups} = require('../lib/task-groups.js');
+const {taskGroups} = require('../lib/tracehouse/task-groups.js');
 const i18n = require('../lib/i18n/i18n.js');
 const NetworkRecords = require('../computed/network-records.js');
 const MainThreadTasks = require('../computed/main-thread-tasks.js');
diff --git a/lighthouse-core/audits/mainthread-work-breakdown.js b/lighthouse-core/audits/mainthread-work-breakdown.js
@@ -11,7 +11,7 @@
 'use strict';
 
 const Audit = require('./audit.js');
-const {taskGroups} = require('../lib/task-groups.js');
+const {taskGroups} = require('../lib/tracehouse/task-groups.js');
 const i18n = require('../lib/i18n/i18n.js');
 const MainThreadTasks = require('../computed/main-thread-tasks.js');
 
@@ -29,7 +29,7 @@ const UIStrings = {
 
 const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
-/** @typedef {import('../lib/task-groups.js').TaskGroupIds} TaskGroupIds */
+/** @typedef {import('../lib/tracehouse/task-groups.js').TaskGroupIds} TaskGroupIds */
 
 class MainThreadWorkBreakdown extends Audit {
   /**
diff --git a/lighthouse-core/computed/main-thread-tasks.js b/lighthouse-core/computed/main-thread-tasks.js
@@ -0,0 +1,24 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+const makeComputedArtifact = require('./computed-artifact.js');
+const MainThreadTasks_ = require('../lib/tracehouse/main-thread-tasks.js');
+const TraceOfTab = require('./trace-of-tab.js');
+
+class MainThreadTasks {
+  /**
+   * @param {LH.Trace} trace
+   * @param {LH.Audit.Context} context
+   * @return {Promise<Array<LH.Artifacts.TaskNode>>}
+   */
+  static async compute_(trace, context) {
+    const {mainThreadEvents, timestamps} = await TraceOfTab.request(trace, context);
+    return MainThreadTasks_.getMainThreadTasks(mainThreadEvents, timestamps.traceEnd);
+  }
+}
+
+module.exports = makeComputedArtifact(MainThreadTasks);
diff --git a/lighthouse-core/computed/metrics/estimated-input-latency.js b/lighthouse-core/computed/metrics/estimated-input-latency.js
@@ -8,7 +8,7 @@
 const makeComputedArtifact = require('../computed-artifact.js');
 const ComputedMetric = require('./metric.js');
 const LHError = require('../../lib/lh-error.js');
-const TracingProcessor = require('../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../lib/tracehouse/tracing-processor.js');
 const LanternEstimatedInputLatency = require('./lantern-estimated-input-latency.js');
 
 const ROLLING_WINDOW_SIZE = 5000;
diff --git a/lighthouse-core/computed/metrics/first-cpu-idle.js b/lighthouse-core/computed/metrics/first-cpu-idle.js
@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const ComputedMetric = require('./metric.js');
-const TracingProcessor = require('../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../lib/tracehouse/tracing-processor.js');
 const LHError = require('../../lib/lh-error.js');
 const LanternFirstCPUIdle = require('./lantern-first-cpu-idle.js');
 
diff --git a/lighthouse-core/computed/metrics/interactive.js b/lighthouse-core/computed/metrics/interactive.js
@@ -10,7 +10,7 @@ const ComputedMetric = require('./metric.js');
 const LanternInteractive = require('./lantern-interactive.js');
 
 const NetworkRecorder = require('../../lib/network-recorder.js');
-const TracingProcessor = require('../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../lib/tracehouse/tracing-processor.js');
 const LHError = require('../../lib/lh-error.js');
 
 const REQUIRED_QUIET_WINDOW = 5000;
diff --git a/lighthouse-core/computed/metrics/max-potential-fid.js b/lighthouse-core/computed/metrics/max-potential-fid.js
@@ -9,7 +9,7 @@ const makeComputedArtifact = require('../computed-artifact.js');
 const MetricArtifact = require('./metric.js');
 const LanternMaxPotentialFID = require('./lantern-max-potential-fid.js');
 const LHError = require('../../lib/lh-error.js');
-const TracingProcessor = require('../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../lib/tracehouse/tracing-processor.js');
 
 class MaxPotentialFID extends MetricArtifact {
   /**
diff --git a/lighthouse-core/computed/metrics/metric.js b/lighthouse-core/computed/metrics/metric.js
@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const TracingProcessor = require('../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../lib/tracehouse/tracing-processor.js');
 const TraceOfTab = require('../trace-of-tab.js');
 const NetworkRecords = require('../network-records.js');
 
diff --git a/lighthouse-core/computed/page-dependency-graph.js b/lighthouse-core/computed/page-dependency-graph.js
@@ -9,7 +9,7 @@ const makeComputedArtifact = require('./computed-artifact.js');
 const NetworkNode = require('../lib/dependency-graph/network-node.js');
 const CPUNode = require('../lib/dependency-graph/cpu-node.js');
 const NetworkAnalyzer = require('../lib/dependency-graph/simulator/network-analyzer.js');
-const TracingProcessor = require('../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../lib/tracehouse/tracing-processor.js');
 const NetworkRequest = require('../lib/network-request.js');
 const TraceOfTab = require('./trace-of-tab.js');
 const NetworkRecords = require('./network-records.js');
diff --git a/lighthouse-core/computed/trace-of-tab.js b/lighthouse-core/computed/trace-of-tab.js
@@ -0,0 +1,23 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+const makeComputedArtifact = require('./computed-artifact.js');
+const TraceOfTab_ = require('../lib/tracehouse/trace-of-tab.js');
+
+class TraceOfTab {
+  /**
+   * Finds key trace events, identifies main process/thread, and returns timings of trace events
+   * in milliseconds since navigation start in addition to the standard microsecond monotonic timestamps.
+   * @param {LH.Trace} trace
+   * @return {Promise<LH.Artifacts.TraceOfTab>}
+  */
+  static async compute_(trace) {
+    return TraceOfTab_.compute(trace);
+  }
+}
+
+module.exports = makeComputedArtifact(TraceOfTab);
diff --git a/lighthouse-core/lib/minify-trace.js b/lighthouse-core/lib/minify-trace.js
@@ -10,13 +10,13 @@
 /**
  * @fileoverview Minifies a trace by removing unnecessary events, throttling screenshots, etc.
  *  See the following files for necessary events:
- *    - lighthouse-core/computed/trace-of-tab.js
  *    - lighthouse-core/computed/page-dependency-graph.js
  *    - lighthouse-core/lib/dependency-graph/cpu-node.js
- *    - lighthouse-core/lib/traces/tracing-processor.js
+ *    - lighthouse-core/lib/tracehouse/trace-of-tab.js
+ *    - lighthouse-core/lib/tracehouse/tracing-processor.js
  */
 
-const TracingProcessor = require('./traces/tracing-processor.js');
+const TracingProcessor = require('./tracehouse/tracing-processor.js');
 
 const toplevelTaskNames = new Set([
   'RunTask', // m71+
diff --git a/lighthouse-core/lib/tracehouse/main-thread-tasks.js b/lighthouse-core/lib/tracehouse/main-thread-tasks.js
@@ -5,9 +5,7 @@
  */
 'use strict';
 
-const makeComputedArtifact = require('./computed-artifact.js');
-const {taskGroups, taskNameToGroup} = require('../lib/task-groups.js');
-const TraceOfTab = require('./trace-of-tab.js');
+const {taskGroups, taskNameToGroup} = require('./task-groups.js');
 
 /**
  * @fileoverview
@@ -26,7 +24,7 @@ const TraceOfTab = require('./trace-of-tab.js');
  * attributableURL for the script that was executing/forced this execution.
  */
 
-/** @typedef {import('../lib/task-groups.js').TaskGroup} TaskGroup */
+/** @typedef {import('./task-groups.js').TaskGroup} TaskGroup */
 
 /**
  * @typedef TaskNode
@@ -263,16 +261,6 @@ class MainThreadTasks {
 
     return tasks;
   }
-
-  /**
-   * @param {LH.Trace} trace
-   * @param {LH.Audit.Context} context
-   * @return {Promise<Array<TaskNode>>} networkRecords
-   */
-  static async compute_(trace, context) {
-    const {mainThreadEvents, timestamps} = await TraceOfTab.request(trace, context);
-    return MainThreadTasks.getMainThreadTasks(mainThreadEvents, timestamps.traceEnd);
-  }
 }
 
-module.exports = makeComputedArtifact(MainThreadTasks);
+module.exports = MainThreadTasks;
diff --git a/lighthouse-core/lib/tracehouse/trace-of-tab.js b/lighthouse-core/lib/tracehouse/trace-of-tab.js
@@ -16,11 +16,10 @@
  * 4. Return all those items in one handy bundle.
  */
 
-const makeComputedArtifact = require('./computed-artifact.js');
 const log = require('lighthouse-logger');
-const TracingProcessor = require('../lib/traces/tracing-processor.js');
-const LHError = require('../lib/lh-error.js');
-const Sentry = require('../lib/sentry.js');
+const TracingProcessor = require('./tracing-processor.js');
+const LHError = require('../lh-error.js');
+const Sentry = require('../sentry.js');
 
 const ACCEPTABLE_NAVIGATION_URL_REGEX = /^(chrome|https?):/;
 
@@ -69,9 +68,9 @@ class TraceOfTab {
    * Finds key trace events, identifies main process/thread, and returns timings of trace events
    * in milliseconds since navigation start in addition to the standard microsecond monotonic timestamps.
    * @param {LH.Trace} trace
-   * @return {Promise<LH.Artifacts.TraceOfTab>}
+   * @return {LH.Artifacts.TraceOfTab}
   */
-  static async compute_(trace) {
+  static compute(trace) {
     // Parse the trace for our key events and sort them by timestamp. Note: sort
     // *must* be stable to keep events correctly nested.
     const keyEvents = TraceOfTab.filteredStableSort(trace.traceEvents, e => {
@@ -189,4 +188,4 @@ class TraceOfTab {
   }
 }
 
-module.exports = makeComputedArtifact(TraceOfTab);
+module.exports = TraceOfTab;
diff --git a/lighthouse-core/scripts/lantern/minify-trace.js b/lighthouse-core/scripts/lantern/minify-trace.js
@@ -8,6 +8,7 @@
 
 /* eslint-disable no-console */
 
+
 const fs = require('fs');
 const path = require('path');
 const {minifyTrace} = require('../../lib/minify-trace.js');
diff --git a/lighthouse-core/test/audits/byte-efficiency/uses-long-cache-ttl-test.js b/lighthouse-core/test/audits/byte-efficiency/uses-long-cache-ttl-test.js
@@ -93,7 +93,7 @@ describe('Cache headers audit', () => {
 
   it('detects low value expires headers', () => {
     const expiresIn = seconds => new Date(Date.now() + seconds * 1000).toGMTString();
-    const closeEnough = (actual, exp) => assert.ok(Math.abs(actual - exp) <= 1, 'invalid expires');
+    const closeEnough = (actual, exp) => assert.ok(Math.abs(actual - exp) <= 5, 'invalid expires');
 
     const networkRecords = [
       networkRecord({headers: {expires: expiresIn(86400 * 365)}}), // a year
@@ -132,9 +132,9 @@ describe('Cache headers audit', () => {
     return CacheHeadersAudit.audit(getArtifacts(networkRecords), context).then(result => {
       const items = result.extendedInfo.value.results;
       assert.equal(items.length, 2);
-      assert.ok(Math.abs(items[0].cacheLifetimeMs - 3600 * 1000) <= 1, 'invalid expires parsing');
+      assert.ok(Math.abs(items[0].cacheLifetimeMs - 3600 * 1000) <= 5, 'invalid expires parsing');
       assert.equal(Math.round(items[0].wastedBytes), 8000);
-      assert.ok(Math.abs(items[1].cacheLifetimeMs - 86400 * 1000) <= 1, 'invalid expires parsing');
+      assert.ok(Math.abs(items[1].cacheLifetimeMs - 86400 * 1000) <= 5, 'invalid expires parsing');
       assert.equal(Math.round(items[1].wastedBytes), 4000);
     });
   });
diff --git a/lighthouse-core/test/computed/main-thread-tasks-test.js b/lighthouse-core/test/computed/main-thread-tasks-test.js
@@ -0,0 +1,19 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+/* eslint-env jest */
+
+const MainThreadTasks = require('../../computed/main-thread-tasks.js');
+const pwaTrace = require('../fixtures/traces/progressive-app-m60.json');
+
+describe('MainThreadTasksComputed', () => {
+  it('computes the artifact', async () => {
+    const context = {computedCache: new Map()};
+    const tasks = await MainThreadTasks.request(pwaTrace, context);
+    expect(tasks.length).toEqual(4784);
+  });
+});
diff --git a/lighthouse-core/test/computed/metrics/first-cpu-idle-test.js b/lighthouse-core/test/computed/metrics/first-cpu-idle-test.js
@@ -6,7 +6,7 @@
 'use strict';
 
 const FirstCPUIdle = require('../../../computed/metrics/first-cpu-idle.js');
-const TracingProcessor = require('../../../lib/traces/tracing-processor.js');
+const TracingProcessor = require('../../../lib/tracehouse/tracing-processor.js');
 
 const tooShortTrace = require('../../fixtures/traces/progressive-app.json');
 const acceptableTrace = require('../../fixtures/traces/progressive-app-m60.json');
diff --git a/lighthouse-core/test/computed/trace-of-tab-test.js b/lighthouse-core/test/computed/trace-of-tab-test.js
diff --git a/lighthouse-core/test/lib/tracehouse/main-thread-tasks-test.js b/lighthouse-core/test/lib/tracehouse/main-thread-tasks-test.js
diff --git a/lighthouse-core/test/lib/tracehouse/trace-of-tab-test.js b/lighthouse-core/test/lib/tracehouse/trace-of-tab-test.js
diff --git a/lighthouse-core/test/lib/tracehouse/tracing-processor-test.js b/lighthouse-core/test/lib/tracehouse/tracing-processor-test.js
diff --git a/types/artifacts.d.ts b/types/artifacts.d.ts
