Class WorkspaceFilesystemStub

packages/computer/src/stub.ts:90–278

// WriteFileContent union includes ReadableStream<Uint8Array> for
// the same reason.
export class WorkspaceFilesystemStub extends RpcTarget {
  readonly #ws: Workspace;

  constructor(ws: Workspace) {
    super();
    this.#ws = ws;
    trackStub(this);
  }

  [Symbol.dispose](): void {
    untrackStub(this);
  }

  // --- Reads -------------------------------------------------------

  readFile(path: string): Promise<ReadableStream<Uint8Array>>;
  readFile(path: string, encoding: "utf8"): Promise<string>;
  readFile(path: string, options: ReadFileOptions): Promise<string | ReadableStream<Uint8Array>>;
  readFile(
    path: string,
    optionsOrEncoding?: "utf8" | ReadFileOptions,
  ): Promise<string | ReadableStream<Uint8Array>> {
    return withSpan(this.#ws.observer, "workspace.fs.readFile", { "workspace.fs.path": path }, () =>
      this.#ws.fs.readFile(path, optionsOrEncoding as ReadFileOptions),
    );
  }

  exists(path: string): Promise<boolean> {
    return withSpan(
      this.#ws.observer,
      "workspace.fs.exists",
      { "workspace.fs.path": path },
      async () => (await this.statOrNull(path)) !== null,
    );
  }

  stat(path: string): Promise<WorkspaceStatResult> {
    return withSpan(this.#ws.observer, "workspace.fs.stat", { "workspace.fs.path": path }, () =>
      this.#ws.fs.stat(path),
    );
  }

  async statOrNull(path: string): Promise<WorkspaceStatResult | null> {
    return withSpan(
      this.#ws.observer,
      "workspace.fs.statOrNull",
      { "workspace.fs.path": path },
      async () => {
        try {
          return await this.#ws.fs.stat(path);
        } catch (error) {
          if ((error as { code?: string }).code === "ENOENT") return null;
          throw error;
        }
      },
    );
  }