@lage-run/reporters 0.1.2 → 0.1.3

package/CHANGELOG.json

@@ -2,7 +2,28 @@
   "name": "@lage-run/reporters",
   "entries": [
     {
-      "date": "Tue, 23 Aug 2022 07:53:38 GMT",
+      "date": "Tue, 23 Aug 2022 21:26:17 GMT",
+      "tag": "@lage-run/reporters_v0.1.3",
+      "version": "0.1.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/reporters",
+            "commit": "703195918ffa167fb2dba2ab5e469cae0122134f",
+            "comment": "Adds the ChromeTraceEventReporters that is used in --profile"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/reporters",
+            "comment": "Bump @lage-run/scheduler to v0.1.4",
+            "commit": "703195918ffa167fb2dba2ab5e469cae0122134f"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 23 Aug 2022 07:53:50 GMT",
       "tag": "@lage-run/reporters_v0.1.2",
       "version": "0.1.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,21 @@
 # Change Log - @lage-run/reporters
 
-This log was last generated on Tue, 23 Aug 2022 07:53:38 GMT and should not be manually modified.
+This log was last generated on Tue, 23 Aug 2022 21:26:17 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.1.3
+
+Tue, 23 Aug 2022 21:26:17 GMT
+
+### Patches
+
+- Adds the ChromeTraceEventReporters that is used in --profile (kchau@microsoft.com)
+- Bump @lage-run/scheduler to v0.1.4
+
 ## 0.1.2
 
-Tue, 23 Aug 2022 07:53:38 GMT
+Tue, 23 Aug 2022 07:53:50 GMT
 
 ### Patches
 

package/lib/ChromeTraceEventsReporter.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import type { LogEntry, Reporter } from "@lage-run/logger";
+import type { SchedulerRunSummary, TargetRun } from "@lage-run/scheduler";
+import type { TargetMessageEntry, TargetStatusEntry } from "./types/TargetLogEntry";
+import { Writable } from "stream";
+export interface ChromeTraceEventsReporterOptions {
+    outputFile?: string;
+    concurrency: number;
+    categorize?: (targetRun?: TargetRun) => string;
+}
+export declare class ChromeTraceEventsReporter implements Reporter {
+    private options;
+    logStream: Writable;
+    consoleLogStream: Writable;
+    private threads;
+    private targetIdThreadMap;
+    private events;
+    private outputFile;
+    constructor(options: ChromeTraceEventsReporterOptions);
+    log(entry: LogEntry<TargetStatusEntry | TargetMessageEntry>): void;
+    summarize(schedulerRunSummary: SchedulerRunSummary): void;
+}

package/lib/ChromeTraceEventsReporter.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChromeTraceEventsReporter = void 0;
+const target_graph_1 = require("@lage-run/target-graph");
+const isTargetStatusLogEntry_1 = require("./isTargetStatusLogEntry");
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function range(len) {
+    return Array(len)
+        .fill(0)
+        .map((_, idx) => idx + 1);
+}
+function hrTimeToMicroseconds(hr) {
+    return hr[0] * 1e6 + hr[1] * 1e-3;
+}
+function getTimeBasedFilename(prefix) {
+    const now = new Date(); // 2011-10-05T14:48:00.000Z
+    const datetime = now.toISOString().split(".")[0]; // 2011-10-05T14:48:00
+    const datetimeNormalized = datetime.replace(/-|:/g, ""); // 20111005T144800
+    return `${prefix ? prefix + "-" : ""}${datetimeNormalized}.json`;
+}
+class ChromeTraceEventsReporter {
+    constructor(options) {
+        var _a;
+        this.options = options;
+        this.consoleLogStream = process.stdout;
+        this.targetIdThreadMap = new Map();
+        this.events = {
+            traceEvents: [],
+            displayTimeUnit: "ms",
+        };
+        this.outputFile = (_a = options.outputFile) !== null && _a !== void 0 ? _a : getTimeBasedFilename("profile");
+        this.threads = range(options.concurrency);
+        if (!fs_1.default.existsSync(path_1.default.dirname(this.outputFile))) {
+            fs_1.default.mkdirSync(path_1.default.dirname(this.outputFile), { recursive: true });
+        }
+        this.logStream = fs_1.default.createWriteStream(this.outputFile, { flags: "w" });
+    }
+    log(entry) {
+        var _a, _b;
+        const data = entry.data;
+        if ((0, isTargetStatusLogEntry_1.isTargetStatusLogEntry)(data) && data.status !== "pending" && data.target.id !== (0, target_graph_1.getStartTargetId)()) {
+            if (data.status === "running") {
+                const threadId = (_a = this.threads.shift()) !== null && _a !== void 0 ? _a : 0;
+                this.targetIdThreadMap.set(data.target.id, threadId);
+            }
+            else {
+                const threadId = this.targetIdThreadMap.get(data.target.id);
+                this.events.traceEvents.push({
+                    name: data.target.id,
+                    cat: "",
+                    ph: "X",
+                    ts: 0,
+                    dur: hrTimeToMicroseconds((_b = data.duration) !== null && _b !== void 0 ? _b : [0, 1000]),
+                    pid: 1,
+                    tid: threadId !== null && threadId !== void 0 ? threadId : 0,
+                });
+                this.threads.unshift(threadId);
+                this.threads.sort((a, b) => a - b);
+            }
+        }
+    }
+    summarize(schedulerRunSummary) {
+        var _a;
+        const { targetRuns, startTime } = schedulerRunSummary;
+        // categorize events
+        const { categorize } = this.options;
+        for (const event of this.events.traceEvents) {
+            const targetRun = targetRuns.get(event.name);
+            event.ts = hrTimeToMicroseconds(targetRun === null || targetRun === void 0 ? void 0 : targetRun.startTime) - hrTimeToMicroseconds(startTime);
+            event.cat = (_a = targetRun === null || targetRun === void 0 ? void 0 : targetRun.status) !== null && _a !== void 0 ? _a : "";
+            if (categorize) {
+                event.cat += `,${categorize(targetRun)}`;
+            }
+        }
+        // write events to stream
+        this.logStream.write(JSON.stringify(this.events, null, 2));
+        this.consoleLogStream.write(chalk_1.default.blueBright(`\nProfiler output written to ${chalk_1.default.underline(this.outputFile)}, open it with chrome://tracing or edge://tracing\n`));
+    }
+}
+exports.ChromeTraceEventsReporter = ChromeTraceEventsReporter;
+//# sourceMappingURL=ChromeTraceEventsReporter.js.map

package/lib/ChromeTraceEventsReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChromeTraceEventsReporter.js","sourceRoot":"","sources":["../src/ChromeTraceEventsReporter.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA0D;AAC1D,qEAAkE;AAClE,kDAA0B;AAC1B,4CAAoB;AACpB,gDAAwB;AA4BxB,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,KAAK,CAAC,GAAG,CAAC;SACd,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,oBAAoB,CAAC,EAAoB;IAChD,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AACpC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,2BAA2B;IACnD,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAsB;IACxE,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB;IAC3E,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,kBAAkB,OAAO,CAAC;AACnE,CAAC;AAED,MAAa,yBAAyB;IAYpC,YAAoB,OAAyC;;QAAzC,YAAO,GAAP,OAAO,CAAkC;QAV7D,qBAAgB,GAAa,OAAO,CAAC,MAAM,CAAC;QAGpC,sBAAiB,GAAwB,IAAI,GAAG,EAAE,CAAC;QACnD,WAAM,GAAsB;YAClC,WAAW,EAAE,EAAE;YACf,eAAe,EAAE,IAAI;SACtB,CAAC;QAIA,IAAI,CAAC,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAE1C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE;YACjD,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,SAAS,GAAG,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,GAAG,CAAC,KAAuD;;QACzD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,IAAA,+CAAsB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,IAAA,+BAAgB,GAAE,EAAE;YACtG,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;gBAC7B,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,mCAAI,CAAC,CAAC;gBAC3C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;aACtD;iBAAM;gBACL,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAE,CAAC;gBAE7D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;oBAC3B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;oBACpB,GAAG,EAAE,EAAE;oBACP,EAAE,EAAE,GAAG;oBACP,EAAE,EAAE,CAAC;oBACL,GAAG,EAAE,oBAAoB,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;oBACrD,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,CAAC;iBACnB,CAAC,CAAC;gBAEH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;aACpC;SACF;IACH,CAAC;IAED,SAAS,CAAC,mBAAwC;;QAChD,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,mBAAmB,CAAC;QAEtD,oBAAoB;QACpB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEpC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;YAC3C,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE7C,KAAK,CAAC,EAAE,GAAG,oBAAoB,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAU,CAAC,GAAG,oBAAoB,CAAC,SAAU,CAAC,CAAC;YAC1F,KAAK,CAAC,GAAG,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,mCAAI,EAAE,CAAC;YACpC,IAAI,UAAU,EAAE;gBACd,KAAK,CAAC,GAAG,IAAI,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;aAC1C;SACF;QAED,yBAAyB;QACzB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,gBAAgB,CAAC,KAAK,CACzB,eAAK,CAAC,UAAU,CACd,gCAAgC,eAAK,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,qDAAqD,CACtH,CACF,CAAC;IACJ,CAAC;CACF;AAzED,8DAyEC"}

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export { AdoReporter } from "./AdoReporter";
 export { JsonReporter } from "./JsonReporter";
 export { NpmLogReporter } from "./NpmLogReporter";
+export { ChromeTraceEventsReporter } from "./ChromeTraceEventsReporter";
 export type { TargetStatusEntry, TargetMessageEntry } from "./types/TargetLogEntry";

package/lib/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NpmLogReporter = exports.JsonReporter = exports.AdoReporter = void 0;
+exports.ChromeTraceEventsReporter = exports.NpmLogReporter = exports.JsonReporter = exports.AdoReporter = void 0;
 var AdoReporter_1 = require("./AdoReporter");
 Object.defineProperty(exports, "AdoReporter", { enumerable: true, get: function () { return AdoReporter_1.AdoReporter; } });
 var JsonReporter_1 = require("./JsonReporter");
 Object.defineProperty(exports, "JsonReporter", { enumerable: true, get: function () { return JsonReporter_1.JsonReporter; } });
 var NpmLogReporter_1 = require("./NpmLogReporter");
 Object.defineProperty(exports, "NpmLogReporter", { enumerable: true, get: function () { return NpmLogReporter_1.NpmLogReporter; } });
+var ChromeTraceEventsReporter_1 = require("./ChromeTraceEventsReporter");
+Object.defineProperty(exports, "ChromeTraceEventsReporter", { enumerable: true, get: function () { return ChromeTraceEventsReporter_1.ChromeTraceEventsReporter; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,yEAAwE;AAA/D,sIAAA,yBAAyB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/reporters",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Log reporters for Lage",
   "repository": {
     "url": "https://github.com/microsoft/lage"
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@lage-run/logger": "^1.1.2",
-    "@lage-run/scheduler": "^0.1.3",
+    "@lage-run/scheduler": "^0.1.4",
     "@lage-run/target-graph": "^0.2.0",
     "chalk": "^4.0.0"
   },