@webpieces/winston 0.4.398 → 0.4.400

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/winston",
-  "version": "0.4.398",
+  "version": "0.4.400",
   "description": "Node-only winston LoggerFactory backends for webpieces: Console (local pretty) + GCP (Cloud Run stdout JSON), auto-enriched with HeaderRegistry context keys",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -23,8 +23,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@webpieces/core-util": "0.4.398",
-    "@webpieces/core-context": "0.4.398",
+    "@webpieces/core-util": "0.4.400",
+    "@webpieces/core-context": "0.4.400",
     "winston": "3.11.0",
     "logform": "2.7.0",
     "safe-stable-stringify": "2.5.0"

package/src/WinstonFactoryBase.d.ts

@@ -8,12 +8,14 @@ import type { Logger, LoggerFactory } from '@webpieces/core-util';
  * out a cached {@link WinstonLogger} per name (each a winston child carrying
  * `loggerName`). Subclasses differ only in the format stack they pass up.
  *
- * Every line carries `svcName` + `version` from {@link ServiceInfo}. Neither used to be a property
- * of the SERVICE: winston has no mandatory logger name (so this backend emitted none — a winston
- * service was distinguishable only by GCP's own resource labels), and the version lived here as an
- * optional `svcGitHash` factory option that bunyan had no counterpart for. Both now come from the
- * ONE {@link ServiceInfo}, so the fields on your logs no longer depend on which logging library the
- * app happened to pick. `version` is opaque — whatever string the app used to identify its build.
+ * Every line carries `svcName` from {@link ServiceInfo} (winston has no mandatory logger name, so this
+ * backend used to emit none — a winston service was distinguishable only by GCP's own resource
+ * labels). It is read here at construction and rides as `defaultMeta`; it is simply absent if the
+ * service was not identified before this factory was built.
+ *
+ * `version` is NOT read here: it is stamped per-record by `RequestContext.buildStructuredLogFields`
+ * (the one map `injectContextFormat` already loops), so it appears the moment `setInfo` runs — even
+ * if that is after this factory was constructed — and logging works before it.
  */
 export declare abstract class WinstonFactoryBase implements LoggerFactory {
     private readonly base;

package/src/WinstonFactoryBase.js

@@ -11,12 +11,14 @@ const WinstonLogger_1 = require("./WinstonLogger");
  * out a cached {@link WinstonLogger} per name (each a winston child carrying
  * `loggerName`). Subclasses differ only in the format stack they pass up.
  *
- * Every line carries `svcName` + `version` from {@link ServiceInfo}. Neither used to be a property
- * of the SERVICE: winston has no mandatory logger name (so this backend emitted none — a winston
- * service was distinguishable only by GCP's own resource labels), and the version lived here as an
- * optional `svcGitHash` factory option that bunyan had no counterpart for. Both now come from the
- * ONE {@link ServiceInfo}, so the fields on your logs no longer depend on which logging library the
- * app happened to pick. `version` is opaque — whatever string the app used to identify its build.
+ * Every line carries `svcName` from {@link ServiceInfo} (winston has no mandatory logger name, so this
+ * backend used to emit none — a winston service was distinguishable only by GCP's own resource
+ * labels). It is read here at construction and rides as `defaultMeta`; it is simply absent if the
+ * service was not identified before this factory was built.
+ *
+ * `version` is NOT read here: it is stamped per-record by `RequestContext.buildStructuredLogFields`
+ * (the one map `injectContextFormat` already loops), so it appears the moment `setInfo` runs — even
+ * if that is after this factory was constructed — and logging works before it.
  */
 class WinstonFactoryBase {
     base;
@@ -28,12 +30,14 @@ class WinstonFactoryBase {
      *   about the SINK, which is where it actually lives — a dev terminal has no such limit.
      */
     constructor(finalFormat, transport) {
-        // Read at STARTUP (this ctor runs while booting), so a forgotten ServiceInfo.setInfo(...)
-        // fails the deploy rather than shipping logs that cannot say which build emitted them.
-        const defaultMeta = {
-            svcName: core_util_1.ServiceInfo.getName(),
-            version: core_util_1.ServiceInfo.getVersion(),
-        };
+        // svcName is a base field on every record when known. Non-throwing read: if the service was
+        // not identified before this factory was built, svcName is simply omitted rather than blocking
+        // the deploy — setupRuntime enforces identity separately via ServiceInfo.assertIdentified().
+        const svcName = core_util_1.ServiceInfo.getName();
+        const defaultMeta = {};
+        if (svcName) {
+            defaultMeta['svcName'] = svcName;
+        }
         // No level set — we do NOT filter; that is winston's job (defaults to 'info').
         this.base = (0, winston_1.createLogger)({
             format: finalFormat,

package/src/WinstonFactoryBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"WinstonFactoryBase.js","sourceRoot":"","sources":["../../../../../packages/logging/winston/src/WinstonFactoryBase.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAKnD,oDAAmD;AACnD,mDAAgD;AAEhD;;;;;;;;;;;;;GAaG;AACH,MAAsB,kBAAkB;IACnB,IAAI,CAAc;IAClB,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAErD;;;;;OAKG;IACH,YAAsB,WAAmB,EAAE,SAAqB;QAC5D,0FAA0F;QAC1F,uFAAuF;QACvF,MAAM,WAAW,GAA2B;YACxC,OAAO,EAAE,uBAAW,CAAC,OAAO,EAAE;YAC9B,OAAO,EAAE,uBAAW,CAAC,UAAU,EAAE;SACpC,CAAC;QAEF,+EAA+E;QAC/E,IAAI,CAAC,IAAI,GAAG,IAAA,sBAAY,EAAC;YACrB,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,WAAW;YACxB,UAAU,EAAE,CAAC,SAAS,IAAI,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;YACnD,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,IAAY;QAClB,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AApCD,gDAoCC","sourcesContent":["import { createLogger, transports } from 'winston';\nimport type { Logger as WinstonBase } from 'winston';\nimport type Transport from 'winston-transport';\nimport type { Format } from 'logform';\nimport type { Logger, LoggerFactory } from '@webpieces/core-util';\nimport { ServiceInfo } from '@webpieces/core-util';\nimport { WinstonLogger } from './WinstonLogger';\n\n/**\n * WinstonFactoryBase - shared plumbing for the winston {@link LoggerFactory}\n * backends. Builds ONE underlying winston logger (a single `Console` transport,\n * handleExceptions/Rejections on) with the caller-chosen format stack, then hands\n * out a cached {@link WinstonLogger} per name (each a winston child carrying\n * `loggerName`). Subclasses differ only in the format stack they pass up.\n *\n * Every line carries `svcName` + `version` from {@link ServiceInfo}. Neither used to be a property\n * of the SERVICE: winston has no mandatory logger name (so this backend emitted none — a winston\n * service was distinguishable only by GCP's own resource labels), and the version lived here as an\n * optional `svcGitHash` factory option that bunyan had no counterpart for. Both now come from the\n * ONE {@link ServiceInfo}, so the fields on your logs no longer depend on which logging library the\n * app happened to pick. `version` is opaque — whatever string the app used to identify its build.\n */\nexport abstract class WinstonFactoryBase implements LoggerFactory {\n    private readonly base: WinstonBase;\n    private readonly loggers = new Map<string, Logger>();\n\n    /**\n     * @param transport - the sink to write through. Defaults to a plain Console; the GCP subclass\n     *   passes a {@link ChunkingConsoleTransport} instead, because only there does a per-entry size\n     *   limit exist. Taking the whole transport (rather than a size knob) keeps the size limit a fact\n     *   about the SINK, which is where it actually lives — a dev terminal has no such limit.\n     */\n    protected constructor(finalFormat: Format, transport?: Transport) {\n        // Read at STARTUP (this ctor runs while booting), so a forgotten ServiceInfo.setInfo(...)\n        // fails the deploy rather than shipping logs that cannot say which build emitted them.\n        const defaultMeta: Record<string, string> = {\n            svcName: ServiceInfo.getName(),\n            version: ServiceInfo.getVersion(),\n        };\n\n        // No level set — we do NOT filter; that is winston's job (defaults to 'info').\n        this.base = createLogger({\n            format: finalFormat,\n            defaultMeta: defaultMeta,\n            transports: [transport ?? new transports.Console()],\n            handleExceptions: true,\n            handleRejections: true,\n        });\n    }\n\n    getLogger(name: string): Logger {\n        let logger = this.loggers.get(name);\n        if (!logger) {\n            logger = new WinstonLogger(this.base.child({ loggerName: name }));\n            this.loggers.set(name, logger);\n        }\n        return logger;\n    }\n}\n"]}
+{"version":3,"file":"WinstonFactoryBase.js","sourceRoot":"","sources":["../../../../../packages/logging/winston/src/WinstonFactoryBase.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAKnD,oDAAmD;AACnD,mDAAgD;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAsB,kBAAkB;IACnB,IAAI,CAAc;IAClB,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAErD;;;;;OAKG;IACH,YAAsB,WAAmB,EAAE,SAAqB;QAC5D,4FAA4F;QAC5F,+FAA+F;QAC/F,6FAA6F;QAC7F,MAAM,OAAO,GAAG,uBAAW,CAAC,OAAO,EAAE,CAAC;QACtC,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,IAAI,OAAO,EAAE,CAAC;YACV,WAAW,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;QACrC,CAAC;QAED,+EAA+E;QAC/E,IAAI,CAAC,IAAI,GAAG,IAAA,sBAAY,EAAC;YACrB,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,WAAW;YACxB,UAAU,EAAE,CAAC,SAAS,IAAI,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;YACnD,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,IAAY;QAClB,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAtCD,gDAsCC","sourcesContent":["import { createLogger, transports } from 'winston';\nimport type { Logger as WinstonBase } from 'winston';\nimport type Transport from 'winston-transport';\nimport type { Format } from 'logform';\nimport type { Logger, LoggerFactory } from '@webpieces/core-util';\nimport { ServiceInfo } from '@webpieces/core-util';\nimport { WinstonLogger } from './WinstonLogger';\n\n/**\n * WinstonFactoryBase - shared plumbing for the winston {@link LoggerFactory}\n * backends. Builds ONE underlying winston logger (a single `Console` transport,\n * handleExceptions/Rejections on) with the caller-chosen format stack, then hands\n * out a cached {@link WinstonLogger} per name (each a winston child carrying\n * `loggerName`). Subclasses differ only in the format stack they pass up.\n *\n * Every line carries `svcName` from {@link ServiceInfo} (winston has no mandatory logger name, so this\n * backend used to emit none — a winston service was distinguishable only by GCP's own resource\n * labels). It is read here at construction and rides as `defaultMeta`; it is simply absent if the\n * service was not identified before this factory was built.\n *\n * `version` is NOT read here: it is stamped per-record by `RequestContext.buildStructuredLogFields`\n * (the one map `injectContextFormat` already loops), so it appears the moment `setInfo` runs — even\n * if that is after this factory was constructed — and logging works before it.\n */\nexport abstract class WinstonFactoryBase implements LoggerFactory {\n    private readonly base: WinstonBase;\n    private readonly loggers = new Map<string, Logger>();\n\n    /**\n     * @param transport - the sink to write through. Defaults to a plain Console; the GCP subclass\n     *   passes a {@link ChunkingConsoleTransport} instead, because only there does a per-entry size\n     *   limit exist. Taking the whole transport (rather than a size knob) keeps the size limit a fact\n     *   about the SINK, which is where it actually lives — a dev terminal has no such limit.\n     */\n    protected constructor(finalFormat: Format, transport?: Transport) {\n        // svcName is a base field on every record when known. Non-throwing read: if the service was\n        // not identified before this factory was built, svcName is simply omitted rather than blocking\n        // the deploy — setupRuntime enforces identity separately via ServiceInfo.assertIdentified().\n        const svcName = ServiceInfo.getName();\n        const defaultMeta: Record<string, string> = {};\n        if (svcName) {\n            defaultMeta['svcName'] = svcName;\n        }\n\n        // No level set — we do NOT filter; that is winston's job (defaults to 'info').\n        this.base = createLogger({\n            format: finalFormat,\n            defaultMeta: defaultMeta,\n            transports: [transport ?? new transports.Console()],\n            handleExceptions: true,\n            handleRejections: true,\n        });\n    }\n\n    getLogger(name: string): Logger {\n        let logger = this.loggers.get(name);\n        if (!logger) {\n            logger = new WinstonLogger(this.base.child({ loggerName: name }));\n            this.loggers.set(name, logger);\n        }\n        return logger;\n    }\n}\n"]}