Method ensureReady

src/node/runtime/CoderSSHRuntime.ts:220–258

* Check if runtime is ready for use. * * Behavior: * - If creation failed during postCreateSetup(), fail fast. * - If workspace is running: return ready. * - If workspace is stopped: auto-start and wait (blocking, ~120s timeout). * - If workspace is stopping: poll until stopped, th

(options?: EnsureReadyOptions)

   * Concurrency: shares an in-flight promise to avoid duplicate start sequences.
   */
  override async ensureReady(options?: EnsureReadyOptions): Promise<EnsureReadyResult> {
    const workspaceName = this.coderConfig.workspaceName;
    if (!workspaceName) {
      return {
        ready: false,
        error: "Coder workspace name not set",
        errorType: "runtime_not_ready",
      };
    }

    const now = Date.now();
    const activityByWorkspace = getCoderActivityMap(this.coderService);
    pruneCoderActivityMap(activityByWorkspace, now);
    const lastActivityAtMs = activityByWorkspace.get(workspaceName) ?? 0;

    // Fast path: recently active, skip expensive status check. This cache intentionally lives
    // outside the runtime instance because existing-workspace stream startup recreates runtimes,
    // and it prunes entries after the same 5-minute window to avoid unbounded workspace-name growth.
    if (lastActivityAtMs !== 0 && now - lastActivityAtMs < CODER_INACTIVITY_THRESHOLD_MS) {
      return { ready: true };
    }

    // Avoid duplicate start/wait sequences only for calls without request-local observers.
    // Abort signals and status sinks are per caller; sharing those would make cancellation/status
    // delivery depend on whichever caller happened to start the singleflight.
    if (options?.signal || options?.statusSink) {
      return this.doEnsureReady(workspaceName, options);
    }
    if (this.ensureReadyPromise) {
      return this.ensureReadyPromise;
    }

    this.ensureReadyPromise = this.doEnsureReady(workspaceName, options);
    try {
      return await this.ensureReadyPromise;
    } finally {
      this.ensureReadyPromise = null;
    }
  }

  /**
   * Core ensureReady logic - called once (protected by ensureReadyPromise).