Add optional idle timeout shutdown

src/node/cli.ts

@@ -83,6 +83,7 @@
   "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 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 @@
     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 @@
   }
   host: string
   port: number
+  "idle-timeout": number
   "proxy-domain": string[]
   verbose: boolean
   usingEnvPassword: boolean
@@ -570,6 +580,10 @@
     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

@@ -1,20 +1,27 @@
 import { logger } from "@coder/logger"
 import { promises as fs } from "fs"
+import { wrapper } from "./wrapper"
 
 /**
  * Provides a heartbeat using a local file to indicate activity.
  */
 export class Heart {
   private heartbeatTimer?: NodeJS.Timeout
+  private idleCheckTimer?: NodeJS.Timeout
   private heartbeatInterval = 60000
   public lastHeartbeat = 0
 
   public constructor(
     private readonly heartbeatPath: string,
+    private readonly idleTimeout: number | undefined,
     private readonly isActive: () => Promise<boolean>,
   ) {
     this.beat = this.beat.bind(this)
     this.alive = this.alive.bind(this)
+    // Start idle check timer if timeout is configured
+    if (this.idleTimeout) {
+      this.startIdleCheck()
+    }
   }
 
   public alive(): boolean {
@@ -44,13 +51,27 @@ export class Heart {
     }
   }
 
+  private startIdleCheck(): void {
+    // Check every minute if the idle timeout has been exceeded
+    this.idleCheckTimer = setInterval(() => {
+      const timeSinceLastBeat = Date.now() - this.lastHeartbeat
+      if (timeSinceLastBeat > this.idleTimeout! * 60 * 1000) {
+        logger.warn(`Idle timeout of ${this.idleTimeout} minutes exceeded`)
+        wrapper.exit(5)
+      }
+    }, 60000)
+  }
+
   /**
    * Call to clear any heartbeatTimer for shutdown.
    */
   public dispose(): void {
     if (typeof this.heartbeatTimer !== "undefined") {
       clearTimeout(this.heartbeatTimer)
     }
+    if (typeof this.idleCheckTimer !== "undefined") {
+      clearInterval(this.idleCheckTimer)
+    }
   }
 }
 

src/node/main.ts

@@ -4,7 +4,7 @@
 import { Disposable } from "../common/emitter"
 import { plural } from "../common/util"
 import { createApp, ensureAddress } from "./app"
 import { AuthType, DefaultedArgs, Feature, toCodeArgs, UserProvidedArgs } from "./cli"
 import { commit, version, vsRootPath } from "./constants"
 import { register } from "./routes"
 import { VSCodeModule } from "./routes/vscode"
@@ -152,6 +152,10 @@
     logger.info("  - Not serving HTTPS")
   }
 
+  if (args["idle-timeout"]) {
+    logger.info(`  - Idle timeout set to ${args["idle-timeout"]} minutes`)
+  }
+
   if (args["disable-proxy"]) {
     logger.info("  - Proxy disabled")
   } else if (args["proxy-domain"].length > 0) {

src/node/routes/index.ts

@@ -9,7 +9,7 @@
 import { HttpCode, HttpError } from "../../common/http"
 import { plural } from "../../common/util"
 import { App } from "../app"
 import { AuthType, DefaultedArgs } from "../cli"
 import { commit, rootPath } from "../constants"
 import { Heart } from "../heart"
 import { ensureAuthenticated, redirect } from "../http"
@@ -31,7 +31,7 @@
  * 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