@lage-run/reporters 1.1.2 → 1.2.0

package/CHANGELOG.json

@@ -2,7 +2,48 @@
   "name": "@lage-run/reporters",
   "entries": [
     {
-      "date": "Fri, 14 Apr 2023 04:37:34 GMT",
+      "date": "Tue, 25 Apr 2023 02:50:56 GMT",
+      "tag": "@lage-run/reporters_v1.2.0",
+      "version": "1.2.0",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@lage-run/reporters",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801",
+            "comment": "Update repository and homepage"
+          }
+        ],
+        "minor": [
+          {
+            "author": "stchur@microsoft.com",
+            "package": "@lage-run/reporters",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801",
+            "comment": "Add VerboseFileLogReporter, which writes verbose, ungrouped logs to a file"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/reporters",
+            "comment": "Bump @lage-run/logger to v1.3.0",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/reporters",
+            "comment": "Bump @lage-run/scheduler-types to v0.3.8",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/reporters",
+            "comment": "Bump @lage-run/target-graph to v0.8.4",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 14 Apr 2023 04:37:55 GMT",
       "tag": "@lage-run/reporters_v1.1.2",
       "version": "1.1.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,27 @@
 # Change Log - @lage-run/reporters
 
-This log was last generated on Fri, 14 Apr 2023 04:37:34 GMT and should not be manually modified.
+This log was last generated on Tue, 25 Apr 2023 02:50:56 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.2.0
+
+Tue, 25 Apr 2023 02:50:56 GMT
+
+### Minor changes
+
+- Add VerboseFileLogReporter, which writes verbose, ungrouped logs to a file (stchur@microsoft.com)
+- Bump @lage-run/logger to v1.3.0
+- Bump @lage-run/scheduler-types to v0.3.8
+- Bump @lage-run/target-graph to v0.8.4
+
+### Patches
+
+- Update repository and homepage (elcraig@microsoft.com)
+
 ## 1.1.2
 
-Fri, 14 Apr 2023 04:37:34 GMT
+Fri, 14 Apr 2023 04:37:55 GMT
 
 ### Patches
 

package/lib/VerboseFileLogReporter.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import type { Reporter, LogEntry } from "@lage-run/logger";
+import { Writable } from "stream";
+export declare class VerboseFileLogReporter implements Reporter {
+    fileStream: Writable;
+    constructor(logFile?: string);
+    cleanup(): void;
+    log(entry: LogEntry<any>): void;
+    private printEntry;
+    private getEntryTargetId;
+    private print;
+    private logTargetEntry;
+    summarize(): void;
+}

package/lib/VerboseFileLogReporter.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "VerboseFileLogReporter", {
+    enumerable: true,
+    get: ()=>VerboseFileLogReporter
+});
+const _formatHrtime = require("@lage-run/format-hrtime");
+const _isTargetStatusLogEntryJs = require("./isTargetStatusLogEntry.js");
+const _logger = require("@lage-run/logger");
+const _ansiRegex = /*#__PURE__*/ _interopRequireDefault(require("ansi-regex"));
+const _stream = require("stream");
+const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const stripAnsiRegex = (0, _ansiRegex.default)();
+function stripAnsi(message) {
+    return message.replace(stripAnsiRegex, "");
+}
+class VerboseFileLogReporter {
+    cleanup() {
+        this.fileStream?.end();
+    }
+    log(entry) {
+        // if "hidden", do not even attempt to record or report the entry
+        if (entry?.data?.target?.hidden) {
+            return;
+        }
+        // if loglevel is not high enough, do not report the entry
+        if (_logger.LogLevel.verbose < entry.level) {
+            return;
+        }
+        // log normal target entries
+        if (entry.data && entry.data.target) {
+            return this.logTargetEntry(entry);
+        }
+        // log generic entries (not related to target)
+        if (entry.msg) {
+            return this.print(`${entry.msg}`);
+        }
+    }
+    printEntry(entry, message) {
+        let packageAndTask = "";
+        if (entry?.data?.target) {
+            const { packageName , task  } = entry.data.target;
+            const pkg = packageName ?? "<root>";
+            packageAndTask = `${pkg} ${task}`.trim();
+        }
+        this.print(`${this.getEntryTargetId(entry)} ${packageAndTask} ${message}`.trim());
+    }
+    getEntryTargetId(entry) {
+        if (entry.data?.target?.id) {
+            return `[:${entry.data.target.id}:]`;
+        }
+        return "";
+    }
+    print(message) {
+        this.fileStream?.write(message + "\n");
+    }
+    logTargetEntry(entry) {
+        const data = entry.data;
+        if ((0, _isTargetStatusLogEntryJs.isTargetStatusLogEntry)(data)) {
+            const { hash , duration , status  } = data;
+            const statusMessages = {
+                running: "➔ start",
+                success: `✓ done - ${duration && (0, _formatHrtime.formatDuration)((0, _formatHrtime.hrToSeconds)(duration))}`,
+                failed: "✖ fail",
+                skipped: `» skip - ${hash}`,
+                aborted: "- aborted",
+                queued: "… queued"
+            };
+            return this.printEntry(entry, statusMessages[status]);
+        } else {
+            const defaultMessage = `: ${stripAnsi(entry.msg)}`;
+            return this.printEntry(entry, defaultMessage);
+        }
+    }
+    summarize() {
+    // No summary needed for VerboseFileLogReporter
+    }
+    constructor(logFile){
+        // if logFile is falsy (not specified on cli args), this.fileStream just become a "nowhere" stream and this reporter effectively does nothing
+        this.fileStream = logFile ? _fs.default.createWriteStream(logFile) : new _stream.Writable({
+            write () {}
+        });
+    }
+}

package/lib/index.d.ts

@@ -3,4 +3,5 @@ export { JsonReporter } from "./JsonReporter.js";
 export { LogReporter } from "./LogReporter.js";
 export { ChromeTraceEventsReporter } from "./ChromeTraceEventsReporter.js";
 export { ProgressReporter } from "./ProgressReporter.js";
+export { VerboseFileLogReporter } from "./VerboseFileLogReporter.js";
 export type { TargetStatusEntry, TargetMessageEntry } from "./types/TargetLogEntry.js";

package/lib/index.js

@@ -13,10 +13,12 @@ _export(exports, {
     JsonReporter: ()=>_jsonReporterJs.JsonReporter,
     LogReporter: ()=>_logReporterJs.LogReporter,
     ChromeTraceEventsReporter: ()=>_chromeTraceEventsReporterJs.ChromeTraceEventsReporter,
-    ProgressReporter: ()=>_progressReporterJs.ProgressReporter
+    ProgressReporter: ()=>_progressReporterJs.ProgressReporter,
+    VerboseFileLogReporter: ()=>_verboseFileLogReporterJs.VerboseFileLogReporter
 });
 const _adoReporterJs = require("./AdoReporter.js");
 const _jsonReporterJs = require("./JsonReporter.js");
 const _logReporterJs = require("./LogReporter.js");
 const _chromeTraceEventsReporterJs = require("./ChromeTraceEventsReporter.js");
 const _progressReporterJs = require("./ProgressReporter.js");
+const _verboseFileLogReporterJs = require("./VerboseFileLogReporter.js");

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@lage-run/reporters",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Log reporters for Lage",
   "repository": {
+    "type": "git",
     "url": "https://github.com/microsoft/lage"
   },
+  "homepage": "https://microsoft.github.io/lage/",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -15,9 +17,9 @@
     "lint": "monorepo-scripts lint"
   },
   "dependencies": {
-    "@lage-run/logger": "^1.2.2",
-    "@lage-run/scheduler-types": "^0.3.7",
-    "@lage-run/target-graph": "^0.8.3",
+    "@lage-run/logger": "^1.3.0",
+    "@lage-run/scheduler-types": "^0.3.8",
+    "@lage-run/target-graph": "^0.8.4",
     "@lage-run/format-hrtime": "^0.1.4",
     "@ms-cloudpack/task-reporter": "^0.3.2",
     "chalk": "^4.0.0",