gcp-structured-logger - npm Package Compare versions

Comparing version 1.4.1 to 1.4.2

index.js

 const { finished } = require('stream')
-const { ErrorReporting } = require('@google-cloud/error-reporting')
 const { StructuredLogger } = require('./src/StructuredLogger')
 const { LogSeverity } = require('./src/severity')
 
-const ERROR_REPORTING_PROP = '__errorReporter'
-
 class Logging {
@@ -19,3 +16,3 @@
       /** @readonly */
-      this.logger = new StructuredLogger(projectId, logName, () => this._errorReporter, productionTransport, extraLabels)
+      this.logger = new StructuredLogger(projectId, logName, serviceContext, productionTransport, extraLabels)
    }
@@ -25,23 +22,2 @@
     * @private
-    * Used for all child logs of this Logging instance, lazily loaded.
-    */
-   get _errorReporter() {
-      /** @type {import('@google-cloud/error-reporting').ErrorReporting} */
-      let e
-      if (ERROR_REPORTING_PROP in this) {
-         e = this[ERROR_REPORTING_PROP]
-      } else {
-         e = new ErrorReporting({
-            serviceContext: this._serviceContext,
-            reportUnhandledRejections: false,
-            // Don't report the errors - we'll manually log errors to include other info
-            reportMode: 'never',
-         })
-         Object.defineProperty(this, ERROR_REPORTING_PROP, { value: e, enumerable: false, configurable: false })
-      }
-      return e
-   }
-
-   /**
-    * @private
     * @param {import('express-serve-static-core').Request} req
@@ -48,0 +24,0 @@ */

package.json

 {
   "name": "gcp-structured-logger",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Structured logger for GCP logging",
@@ -34,11 +34,9 @@ "main": "index.js",
   },
