Function createCoderUnarchiveHook

src/node/runtime/coderLifecycleHooks.ts:128–248

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

}

export function createCoderUnarchiveHook(options: {
  coderService: CoderService;
  getArchiveBehavior: () => CoderWorkspaceArchiveBehavior;
  timeoutMs?: number;
  stoppingWaitTimeoutMs?: number;
  stoppingPollIntervalMs?: number;
}): AfterUnarchiveHook {
  const timeoutMs = options.timeoutMs ?? DEFAULT_START_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 start Coder workspaces that mux created (dedicated workspaces). If the user connected
    // mux to an existing Coder workspace, unarchiving in mux should *not* start their environment.
    if (coder.existingWorkspace === true) {
      return Ok(undefined);
    }

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

    if (options.getArchiveBehavior() !== "stop") {
      return Ok(undefined);
    }

    let status = await options.coderService.getWorkspaceStatus(workspaceName, {
      timeoutMs: DEFAULT_STATUS_TIMEOUT_MS,
    });

    // Unarchive can happen immediately after archive, while the Coder workspace is still
    // transitioning through "stopping". Starting during that transition can fail, so we
    // best-effort poll briefly until it reaches a terminal state.
    if (status.kind === "ok" && status.status === "stopping") {
      const waitTimeoutMs = options.stoppingWaitTimeoutMs ?? DEFAULT_STOPPING_WAIT_TIMEOUT_MS;
      const pollIntervalMs = options.stoppingPollIntervalMs ?? DEFAULT_STOPPING_POLL_INTERVAL_MS;
      const deadlineMs = Date.now() + waitTimeoutMs;

      log.debug(
        "Coder workspace is still stopping after mux unarchive; waiting briefly before starting",
        {
          workspaceId,
          coderWorkspaceName: workspaceName,
          waitTimeoutMs,
          pollIntervalMs,
        }
      );

      while (status.kind === "ok" && status.status === "stopping") {
        const remainingMs = deadlineMs - Date.now();
        if (remainingMs <= 0) {