chore: migrate to owl bot (#1348)

SurferJeffAtGoogle · web-flow · commit ba6449952585 · 2021-05-20T21:43:52.000-07:00
* chore: migrate to owl bot

* chore: copy files from googleapis-gen 397c0bfd367a2427104f988d5329bc117caafd95

* chore: run the post processor

* fix: lint
diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml
@@ -0,0 +1,4 @@
+docker:
+  digest: sha256:f556e6e7be625deb1b2429fe608df27be57185c3e6b7d39ee0059f1609f17530
+  image: gcr.io/repo-automation-bots/owlbot-nodejs:latest  
+
diff --git a/.github/.OwlBot.yaml b/.github/.OwlBot.yaml
@@ -0,0 +1,19 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+docker:
+  image: gcr.io/repo-automation-bots/owlbot-nodejs:latest
+
+
+begin-after-commit-hash: 397c0bfd367a2427104f988d5329bc117caafd95
+
diff --git a/.github/generated-files-bot.yml b/.github/generated-files-bot.yml
@@ -0,0 +1,16 @@
+generatedFiles:
+- path: '.kokoro/**'
+  message: '`.kokoro` files are templated and should be updated in [`synthtool`](https://github.com/googleapis/synthtool)'
+- path: '.github/CODEOWNERS'
+  message: 'CODEOWNERS should instead be modified via the `codeowner_team` property in .repo-metadata.json'
+- path: '.github/workflows/**'
+  message: '`.github/workflows` (GitHub Actions) should be updated in [`synthtool`](https://github.com/googleapis/synthtool)'
+- path: '.github/generated-files-bot.+(yml|yaml)'
+  message: '`.github/generated-files-bot.(yml|yaml)` should be updated in [`synthtool`](https://github.com/googleapis/synthtool)'
+- path: 'README.md'
+  message: '`README.md` is managed by [`synthtool`](https://github.com/googleapis/synthtool). However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/master/.readme-partials.yaml'
+- path: 'samples/README.md'
+  message: '`samples/README.md` is managed by [`synthtool`](https://github.com/googleapis/synthtool). However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/master/.readme-partials.yaml'
+ignoreAuthors:
+- 'gcf-owl-bot[bot]'
+- 'yoshi-automation'
diff --git a/owlbot.py b/owlbot.py
@@ -13,18 +13,9 @@
 # limitations under the License.
 
 import synthtool as s
-import synthtool.gcp as gcp
-import logging
-import subprocess
+import synthtool.languages.node as node
 
-logging.basicConfig(level=logging.DEBUG)
-
-AUTOSYNTH_MULTIPLE_COMMITS = True
-
-common_templates = gcp.CommonTemplates()
-templates = common_templates.node_library()
-# Don't use .nycrc for code coverage (see "Fix Code Coverage")
-s.copy(templates, excludes=[
+node.owlbot_main(templates_excludes=[
   '.eslintignore',
   '.github/workflows/ci.yaml',
   '.nycrc',
diff --git a/scripts/get-plugin-types.ts b/scripts/get-plugin-types.ts
@@ -31,10 +31,9 @@ async function mkdirSafeP(dir: string) {
 export async function getPluginTypes() {
   await mkdirSafeP(TYPES_DIRECTORY);
 
-  const indexTs = ((await readFileP(
-    `${TYPES_DIRECTORY}/index.d.ts`,
-    'utf8'
-  )) as string).split('\n');
+  const indexTs = (
+    (await readFileP(`${TYPES_DIRECTORY}/index.d.ts`, 'utf8')) as string
+  ).split('\n');
   for (const line of indexTs) {
     const matches = line.match(
       /^import \* as .* from '\.\/(.+)';\s*\/\/\s*(.+)@(.+)/
diff --git a/src/config.ts b/src/config.ts
@@ -64,9 +64,7 @@ export interface SetHeaderFunction {
   setHeader: (key: string, value: string) => void;
 }
 export interface OpenCensusPropagation {
-  extract: (
-    getHeader: GetHeaderFunction
-  ) => {
+  extract: (getHeader: GetHeaderFunction) => {
     traceId: string;
     spanId: string;
     options?: number;
diff --git a/src/index.ts b/src/index.ts
@@ -183,7 +183,8 @@ function initConfig(userConfig: Forceable<Config>): TopLevelConfig {
       samplingRate: mergedConfig.samplingRate,
       ignoreMethods: mergedConfig.ignoreMethods,
       ignoreUrls: mergedConfig.ignoreUrls,
-      contextHeaderBehavior: mergedConfig.contextHeaderBehavior as TraceContextHeaderBehavior,
+      contextHeaderBehavior:
+        mergedConfig.contextHeaderBehavior as TraceContextHeaderBehavior,
     },
     overrides: {
       tracePolicy: mergedConfig.tracePolicy,
diff --git a/src/plugins/plugin-express.ts b/src/plugins/plugin-express.ts
@@ -21,9 +21,9 @@ import {express_4} from './types';
 // application is an undocumented member of the express object.
 type Express4Module = typeof express_4 & {application: express_4.Application};
 
-const methods: Array<keyof express_4.Application> = (httpMethods as Array<
-  keyof express_4.Application
->).concat('use', 'route', 'param', 'all');
+const methods: Array<keyof express_4.Application> = (
+  httpMethods as Array<keyof express_4.Application>
+).concat('use', 'route', 'param', 'all');
 
 const SUPPORTED_VERSIONS = '4.x';
 
diff --git a/src/plugins/plugin-grpc.ts b/src/plugins/plugin-grpc.ts
@@ -151,9 +151,8 @@ function patchClient(client: ClientModule, api: Tracer) {
     traceContext: TraceContext | null
   ): void {
     if (traceContext) {
-      const metadataValue = api.traceContextUtils.encodeAsByteArray(
-        traceContext
-      );
+      const metadataValue =
+        api.traceContextUtils.encodeAsByteArray(traceContext);
       metadata.set(
         api.constants.TRACE_CONTEXT_GRPC_METADATA_NAME,
         metadataValue
@@ -293,7 +292,7 @@ function patchClient(client: ClientModule, api: Tracer) {
     // TODO(kjin): Investigate whether we need to copy properties of
     // method onto clientMethodTrace.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return (clientMethodTrace as any) as ClientMethod<S, T>;
+    return clientMethodTrace as any as ClientMethod<S, T>;
   }
 
   /**
diff --git a/src/plugins/plugin-pg.ts b/src/plugins/plugin-pg.ts
@@ -87,12 +87,14 @@ class PostgresPatchUtility {
   readonly maybePopulateLabelsFromOutputs: typeof populateLabelsFromOutputs;
 
   constructor(private readonly tracer: Tracer) {
-    this.maybePopulateLabelsFromInputs = tracer.enhancedDatabaseReportingEnabled()
-      ? populateLabelsFromInputs
-      : noOp;
-    this.maybePopulateLabelsFromOutputs = tracer.enhancedDatabaseReportingEnabled()
-      ? populateLabelsFromOutputs
-      : noOp;
+    this.maybePopulateLabelsFromInputs =
+      tracer.enhancedDatabaseReportingEnabled()
+        ? populateLabelsFromInputs
+        : noOp;
+    this.maybePopulateLabelsFromOutputs =
+      tracer.enhancedDatabaseReportingEnabled()
+        ? populateLabelsFromOutputs
+        : noOp;
   }
 
   patchSubmittable(pgQuery: Submittable, span: Span): Submittable {
diff --git a/src/span-data.ts b/src/span-data.ts
@@ -83,12 +83,11 @@ export abstract class BaseSpanData implements Span {
     if (stackFrames.length > 0) {
       // Developer note: This is not equivalent to using addLabel, because the
       // stack trace label has its own size constraints.
-      this.span.labels[
-        TraceLabels.STACK_TRACE_DETAILS_KEY
-      ] = traceUtil.truncate(
-        JSON.stringify({stack_frame: stackFrames}),
-        Constants.TRACE_SERVICE_LABEL_VALUE_LIMIT
-      );
+      this.span.labels[TraceLabels.STACK_TRACE_DETAILS_KEY] =
+        traceUtil.truncate(
+          JSON.stringify({stack_frame: stackFrames}),
+          Constants.TRACE_SERVICE_LABEL_VALUE_LIMIT
+        );
     }
   }
 
diff --git a/src/trace-plugin-loader.ts b/src/trace-plugin-loader.ts
@@ -154,13 +154,12 @@ export class ModulePluginWrapper implements PluginWrapper {
     const plugin = this.getPluginExportedValue();
     // Get a list of supported patches. This is the subset of objects in the
     // plugin exported value with matching file/version fields.
-    const supportedPatches: Array<
-      Partial<Monkeypatch<T> & Intercept<T>>
-    > = plugin.filter(
-      patch =>
-        semver.satisfies(version, patch.versions || '*') &&
-        (file === patch.file || (!file && !patch.file))
-    );
+    const supportedPatches: Array<Partial<Monkeypatch<T> & Intercept<T>>> =
+      plugin.filter(
+        patch =>
+          semver.satisfies(version, patch.versions || '*') &&
+          (file === patch.file || (!file && !patch.file))
+      );
     if (supportedPatches.length > 1) {
       this.logger.warn(
         `PluginWrapper#applyPlugin: [${logString}] Plugin has more than one patch/intercept object for this file. Applying all.`
diff --git a/src/tracing-policy.ts b/src/tracing-policy.ts
@@ -86,7 +86,8 @@ class MethodsFilter implements TracePolicyPredicate<string> {
 }
 
 class ContextHeaderFilter
-  implements TracePolicyPredicate<Required<TraceContext> | null> {
+  implements TracePolicyPredicate<Required<TraceContext> | null>
+{
   constructor(
     private readonly contextHeaderBehavior: TraceContextHeaderBehavior
   ) {}
diff --git a/synth.metadata b/synth.metadata
diff --git a/test/plugins/test-trace-grpc.ts b/test/plugins/test-trace-grpc.ts
@@ -54,9 +54,8 @@ const COMMON_TRACE_ID = 'ffeeddccbbaa99887766554433221100';
 
 function checkServerMetadata(metadata) {
   if (checkMetadata) {
-    const traceContext = metadata.getMap()[
-      Constants.TRACE_CONTEXT_GRPC_METADATA_NAME
-    ];
+    const traceContext =
+      metadata.getMap()[Constants.TRACE_CONTEXT_GRPC_METADATA_NAME];
     const parsedContext = util.deserializeTraceContext(traceContext);
     assert.ok(parsedContext);
     const root = asRootSpanData(cls.get().getContext() as Span);
diff --git a/test/plugins/test-trace-http.ts b/test/plugins/test-trace-http.ts
@@ -527,10 +527,10 @@ for (const nodule of Object.keys(servers) as Array<keyof typeof servers>) {
     });
 
     describe('trace spans', () => {
-      const ERROR_DETAILS_NAME = testTraceModule.get().labels
-        .ERROR_DETAILS_NAME;
-      const ERROR_DETAILS_MESSAGE = testTraceModule.get().labels
-        .ERROR_DETAILS_MESSAGE;
+      const ERROR_DETAILS_NAME =
+        testTraceModule.get().labels.ERROR_DETAILS_NAME;
+      const ERROR_DETAILS_MESSAGE =
+        testTraceModule.get().labels.ERROR_DETAILS_MESSAGE;
       let port: number;
       let successSpan: TraceSpan;
       let errorSpan: TraceSpan;
diff --git a/test/plugins/test-trace-http2.ts b/test/plugins/test-trace-http2.ts
@@ -407,9 +407,8 @@ maybeSkipHttp2('Trace Agent integration with http2', () => {
         key: SERVER_KEY,
         cert: SERVER_CERT,
       };
-      const secureServer: http2Types.Http2SecureServer = http2.createSecureServer(
-        options
-      );
+      const secureServer: http2Types.Http2SecureServer =
+        http2.createSecureServer(options);
       secureServer.on('stream', s => {
         setTimeout(() => {
           s.respond({':status': 200});
diff --git a/test/test-index.ts b/test/test-index.ts
@@ -20,7 +20,7 @@ import * as assert from 'assert';
 import * as trace from '../src';
 import {describe, it, before} from 'mocha';
 
-const disabledAgent = (trace.get() as {}) as StackdriverTracer;
+const disabledAgent = trace.get() as {} as StackdriverTracer;
 
 describe('index.js', () => {
   it('should get a disabled agent with `Trace.get`', async () => {
diff --git a/test/test-modules-loaded-before-agent.ts b/test/test-modules-loaded-before-agent.ts
@@ -21,7 +21,8 @@ import * as log from '../src/logger';
 import {TestLogger} from './logger';
 import * as testTraceModule from './trace';
 
-const UNTRACED_LOGS_WARNING = /StackdriverTracer#start.*modules.*loaded.*before.*trace agent.*: \[.*shimmer.*\]/;
+const UNTRACED_LOGS_WARNING =
+  /StackdriverTracer#start.*modules.*loaded.*before.*trace agent.*: \[.*shimmer.*\]/;
 
 describe('modules loaded before agent', () => {
   let logger: CaptureTestLogger | null = null;
diff --git a/test/test-span-data.ts b/test/test-span-data.ts
@@ -151,10 +151,8 @@ describe('SpanData', () => {
       spanData.addLabel(longKey, 'val');
       delete spanData.span.labels[TraceLabels.STACK_TRACE_DETAILS_KEY];
       assert.deepStrictEqual(spanData.span.labels, {
-        [`${longKey.slice(
-          0,
-          Constants.TRACE_SERVICE_LABEL_KEY_LIMIT - 3
-        )}...`]: 'val',
+        [`${longKey.slice(0, Constants.TRACE_SERVICE_LABEL_KEY_LIMIT - 3)}...`]:
+          'val',
       });
     });
 
@@ -218,11 +216,10 @@ describe('SpanData', () => {
 
       for (const sourceMapType of sourceMapTypes) {
         it(`uses source maps when available in stack traces: ${sourceMapType}`, () => {
-          const {
-            applyGeneric,
-          } = require(`./fixtures/source-maps-test/${sourceMapType}`) as {
-            applyGeneric: <T>(fn: () => T) => T;
-          };
+          const {applyGeneric} =
+            require(`./fixtures/source-maps-test/${sourceMapType}`) as {
+              applyGeneric: <T>(fn: () => T) => T;
+            };
           const spanData = applyGeneric(
             () => new CommonSpanData(trace, 'name', '0', 0)
           );
@@ -235,11 +232,10 @@ describe('SpanData', () => {
       }
 
       it("doesn't break when there are no source maps", () => {
-        const {
-          applyGeneric,
-        } = require('./fixtures/source-maps-test/no-source-map') as {
-          applyGeneric: <T>(fn: () => T) => T;
-        };
+        const {applyGeneric} =
+          require('./fixtures/source-maps-test/no-source-map') as {
+            applyGeneric: <T>(fn: () => T) => T;
+          };
         const spanData = applyGeneric(
           () => new CommonSpanData(trace, 'name', '0', 0)
         );
diff --git a/test/test-trace-uncaught-exception.ts b/test/test-trace-uncaught-exception.ts
@@ -79,7 +79,8 @@ describe('Trace Writer', () => {
   });
 
   it("should publish on unhandled exception for 'flush' config option", done => {
-    const restoreOriginalUncaughtExceptionListeners = removeAllUncaughtExceptionListeners();
+    const restoreOriginalUncaughtExceptionListeners =
+      removeAllUncaughtExceptionListeners();
     trace.start({onUncaughtException: 'flush', projectId: '0'});
     setImmediate(() => {
       setImmediate(() => {
@@ -96,7 +97,8 @@ describe('Trace Writer', () => {
   });
 
   it("should not assign an oUE listener for 'ignore' config option", () => {
-    const restoreOriginalUncaughtExceptionListeners = removeAllUncaughtExceptionListeners();
+    const restoreOriginalUncaughtExceptionListeners =
+      removeAllUncaughtExceptionListeners();
     trace.start({onUncaughtException: 'ignore'});
     assert.strictEqual(process.listenerCount('onHandledException'), 0);
     restoreOriginalUncaughtExceptionListeners();
diff --git a/test/test-trace-web-frameworks.ts b/test/test-trace-web-frameworks.ts
@@ -389,8 +389,9 @@ describe('Web framework tracing', () => {
       });
 
       it('uses the span name override option', async () => {
-        const oldSpanNameOverride = testTraceModule.get().getConfig()
-          .rootSpanNameOverride;
+        const oldSpanNameOverride = testTraceModule
+          .get()
+          .getConfig().rootSpanNameOverride;
         testTraceModule.get().getConfig().rootSpanNameOverride = (
           path: string
         ) => `${path}-goodbye`;
@@ -406,9 +407,8 @@ describe('Web framework tracing', () => {
           const serverSpan = testTraceModule.getOneSpan(isServerSpan);
           assert.strictEqual(serverSpan.name, '/hello-goodbye');
         } finally {
-          testTraceModule
-            .get()
-            .getConfig().rootSpanNameOverride = oldSpanNameOverride;
+          testTraceModule.get().getConfig().rootSpanNameOverride =
+            oldSpanNameOverride;
         }
       });
     });
diff --git a/test/utils.ts b/test/utils.ts
@@ -191,8 +191,9 @@ function getFixturesForModule<T>(moduleName: string): Array<FixtureHelper<T>> {
       return moduleNameMatches && versionCompatible;
     })
     .map(key => {
-      const version = require(`./plugins/fixtures/${key}/node_modules/${moduleName}/package.json`)
-        .version as string;
+      const version =
+        require(`./plugins/fixtures/${key}/node_modules/${moduleName}/package.json`)
+          .version as string;
       const parsedVersion = semver.parse(version)!;
       const getModule: () => T = () => require(`./plugins/fixtures/${key}`);
       // Convenience function -- returns if.skip if the selected module's
diff --git a/test/web-frameworks/express-secure.ts b/test/web-frameworks/express-secure.ts
@@ -40,10 +40,10 @@ export class Express4Secure extends Express4 {
   listen(port: number): number {
     // The types of (http|https).Server are not compatible, but we don't
     // access any properties that aren't present on both in the test.
-    this.server = (this.https.createServer(
+    this.server = this.https.createServer(
       {key: Express4Secure.key, cert: Express4Secure.cert},
       this.app
-    ) as {}) as httpModule.Server;
+    ) as {} as httpModule.Server;
     this.server.listen(port);
     return (this.server.address() as AddressInfo).port;
   }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +docker:
 +  digest: sha256:f556e6e7be625deb1b2429fe608df27be57185c3e6b7d39ee0059f1609f17530
 +  image: gcr.io/repo-automation-bots/owlbot-nodejs:latest
++