-  "dependencies": {
-    "@google-cloud/error-reporting": "^2.0.5"
-  },
+  "dependencies": {},
   "devDependencies": {
-    "@types/express-serve-static-core": "^4.17.28",
+    "@types/express-serve-static-core": "^4.17.29",
     "c8": "^7.11.3",
     "chai": "^4.3.6",
-    "eslint": "^8.16.0",
-    "eslint-plugin-mocha": "^10.0.3",
+    "eslint": "^8.19.0",
+    "eslint-plugin-mocha": "^10.0.5",
     "eslint-plugin-node": "^11.1.0",
@@ -45,0 +43,0 @@ "mocha": "^10.0.0",

src/request-transformers.js

 /**
- * Converts a request (and its attached response) to a HttpRequest for Stackdriver LogEntry.
+ * Converts a request (and its attached response) to a `HttpRequest` for Stackdriver `LogEntry`.
  *
@@ -15,6 +15,6 @@ * @param {import('express-serve-static-core').Request} req
    }
-   if ('remoteAddress' in reportingReq) httpReq.remoteIp = reportingReq.remoteAddress
+   if ('remoteIp' in reportingReq) httpReq.remoteIp = reportingReq.remoteIp
    if ('referrer' in reportingReq) httpReq.referer = reportingReq.referrer
    if ('userAgent' in reportingReq) httpReq.userAgent = reportingReq.userAgent
-   if ('statusCode' in reportingReq) httpReq.status = reportingReq.statusCode
+   if ('responseStatusCode' in reportingReq) httpReq.status = reportingReq.responseStatusCode
 
@@ -36,4 +36,11 @@ // Add in extra request info
 /**
- * Converts a request (and its attached response) to a HttpRequestContext for Stackdriver error reporting.
+ * Converts a request (and its attached response) to a `HttpRequestContext` for Stackdriver error reporting.
  * See https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorContext#httprequestcontext
+ * @typedef {object} HttpRequestContext
+ * @prop {string} method
+ * @prop {string} url
+ * @prop {string} [userAgent]
+ * @prop {string} [referrer]
+ * @prop {number} [responseStatusCode]
+ * @prop {string} [remoteIp]
  *
@@ -43,15 +50,15 @@ * @param {import('express-serve-static-core').Request} req
 function requestToErrorReportingHttpRequest(req) {
-   /** @type {import('@google-cloud/error-reporting/build/src/request-extractors/manual').Request} */
+   /** @type {HttpRequestContext} */
    const httpReq = {
       url: req.originalUrl,
       method: req.method,
-      remoteAddress: req.ip || (Array.isArray(req.ips) ? req.ips[0] : null)
+      remoteIp: req.ip || (Array.isArray(req.ips) ? req.ips[0] : null)
    }
 
-   if (!httpReq.remoteAddress) {
+   if (!httpReq.remoteIp) {
       const headerIps = req.get('x-forwarded-for')
       if (headerIps && (!Array.isArray(headerIps) || headerIps.length > 0)) {
-         httpReq.remoteAddress = Array.isArray(headerIps) ? headerIps[0] : headerIps
+         httpReq.remoteIp = Array.isArray(headerIps) ? headerIps[0] : headerIps
       } else {
-         delete httpReq.remoteAddress
+         delete httpReq.remoteIp
       }
@@ -66,3 +73,3 @@ }
 
-   if (req.res) httpReq.statusCode = req.res.statusCode
+   if (req.res) httpReq.responseStatusCode = req.res.statusCode
 
@@ -69,0 +76,0 @@ return httpReq

src/StructuredLogger.js

@@ -1,2 +0,2 @@
-const { format, formatWithOptions } = require('util')
+const { format, formatWithOptions, inspect } = require('util')
 const { LogSeverity, CONSOLE_SEVERITY } = require('./severity')
@@ -40,7 +40,7 @@ const cleanupForJSON = require('./cleanup-for-json')
     * @param {string} logName
-    * @param {() => import('@google-cloud/error-reporting').ErrorReporting} errorReporter
+    * @param {import('../').ServiceContext} serviceContext
     * @param {?import('../').Transport} productionTransport
     * @param {{ [key: string]: string }} labels
     */
-   constructor(projectId, logName, errorReporter, productionTransport, labels) {
+   constructor(projectId, logName, serviceContext, productionTransport, labels) {
       /** @readonly @private */
@@ -51,3 +51,3 @@ this._projectId = projectId
       /** @readonly @private */
-      this._errorReporter = errorReporter
+      this._serviceContext = serviceContext
       /** @readonly @private */
@@ -66,3 +66,3 @@ this._productionTransport = productionTransport
    child(type) {
-      return new StructuredLogger(this._projectId, this._logName, this._errorReporter, this._productionTransport, { ...this._labels, type })
+      return new StructuredLogger(this._projectId, this._logName, this._serviceContext, this._productionTransport, { ...this._labels, type })
    }
@@ -76,3 +76,3 @@
    _requestChild(request, extractUser) {
-      return new StructuredRequestLogger(this._projectId, this._logName, this._errorReporter, this._productionTransport, { ...this._labels, type: 'request' }, request, extractUser)
+      return new StructuredRequestLogger(this._projectId, this._logName, this._serviceContext, this._productionTransport, { ...this._labels, type: 'request' }, request, extractUser)
    }
@@ -135,5 +135,3 @@
       }
-      const event = this._makeReportableError(this._errorReporter(), err)
-      // Remove report location as the stack trace is used
-      delete event.context.reportLocation
+      const event = { eventTime: timestamp.toISOString(), ...this._makeReportableError(err) }
       if (!event.context.user) delete event.context.user
@@ -260,9 +258,43 @@ if (!event.context.user && !event.context.httpRequest) delete event.context
    /**
+    * @typedef {object} ReportedErrorEvent
+    * @prop {import('../').ServiceContext} serviceContext
+    * @prop {string} message
+    * @prop {{ httpRequest?: import('./request-transformers').HttpRequestContext, user?: string }} context
+    *
     * @protected
-    * @param {import('@google-cloud/error-reporting').ErrorReporting} errorReporter
     * @param {any} err
     */
-   _makeReportableError(errorReporter, err) {
-      const event = errorReporter.report(err)
-      delete event.context.httpRequest
+   _makeReportableError(err) {
+      /** @type {string?} */
+      let message
+      {
+         let hasStack = false
+         if (err && typeof err === 'object') {
+            if (err.stack) {
+               message = err.stack
+               hasStack = true
+            } else {
+               message = (typeof err.toString === 'function' && err.toString() !== String({})) ? err.toString() : err.message
+            }
+         } else {
+            message = typeof err === 'string' ? err : String(err)
+         }
+
+         if (!message) message = inspect(err)
+         if (!hasStack) {
+            message += '\n'
+            const trace = {}
+            Error.captureStackTrace(trace, this._makeReportableError)
+            // Remove first line
+            message += trace.stack.slice(trace.stack.indexOf('\n') + 1)
+         }
+      }
+
+      /** @type {ReportedErrorEvent} */
+      const event = {
+         message,
+         serviceContext: { ...this._serviceContext },
+         context: {},
+      }
+      if (typeof err === 'object' && err && err.user) event.context.user = String(err.user)
       return event
@@ -439,3 +471,3 @@ }
     * @param {string} logName
-    * @param {() => import('@google-cloud/error-reporting').ErrorReporting} errorReporter
+    * @param {import('../').ServiceContext} serviceContext
     * @param {import('../').Transport} productionTransport
@@ -446,4 +478,4 @@ * @param {{ [key: string]: string }} labels
     */
-   constructor(projectId, logName, errorReporter, productionTransport, labels, request, extractUser) {
-      super(projectId, logName, errorReporter, productionTransport, labels)
+   constructor(projectId, logName, serviceContext, productionTransport, labels, request, extractUser) {
+      super(projectId, logName, serviceContext, productionTransport, labels)
       /** @readonly @private */
@@ -468,11 +500,11 @@ this._request = request
    /**
-    * @param {import('@google-cloud/error-reporting').ErrorReporting} errorReporter
     * @param {any} err
     */
-   _makeReportableError(errorReporter, err) {
+   _makeReportableError(err) {
+      const event = super._makeReportableError(err)
       // Add in request and user info
-      const event = errorReporter.report(err, requestToErrorReportingHttpRequest(this._request))
+      event.context = { httpRequest: requestToErrorReportingHttpRequest(this._request) }
       if (typeof this._extractUser === 'function') {
          const user = this._extractUser(this._request)
-         if (user) event.setUser(user)
+         if (user) event.context.user = user
       }
@@ -479,0 +511,0 @@ return event

No alert changes

Improved metrics

Total package byte prevSize

37799

0.54%

Dependency count

0

-100%

Lines of code

850

1.8%

Dependency changes

• - Removed

  @google-cloud/error-reporting@^2.0.5

• - Removed

  @google-cloud/common@3.10.0
  (transitive)

• - Removed

  @google-cloud/error-reporting@2.0.5
  (transitive)

• - Removed

  @google-cloud/projectify@2.1.1
  (transitive)

• - Removed

  @google-cloud/promisify@2.0.4
  (transitive)

• - Removed

  @tootallnate/once@2.0.0
  (transitive)

• - Removed

  abort-controller@3.0.0
  (transitive)

• - Removed

  agent-base@6.0.2
  (transitive)

• - Removed

  arrify@2.0.1
  (transitive)

• - Removed

  base64-js@1.5.1
  (transitive)

• - Removed

  bignumber.js@9.3.1
  (transitive)

• - Removed

  buffer-equal-constant-time@1.0.1
  (transitive)

• - Removed

  call-bind-apply-helpers@1.0.2
  (transitive)

• - Removed

  call-bound@1.0.4
  (transitive)

• - Removed

  console-log-level@1.4.1
  (transitive)

• - Removed

  debug@4.4.1
  (transitive)

• - Removed

  dunder-proto@1.0.1
  (transitive)

• - Removed

  duplexify@4.1.3
  (transitive)

• - Removed

  ecdsa-sig-formatter@1.0.11
  (transitive)

• - Removed

  end-of-stream@1.4.5
  (transitive)

• - Removed

  ent@2.2.2
  (transitive)

• - Removed

  es-define-property@1.0.1
  (transitive)

• - Removed

  es-errors@1.3.0
  (transitive)

• - Removed

  es-object-atoms@1.1.1
  (transitive)

• - Removed

  event-target-shim@5.0.1
  (transitive)

• - Removed

  extend@3.0.2
  (transitive)

• - Removed

  fast-text-encoding@1.0.6
  (transitive)

• - Removed

  function-bind@1.1.2
  (transitive)

• - Removed

  gaxios@4.3.3
  (transitive)

• - Removed

  gcp-metadata@4.3.1
  (transitive)

• - Removed

  get-intrinsic@1.3.0
  (transitive)

• - Removed

  get-proto@1.0.1
  (transitive)

• - Removed

  google-auth-library@7.14.1
  (transitive)

• - Removed

  google-p12-pem@3.1.4
  (transitive)

• - Removed

  gopd@1.2.0
  (transitive)

• - Removed

  gtoken@5.3.2
  (transitive)

• - Removed

  has-symbols@1.1.0
  (transitive)

• - Removed

  has-tostringtag@1.0.2
  (transitive)

• - Removed

  hasown@2.0.2
  (transitive)

• - Removed

  http-proxy-agent@5.0.0
  (transitive)

• - Removed

  https-proxy-agent@5.0.1
  (transitive)

• - Removed

  inherits@2.0.4
  (transitive)

• - Removed

  is-regex@1.2.1
  (transitive)

• - Removed

  is-stream@2.0.1
  (transitive)

• - Removed

  json-bigint@1.0.0
  (transitive)

• - Removed

  jwa@2.0.1
  (transitive)

• - Removed

  jws@4.0.0
  (transitive)

• - Removed

  lru-cache@6.0.0
  (transitive)

• - Removed

  math-intrinsics@1.1.0
  (transitive)

• - Removed

  ms@2.1.3
  (transitive)

• - Removed

  node-fetch@2.7.0
  (transitive)

• - Removed

  node-forge@1.3.1
  (transitive)

• - Removed

  once@1.4.0
  (transitive)

• - Removed

  punycode@1.4.1
  (transitive)

• - Removed

  readable-stream@3.6.2
  (transitive)

• - Removed

  retry-request@4.2.2
  (transitive)

• - Removed

  safe-buffer@5.2.1
  (transitive)

• - Removed

  safe-regex-test@1.1.0
  (transitive)

• - Removed

  stream-events@1.0.5
  (transitive)

• - Removed

  stream-shift@1.0.3
  (transitive)

• - Removed

  string_decoder@1.3.0
  (transitive)

• - Removed

  stubs@3.0.0
  (transitive)

• - Removed

  teeny-request@7.2.0
  (transitive)

• - Removed

  tr46@0.0.3
  (transitive)

• - Removed

  util-deprecate@1.0.2
  (transitive)

• - Removed

  uuid@8.3.2
  (transitive)

• - Removed

  webidl-conversions@3.0.1
  (transitive)

• - Removed

  whatwg-url@5.0.0
  (transitive)

• - Removed

  wrappy@1.0.2
  (transitive)

• - Removed

  yallist@4.0.0
  (transitive)