@lage-run/reporters 0.2.42 → 0.2.43

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "@lage-run/reporters",
   "entries": [
     {
-      "date": "Tue, 06 Dec 2022 23:28:03 GMT",
+      "date": "Thu, 08 Dec 2022 00:49:16 GMT",
+      "tag": "@lage-run/reporters_v0.2.43",
+      "version": "0.2.43",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/reporters",
+            "commit": "ad281dfe8b222d949130821828a680d1c3625154",
+            "comment": "adding some more niceties to progress reporter"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 06 Dec 2022 23:33:47 GMT",
+      "tag": "@lage-run/reporters_v0.2.42",
+      "version": "0.2.42",
+      "comments": {
+        "none": [
+          {
+            "author": "renovate@whitesourcesoftware.com",
+            "package": "@lage-run/reporters",
+            "commit": "07c1993552c81082c2717146ce0ff57a7a2eba1b",
+            "comment": "Update devDependency @types/react to v18.0.26"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 06 Dec 2022 23:28:12 GMT",
       "tag": "@lage-run/reporters_v0.2.42",
       "version": "0.2.42",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - @lage-run/reporters
 
-This log was last generated on Tue, 06 Dec 2022 23:28:03 GMT and should not be manually modified.
+This log was last generated on Thu, 08 Dec 2022 00:49:16 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.2.43
+
+Thu, 08 Dec 2022 00:49:16 GMT
+
+### Patches
+
+- adding some more niceties to progress reporter (kchau@microsoft.com)
+
 ## 0.2.42
 
-Tue, 06 Dec 2022 23:28:03 GMT
+Tue, 06 Dec 2022 23:28:12 GMT
 
 ### Patches
 

package/lib/ChromeTraceEventsReporter.d.ts

@@ -11,8 +11,6 @@ export declare class ChromeTraceEventsReporter implements Reporter {
     private options;
     logStream: Writable;
     consoleLogStream: Writable;
-    private threads;
-    private targetIdThreadMap;
     private events;
     private outputFile;
     constructor(options: ChromeTraceEventsReporterOptions);

package/lib/ChromeTraceEventsReporter.js

@@ -14,9 +14,6 @@ function _interopRequireDefault(obj) {
         default: obj
     };
 }
-function range(len) {
-    return Array(len).fill(0).map((_, idx)=>idx + 1);
-}
 function hrTimeToMicroseconds(hr) {
     return hr[0] * 1e6 + hr[1] * 1e-3;
 }
@@ -48,7 +45,7 @@ class ChromeTraceEventsReporter {
                     1000
                 ]),
                 pid: 1,
-                tid: targetRun.threadId ?? 0
+                tid: targetRun.threadId
             };
             if (categorize) {
                 event.cat += `,${categorize(targetRun)}`;
@@ -62,13 +59,11 @@ class ChromeTraceEventsReporter {
     constructor(options){
         this.options = options;
         this.consoleLogStream = process.stdout;
-        this.targetIdThreadMap = new Map();
         this.events = {
             traceEvents: [],
             displayTimeUnit: "ms"
         };
         this.outputFile = options.outputFile ?? getTimeBasedFilename("profile");
-        this.threads = range(options.concurrency);
         if (!_fs.default.existsSync(_path.default.dirname(this.outputFile))) {
             _fs.default.mkdirSync(_path.default.dirname(this.outputFile), {
                 recursive: true

package/lib/ProgressReporter.d.ts

@@ -1,13 +1,17 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import EventEmitter from "events";
 import type { LogEntry, Reporter } from "@lage-run/logger";
 import type { SchedulerRunSummary } from "@lage-run/scheduler-types";
 export declare class ProgressReporter implements Reporter {
+    timer: NodeJS.Timeout;
+    startTime: [number, number];
     logEvent: EventEmitter;
     logEntries: Map<string, LogEntry<import("@lage-run/logger").LogStructuredData>[]>;
     constructor(options?: {
         concurrency: number;
     });
+    heartBeat: () => void;
     log(entry: LogEntry<any>): void;
     summarize(schedulerRunSummary: SchedulerRunSummary): void;
 }

package/lib/ProgressReporter.js

@@ -67,6 +67,9 @@ class ProgressReporter {
         if (entry?.data?.target?.hidden) {
             return;
         }
+        if (entry.data && entry.data.schedulerRun) {
+            this.startTime = entry.data.schedulerRun.startTime;
+        }
         if (entry.data && entry.data.target && typeof entry.data.threadId !== "undefined") {
             this.logEvent.emit("status", entry);
         }
@@ -79,15 +82,27 @@ class ProgressReporter {
             schedulerRunSummary,
             logEntries: this.logEntries
         });
+        clearTimeout(this.timer);
     }
     constructor(options = {
         concurrency: 0
     }){
+        this.startTime = [
+            0,
+            0
+        ];
         this.logEvent = new _events.default();
         this.logEntries = new Map();
+        this.heartBeat = ()=>{
+            this.logEvent.emit("heartbeat", {
+                currentTime: process.hrtime(this.startTime)
+            });
+            this.timer = setTimeout(this.heartBeat, 1000);
+        };
         (0, _ink.render)(/*#__PURE__*/ _react.createElement(_progressReporterApp.ProgressReporterApp, {
             logEvent: this.logEvent,
             concurrency: options.concurrency
         }));
+        this.timer = setTimeout(this.heartBeat, 1000);
     }
 }

package/lib/components/ProgressReporterApp.js

@@ -50,14 +50,25 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
+function range(len) {
+    return Array(len).fill(0).map((_, idx)=>idx + 1);
+}
 function ProgressReporterApp(props) {
-    const [threadInfo, setThreadInfo] = _react.useState({});
+    const initialThreadInfo = range(props.concurrency).reduce((acc, threadId)=>{
+        acc[threadId] = "";
+        return acc;
+    }, {});
+    const [threadInfo, setThreadInfo] = _react.useState(initialThreadInfo);
     const [progress, setProgress] = _react.useState({
         waiting: 0,
         completed: 0,
         total: 0
     });
     const [summary, setSummary] = _react.useState();
+    const [currentTime, setCurrentTime] = _react.useState([
+        0,
+        0
+    ]);
     const { logEvent  } = props;
     _react.useEffect(()=>{
         logEvent.on("status", (entry)=>{
@@ -67,7 +78,7 @@ function ProgressReporterApp(props) {
                         ...threadInfo,
                         [threadId]: target.id
                     }));
-            } else if (status === "success" || status === "aborted" || status === "failed") {
+            } else if (status === "success" || status === "aborted" || status === "failed" || status === "skipped") {
                 setThreadInfo((threadInfo)=>{
                     const newThreadInfo = {
                         ...threadInfo
@@ -83,6 +94,9 @@ function ProgressReporterApp(props) {
         logEvent.on("summary", (summary)=>{
             setSummary(summary);
         });
+        logEvent.on("heartbeat", (heartbeat)=>{
+            setCurrentTime(heartbeat.currentTime);
+        });
     }, [
         logEvent
     ]);
@@ -90,9 +104,7 @@ function ProgressReporterApp(props) {
     const idleWorkerDummyThreadInfo = arrayGapLength > 0 ? new Array(arrayGapLength).fill(0) : [];
     return /*#__PURE__*/ _react.createElement(_ink.Box, {
         flexDirection: "column"
-    }, /*#__PURE__*/ _react.createElement(_ink.Text, null, "Lage running tasks"), /*#__PURE__*/ _react.createElement(_ink.Text, {
-        color: "yellow"
-    }, "[warning: this progress reporter is currently in beta and unstable]"), summary ? /*#__PURE__*/ _react.createElement(_summaryInfo.SummaryInfo, {
+    }, /*#__PURE__*/ _react.createElement(_ink.Text, null, "Lage running tasks with ", props.concurrency, " workers"), summary ? /*#__PURE__*/ _react.createElement(_summaryInfo.SummaryInfo, {
         summary: summary
     }) : /*#__PURE__*/ _react.createElement(_ink.Box, {
         flexDirection: "column"
@@ -103,15 +115,18 @@ function ProgressReporterApp(props) {
     }, Object.entries(threadInfo).map(([threadId, targetId])=>{
         return /*#__PURE__*/ _react.createElement(_threadItem.ThreadItem, {
             key: threadId,
+            threadId: threadId,
             targetId: targetId
         });
     }), idleWorkerDummyThreadInfo.map((_, index)=>{
         return /*#__PURE__*/ _react.createElement(_react.Fragment, {
             key: `idle-${index}`
         }, /*#__PURE__*/ _react.createElement(_threadItem.ThreadItem, {
+            threadId: "?",
             targetId: ""
         }));
     })), /*#__PURE__*/ _react.createElement(_progressStatus.ProgressStatus, {
-        progress: progress
+        progress: progress,
+        currentTime: currentTime
     })));
 }

package/lib/components/ProgressStatus.d.ts

@@ -2,7 +2,6 @@
 import { Progress } from "../types/progressBarTypes";
 export interface ProgressStatusProps {
     progress: Progress;
+    currentTime: [number, number];
 }
-export declare function ProgressStatus(props: {
-    progress: Progress;
-}): JSX.Element;
+export declare function ProgressStatus(props: ProgressStatusProps): JSX.Element;

package/lib/components/ProgressStatus.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "ProgressStatus", {
     enumerable: true,
     get: ()=>ProgressStatus
 });
+const _formatHrtime = require("@lage-run/format-hrtime");
 const _ink = require("ink");
 const _react = /*#__PURE__*/ _interopRequireWildcard(require("react"));
 function _getRequireWildcardCache(nodeInterop) {
@@ -50,6 +51,6 @@ function _interopRequireWildcard(obj, nodeInterop) {
 function ProgressStatus(props) {
     const { waiting , completed , total  } = props.progress;
     const percentage = total > 0 ? `${(completed / total * 100).toFixed(2)}%` : "0%";
-    const status = `Waiting: ${waiting} | Completed: ${completed} | Total: ${total} | ${percentage}`;
+    const status = `Waiting: ${waiting} | Completed: ${completed} | Total: ${total} | ${percentage} | ${(0, _formatHrtime.formatDuration)((0, _formatHrtime.hrToSeconds)(props.currentTime))}`;
     return /*#__PURE__*/ _react.createElement(_ink.Box, null, /*#__PURE__*/ _react.createElement(_ink.Text, null, status));
 }

package/lib/components/ThreadItem.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
 export declare function ThreadItem(props: {
+    threadId: string | number;
     targetId: string;
 }): JSX.Element;

package/lib/components/ThreadItem.js

@@ -48,10 +48,12 @@ function _interopRequireWildcard(obj, nodeInterop) {
     return newObj;
 }
 function ThreadItem(props) {
-    const { targetId  } = props;
-    return /*#__PURE__*/ _react.createElement(_ink.Box, null, targetId ? /*#__PURE__*/ _react.createElement(_ink.Text, {
+    const { targetId , threadId  } = props;
+    return /*#__PURE__*/ _react.createElement(_ink.Box, null, /*#__PURE__*/ _react.createElement(_ink.Box, {
+        width: "2"
+    }, /*#__PURE__*/ _react.createElement(_ink.Text, null, threadId)), targetId ? /*#__PURE__*/ _react.createElement(_ink.Text, {
         color: "whiteBright"
-    }, "[ ", targetId, " ]") : /*#__PURE__*/ _react.createElement(_ink.Text, {
+    }, targetId, " ") : /*#__PURE__*/ _react.createElement(_ink.Text, {
         color: "gray"
-    }, "[ IDLE ]"));
+    }, "IDLE"));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/reporters",
-  "version": "0.2.42",
+  "version": "0.2.43",
   "description": "Log reporters for Lage",
   "repository": {
     "url": "https://github.com/microsoft/lage"
@@ -26,7 +26,7 @@
     "react": "^18.2.0"
   },
   "devDependencies": {
-    "@types/react": "18.0.25",
+    "@types/react": "18.0.26",
     "memory-streams": "0.1.3"
   },
   "publishConfig": {