refactor: clean up types and imports (#409)

Author: JustinBeckwith

handwritten/logging/.gitignore

@@ -9,3 +9,5 @@ system-test/*key.json
 *.lock
 .DS_Store
 package-lock.json
+__pycache__
+.vscode

handwritten/logging/package.json

@@ -88,6 +88,7 @@
     "@types/pify": "^3.0.2",
     "@types/proxyquire": "^1.3.28",
     "@types/pumpify": "^1.4.1",
+    "@types/sinon": "^7.0.8",
     "@types/through2": "^2.0.34",
     "@types/uuid": "^3.4.4",
     "assert-rejects": "^1.0.0",
@@ -99,17 +100,18 @@
     "eslint-plugin-prettier": "^3.0.0",
     "google-proto-files": "^0.18.0",
     "gts": "^0.9.0",
-    "jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.5.5",
+    "jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
+    "linkinator": "^1.1.2",
     "mocha": "^6.0.0",
     "nock": "^10.0.1",
     "nyc": "^13.0.1",
     "power-assert": "^1.6.0",
     "prettier": "^1.15.1",
     "proxyquire": "^2.1.0",
+    "sinon": "^7.2.5",
     "typescript": "~3.3.0",
-    "uuid": "^3.3.2",
-    "linkinator": "^1.1.2"
+    "uuid": "^3.3.2"
   }
 }

handwritten/logging/src/entry.ts

@@ -25,6 +25,8 @@ const eventId = new EventId();
 
 export type LogEntry = google.logging.v2.ILogEntry;
 export type Timestamp = google.protobuf.IDuration;
+// tslint:disable-next-line no-any
+export type Data = any;
 
 export interface EntryJson {
   timestamp: Timestamp|Date;
@@ -97,10 +99,8 @@ export interface ToJsonOptions {
  */
 class Entry {
   metadata: LogEntry;
-  // tslint:disable-next-line no-any
-  data: any;
-  // tslint:disable-next-line no-any
-  constructor(metadata?: LogEntry, data?: any) {
+  data: Data;
+  constructor(metadata?: LogEntry, data?: Data) {
     /**
      * @name Entry#metadata
      * @type {object}
@@ -136,8 +136,7 @@ class Entry {
    * @param {boolean} [options.removeCircular] Replace circular references in an
    *     object with a string value, `[Circular]`.
    */
-  toJSON(options: ToJsonOptions) {
-    options = options || {};
+  toJSON(options: ToJsonOptions = {}) {
     const entry = extend(true, {}, this.metadata) as {} as EntryJson;
     if (is.object(this.data)) {
       // tslint:disable-next-line no-any
@@ -178,8 +177,7 @@ class Entry {
     if (serializedEntry.metadata.timestamp) {
       let ms = Number(serializedEntry.metadata.timestamp.seconds) * 1000;
       ms += Number(serializedEntry.metadata.timestamp.nanos) / 1e6;
-      // tslint:disable-next-line no-any
-      (serializedEntry as any).metadata.timestamp = new Date(ms);
+      serializedEntry.metadata.timestamp = new Date(ms) as Timestamp;
     }
     return serializedEntry;
   }

handwritten/logging/src/index.ts

@@ -587,9 +587,7 @@ class Logging {
    *     this.end();
    *   });
    */
-  getEntriesStream(options: GetEntriesRequest) {
-    const self = this;
-    options = options || {};
+  getEntriesStream(options: GetEntriesRequest = {}) {
     let requestStream: Duplex;
     const userStream = streamEvents<Duplex>(pumpify.obj());
     (userStream as AbortableDuplex).abort = () => {
@@ -607,15 +605,15 @@ class Logging {
           },
           options);
       reqOpts.resourceNames = arrify(reqOpts.resourceNames);
-      reqOpts.resourceNames.push('projects/' + self.projectId);
+      reqOpts.resourceNames.push(`projects/${this.projectId}`);
       delete reqOpts.autoPaginate;
       delete reqOpts.gaxOptions;
       const gaxOptions = extend(
           {
             autoPaginate: options.autoPaginate,
           },
           options.gaxOptions);
-      requestStream = self.request({
+      requestStream = this.request({
         client: 'LoggingServiceV2Client',
         method: 'listLogEntriesStream',
         reqOpts,
@@ -921,7 +919,6 @@ class Logging {
    */
   setAclForBucket_(
       name: string, config: CreateSinkRequest, callback: CreateSinkCallback) {
-    const self = this;
     const bucket = config.destination as Bucket;
     // tslint:disable-next-line no-any
     (bucket.acl.owners as any)
@@ -933,7 +930,7 @@ class Logging {
                 return;
               }
               config.destination = 'storage.googleapis.com/' + bucket.name;
-              self.createSink(name, config, callback);
+              this.createSink(name, config, callback);
             });
   }
 

handwritten/logging/src/log.ts

@@ -18,7 +18,7 @@ import {DeleteCallback} from '@google-cloud/common';
 import {promisifyAll} from '@google-cloud/promisify';
 import * as arrify from 'arrify';
 import * as extend from 'extend';
-import {CallOptions} from 'google-gax/build/src/gax';
+import {CallOptions} from 'google-gax';
 import * as is from 'is';
 import {Response} from 'request';
 
@@ -531,8 +531,9 @@ class Log implements LogSeverityFunctions {
   }
 
   /**
-   * This method is a wrapper around {module:logging#getEntriesStream}, but with a
-   * filter specified to only return {module:logging/entry} objects from this log.
+   * This method is a wrapper around {module:logging#getEntriesStream}, but with
+   * a filter specified to only return {module:logging/entry} objects from this
+   * log.
    *
    * @method Log#getEntriesStream
    * @param {GetEntriesRequest} [query] Query object for listing entries.
@@ -601,9 +602,14 @@ class Log implements LogSeverityFunctions {
    * });
    */
   info(entry: Entry|Entry[], options?: WriteOptions): Promise<ApiResponse>;
-  info(entry: Entry|Entry[], options: WriteOptions, callback: ApiResponseCallback): void;
+  info(
+      entry: Entry|Entry[], options: WriteOptions,
+      callback: ApiResponseCallback): void;
   info(entry: Entry|Entry[], callback: ApiResponseCallback): void;
-  info(entry: Entry|Entry[], optionsOrCallback?: WriteOptions|ApiResponseCallback, cb?: ApiResponseCallback):void|Promise<ApiResponse> {
+  info(
+      entry: Entry|Entry[],
+      optionsOrCallback?: WriteOptions|ApiResponseCallback,
+      cb?: ApiResponseCallback): void|Promise<ApiResponse> {
       const options =
           typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
       const callback =
@@ -641,9 +647,14 @@ class Log implements LogSeverityFunctions {
    * });
    */
   notice(entry: Entry|Entry[], options?: WriteOptions): Promise<ApiResponse>;
-  notice(entry: Entry|Entry[], options: WriteOptions, callback: ApiResponseCallback): void;
+  notice(
+      entry: Entry|Entry[], options: WriteOptions,
+      callback: ApiResponseCallback): void;
   notice(entry: Entry|Entry[], callback: ApiResponseCallback): void;
-  notice(entry: Entry|Entry[], optionsOrCallback?: WriteOptions|ApiResponseCallback, cb?: ApiResponseCallback):void|Promise<ApiResponse> {
+  notice(
+      entry: Entry|Entry[],
+      optionsOrCallback?: WriteOptions|ApiResponseCallback,
+      cb?: ApiResponseCallback): void|Promise<ApiResponse> {
       const options =
           typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
       const callback =
@@ -681,9 +692,14 @@ class Log implements LogSeverityFunctions {
    * });
    */
   warning(entry: Entry|Entry[], options?: WriteOptions): Promise<ApiResponse>;
-  warning(entry: Entry|Entry[], options: WriteOptions, callback: ApiResponseCallback): void;
+  warning(
+      entry: Entry|Entry[], options: WriteOptions,
+      callback: ApiResponseCallback): void;
   warning(entry: Entry|Entry[], callback: ApiResponseCallback): void;
-  warning(entry: Entry|Entry[], optionsOrCallback?: WriteOptions|ApiResponseCallback, cb?: ApiResponseCallback):void|Promise<ApiResponse> {
+  warning(
+      entry: Entry|Entry[],
+      optionsOrCallback?: WriteOptions|ApiResponseCallback,
+      cb?: ApiResponseCallback): void|Promise<ApiResponse> {
       const options =
           typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
       const callback =
@@ -750,8 +766,8 @@ class Log implements LogSeverityFunctions {
    *
    * //-
    * // To save some steps, you can also pass in plain values as your entries.
-   * // Note, however, that you must provide a configuration object to specify the
-   * // resource.
+   * // Note, however, that you must provide a configuration object to specify
+   * // the resource.
    * //-
    * const entries = [
    *   {
@@ -784,9 +800,14 @@ class Log implements LogSeverityFunctions {
    * Another example:
    */
   write(entry: Entry|Entry[], options?: WriteOptions): Promise<ApiResponse>;
-  write(entry: Entry|Entry[], options: WriteOptions, callback: ApiResponseCallback): void;
+  write(
+      entry: Entry|Entry[], options: WriteOptions,
+      callback: ApiResponseCallback): void;
   write(entry: Entry|Entry[], callback: ApiResponseCallback): void;
-  write(entry: Entry|Entry[], optionsOrCallback?: WriteOptions|ApiResponseCallback, cb?: ApiResponseCallback): void|Promise<ApiResponse> {
+  write(
+      entry: Entry|Entry[],
+      optionsOrCallback?: WriteOptions|ApiResponseCallback,
+      cb?: ApiResponseCallback): void|Promise<ApiResponse> {
       const options =
           typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
       const callback =
@@ -866,7 +887,8 @@ class Log implements LogSeverityFunctions {
    * @param {object|object[]} entries - Log entries.
    * @param {string} severity - The desired severity level.
    */
-  static assignSeverityToEntries_(entries: Entry|Entry[], severity: string): Entry[] {
+  static assignSeverityToEntries_(entries: Entry|Entry[], severity: string):
+      Entry[] {
       return arrify(entries).map(entry => {
         const metadata = extend(true, {}, entry.metadata, {
           severity,

handwritten/logging/src/sink.ts

@@ -17,9 +17,7 @@
 import * as common from '@google-cloud/common-grpc';
 import {promisifyAll} from '@google-cloud/promisify';
 import * as extend from 'extend';
-import {CallOptions} from 'google-gax/build/src/gax';
-import * as is from 'is';
-
+import {CallOptions} from 'google-gax';
 import {CreateSinkCallback, CreateSinkRequest, DeleteCallback, DeleteResponse, Logging, LogSink} from '.';
 
 export interface SinkMetadataCallback {