@paulirish/trace_engine 0.0.6 → 0.0.8

package/analyze-trace.mjs

@@ -5,19 +5,25 @@
 // Run this first:
 //    front_end/models/trace/build-trace-engine-lib.sh
 
+/* eslint-disable rulesdir/es_modules_import */
 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();
+/** @typedef {import('../front_end/models/trace/trace.ts')} TraceEngine */
+
+/** @type {TraceEngine} */
+import * as TraceEngine from './trace.mjs';
 
+polyfillDOMRect();
 
+/**
+ * @param {string} filename
+ * @returns {Promise<TraceEngine.TraceModel>}
+ */
 export async function analyzeTrace(filename) {
   const traceEvents = loadTraceEventsFromFile(filename);
 
-  // Primary usage:
-  const processor = TraceModel.Processor.TraceProcessor.createWithAllHandlers(); // aka `fullTraceEngine`
+  const processor = TraceEngine.Processor.TraceProcessor.createWithAllHandlers(TraceEngine.Types.Configuration.DEFAULT); // aka `fullTraceEngine`
   await processor.parse(traceEvents);
   return processor.data;
 }
@@ -29,8 +35,8 @@ if (import.meta.url.endsWith(process?.argv[1])) {
 
 async function cli() {
   const filename = process.argv.at(2);
-  const traceModel = await analyzeTrace(filename);
-  console.log(traceModel);
+  const TraceEngine = await analyzeTrace(filename);
+  console.log(TraceEngine);
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paulirish/trace_engine",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "",
   "main": "trace.mjs",
   "scripts": {

package/test/test-trace-engine.mjs

@@ -11,7 +11,7 @@ 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.Renderer.allTraceEntries.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);