refactor(logging): rename flush to end to make it clear the stream is closed

Author: Hweinstock

src/index.ts

@@ -55,7 +55,7 @@ process.exit(
         .error();
       throw e;
     } finally {
-      await rootLogger.flush();
+      await rootLogger.end();
     }
   }),
 );

src/logging/fileLogger.tsx

@@ -27,9 +27,10 @@ function wrapWinstonLogger(
     error: log("error"),
     child: (childBindings) =>
       wrapWinstonLogger(winstonLogger, transport, { ...bindings, ...childBindings }),
-    flush: () =>
+    end: () =>
       new Promise<void>((resolve) => {
         transport.on("finish", resolve);
+        // note: we prefer close over end since close calls end on the stream internally: https://github.com/winstonjs/winston-daily-rotate-file/blob/a1a4668cfea77476cd6a4a11f038c2aac9d10741/daily-rotate-file.js#L201-L207
         if (transport.close) transport.close();
       }),
   };

src/logging/types.tsx

@@ -27,5 +27,6 @@ export interface Logger {
 /** An extension of {@link Logger} that writes logs asynchronously and requires output to be flushed */
 export interface AsyncLogger extends Logger {
   child: (bindings: LoggerBindings) => AsyncLogger;
-  flush: () => Promise<void>;
+  /** Flushes the pending logs and closes the underlying logging streams **/
+  end: () => Promise<void>;
 }

src/middleware/withLogging.test.ts

@@ -21,7 +21,7 @@ describe("withLogging", () => {
   });
 
   afterEach(async () => {
-    await logger.flush();
+    await logger.end();
     await rm(tempDir, { recursive: true, force: true });
   });