feat: implement store close method and handle process termination sig…

…nals
kuoruan · Jan 11, 2025 · b096b83 · b096b83
1 parent b515afa
commit b096b83
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 8 deletions.
diff --git a/src/server/plugin/Plugin.ts b/src/server/plugin/Plugin.ts
@@ -49,6 +49,21 @@ export class Plugin implements IPluginMiddleware<any>, IPluginAuth<any> {
 
     const store = createStore(parsedConfig);
 
+    // close store on process termination
+    for (const signal of ["SIGINT", "SIGQUIT", "SIGTERM", "SIGHUP"]) {
+      process.once(signal, async () => {
+        try {
+          debug("Received signal %s, closing store...", signal);
+
+          await store.close();
+
+          debug("Store closed, good bye!");
+        } catch (e: any) {
+          debug("Error closing store: %s", e.message);
+        }
+      });
+    }
+
     const provider = new OpenIDConnectAuthProvider(parsedConfig, store);
     const core = new AuthCore(parsedConfig, provider);
 

diff --git a/src/server/store/File.ts b/src/server/store/File.ts
@@ -70,4 +70,8 @@ export default class FileStore extends BaseStore implements Store {
 
     return this.db.getItem(groupsKey);
   }
+
+  close(): void {
+    // ignore
+  }
 }
diff --git a/src/server/store/InMemory.ts b/src/server/store/InMemory.ts
@@ -79,4 +79,10 @@ export default class InMemoryStore extends BaseStore implements Store {
 
     return this.groupsCache.get(userGroupsKey);
   }
+
+  close(): void {
+    this.stateCache.clear();
+    this.userinfoCache.clear();
+    this.groupsCache.clear();
+  }
 }
diff --git a/src/server/store/Redis.ts b/src/server/store/Redis.ts
@@ -60,14 +60,6 @@ export default class RedisStore extends BaseStore implements Store {
         this.ttl = ttl;
       }
     }
-
-    this.addProcessExitHandler();
-  }
-
-  private addProcessExitHandler(): void {
-    process.once("exit", async () => {
-      await this.redis.quit();
-    });
   }
 
   private async isKeyExists(key: string): Promise<boolean> {
@@ -129,4 +121,8 @@ export default class RedisStore extends BaseStore implements Store {
 
     return this.redis.lrange(groupsKey, 0, -1);
   }
+
+  async close(): Promise<void> {
+    await this.redis.quit();
+  }
 }
diff --git a/src/server/store/Store.ts b/src/server/store/Store.ts
@@ -23,6 +23,9 @@ export interface Store {
 
   /** get user groups from the store */
   getUserGroups?: (key: string, providerId: string) => MaybePromise<string[] | null | undefined>;
+
+  /** close the store */
+  close: () => MaybePromise<void>;
 }
 
 export class BaseStore {