refactor!: only support winston3 (#297)

Author: ofrobots

handwritten/logging-winston/bin/install-winston2.js

@@ -46,7 +46,7 @@
     "postcompile": "cpy ./src/types/* ./build/src/types",
     "fix": "gts fix && eslint --fix '**/*.js'",
     "prepare": "npm run compile",
-    "pretest": "npm run compile && node ./bin/install-winston2.js",
+    "pretest": "npm run compile",
     "posttest": "npm run check",
     "docs-test": "linkinator docs -r --skip www.googleapis.com",
     "predocs-test": "npm run docs"
@@ -56,7 +56,6 @@
     "google-auth-library": "^3.1.0",
     "lodash.mapvalues": "^4.6.0",
     "logform": "^2.0.0",
-    "semver": "^6.0.0",
     "winston-transport": "^4.2.0"
   },
   "devDependencies": {
@@ -91,6 +90,6 @@
     "linkinator": "^1.1.2"
   },
   "peerDependencies": {
-    "winston": ">=2.x <=3.x"
+    "winston": "3.x"
   }
 }

handwritten/logging-winston/package.json

@@ -1,11 +1,10 @@
 
-import * as semver from 'semver';
-import {LOGGING_TRACE_KEY as COMMON_TRACE_KEY} from './common';
-import * as types from './types/core';
+import * as TransportStream from 'winston-transport';
 
+import {LOGGING_TRACE_KEY as COMMON_TRACE_KEY, LoggingCommon} from './common';
+import * as types from './types/core';
 
-require('winston');
-const winstonVersion = require('winston/package.json').version;
+type Callback = (err: Error, apiResponse: {}) => void;
 
 /**
  * This module provides support for streaming your winston logs to
@@ -85,12 +84,29 @@ const winstonVersion = require('winston/package.json').version;
  * region_tag:logging_winston_quickstart
  * Full quickstart example:
  */
-// This is a class.
-// tslint:disable-next-line:variable-name
-export const LoggingWinston: types.Logger = semver.lt(winstonVersion, '3.0.0') ?
-    require('./winston2').LoggingWinston :
-    require('./winston3').LoggingWinston;
-// winstons are required instead of imported so they are not executed unless
-// they're used.
+export class LoggingWinston extends TransportStream {
+  static readonly LOGGING_TRACE_KEY = COMMON_TRACE_KEY;
+
+  common: LoggingCommon;
+  constructor(options?: types.Options) {
+    options = options || {};
+
+    super({
+      level: options.level,
+    });
+
+    this.common = new LoggingCommon(options);
+  }
+
+  log({message, level, splat, stack, ...metadata}: types.Winston3LogArg,
+      callback: Callback) {
+    // If the whole message is an error we have to manually copy the stack into
+    // metadata. Errors dont have enumerable properties so they don't
+    // destructure.
+    if (stack) metadata.stack = stack;
+
+    this.common.log(level, message, metadata || {}, callback);
+  }
+}
 
 export const LOGGING_TRACE_KEY = COMMON_TRACE_KEY;

handwritten/logging-winston/src/index.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as TransportStream from "winston-transport";
+import * as TransportStream from 'winston-transport';
+import {GoogleAuth} from 'google-auth-library';
 
 
 export interface Options {
@@ -168,6 +169,7 @@ interface StackdriverOtherFunctions {
        callback?:
            (err: Error, apiResponse: {}) => void) => Promise<LogWriteResponse>;
   entry: (metadata: {}, data: {}|string) => StackdriverEntry;
+  logging: { auth: GoogleAuth };
 }
 
 export type StackdriverLog = StackdriverLogFunctions&StackdriverOtherFunctions;

handwritten/logging-winston/src/types/core.d.ts

@@ -23,12 +23,10 @@ import {ErrorsApiTransport} from './errors-transport';
 
 const inject = require('require-inject');
 
-const winston3 = require('winston');
-const winston2 = require('../../test/winston-2/node_modules/winston');
+const winston = require('winston');
 
 const {Logging} = require('@google-cloud/logging');
 const logging = new Logging();
-const LoggingWinston = require('../src/index').LoggingWinston;
 
 const WRITE_CONSISTENCY_DELAY_MS = 90000;
 
