Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion apps/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@
"ignore": [
"scripts/*.ts",
"tests/**/*.ts",
"src/shared/telemetry/event-catalog.ts"
"src/shared/telemetry/event-catalog.ts",
"src/shared/workers/stacks/**"
],
"ignoreBinaries": [
"nx",
Expand Down
3 changes: 1 addition & 2 deletions apps/cli/scripts/build-binary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import { bundleServeMainTemplate } from "../src/shared/functions/serve-main-bund
* Compile a single CLI shell to a standalone binary, embedding the pre-bundled
* edge-runtime template via the `SUPABASE_FUNCTIONS_SERVE_MAIN_TEMPLATE` define so
* the binary serves Functions offline without bundling at runtime
* (supabase/supabase#45570). Used by the `build:next` / `build:legacy` scripts; the
* multi-target release build in `build.ts` injects the same define.
* (supabase/supabase#45570). Used by the `build:next` / `build:legacy` scripts.
*/
const shell = process.argv[2];
if (shell !== "next" && shell !== "legacy") {
Expand Down
2 changes: 2 additions & 0 deletions apps/cli/src/legacy/cli/root.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import { legacyStorageCommand } from "../commands/storage/storage.command.ts";
import { legacyTestCommand } from "../commands/test/test.command.ts";
import { legacyTelemetryCommand } from "../commands/telemetry/telemetry.command.ts";
import { legacyUnlinkCommand } from "../commands/unlink/unlink.command.ts";
import { legacyWorkersCommand } from "../commands/workers/workers.command.ts";
import { legacyVanitySubdomainsCommand } from "../commands/vanity-subdomains/vanity-subdomains.command.ts";
import { OutputFormatFlag } from "../../shared/cli/global-flags.ts";
import { outputLayerFor } from "../../shared/output/output.layer.ts";
Expand Down Expand Up @@ -70,6 +71,7 @@ export const legacyRoot = Command.make("supabase").pipe(
legacyDomainsCommand,
legacyEncryptionCommand,
legacyFunctionsCommand,
legacyWorkersCommand,
legacyGenCommand,
legacyInitCommand,
legacyInspectCommand,
Expand Down
61 changes: 61 additions & 0 deletions apps/cli/src/legacy/commands/workers/new/SIDE_EFFECTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# `supabase workers new [name]`

> **Local-disk only.** Nothing is deployed and no Management API route is
> called; `workers push` is what talks to the platform.

## Files Read

| Path | Format | When |
| -------------------------------- | ------ | ----------------------------------------------------------- |
| `<workdir>/supabase/config.toml` | TOML | always, for `[workers]` root and any existing entry |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Document the profile files read during startup

Every invocation constructs legacyCliConfigLayer, which reads ~/.supabase/profile when no profile flag or environment value is supplied and reads the selected YAML file when SUPABASE_PROFILE names a custom profile; either custom-profile read can also abort this otherwise local command. Neither path appears in the Files Read table, leaving the command's compatibility checklist and its E2E input incomplete.

AGENTS.md reference: apps/cli/AGENTS.md:L359-L366

Useful? React with 👍 / 👎.

| `<destination>/` | dir | always, to refuse a non-empty destination without `--force` |

## Files Written

| Path | Format | When |
| ----------------------------------------------- | ------ | ------------------------------------------------------------------------- |
| `<workdir>/supabase/config.toml` | TOML | always — appends/updates `[workers.<name>]` in place, preserving comments |
| `<workdir>/supabase/<root>/<name>/*` | varies | always, unless `--source` names another directory |
| `<workdir>/<source>/*` | varies | when `--source` is given |
| `<SUPABASE_HOME or ~/.supabase>/telemetry.json` | JSON | always — flushed on success and on failure |

Existing files at the destination are **deleted** when `--force` is passed.
`--source` is refused when it resolves to the project root, `supabase/`,
`supabase/functions/`, `supabase/migrations/`, or outside the project. Symlinks
are resolved first, so a path inside the project that points outside it is
refused too. A relative `--source` is resolved against the directory the command
was run in; a `source` recorded in `config.toml` is resolved against the project
root.

## API Routes

| Method | Path | Auth | Request body | Response (used fields) |
| ------ | ---- | ---- | ------------ | ---------------------- |
| — | — | — | — | — |

## Exit Codes

| Code | Condition |
| ---- | --------------------------------------------------------------------- |
| `0` | success |
| `1` | invalid or reserved worker name, unknown runtime/size, bad `--source` |
| `1` | destination exists and is not empty without `--force` |
| `1` | `config.toml` records a worker in a form that cannot be edited safely |

## Environment Variables

| Variable | Purpose | Required? |
| ----------------------- | ---------------------------------------------------- | ------------------------------------------------------- |
| `SUPABASE_ACCESS_TOKEN` | auth token (bypasses credential file/keyring lookup) | no (falls back to keyring → `~/.supabase/access-token`) |
| `SUPABASE_PROFILE` | built-in profile name or YAML file path | no (falls back to `~/.supabase/profile` -> `supabase`) |
| `SUPABASE_WORKDIR` | project directory the command acts on | no (falls back to `--workdir`, then the ancestor walk) |
| `SUPABASE_HOME` | directory holding `telemetry.json` | no (falls back to `~/.supabase`) |

## Telemetry Events Fired

| Event | When | Notable properties / groups |
| ---------------------- | ------------------------------------------ | ----------------------------------- |
| `cli_command_executed` | post-run, success or failure (via wrapper) | `exit_code`, `duration_ms`, `flags` |

No custom events — only the `cli_command_executed` that the instrumentation
wrapper emits for every command.
80 changes: 80 additions & 0 deletions apps/cli/src/legacy/commands/workers/new/new.command.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import { Layer } from "effect";
import { Argument, Command, Flag } from "effect/unstable/cli";
import type * as CliCommand from "effect/unstable/cli/Command";
import { withJsonErrorHandling } from "../../../../shared/output/json-error-handling.ts";
import { commandRuntimeLayer } from "../../../../shared/runtime/command-runtime.layer.ts";
import { randomLayer } from "../../../../shared/runtime/random.layer.ts";
import { WORKER_RUNTIMES, WORKER_SIZES } from "../../../../shared/workers/worker-runtimes.ts";
import { legacyCliConfigLayer } from "../../../config/legacy-cli-config.layer.ts";
import { legacyDebugLoggerLayer } from "../../../shared/legacy-debug-logger.layer.ts";
import { legacyTelemetryStateLayer } from "../../../telemetry/legacy-telemetry-state.layer.ts";
import { withLegacyCommandInstrumentation } from "../../../telemetry/legacy-command-instrumentation.ts";
import { legacyWorkersNew } from "./new.handler.ts";

const config = {
name: Argument.string("name").pipe(
Argument.withDescription("Worker name. Doubles as its directory; generated when omitted."),
Argument.optional,
),
runtime: Flag.choice("runtime", WORKER_RUNTIMES).pipe(
Comment thread
johnstonmatt marked this conversation as resolved.
Flag.withDescription(
"Runtime to scaffold and record in supabase/config.toml. Prompted when omitted.",
),
Flag.optional,
),
size: Flag.choice("size", WORKER_SIZES).pipe(
Flag.withDescription(
"Instance size to record in supabase/config.toml. Each size implies its own vCPU count, so there is no separate --cpu. Prompted when omitted.",
),
Flag.optional,
),
source: Flag.string("source").pipe(
Flag.withDescription(
"Scaffold the worker here instead of the default workers directory, recorded as `source` in supabase/config.toml.",
),
Flag.optional,
),
force: Flag.boolean("force").pipe(
Flag.withDescription("Replace the destination if it already exists and is not empty."),
),
} as const;

export type LegacyWorkersNewFlags = CliCommand.Command.Config.Infer<typeof config>;

const cliConfig = legacyCliConfigLayer.pipe(Layer.provide(legacyDebugLoggerLayer));

/** Local-disk only: no Management API, so no platform stack is built. */
const legacyWorkersNewRuntimeLayer = Layer.mergeAll(
cliConfig,
legacyTelemetryStateLayer,
randomLayer,
commandRuntimeLayer(["workers", "new"]),
);

export const legacyWorkersNewCommand = Command.make("new", config).pipe(
Command.withDescription(
"Scaffold a worker directory from a runtime's starter files and record the choice in supabase/config.toml. Nothing is deployed.",
),
Command.withShortDescription("Scaffold a worker locally"),
Command.withExamples([
{
command: "supabase workers new",
description: "Scaffold a worker, prompting for runtime and size",
},
{
command: "supabase workers new api --runtime node",
description: "Scaffold supabase/workers/api on the node runtime",
},
{
command: "supabase workers new api --source packages/api",
description: "Scaffold the worker outside the workers directory",
},
]),
Command.withHandler((flags) =>
legacyWorkersNew(flags).pipe(
withLegacyCommandInstrumentation({ flags, config }),
withJsonErrorHandling,
),
),
Command.provide(legacyWorkersNewRuntimeLayer),
);
Loading
Loading