chore(deps): upgrade to gts 1.0.0 (#299)

Author: DominicKramer

handwritten/nodejs-logging-bunyan/package.json

@@ -76,7 +76,7 @@
     "eslint-plugin-node": "^8.0.0",
     "eslint-plugin-prettier": "^3.0.0",
     "express": "^4.16.3",
-    "gts": "^0.9.0",
+    "gts": "^1.0.0",
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.5.5",
     "jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",

handwritten/nodejs-logging-bunyan/src/index.ts

@@ -137,17 +137,16 @@ function getCurrentTraceFromAgent() {
  */
 export class LoggingBunyan extends Writable {
   private logName: string;
-  private resource: types.MonitoredResource|undefined;
+  private resource: types.MonitoredResource | undefined;
   private serviceContext?: types.ServiceContext;
-  stackdriverLog:
-      types.StackdriverLog;  // TODO: add type for @google-cloud/logging
+  stackdriverLog: types.StackdriverLog; // TODO: add type for @google-cloud/logging
   constructor(options?: types.Options) {
     options = options || {};
     super({objectMode: true});
     this.logName = options.logName || 'bunyan_log';
     this.resource = options.resource;
     this.serviceContext = options.serviceContext;
-    this.stackdriverLog = (new Logging(options)).log(this.logName, {
+    this.stackdriverLog = new Logging(options).log(this.logName, {
       removeCircular: true,
     });
 
@@ -160,20 +159,21 @@ export class LoggingBunyan extends Writable {
     // that serviceContext.service is specified.
     if (this.serviceContext && !this.serviceContext.service) {
       throw new Error(
-          `If 'serviceContext' is specified then ` +
-          `'serviceContext.service' is required.`);
+        `If 'serviceContext' is specified then ` +
+          `'serviceContext.service' is required.`
+      );
     }
 
     /* Asynchrnously attempt to discover the service context. */
     if (!this.serviceContext) {
-      detectServiceContext(this.stackdriverLog.logging.auth)
-          .then(
-              (serviceContext: types.ServiceContext) => {
-                this.serviceContext = serviceContext;
-              },
-              () => {
-                  /* swallow any errors. */
-              });
+      detectServiceContext(this.stackdriverLog.logging.auth).then(
+        (serviceContext: types.ServiceContext) => {
+          this.serviceContext = serviceContext;
+        },
+        () => {
+          /* swallow any errors. */
+        }
+      );
     }
   }
 
@@ -188,10 +188,11 @@ export class LoggingBunyan extends Writable {
   /**
    * Format a bunyan record into a Stackdriver log entry.
    */
-  private formatEntry_(record: string|types.BunyanLogRecord) {
+  private formatEntry_(record: string | types.BunyanLogRecord) {
     if (typeof record === 'string') {
       throw new Error(
-          '@google-cloud/logging-bunyan only works as a raw bunyan stream type.');
+        '@google-cloud/logging-bunyan only works as a raw bunyan stream type.'
+      );
     }
     // Stackdriver Log Viewer picks up the summary line from the 'message' field
     // of the payload. Unless the user has provided a 'message' property also,
@@ -216,7 +217,7 @@ export class LoggingBunyan extends Writable {
     const entryMetadata: types.StackdriverEntryMetadata = {
       resource: this.resource,
       timestamp: record.time,
-      severity: BUNYAN_TO_STACKDRIVER.get(Number(record.level))
+      severity: BUNYAN_TO_STACKDRIVER.get(Number(record.level)),
     };
 
     // If the record contains a httpRequest property, provide it on the entry
@@ -268,15 +269,18 @@ export class LoggingBunyan extends Writable {
    * we may well be in a different continuation.
    */
   write(record: types.BunyanLogRecord, callback?: Function): boolean;
-  write(record: types.BunyanLogRecord, encoding?: string, callback?: Function):
-      boolean;
+  write(
+    record: types.BunyanLogRecord,
+    encoding?: string,
+    callback?: Function
+  ): boolean;
   // Writable.write used 'any' in function signature.
   // tslint:disable-next-line:no-any
   write(...args: any[]): boolean {
     let record = args[0];
-    let encoding: string|null = null;
-    type Callback = (error: Error|null|undefined) => void;
-    let callback: Callback|string;
+    let encoding: string | null = null;
+    type Callback = (error: Error | null | undefined) => void;
+    let callback: Callback | string;
     if (typeof args[1] === 'string') {
       encoding = args[1];
       callback = args[2];
@@ -312,15 +316,15 @@ export class LoggingBunyan extends Writable {
    */
   // Writable._write used 'any' in function signature.
   _writev(
-      chunks: Array<{
-        // tslint:disable-next-line:no-any
-        chunk: any; encoding: string;
-      }>,
-      callback: Function) {
-    const entries = chunks.map((request: {
-                                 // tslint:disable-next-line:no-any
-                                 chunk: any; encoding: string;
-                               }) => {
+    chunks: Array<{
+      // tslint:disable-next-line:no-any
+      chunk: any;
+      encoding: string;
+    }>,
+    callback: Function
+  ) {
+    const entries = chunks.map((request: {// tslint:disable-next-line:no-any
+      chunk: any; encoding: string}) => {
       return this.formatEntry_(request.chunk);
     });
 
@@ -336,4 +340,4 @@ module.exports.BUNYAN_TO_STACKDRIVER = BUNYAN_TO_STACKDRIVER;
  * @name LoggingBunyan.LOGGING_TRACE_KEY
  * @type {string}
  */
-module.exports.LOGGING_TRACE_KEY = LOGGING_TRACE_KEY;
+module.exports.LOGGING_TRACE_KEY = LOGGING_TRACE_KEY;

handwritten/nodejs-logging-bunyan/src/middleware/express.ts

@@ -13,7 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import {HttpRequest, middleware as commonMiddleware} from '@google-cloud/logging';
+import {
+  HttpRequest,
+  middleware as commonMiddleware,
+} from '@google-cloud/logging';
 import * as bunyan from 'bunyan';
 import {GCPEnv} from 'google-auth-library';
 
@@ -38,25 +41,30 @@ export interface MiddlewareReturnType {
 /**
  * Express middleware
  */
-export async function middleware(options?: MiddlewareOptions):
-    Promise<MiddlewareReturnType> {
+export async function middleware(
+  options?: MiddlewareOptions
+): Promise<MiddlewareReturnType> {
   const defaultOptions = {logName: 'bunyan_log', level: 'info'};
   options = Object.assign({}, defaultOptions, options);
 
-  const loggingBunyanApp = new LoggingBunyan(Object.assign({}, options, {
-    // For request bundling to work, the parent (request) and child (app) logs
-    // need to have distinct names. For exact requirements see:
-    // https://cloud.google.com/appengine/articles/logging#linking_app_logs_and_requests
-    logName: `${options.logName}_${APP_LOG_SUFFIX}`
-  }));
+  const loggingBunyanApp = new LoggingBunyan(
+    Object.assign({}, options, {
+      // For request bundling to work, the parent (request) and child (app) logs
+      // need to have distinct names. For exact requirements see:
+      // https://cloud.google.com/appengine/articles/logging#linking_app_logs_and_requests
+      logName: `${options.logName}_${APP_LOG_SUFFIX}`,
+    })
+  );
   const logger = bunyan.createLogger({
     name: `${options.logName}_${APP_LOG_SUFFIX}`,
-    streams: [loggingBunyanApp.stream(options.level as types.LogLevel)]
+    streams: [loggingBunyanApp.stream(options.level as types.LogLevel)],
   });
 
   const auth = loggingBunyanApp.stackdriverLog.logging.auth;
-  const [env, projectId] =
-      await Promise.all([auth.getEnv(), auth.getProjectId()]);
+  const [env, projectId] = await Promise.all([
+    auth.getEnv(),
+    auth.getProjectId(),
+  ]);
 
   // Unless we are running on Google App Engine or Cloud Functions, generate a
   // parent request log entry that all the request-specific logs ("app logs")
@@ -67,7 +75,7 @@ export async function middleware(options?: MiddlewareOptions):
     const loggingBunyanReq = new LoggingBunyan(options);
     const requestLogger = bunyan.createLogger({
       name: options.logName!,
-      streams: [loggingBunyanReq.stream(options.level as types.LogLevel)]
+      streams: [loggingBunyanReq.stream(options.level as types.LogLevel)],
     });
     emitRequestLog = (httpRequest: HttpRequest, trace: string) => {
       requestLogger.info({[LOGGING_TRACE_KEY]: trace, httpRequest});
@@ -77,7 +85,10 @@ export async function middleware(options?: MiddlewareOptions):
   return {
     logger,
     mw: commonMiddleware.express.makeMiddleware(
-        projectId, makeChildLogger, emitRequestLog)
+      projectId,
+      makeChildLogger,
+      emitRequestLog
+    ),
   };
 
   function makeChildLogger(trace: string) {

handwritten/nodejs-logging-bunyan/system-test/errors-transport.ts

@@ -41,7 +41,7 @@ export interface ErrorGroupStats {
 }
 
 export interface ApiResponse {
-  body: {errorGroupStats: ErrorGroupStats[]; errorEvents: ErrorEvent[];};
+  body: {errorGroupStats: ErrorGroupStats[]; errorEvents: ErrorEvent[]};
 }
 
 /* @const {String} Base Error Reporting API */
@@ -54,7 +54,7 @@ export class ErrorsApiTransport extends common.Service {
     super({
       baseUrl: 'https://clouderrorreporting.googleapis.com/v1beta1',
       scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-      packageJson
+      packageJson,
     });
   }
 
@@ -70,7 +70,7 @@ export class ErrorsApiTransport extends common.Service {
     const projectId = await this.getProjectId();
     const options = {
       uri: [API, projectId, 'groupStats?' + ONE_HOUR_API].join('/'),
-      method: 'GET'
+      method: 'GET',
     };
     const response = await this.request(options);
     return response.body.errorGroupStats || [];
@@ -80,18 +80,22 @@ export class ErrorsApiTransport extends common.Service {
     const projectId = await this.getProjectId();
     const options = {
       uri: [
-        API, projectId,
-        'events?groupId=' + groupId + '&pageSize=10&' + ONE_HOUR_API
+        API,
+        projectId,
+        'events?groupId=' + groupId + '&pageSize=10&' + ONE_HOUR_API,
       ].join('/'),
-      method: 'GET'
+      method: 'GET',
     };
 
     const response = await this.request(options);
     return response.body.errorEvents || [];
   }
 
-  async pollForNewEvents(service: string, time: number, timeout: number):
-      Promise<ErrorEvent[]> {
+  async pollForNewEvents(
+    service: string,
+    time: number,
+    timeout: number
+  ): Promise<ErrorEvent[]> {
     const timeLimit = Date.now() + timeout;
     let groupId;
     // wait for a group
@@ -102,9 +106,10 @@ export class ErrorsApiTransport extends common.Service {
         const groups = await this.getAllGroups();
         if (!groups.length) continue;
         // find an error group that matches the service
-        groups.forEach((group) => {
+        groups.forEach(group => {
           const match = group.affectedServices.find(
-              context => context.service === service);
+            context => context.service === service
+          );
           if (match) {
             groupId = group.group.groupId;
           }
@@ -116,8 +121,10 @@ export class ErrorsApiTransport extends common.Service {
 
       const events = await this.getGroupEvents(groupId);
       const filteredEvents = events.filter(
-          event => event.serviceContext.service === service &&
-              (new Date(event.eventTime).getTime() >= time));
+        event =>
+          event.serviceContext.service === service &&
+          new Date(event.eventTime).getTime() >= time
+      );
       if (filteredEvents.length) {
         return filteredEvents;
       }