fix(api): pm2 start script & limit auto restarts (#1040)

pujitm · web-flow · commit ebcd3479e735 · 2025-01-14T14:27:00.000-05:00
* fix(api): limit auto restarts to 10

so persistent errors (e.g. during server boot) don't cause an infinite
loop that's difficult for users to see

* fix(api): invoke js directly from pm2 instead of npm script

npm script wraps it in a child process, so we lose ipc.

* fix(api): update api key service test for ensureDir change

* chore: increase max_restart threshold to 10s per cycle
diff --git a/api/ecosystem.config.json b/api/ecosystem.config.json
@@ -2,13 +2,14 @@
     "apps": [
         {
             "name": "unraid-api",
-            "script": "npm",
-            "args": "start",
+            "script": "./dist/main.js",
             "cwd": "/usr/local/unraid-api",
             "log": "/var/log/unraid-api/unraid-api.log",
             "exec_mode": "fork",
             "wait_ready": true,
             "listen_timeout": 30000,
+            "max_restarts": 10,
+            "min_uptime": 10000,
             "ignore_watch": [
                 "node_modules",
                 "src",
@@ -17,4 +18,4 @@
             ]
         }
     ]
-}
+}
diff --git a/api/src/unraid-api/auth/api-key.service.spec.ts b/api/src/unraid-api/auth/api-key.service.spec.ts
@@ -91,7 +91,6 @@ describe('ApiKeyService', () => {
         vi.mocked(ensureDir).mockResolvedValue();
 
         apiKeyService = new ApiKeyService();
-        await apiKeyService.initialize();
 
         vi.spyOn(apiKeyService as any, 'generateApiKey').mockReturnValue('test-api-key');
         vi.mock('uuid', () => ({
@@ -113,12 +112,8 @@ describe('ApiKeyService', () => {
 
     describe('initialization', () => {
         it('should ensure directory exists', async () => {
-            vi.mocked(ensureDir).mockResolvedValue();
             const service = new ApiKeyService();
-
-            await service.initialize();
-
-            expect(ensureDir).toHaveBeenCalledWith(mockBasePath);
+            expect(ensureDirSync).toHaveBeenCalledWith(mockBasePath);
         });
 
         it('should return correct paths', async () => {
diff --git a/api/src/unraid-api/main.ts b/api/src/unraid-api/main.ts
@@ -54,6 +54,8 @@ export async function bootstrapNestServer(): Promise<NestFastifyApplication> {
     // See https://pm2.keymetrics.io/docs/usage/signals-clean-restart/
     if (process.send) {
         process.send('ready');
+    } else {
+        console.log('Warning: process.send is unavailable. This will affect IPC communication with PM2.');
     }
     apiLogger.info('Nest Server is now listening');
 

Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,14 @@`
`2`	`2`	`"apps": [`
`3`	`3`	`{`
`4`	`4`	`"name": "unraid-api",`
`5`		`- "script": "npm",`
`6`		`- "args": "start",`
	`5`	`+ "script": "./dist/main.js",`
`7`	`6`	`"cwd": "/usr/local/unraid-api",`
`8`	`7`	`"log": "/var/log/unraid-api/unraid-api.log",`
`9`	`8`	`"exec_mode": "fork",`
`10`	`9`	`"wait_ready": true,`
`11`	`10`	`"listen_timeout": 30000,`
	`11`	`+ "max_restarts": 10,`
	`12`	`+ "min_uptime": 10000,`
`12`	`13`	`"ignore_watch": [`
`13`	`14`	`"node_modules",`
`14`	`15`	`"src",`
`@@ -17,4 +18,4 @@`
`17`	`18`	`]`
`18`	`19`	`}`
`19`	`20`	`]`
`20`		`-}`
	`21`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,8 @@ export async function bootstrapNestServer(): Promise<NestFastifyApplication> {`
`54`	`54`	`// See https://pm2.keymetrics.io/docs/usage/signals-clean-restart/`
`55`	`55`	`if (process.send) {`
`56`	`56`	`process.send('ready');`
	`57`	`+ } else {`
	`58`	`+ console.log('Warning: process.send is unavailable. This will affect IPC communication with PM2.');`
`57`	`59`	`}`
`58`	`60`	`apiLogger.info('Nest Server is now listening');`
`59`	`61`