@paulirish/trace_engine 0.0.4 → 0.0.6

package/PAUL.readme.md

@@ -0,0 +1,5 @@
+# see readme for cmds
+
+# some types thing that might work
+
+node out/Typed/../../third_party/typescript/../../node_modules/typescript/bin/tsc -p out/Typed/gen/front_end/models/trace/trace-tsconfig.json  # this then has js/map/d.ts.  should be able to use for typs

package/README.md

@@ -18,18 +18,41 @@ console.log(processor.data)
 
 See the included `analyze-trace.mjs` a runnable invocation.
 
-## Building standalone
+## Maintainer cheatsheet
 
-```sh
-# parent doc: go/btlax
+See also http://go/btlax
 
-# these in no particular order..
+#### Build, run, extract
 
+```sh
+# build bundle with esbuild
 front_end/models/trace/build-trace-engine-lib.sh
 
+# run
+node scripts/analyze-trace.mjs test/unittests/fixtures/traces/web-dev.json.gz
+
+# test
+node scripts/test/test-trace-engine.mjs
+
+# copy built files to $HOME/code/trace_engine
 front_end/models/trace/copy-build-trace-engine-for-publish.sh
 ```
 
+#### Test and publish
+
+```sh
+# switch to standalone
+cd $HOME/code/trace_engine
+
+# test
+node test/test-trace-engine.mjs
+
+# bump and publish
+npm version v0.0.XXX   # Manually determine next version
+npm publish --access public --dry-run
+npm publish --access public
+```
+
 ## High level architecture
 
 ```

package/analyze-trace.mjs

@@ -5,26 +5,35 @@
 // Run this first:
 //    front_end/models/trace/build-trace-engine-lib.sh
 
-import fs from 'fs';
-import zlib from 'zlib';
+import fs from 'node:fs';
+import zlib from 'node:zlib';
 // eslint-disable-next-line rulesdir/es_modules_import
 import * as TraceModel from './trace.mjs';
 
 polyfillDOMRect();
 
-// If run as CLI, parse the argv trace (or a fallback)
-if (import.meta.url.endsWith(process.argv[1])) {
-  const filename = process.argv.at(2) ?? './test/invalid-animation-events.json.gz';
+
+export async function analyzeTrace(filename) {
   const traceEvents = loadTraceEventsFromFile(filename);
 
   // Primary usage:
   const processor = TraceModel.Processor.TraceProcessor.createWithAllHandlers(); // aka `fullTraceEngine`
   await processor.parse(traceEvents);
+  return processor.data;
+}
 
-  console.log(processor.data);
-  console.assert(processor.data.Renderer.allRendererEvents.length);
+// If run as CLI, parse the argv trace (or a fallback)
+if (import.meta.url.endsWith(process?.argv[1])) {
+  cli();
 }
 
+async function cli() {
+  const filename = process.argv.at(2);
+  const traceModel = await analyzeTrace(filename);
+  console.log(traceModel);
+}
+
+
 /**
  * @param {string=} filename
  * @returns TraceEvent[]

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@paulirish/trace_engine",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "",
   "main": "trace.mjs",
   "scripts": {
-    "test": "node analyze-trace.mjs"
+    "test": "node test/test-trace-engine.mjs",
+    "prepublishOnly": "npm test"
   },
   "type": "module",
   "keywords": [],

package/test/test-trace-engine.mjs

@@ -0,0 +1,52 @@
+// Copyright 2023 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import test from 'node:test';
+import {strict as assert} from 'assert';
+
+import {analyzeTrace} from '../analyze-trace.mjs';
+
+const filename = './test/invalid-animation-events.json.gz';
+const data = await analyzeTrace(filename);
+
+test('key values are populated', t => {
+  assert.equal(data.Renderer.allRendererEvents.length > 90_000, true);
+  assert.equal(data.Screenshots.length > 2, true);
+  assert.equal(data.Meta.threadsInProcess.size > 2, true);
+  assert.equal(data.Meta.mainFrameNavigations.length > 0, true);
+});
+
+test('numeric values are set and look legit', t => {
+  const shouldBeNumbers = [
+    data.Meta.traceBounds.min,
+    data.Meta.traceBounds.max,
+    data.Meta.traceBounds.range,
+    data.Meta.browserProcessId,
+    data.Meta.browserThreadId,
+    data.Meta.gpuProcessId,
+    data.Meta.gpuThreadId,
+    Array.from(data.Meta.topLevelRendererIds.values()).at(0),
+    Array.from(data.Meta.frameByProcessId.keys()).at(0),
+  ];
+  for (const datum of shouldBeNumbers) {
+    assert.equal(isNaN(datum), false);
+    assert.equal(typeof datum, 'number');
+    assert.equal(datum > 10, true);
+  }
+});
+
+test('string values are set and look legit', t => {
+  const shouldBeStrings = [
+    data.Meta.mainFrameId,
+    data.Meta.mainFrameURL,
+    Array.from(data.Meta.navigationsByFrameId.keys()).at(0),
+    Array.from(data.Meta.navigationsByNavigationId.keys()).at(0),
+    data.Meta.mainFrameId,
+  ];
+
+  for (const datum of shouldBeStrings) {
+    assert.equal(typeof datum, 'string');
+    assert.equal(datum.length > 10, true);
+  }
+});