@@ -84,58 +82,7 @@ describe('LoggingWinston', function() {
     args: any[]; level: string; verify: (entry: types.StackdriverEntry) => void;
   };
 
-  describe('log winston 2', () => {
-    const testData = commonTestData.concat([
-      {
-        args: [new Error('fourth')],
-        level: 'error',
-        verify: (entry: types.StackdriverEntry) => {
-          assert((entry.data as {
-                   message: string
-                 }).message.startsWith('Error: fourth'));
-        },
-      },
-      {
-        args: ['fifth message', new Error('fifth')],
-        level: 'error',
-        verify: (entry: types.StackdriverEntry) => {
-          assert((entry.data as {
-                   message: string
-                 }).message.startsWith('fifth message Error: fifth'));
-        },
-      },
-    ] as typeof commonTestData);
-
-    const LOG_NAME = logName('logging_winston_2_system_tests');
-    const LoggingWinston = inject('../src/index', {
-                             winston: winston2,
-                             'winston/package.json': {version: '2.2.0'}
-                           }).LoggingWinston;
-
-    const logger = new winston2.Logger({
-      transports: [new LoggingWinston({logName: LOG_NAME})],
-    });
-
-    it('should properly write log entries', async () => {
-      const start = Date.now();
-      testData.forEach((test) => {
-        // logger does not have index signature.
-        // tslint:disable-next-line:no-any
-        (logger as any)[test.level].apply(logger, test.args);
-      });
-
-      const entries = await pollLogs(
-          LOG_NAME, start, testData.length, WRITE_CONSISTENCY_DELAY_MS);
-      assert.strictEqual(entries.length, testData.length);
-      entries.reverse().forEach((entry, index) => {
-        const test = testData[index];
-        test.verify(entry);
-      });
-    });
-  });
-
-
-  describe('log winston 3', () => {
+  describe('log', () => {
     const testData = commonTestData.concat([
       {
         args: [new Error('fourth')],
@@ -161,13 +108,12 @@ describe('LoggingWinston', function() {
       },
     ] as TestData[]);
 
-    const LOG_NAME = logName('logging_winston_3_system_tests');
+    const LOG_NAME = logName('logging_winston_system_tests');
     const LoggingWinston = inject('../src/index', {
-                             winston: winston3,
-                             'winston/package.json': {version: '3.0.0'}
+                             winston,
                            }).LoggingWinston;
 
-    const logger = winston3.createLogger({
+    const logger = winston.createLogger({
       transports: [new LoggingWinston({logName: LOG_NAME})],
     });
 
@@ -194,42 +140,14 @@ describe('LoggingWinston', function() {
     const ERROR_REPORTING_POLL_TIMEOUT = WRITE_CONSISTENCY_DELAY_MS;
     const errorsTransport = new ErrorsApiTransport();
 
-    it('reports errors when logging errors with winston2', async () => {
-      const start = Date.now();
-      const service = `logging-winston-system-test-winston2-${UUID}`;
-      const LoggingWinston = inject('../src/index', {
-                               winston: winston2,
-                               'winston/package.json': {version: '2.2.0'}
-                             }).LoggingWinston;
-
-      const logger = new winston2.Logger({
-        transports: [new LoggingWinston(
-            {logName: LOG_NAME, serviceContext: {service, version: 'none'}})],
-      });
-
-      const message = `an error at ${Date.now()}`;
-
-      logger.error('an error', new Error(message));
-
-      const errors = await errorsTransport.pollForNewEvents(
-          service, start, ERROR_REPORTING_POLL_TIMEOUT);
-
-      assert.strictEqual(errors.length, 1);
-      const errEvent = errors[0];
-
-      assert.strictEqual(errEvent.serviceContext.service, service);
-      assert(errEvent.message.startsWith(`an error Error: ${message}`));
-    });
-
-    it('reports errors when logging errors with winston3', async () => {
+    it('reports errors', async () => {
       const start = Date.now();
       const service = `logging-winston-system-test-winston3-${UUID}`;
       const LoggingWinston = inject('../src/index', {
-                               winston: winston3,
-                               'winston/package.json': {version: '3.0.0'}
+                               winston,
                              }).LoggingWinston;
 
-      const logger = winston3.createLogger({
+      const logger = winston.createLogger({
         transports: [new LoggingWinston(
             {logName: LOG_NAME, serviceContext: {service, version: 'none'}})],
       });