Function createCoderArchiveHook

src/node/runtime/coderLifecycleHooks.ts:54–126

(options: {
  coderService: CoderService;
  getArchiveBehavior: () => CoderWorkspaceArchiveBehavior;
  timeoutMs?: number;
})

}

export function createCoderArchiveHook(options: {
  coderService: CoderService;
  getArchiveBehavior: () => CoderWorkspaceArchiveBehavior;
  timeoutMs?: number;
}): BeforeArchiveHook {
  const timeoutMs = options.timeoutMs ?? DEFAULT_STOP_TIMEOUT_MS;

  return async ({ workspaceId, workspaceMetadata }): Promise<Result<void>> => {
    const runtimeConfig = workspaceMetadata.runtimeConfig;
    if (!isSSHRuntime(runtimeConfig) || !runtimeConfig.coder) {
      return Ok(undefined);
    }

    const coder = runtimeConfig.coder;

    // Important safety invariant:
    // Only stop/delete Coder workspaces that mux created (dedicated workspaces). If the user
    // connected mux to an existing Coder workspace, archiving in mux should *not* manage their
    // environment.
    if (coder.existingWorkspace === true) {
      return Ok(undefined);
    }

    const workspaceName = coder.workspaceName?.trim();
    if (!workspaceName) {
      return Ok(undefined);
    }

    const archiveBehavior = options.getArchiveBehavior();
    if (archiveBehavior === "keep") {
      return Ok(undefined);
    }

    if (archiveBehavior === "delete") {
      log.debug("Deleting Coder workspace before mux archive", {
        workspaceId,
        coderWorkspaceName: workspaceName,
      });

      try {
        await options.coderService.deleteWorkspace(workspaceName);
        return Ok(undefined);
      } catch (error) {
        return Err(
          `Failed to delete Coder workspace "${workspaceName}": ${getErrorMessage(error)}`
        );
      }
    }

    // Best-effort: skip the stop call if the control-plane already thinks the workspace is down.
    const status = await options.coderService.getWorkspaceStatus(workspaceName, {
      timeoutMs: DEFAULT_STATUS_TIMEOUT_MS,
    });

    if (isAlreadyStoppedOrGone(status)) {
      return Ok(undefined);
    }