chore: when closing ExportsManager should not accept any more requests

Author: himanshusinghs

src/common/exportsManager.ts

@@ -64,6 +64,7 @@ type ExportsManagerEvents = {
 
 export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
     private wasInitialized: boolean = false;
+    private isShuttingDown: boolean = false;
     private storedExports: Record<StoredExport["exportName"], StoredExport> = {};
     private exportsCleanupInProgress: boolean = false;
     private exportsCleanupInterval?: NodeJS.Timeout;
@@ -77,6 +78,7 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
     }
 
     public get availableExports(): AvailableExport[] {
+        this.assertIsNotShuttingDown();
         return Object.values(this.storedExports)
             .filter((storedExport) => {
                 return (
@@ -103,6 +105,11 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
     }
 
     public async close(): Promise<void> {
+        if (this.isShuttingDown) {
+            return;
+        }
+
+        this.isShuttingDown = true;
         try {
             clearInterval(this.exportsCleanupInterval);
             await fs.rm(this.exportsDirectoryPath, { force: true, recursive: true });
@@ -117,6 +124,7 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
 
     public async readExport(exportName: string): Promise<string> {
         try {
+            this.assertIsNotShuttingDown();
             exportName = decodeURIComponent(exportName);
             const exportHandle = this.storedExports[exportName];
             if (!exportHandle) {
@@ -157,6 +165,7 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
         jsonExportFormat: JSONExportFormat;
     }): AvailableExport {
         try {
+            this.assertIsNotShuttingDown();
             const exportNameWithExtension = validateExportName(ensureExtension(exportName, "json"));
             if (this.storedExports[exportNameWithExtension]) {
                 throw new Error("Export with same name is either already available or being generated.");
@@ -270,7 +279,7 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
     }
 
     private async cleanupExpiredExports(): Promise<void> {
-        if (this.exportsCleanupInProgress) {
+        if (this.exportsCleanupInProgress || this.isShuttingDown) {
             return;
         }
 
@@ -318,6 +327,12 @@ export class ExportsManager extends EventEmitter<ExportsManagerEvents> {
         }
     }
 
+    private assertIsNotShuttingDown(): void {
+        if (this.isShuttingDown) {
+            throw new Error("ExportsManager is shutting down.");
+        }
+    }
+
     static init(sessionId: string, config: ExportsManagerConfig, logger: LoggerBase): ExportsManager {
         const exportsDirectoryPath = path.join(config.exportsPath, sessionId);
         const exportsManager = new ExportsManager(exportsDirectoryPath, config, logger);

tests/unit/common/exportsManager.test.ts

@@ -130,6 +130,11 @@ describe("ExportsManager unit test", () => {
     });
 
     describe("#availableExport", () => {
+        it("should throw if the manager is shutting down", () => {
+            void manager.close();
+            expect(() => manager.availableExports).toThrow("ExportsManager is shutting down.");
+        });
+
         it("should list only the exports that are in ready state", async () => {
             // This export will finish in at-least 1 second
             const { exportName: exportName1 } = getExportNameAndPath(session.sessionId);
@@ -156,6 +161,11 @@ describe("ExportsManager unit test", () => {
     });
 
     describe("#readExport", () => {
+        it("should throw if the manager is shutting down", async () => {
+            void manager.close();
+            await expect(() => manager.readExport("name")).rejects.toThrow("ExportsManager is shutting down.");
+        });
+
         it("should throw when export name has no extension", async () => {
             await expect(() => manager.readExport("name")).rejects.toThrow();
         });
@@ -208,6 +218,18 @@ describe("ExportsManager unit test", () => {
             ({ exportName, exportPath, exportURI } = getExportNameAndPath(session.sessionId));
         });
 
+        it("should throw if the manager is shutting down", () => {
+            const { cursor } = createDummyFindCursor([]);
+            void manager.close();
+            expect(() =>
+                manager.createJSONExport({
+                    input: cursor,
+                    exportName,
+                    jsonExportFormat: "relaxed",
+                })
+            ).toThrow();
+        });
+
         describe("when cursor is empty", () => {
             it("should create an empty export", async () => {
                 const { cursor, cursorCloseNotification } = createDummyFindCursor([]);