fix: accept uniqueWriterIdentity in setMetadata (#1034)

freelerobot · web-flow · commit 02e8bb4b5983 · 2021-04-14T17:51:04.000-07:00
* fix: accept uniqueWriterIdentity in setMetadata

* docs: explain unique writer id flag better

* chore: explain uniqueWriterIdentity field

* fix: prevent topic_permission_denied errors in tests
diff --git a/src/index.ts b/src/index.ts
@@ -83,7 +83,7 @@ export interface CreateSinkRequest {
   includeChildren?: boolean;
   name?: string;
   outputVersionFormat?: google.logging.v2.LogSink.VersionFormat;
-  uniqueWriterIdentity?: string;
+  uniqueWriterIdentity?: string | boolean;
   gaxOptions?: gax.CallOptions;
 }
 
@@ -315,7 +315,7 @@ class Logging {
    * https://cloud.google.com/nodejs/docs/reference/pubsub/latest/Topic Topic}
    * @property {string} [filter] An advanced logs filter. Only log entries
    *     matching the filter are written.
-   * @property {string} [uniqueWriterIdentity] Determines the kind of IAM
+   * @property {string|boolean} [uniqueWriterIdentity] Determines the kind of IAM
    *     identity returned as `writerIdentity` in the new sink. See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create#query-parameters}.
    */
   /**
diff --git a/src/sink.ts b/src/sink.ts
@@ -34,6 +34,9 @@ export type SinkMetadataResponse = [LogSink];
 
 export interface SetSinkMetadata extends LogSink {
   gaxOptions?: CallOptions;
+  // A unique service account just for the sink
+  // https://cloud.google.com/logging/docs/api/tasks/exporting-logs#using_a_unique_writer_identity
+  uniqueWriterIdentity?: boolean | string;
 }
 
 /**
@@ -289,6 +292,11 @@ class Sink {
   /**
    * Set the sink's metadata.
    *
+   * Note: If the sink was previously created or updated with
+   * uniqueWriterIdentity = true, then you must update the sink by setting
+   * uniqueWriterIdentity = true. Read more about using a unique writer identity
+   * here: https://cloud.google.com/logging/docs/api/tasks/exporting-logs#using_a_unique_writer_identity
+   *
    * @see [Sink Resource]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink}
    * @see [projects.sink.update API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/update}
    *
@@ -325,11 +333,18 @@ class Sink {
    */
   async setMetadata(metadata: SetSinkMetadata): Promise<SinkMetadataResponse> {
     const [currentMetadata] = await this.getMetadata();
-    const reqOpts = {
+    const uniqueWriterIdentity = metadata.uniqueWriterIdentity;
+    delete metadata.uniqueWriterIdentity;
+    let reqOpts = {
       sinkName: this.formattedName_,
       sink: extend({}, currentMetadata, metadata),
     };
     delete reqOpts.sink.gaxOptions;
+    // Add user specified uniqueWriterIdentity boolean, if any.
+    reqOpts = {
+      ...reqOpts,
+      ...(uniqueWriterIdentity && {uniqueWriterIdentity}),
+    };
     [this.metadata] = await this.logging.configService.updateSink(
       reqOpts,
       metadata.gaxOptions
diff --git a/system-test/logging.ts b/system-test/logging.ts
@@ -182,6 +182,43 @@ describe('Logging', () => {
       });
     });
 
+    describe('metadata with uniqueWriterIdentity', () => {
+      it('should set metadata if uniqueWriterIdentity was true', async () => {
+        const sink = logging.sink(generateName());
+        const FILTER = 'severity = ALERT';
+        await sink.create({
+          destination: topic,
+          uniqueWriterIdentity: true,
+        });
+        const metadata = {
+          filter: FILTER,
+          uniqueWriterIdentity: true,
+        };
+        const [apiResponse] = await sink.setMetadata(metadata);
+        assert.strictEqual(apiResponse.filter, FILTER);
+        // Sink must be deleted within this test before any logs are generated
+        // to avoid topic_permission_denied emails.
+        await sink.delete();
+      });
+
+      it('should set uniqueWriterIdentity from false to true', async () => {
+        const sink = logging.sink(generateName());
+        const FILTER = 'severity = ALERT';
+        await sink.create({
+          destination: topic,
+        });
+        const metadata = {
+          filter: FILTER,
+          uniqueWriterIdentity: true,
+        };
+        const [apiResponse] = await sink.setMetadata(metadata);
+        assert.strictEqual(apiResponse.filter, FILTER);
+        // Sink must be deleted within this test before any logs are generated
+        // to avoid topic_permission_denied emails.
+        await sink.delete();
+      });
+    });
+
     describe('listing sinks', () => {
       const sink = logging.sink(generateName());
 
