fix: Add LogSyncOptions parameter to Logging.logSync() API (#1307)

losalex · web-flow · commit 89408b0c18a6 · 2022-07-14T14:43:50.000-07:00
diff --git a/src/index.ts b/src/index.ts
@@ -49,7 +49,7 @@ import {
   assignSeverityToEntries,
 } from './utils/log-common';
 import {Log, GetEntriesRequest, TailEntriesRequest, LogOptions} from './log';
-import {LogSync} from './log-sync';
+import {LogSync, LogSyncOptions} from './log-sync';
 import {Sink} from './sink';
 import {Duplex, PassThrough, Transform, Writable} from 'stream';
 import {google} from '../protos/protos';
@@ -1251,6 +1251,7 @@ class Logging {
    *
    * @param {string} name Name of the existing log.
    * @param {object} transport An optional write stream.
+   * @param {LogSyncOptions} options An optional configuration object.
    * @returns {LogSync}
    *
    * @example
@@ -1266,8 +1267,8 @@ class Logging {
    * const log = logging.logSync('my-log');
    * ```
    */
-  logSync(name: string, transport?: Writable) {
-    return new LogSync(this, name, transport);
+  logSync(name: string, transport?: Writable, options?: LogSyncOptions) {
+    return new LogSync(this, name, transport, options);
   }
 
   /**
diff --git a/test/index.ts b/test/index.ts
@@ -1234,6 +1234,18 @@ describe('Logging', () => {
       assert.strictEqual(log.calledWith_[0], logging);
       assert.strictEqual(log.calledWith_[1], NAME);
     });
+
+    it('should pass useMessageField properly', () => {
+      const log = logging.logSync(NAME, undefined, {
+        useMessageField: false,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      }) as any;
+      assert(log instanceof FakeLog);
+      assert.strictEqual(log.calledWith_[0], logging);
+      assert.strictEqual(log.calledWith_[1], NAME);
+      assert.strictEqual(log.calledWith_[2], undefined);
+      assert.strictEqual(log.calledWith_[3].useMessageField, false);
+    });
   });
 
   describe('request', () => {
