fix(cli): wait for managed server shutdown

Author: pallyoung

packages/cli/src/pm2-control.test.ts

@@ -33,12 +33,16 @@ import {
 describe("pm2-control", () => {
   const originalHome = process.env.HOME;
   const originalUserProfile = process.env.USERPROFILE;
+  const originalRuntimeDir = process.env.CODER_STUDIO_RUNTIME_DIR;
+  const originalRuntimeJsonPath = process.env.CODER_STUDIO_RUNTIME_JSON_PATH;
   let testHomeDir: string;
 
   beforeEach(() => {
     testHomeDir = mkdtempSync(join(tmpdir(), "cs-pm2-control-home-"));
     process.env.HOME = testHomeDir;
     process.env.USERPROFILE = testHomeDir;
+    process.env.CODER_STUDIO_RUNTIME_DIR = join(testHomeDir, ".coder-studio");
+    delete process.env.CODER_STUDIO_RUNTIME_JSON_PATH;
 
     connect.mockImplementation((callback: (error: Error | null) => void) => callback(null));
     disconnect.mockImplementation(() => undefined);
@@ -80,6 +84,18 @@ describe("pm2-control", () => {
       process.env.USERPROFILE = originalUserProfile;
     }
 
+    if (originalRuntimeDir === undefined) {
+      delete process.env.CODER_STUDIO_RUNTIME_DIR;
+    } else {
+      process.env.CODER_STUDIO_RUNTIME_DIR = originalRuntimeDir;
+    }
+
+    if (originalRuntimeJsonPath === undefined) {
+      delete process.env.CODER_STUDIO_RUNTIME_JSON_PATH;
+    } else {
+      process.env.CODER_STUDIO_RUNTIME_JSON_PATH = originalRuntimeJsonPath;
+    }
+
     if (existsSync(testHomeDir)) {
       rmSync(testHomeDir, { recursive: true, force: true });
     }
@@ -183,6 +199,10 @@ describe("pm2-control", () => {
           callback(null, [])
       )
       .mockImplementationOnce(
+        (_name: string, callback: (error: Error | null, result: unknown[]) => void) =>
+          callback(null, [])
+      )
+      .mockImplementation(
         (_name: string, callback: (error: Error | null, result: unknown[]) => void) =>
           callback(null, [{ pid: 424242, pm2_env: { status: "online", restart_time: 0 } }])
       );

packages/cli/src/pm2-control.ts

@@ -8,6 +8,7 @@ export const MANAGED_SERVER_NAME = "coder-studio-server";
 const PM2_RESTART_DELAY_MS = 2000;
 const PM2_MIN_UPTIME = "5s";
 const PM2_MAX_RESTARTS = 10;
+const PM2_DELETE_WAIT_MS = 5000;
 const STARTUP_POLL_INTERVAL_MS = 100;
 const STARTUP_FAILURE_GUIDANCE =
   "Run `coder-studio logs` for details or `coder-studio serve --foreground` for interactive debugging.";
@@ -236,6 +237,26 @@ const waitForManagedServerExit = async (): Promise<void> => {
   }
 };
 
+const waitForManagedServerDeletion = async (waitMs: number): Promise<void> => {
+  const deadline = Date.now() + waitMs;
+
+  while (Date.now() <= deadline) {
+    const processes = await withPm2Connection(describeManagedServer);
+    if (processes.length === 0) {
+      return;
+    }
+
+    const remainingMs = deadline - Date.now();
+    if (remainingMs <= 0) {
+      break;
+    }
+
+    await sleep(Math.min(STARTUP_POLL_INTERVAL_MS, remainingMs));
+  }
+
+  throw new Error(`Timed out waiting for the managed server to stop after ${waitMs}ms.`);
+};
+
 const ensureLogDirectory = (): void => {
   mkdirSync(join(homedir(), ".coder-studio", "logs"), { recursive: true });
 };
@@ -286,8 +307,8 @@ export const deleteManagedServer = async ({
   ignoreMissing = false,
 }: {
   ignoreMissing?: boolean;
-} = {}): Promise<boolean> =>
-  withPm2Connection(async () => {
+} = {}): Promise<boolean> => {
+  const deleted = await withPm2Connection(async () => {
     const processes = await describeManagedServer();
     if (processes.length === 0) {
       return false;
@@ -305,6 +326,14 @@ export const deleteManagedServer = async ({
     }
   });
 
+  if (!deleted) {
+    return false;
+  }
+
+  await waitForManagedServerDeletion(PM2_DELETE_WAIT_MS);
+  return true;
+};
+
 export const startManagedServer = async ({
   script,
   cwd,
@@ -402,6 +431,14 @@ export const getManagedServerStatus = async (): Promise<ManagedServerStatus> =>
       };
     }
 
+    if (pm2Pid === null || pm2Pid === 0) {
+      return {
+        status: "stopped",
+        pm2Pid: null,
+        restartCount,
+      };
+    }
+
     return {
       status: "errored",
       pm2Pid,

packages/cli/src/server-control.test.ts

@@ -149,6 +149,25 @@ describe("server-control", () => {
     });
   });
 
+  it("reports stopped when pm2 is no longer running and runtime is absent", async () => {
+    getManagedServerStatus.mockResolvedValue({
+      status: "starting",
+      pm2Pid: null,
+      restartCount: 0,
+    });
+
+    await expect(getServerStatus()).resolves.toEqual({
+      status: "stopped",
+      pid: null,
+      host: null,
+      port: null,
+      restartCount: 0,
+      outFile: "/tmp/server.out.log",
+      errFile: "/tmp/server.err.log",
+      startedAt: null,
+    });
+  });
+
   it("cleans stale runtime when pm2 reports stopped", async () => {
     writeRuntimeConfig({
       host: "127.0.0.1",

packages/cli/src/server-control.ts

@@ -31,7 +31,7 @@ export async function getServerStatus(): Promise<ServerStatus> {
   const runtime = readRuntimeConfig();
   const { outFile, errFile } = getLogPaths();
 
-  if (managedStatus.status === "stopped") {
+  if (managedStatus.status === "stopped" || (managedStatus.pm2Pid === null && runtime === null)) {
     if (runtime) {
       deleteRuntimeConfig();
     }