Add idle-timeout: Timeout in minutes to wait before shutting down when idle

Author: gaberudy

src/node/cli.ts

@@ -83,6 +83,7 @@ export interface UserProvidedArgs extends UserProvidedCodeArgs {
   "socket-mode"?: string
   "trusted-origins"?: string[]
   version?: boolean
+  "idle-timeout"?: number
   "proxy-domain"?: string[]
   "reuse-window"?: boolean
   "new-window"?: boolean
@@ -137,6 +138,13 @@ export type Options<T> = {
 
 export const options: Options<Required<UserProvidedArgs>> = {
   auth: { type: AuthType, description: "The type of authentication to use." },
+<<<<<<< HEAD
+=======
+  "auth-user": {
+     type: "string",
+     description: "The username for http-basic authentication."
+  },
+>>>>>>> c6a85663 (Add idle-timeout: Timeout in minutes to wait before shutting down when idle)
   password: {
     type: "string",
     description: "The password for password authentication (can only be passed in via $PASSWORD or the config file).",
@@ -251,6 +259,7 @@ export const options: Options<Required<UserProvidedArgs>> = {
     type: "string",
     description: "GitHub authentication token (can only be passed in via $GITHUB_TOKEN or the config file).",
   },
+  "idle-timeout": { type: "number", description: "Timeout in minutes to wait before shutting down when idle." },
   "proxy-domain": { type: "string[]", description: "Domain used for proxying ports." },
   "ignore-last-opened": {
     type: "boolean",
@@ -477,6 +486,7 @@ export interface DefaultedArgs extends ConfigArgs {
   }
   host: string
   port: number
+  "idle-timeout": number
   "proxy-domain": string[]
   verbose: boolean
   usingEnvPassword: boolean
@@ -570,6 +580,10 @@ export async function setDefaults(cliArgs: UserProvidedArgs, configArgs?: Config
     args.password = process.env.PASSWORD
   }
 
+  if (process.env.IDLE_TIMEOUT) {
+    args["idle-timeout"] = parseInt(process.env.IDLE_TIMEOUT, 10)
+  }
+
   if (process.env.CS_DISABLE_FILE_DOWNLOADS?.match(/^(1|true)$/)) {
     args["disable-file-downloads"] = true
   }

src/node/heart.ts

@@ -11,6 +11,7 @@ export class Heart {
 
   public constructor(
     private readonly heartbeatPath: string,
+    private readonly idleTimeout: number | undefined,
     private readonly isActive: () => Promise<boolean>,
   ) {
     this.beat = this.beat.bind(this)
@@ -36,7 +37,10 @@ export class Heart {
     if (typeof this.heartbeatTimer !== "undefined") {
       clearTimeout(this.heartbeatTimer)
     }
-    this.heartbeatTimer = setTimeout(() => heartbeatTimer(this.isActive, this.beat), this.heartbeatInterval)
+    this.heartbeatTimer = setTimeout(
+      () => heartbeatTimer(this.isActive, this.beat, this.lastHeartbeat, this.idleTimeout),
+      this.heartbeatInterval
+    )
     try {
       return await fs.writeFile(this.heartbeatPath, "")
     } catch (error: any) {
@@ -61,8 +65,21 @@ export class Heart {
  *
  * Extracted to make it easier to test.
  */
-export async function heartbeatTimer(isActive: Heart["isActive"], beat: Heart["beat"]) {
+export async function heartbeatTimer(
+  isActive: Heart["isActive"],
+  beat: Heart["beat"],
+  lastHeartbeat: number,
+  idleTimeout?: number,
+) {
   try {
+    // Check for idle timeout first
+    if (idleTimeout) {
+      const timeSinceLastBeat = Date.now() - lastHeartbeat
+      if (timeSinceLastBeat > idleTimeout * 60 * 1000) {
+        logger.warn(`Idle timeout of ${idleTimeout} minutes exceeded`)
+        process.exit(0)
+      }
+    }
     if (await isActive()) {
       beat()
     }

src/node/routes/index.ts

@@ -31,7 +31,7 @@ import * as vscode from "./vscode"
  * Register all routes and middleware.
  */
 export const register = async (app: App, args: DefaultedArgs): Promise<Disposable["dispose"]> => {
-  const heart = new Heart(path.join(paths.data, "heartbeat"), async () => {
+  const heart = new Heart(path.join(paths.data, "heartbeat"), args["idle-timeout"], async () => {
     return new Promise((resolve, reject) => {
       // getConnections appears to not call the callback when there are no more
       // connections.  Feels like it must be a bug?  For now add a timer to make

test/unit/node/heart.test.ts

@@ -95,7 +95,7 @@ describe("heartbeatTimer", () => {
     const isActive = true
     const mockIsActive = jest.fn().mockResolvedValue(isActive)
     const mockBeatFn = jest.fn()
-    await heartbeatTimer(mockIsActive, mockBeatFn)
+    await heartbeatTimer(mockIsActive, mockBeatFn, 0)
     expect(mockIsActive).toHaveBeenCalled()
     expect(mockBeatFn).toHaveBeenCalled()
   })
@@ -104,7 +104,7 @@ describe("heartbeatTimer", () => {
     const error = new Error(errorMsg)
     const mockIsActive = jest.fn().mockRejectedValue(error)
     const mockBeatFn = jest.fn()
-    await heartbeatTimer(mockIsActive, mockBeatFn)
+    await heartbeatTimer(mockIsActive, mockBeatFn, 0)
     expect(mockIsActive).toHaveBeenCalled()
     expect(mockBeatFn).not.toHaveBeenCalled()
     expect(logger.warn).toHaveBeenCalledWith(errorMsg)