implement dynamic remote access timeout job

pujitm · pujitm · commit c876997e95c5 · 2025-05-05T13:06:12.000-04:00
diff --git a/packages/unraid-api-plugin-connect/src/config.entity.ts b/packages/unraid-api-plugin-connect/src/config.entity.ts
@@ -25,9 +25,9 @@ export enum MinigraphStatus {
 }
 
 export enum DynamicRemoteAccessType {
-    NONE = 'none',
-    UPNP = 'upnp',
-    MANUAL = 'manual',
+    STATIC = 'STATIC',
+    UPNP = 'UPNP',
+    DISABLED = 'DISABLED',
 }
 
 export enum URL_TYPE {
@@ -193,15 +193,18 @@ export class AccessUrlObject {
     name!: string | null | undefined;
 }
 
+export const makeDisabledDynamicRemoteAccessState = (): DynamicRemoteAccessState =>
+    plainToInstance(DynamicRemoteAccessState, {
+        runningType: DynamicRemoteAccessType.DISABLED,
+        error: null,
+        lastPing: null,
+        allowedUrl: null,
+    });
+
 export const configFeature = registerAs<ConnectConfig>('connect', () => ({
     demo: 'hello.unraider',
     mothership: plainToInstance(ConnectionMetadata, {
         status: MinigraphStatus.PRE_INIT,
     }),
-    dynamicRemoteAccess: plainToInstance(DynamicRemoteAccessState, {
-        runningType: DynamicRemoteAccessType.NONE,
-        error: null,
-        lastPing: null,
-        allowedUrl: null,
-    }),
+    dynamicRemoteAccess: makeDisabledDynamicRemoteAccessState(),
 }));
diff --git a/packages/unraid-api-plugin-connect/src/helpers/consts.ts b/packages/unraid-api-plugin-connect/src/helpers/consts.ts
@@ -0,0 +1,2 @@
+export const ONE_MINUTE_MS = 60 * 1000;
+export const THREE_MINUTES_MS = 3 * ONE_MINUTE_MS;
diff --git a/packages/unraid-api-plugin-connect/src/mothership/timeout-checker.job.ts b/packages/unraid-api-plugin-connect/src/mothership/timeout-checker.job.ts
@@ -4,6 +4,8 @@ import { SchedulerRegistry } from '@nestjs/schedule';
 import { isDefined } from 'class-validator';
 
 import { MinigraphStatus } from '../config.entity.js';
+import { ONE_MINUTE_MS, THREE_MINUTES_MS } from '../helpers/consts.js';
+import { DynamicRemoteAccessStateService } from '../remote-access/dynamic-remote-access-state.service.js';
 import { MothershipConnectionService } from './connection.service.js';
 import { MothershipSubscriptionHandler } from './mothership-subscription.handler.js';
 
@@ -12,26 +14,23 @@ export class TimeoutCheckerJob {
     constructor(
         private readonly connectionService: MothershipConnectionService,
         private readonly subscriptionHandler: MothershipSubscriptionHandler,
-        private schedulerRegistry: SchedulerRegistry
+        private schedulerRegistry: SchedulerRegistry,
+        private readonly dynamicRemoteAccess: DynamicRemoteAccessStateService
     ) {}
 
     public jobName = 'connect-timeout-checker';
     private readonly logger = new Logger(TimeoutCheckerJob.name);
-    private THREE_MINUTES_MS = 3 * 60 * 1000;
-    private ONE_MINUTE_MS = 60 * 1000;
 
     private hasMothershipClientTimedOut() {
         const { lastPing, status } = this.connectionService.getConnectionState() ?? {};
         return (
-            status === MinigraphStatus.CONNECTED &&
-            lastPing &&
-            Date.now() - lastPing > this.THREE_MINUTES_MS
+            status === MinigraphStatus.CONNECTED && lastPing && Date.now() - lastPing > THREE_MINUTES_MS
         );
     }
 
     private checkMothershipClientTimeout() {
         if (this.hasMothershipClientTimedOut()) {
-            const minutes = this.msToMinutes(this.THREE_MINUTES_MS);
+            const minutes = this.msToMinutes(THREE_MINUTES_MS);
             this.logger.warn(`NO PINGS RECEIVED IN ${minutes} MINUTES, SOCKET MUST BE RECONNECTED`);
             this.connectionService.setConnectionStatus({
                 status: MinigraphStatus.PING_FAILURE,
@@ -43,21 +42,17 @@ export class TimeoutCheckerJob {
     private msToMinutes(ms: number) {
         return ms / 1000 / 60;
     }
-
-    private checkRemoteAccessTimeout() {
-        // todo: implement
-    }
-
+    
     async checkForTimeouts() {
-        this.subscriptionHandler.clearStaleSubscriptions({ maxAgeMs: this.THREE_MINUTES_MS });
+        this.subscriptionHandler.clearStaleSubscriptions({ maxAgeMs: THREE_MINUTES_MS });
         this.checkMothershipClientTimeout();
-        this.checkRemoteAccessTimeout();
+        this.dynamicRemoteAccess.checkForTimeout();
     }
 
     start() {
         this.stop();
         const callback = () => this.checkForTimeouts();
-        const interval = setInterval(callback, this.ONE_MINUTE_MS);
+        const interval = setInterval(callback, ONE_MINUTE_MS);
         this.schedulerRegistry.addInterval(this.jobName, interval);
     }
 
diff --git a/packages/unraid-api-plugin-connect/src/remote-access/dynamic-remote-access-state.service.ts b/packages/unraid-api-plugin-connect/src/remote-access/dynamic-remote-access-state.service.ts
@@ -0,0 +1,27 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+
+import { DynamicRemoteAccessState, makeDisabledDynamicRemoteAccessState } from '../config.entity.js';
+import { ONE_MINUTE_MS } from '../helpers/consts.js';
+
+@Injectable()
+export class DynamicRemoteAccessStateService {
+    private readonly logger = new Logger(DynamicRemoteAccessStateService.name);
+
+    constructor(private readonly configService: ConfigService) {}
+
+    get state() {
+        return this.configService.getOrThrow<DynamicRemoteAccessState>('connect.dynamicRemoteAccess');
+    }
+
+    checkForTimeout() {
+        const state = this.state;
+        if (state.lastPing && Date.now() - state.lastPing > ONE_MINUTE_MS) {
+            this.logger.warn('No pings received in 1 minute, disabling dynamic remote access');
+            this.configService.set(
+                'connect.dynamicRemoteAccess',
+                makeDisabledDynamicRemoteAccessState()
+            );
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export const ONE_MINUTE_MS = 60 * 1000;`
	`2`	`+export const THREE_MINUTES_MS = 3 * ONE_MINUTE_MS;`