feat!: add log writer options to LogManager and use settings objects instead of parameters

This is a breaking change which I believe would be useful for the future to create better consistency between LogManager and LogWriter and scale better as we add more parameters to log writer settings.

Author: gagik

packages/mongodb-log-writer/src/mongo-log-manager.spec.ts

@@ -213,4 +213,17 @@ describe('MongoLogManager', function () {
     writer.end();
     await once(writer, 'finish');
   });
+
+  it('can create a disabled writer', async function () {
+    const manager = new MongoLogManager({
+      directory,
+      retentionDays,
+      onwarn,
+      onerror,
+      gzip: true,
+    });
+    const logWriter = await manager.createLogWriter({ isDisabled: true });
+
+    expect(logWriter.isDisabled).is.true;
+  });
 });

packages/mongodb-log-writer/src/mongo-log-manager.ts

@@ -4,11 +4,12 @@ import { once } from 'events';
 import { createWriteStream, promises as fs } from 'fs';
 import { createGzip, constants as zlibConstants } from 'zlib';
 import { Heap } from 'heap-js';
+import type { MongoLogWriterOptions } from './mongo-log-writer';
 import { MongoLogWriter } from './mongo-log-writer';
 import { Writable } from 'stream';
 
 /** Options used by MongoLogManager instances. */
-interface MongoLogOptions {
+export interface MongoLogManagerOptions {
   /** A base directory in which log files are stored. */
   directory: string;
   /** Whether to write files as .gz files or not. */
@@ -29,9 +30,9 @@ interface MongoLogOptions {
  * naming convention `${logId}_log`.
  */
 export class MongoLogManager {
-  _options: MongoLogOptions;
+  _options: MongoLogManagerOptions;
 
-  constructor(options: MongoLogOptions) {
+  constructor(options: MongoLogManagerOptions) {
     this._options = options;
   }
 
@@ -97,7 +98,9 @@ export class MongoLogManager {
   }
 
   /** Create a MongoLogWriter stream for a new log file. */
-  async createLogWriter(): Promise<MongoLogWriter> {
+  async createLogWriter(
+    writerOptions: Pick<MongoLogWriterOptions, 'isDisabled'> = {}
+  ): Promise<MongoLogWriter> {
     const logId = new ObjectId().toString();
     const doGzip = !!this._options.gzip;
     const logFilePath = path.join(
@@ -132,10 +135,15 @@ export class MongoLogManager {
         },
       });
       originalTarget = stream;
-      logWriter = new MongoLogWriter(logId, null, stream);
+      logWriter = new MongoLogWriter({
+        ...writerOptions,
+        logId,
+        logFilePath: null,
+        target: stream,
+      });
     }
     if (!logWriter) {
-      logWriter = new MongoLogWriter(logId, logFilePath, stream);
+      logWriter = new MongoLogWriter({ logId, logFilePath, target: stream });
     }
 
     // We use 'log-finish' to give consumers an event that they can

packages/mongodb-log-writer/src/mongo-log-writer.spec.ts

@@ -28,7 +28,12 @@ describe('MongoLogWriter', function () {
 
     beforeEach(function () {
       target = new stream.PassThrough().setEncoding('utf8');
-      writer = new MongoLogWriter('logid', null, target, () => now);
+      writer = new MongoLogWriter({
+        logId: 'logid',
+        logFilePath: null,
+        target,
+        now: () => now,
+      });
       writeSpy = sinon.spy(writer, 'write');
     });
 
@@ -48,15 +53,12 @@ describe('MongoLogWriter', function () {
     });
 
     it('can be disabled on initialization', async function () {
-      const disabledWriter = new MongoLogWriter(
-        'logid',
-        null,
+      const disabledWriter = new MongoLogWriter({
+        logId: 'logid',
+        logFilePath: null,
         target,
-        () => now,
-        {
-          isDisabled: true,
-        }
-      );
+        now: () => now,
+      });
 
       expect(disabledWriter.isDisabled).to.equal(true);
       logAllSeverities(disabledWriter);
@@ -107,7 +109,12 @@ describe('MongoLogWriter', function () {
 
   it('allows writing log messages to a stream', async function () {
     const target = new stream.PassThrough().setEncoding('utf8');
-    const writer = new MongoLogWriter('logid', null, target, () => now);
+    const writer = new MongoLogWriter({
+      logId: 'logid',
+      logFilePath: null,
+      target,
+      now: () => now,
+    });
     const logEvents: MongoLogEntry[] = [];
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     writer.on('log', (entry) => logEvents.push(entry));
@@ -207,7 +214,12 @@ describe('MongoLogWriter', function () {
   it('can log error object as data as-is', async function () {
     const now = new Date(1628591965386);
     const target = new stream.PassThrough().setEncoding('utf8');
-    const writer = new MongoLogWriter('logid', null, target, () => now);
+    const writer = new MongoLogWriter({
+      logId: 'logid',
+      logFilePath: null,
+      target,
+      now: () => now,
+    });
     writer.error(
       'component',
       mongoLogId(12345),
@@ -233,7 +245,12 @@ describe('MongoLogWriter', function () {
   it('can log non-trivial data', async function () {
     const now = new Date(1628591965386);
     const target = new stream.PassThrough().setEncoding('utf8');
-    const writer = new MongoLogWriter('logid', null, target, () => now);
+    const writer = new MongoLogWriter({
+      logId: 'logid',
+      logFilePath: null,
+      target,
+      now: () => now,
+    });
 
     const cyclic: any = {};
     cyclic.cyclic = cyclic;
@@ -256,7 +273,11 @@ describe('MongoLogWriter', function () {
     const errors: Error[] = [];
     function tryWrite(input: any) {
       const target = new stream.PassThrough().setEncoding('utf8');
-      const writer = new MongoLogWriter('logid', null, target);
+      const writer = new MongoLogWriter({
+        logId: 'logid',
+        logFilePath: null,
+        target,
+      });
       writer.on('error', (err) => errors.push(err));
       writer.write(input);
     }

packages/mongodb-log-writer/src/mongo-log-writer.ts

@@ -65,6 +65,10 @@ function validateLogEntry(info: MongoLogEntry): Error | null {
 
 export type MongoLogWriterOptions = {
   isDisabled?: boolean;
+  logId: string;
+  logFilePath: string | null;
+  target: PlainWritable;
+  now?: () => Date;
 };
 
 /**
@@ -88,13 +92,13 @@ export class MongoLogWriter extends Writable {
    * @param target The Writable stream to write data to.
    * @param now An optional function that overrides computation of the current time. This is used for testing.
    */
-  constructor(
-    logId: string,
-    logFilePath: string | null,
-    target: PlainWritable,
-    now?: () => Date,
-    { isDisabled = false }: MongoLogWriterOptions = {}
-  ) {
+  constructor({
+    logId,
+    logFilePath,
+    target,
+    now,
+    isDisabled = false,
+  }: MongoLogWriterOptions) {
     super({ objectMode: true });
     this._logId = logId;
     this._logFilePath = logFilePath;