@naturalcycles/nodejs-lib 13.16.0 → 13.17.0

package/dist/fs/json2env.d.ts

@@ -30,7 +30,7 @@ export declare function appendToGithubOutput(obj: AnyObject, prefix?: string): v
 /**
  * https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
  */
-export declare function appendToGithubSummary(str: string): void;
+export declare function appendToGithubSummary(...lines: string[]): void;
 /**
  * Turns Object with keys/values into a *.sh script that exports all keys as values.
  *

package/dist/fs/json2env.js

@@ -81,10 +81,11 @@ exports.appendToGithubOutput = appendToGithubOutput;
 /**
  * https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
  */
-function appendToGithubSummary(str) {
+function appendToGithubSummary(...lines) {
     const { GITHUB_STEP_SUMMARY } = process.env;
     if (GITHUB_STEP_SUMMARY) {
-        node_fs_1.default.appendFileSync(GITHUB_STEP_SUMMARY, str + '\n');
+        const str = lines.join('\n') + '\n';
+        node_fs_1.default.appendFileSync(GITHUB_STEP_SUMMARY, str);
         console.log(`GITHUB_STEP_SUMMARY appended:\n${str}`);
     }
 }

package/dist/stream/transform/transformMap.d.ts

@@ -1,4 +1,4 @@
-import { AbortableAsyncMapper, AsyncPredicate, CommonLogger, END, ErrorMode, SKIP } from '@naturalcycles/js-lib';
+import { AbortableAsyncMapper, AsyncPredicate, CommonLogger, END, ErrorMode, SKIP, StringMap, UnixTimestampMillisNumber } from '@naturalcycles/js-lib';
 import { TransformTyped } from '../stream.model';
 export interface TransformMapOptions<IN = any, OUT = IN> {
     /**
@@ -61,6 +61,7 @@ export interface TransformMapStats {
     countErrors: number;
     countIn: number;
     countOut: number;
+    started: UnixTimestampMillisNumber;
 }
 /**
  * Like pMap, but for streams.
@@ -75,3 +76,7 @@ export interface TransformMapStats {
  * If an Array is returned by `mapper` - it will be flattened and multiple results will be emitted from it. Tested by Array.isArray().
  */
 export declare function transformMap<IN = any, OUT = IN>(mapper: AbortableAsyncMapper<IN, OUT | typeof SKIP | typeof END>, opt?: TransformMapOptions<IN, OUT>): TransformTyped<IN, OUT>;
+export declare function appendTransformMapStatsToGithubSummary(stats: TransformMapStats & {
+    name?: string;
+    extra?: StringMap<any>;
+}): void;

package/dist/stream/transform/transformMap.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMap = void 0;
+exports.appendTransformMapStatsToGithubSummary = exports.transformMap = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const through2Concurrent = require("through2-concurrent");
 const colors_1 = require("../../colors/colors");
+const json2env_1 = require("../../fs/json2env");
 const stream_util_1 = require("../stream.util");
 // doesn't work, cause here we don't construct our Transform instance ourselves
 // export class TransformMap extends AbortableTransform {}
@@ -22,6 +23,7 @@ const stream_util_1 = require("../stream.util");
 function transformMap(mapper, opt = {}) {
     const { concurrency = 16, predicate, // we now default to "no predicate" (meaning pass-everything)
     errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput, onError, onDone, metric = 'stream', logger = console, } = opt;
+    const started = Date.now();
     let index = -1;
     let countOut = 0;
     let isSettled = false;
@@ -39,6 +41,7 @@ function transformMap(mapper, opt = {}) {
                     countErrors: errors,
                     countIn: index + 1,
                     countOut,
+                    started,
                 });
                 // emit Aggregated error
                 cb(new AggregateError(collectedErrors, `transformMap resulted in ${collectedErrors.length} error(s)`));
@@ -51,6 +54,7 @@ function transformMap(mapper, opt = {}) {
                     countErrors: errors,
                     countIn: index + 1,
                     countOut,
+                    started,
                 });
                 cb();
             }
@@ -95,6 +99,7 @@ function transformMap(mapper, opt = {}) {
                     countErrors: errors,
                     countIn: index + 1,
                     countOut,
+                    started,
                 });
                 return cb(err); // Emit error immediately
             }
@@ -112,3 +117,14 @@ function transformMap(mapper, opt = {}) {
     }
 }
 exports.transformMap = transformMap;
+function appendTransformMapStatsToGithubSummary(stats) {
+    const { countIn, countOut, countErrors, started, name = 'Transform', extra = {} } = stats;
+    (0, json2env_1.appendToGithubSummary)(...[
+        `### ${name} summary\n`,
+        `${(0, js_lib_1._since)(started)} spent`,
+        `${(0, js_lib_1._hc)(countIn)} / ${(0, js_lib_1._hc)(countOut)} rows in / out`,
+        countErrors ? `${countErrors} errors` : '',
+        ...Object.entries(extra).map(([k, v]) => `${k}: ${v}`),
+    ].filter(Boolean));
+}
+exports.appendTransformMapStatsToGithubSummary = appendTransformMapStatsToGithubSummary;

package/dist/stream/transform/transformMapSync.js

@@ -15,6 +15,7 @@ exports.TransformMapSync = TransformMapSync;
 function transformMapSync(mapper, opt = {}) {
     const { predicate, // defaults to "no predicate" (pass everything)
     errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput = false, onError, onDone, metric = 'stream', objectMode = true, logger = console, } = opt;
+    const started = Date.now();
     let index = -1;
     let countOut = 0;
     let isSettled = false;
@@ -64,6 +65,7 @@ function transformMapSync(mapper, opt = {}) {
                         countErrors: errors,
                         countIn: index + 1,
                         countOut,
+                        started,
                     });
                     // Emit error immediately
                     return cb(err);
@@ -84,6 +86,7 @@ function transformMapSync(mapper, opt = {}) {
                     countErrors: errors,
                     countIn: index + 1,
                     countOut,
+                    started,
                 });
                 // emit Aggregated error
                 cb(new AggregateError(collectedErrors, `transformMapSync resulted in ${collectedErrors.length} error(s)`));
@@ -96,6 +99,7 @@ function transformMapSync(mapper, opt = {}) {
                     countErrors: errors,
                     countIn: index + 1,
                     countOut,
+                    started,
                 });
                 cb();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "13.16.0",
+  "version": "13.17.0",
   "scripts": {
     "prepare": "husky",
     "docs-serve": "vuepress dev docs",

package/src/fs/json2env.ts

@@ -120,10 +120,11 @@ export function appendToGithubOutput(obj: AnyObject, prefix = ''): void {
 /**
  * https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
  */
-export function appendToGithubSummary(str: string): void {
+export function appendToGithubSummary(...lines: string[]): void {
   const { GITHUB_STEP_SUMMARY } = process.env
   if (GITHUB_STEP_SUMMARY) {
-    fs.appendFileSync(GITHUB_STEP_SUMMARY, str + '\n')
+    const str = lines.join('\n') + '\n'
+    fs.appendFileSync(GITHUB_STEP_SUMMARY, str)
     console.log(`GITHUB_STEP_SUMMARY appended:\n${str}`)
   }
 }

package/src/stream/transform/transformMap.ts

@@ -1,5 +1,7 @@
 import {
   _anyToError,
+  _hc,
+  _since,
   AbortableAsyncMapper,
   AsyncPredicate,
   CommonLogger,
@@ -7,9 +9,12 @@ import {
   ErrorMode,
   pFilter,
   SKIP,
+  StringMap,
+  UnixTimestampMillisNumber,
 } from '@naturalcycles/js-lib'
 import through2Concurrent = require('through2-concurrent')
 import { yellow } from '../../colors/colors'
+import { appendToGithubSummary } from '../../fs/json2env'
 import { AbortableTransform } from '../pipeline/pipeline'
 import { TransformTyped } from '../stream.model'
 import { pipelineClose } from '../stream.util'
@@ -83,6 +88,7 @@ export interface TransformMapStats {
   countErrors: number
   countIn: number
   countOut: number
+  started: UnixTimestampMillisNumber
 }
 
 // doesn't work, cause here we don't construct our Transform instance ourselves
@@ -115,6 +121,7 @@ export function transformMap<IN = any, OUT = IN>(
     logger = console,
   } = opt
 
+  const started = Date.now()
   let index = -1
   let countOut = 0
   let isSettled = false
@@ -136,6 +143,7 @@ export function transformMap<IN = any, OUT = IN>(
             countErrors: errors,
             countIn: index + 1,
             countOut,
+            started,
           })
 
           // emit Aggregated error
@@ -154,6 +162,7 @@ export function transformMap<IN = any, OUT = IN>(
             countErrors: errors,
             countIn: index + 1,
             countOut,
+            started,
           })
 
           cb()
@@ -207,6 +216,7 @@ export function transformMap<IN = any, OUT = IN>(
             countErrors: errors,
             countIn: index + 1,
             countOut,
+            started,
           })
           return cb(err) // Emit error immediately
         }
@@ -226,3 +236,19 @@ export function transformMap<IN = any, OUT = IN>(
     logger.log(`${metric} ${final ? 'final ' : ''}errors: ${yellow(errors)}`)
   }
 }
+
+export function appendTransformMapStatsToGithubSummary(
+  stats: TransformMapStats & { name?: string; extra?: StringMap<any> },
+): void {
+  const { countIn, countOut, countErrors, started, name = 'Transform', extra = {} } = stats
+
+  appendToGithubSummary(
+    ...[
+      `### ${name} summary\n`,
+      `${_since(started)} spent`,
+      `${_hc(countIn)} / ${_hc(countOut)} rows in / out`,
+      countErrors ? `${countErrors} errors` : '',
+      ...Object.entries(extra).map(([k, v]) => `${k}: ${v}`),
+    ].filter(Boolean),
+  )
+}

package/src/stream/transform/transformMapSync.ts

@@ -88,6 +88,7 @@ export function transformMapSync<IN = any, OUT = IN>(
     logger = console,
   } = opt
 
+  const started = Date.now()
   let index = -1
   let countOut = 0
   let isSettled = false
@@ -144,6 +145,7 @@ export function transformMapSync<IN = any, OUT = IN>(
             countErrors: errors,
             countIn: index + 1,
             countOut,
+            started,
           })
           // Emit error immediately
           return cb(err as Error)
@@ -168,6 +170,7 @@ export function transformMapSync<IN = any, OUT = IN>(
           countErrors: errors,
           countIn: index + 1,
           countOut,
+          started,
         })
 
         // emit Aggregated error
@@ -186,6 +189,7 @@ export function transformMapSync<IN = any, OUT = IN>(
           countErrors: errors,
           countIn: index + 1,
           countOut,
+          started,
         })
 
         cb()