feat(cli): Add --no-apply flag for db schema declarative sync command#5220
Open
mittal-parth wants to merge 4 commits into
Open
feat(cli): Add --no-apply flag for db schema declarative sync command#5220mittal-parth wants to merge 4 commits into
mittal-parth wants to merge 4 commits into
Conversation
The earlier behavior did not have any way to opt out of the prompt without also force applying via `--apply` in the `db schema declarative sync` command. This change introduces a new flag called `no-apply` , allowing users to generate migration files without applying them to the local database.
Coverage Report for CI Build 25658370387Coverage increased (+0.008%) to 63.755%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions79 previously-covered lines in 2 files lost coverage.
Coverage Stats
💛 - Coveralls |
avallete
reviewed
May 12, 2026
| | `db branch switch` | `wrapped` | [`../src/legacy/commands/db/branch/switch/switch.command.ts`](../src/legacy/commands/db/branch/switch/switch.command.ts) | | ||
| | `db remote changes` | `wrapped` | [`../src/legacy/commands/db/remote/changes/changes.command.ts`](../src/legacy/commands/db/remote/changes/changes.command.ts) | | ||
| | `db remote commit` | `wrapped` | [`../src/legacy/commands/db/remote/commit/commit.command.ts`](../src/legacy/commands/db/remote/commit/commit.command.ts) | | ||
| | `db schema declarative sync` | `wrapped` | [`../src/legacy/commands/db/schema/declarative/sync/sync.command.ts`](../src/legacy/commands/db/schema/declarative/sync/sync.command.ts) — `--apply` and `--no-apply` are mutually exclusive | |
Member
There was a problem hiding this comment.
nipick
Worth flagging here that --no-apply is not compatible with --yes flag.
Comment on lines
+1
to
+80
| import { describe, expect, it } from "@effect/vitest"; | ||
| import { Effect, Layer, Option } from "effect"; | ||
| import { LegacyGoProxy } from "../../../../../../shared/legacy/go-proxy.service.ts"; | ||
| import type { LegacyDbSchemaDeclarativeSyncFlags } from "./sync.command.ts"; | ||
| import { legacyDbSchemaDeclarativeSync } from "./sync.handler.ts"; | ||
|
|
||
| function mockLegacyGoProxy() { | ||
| const calls: string[][] = []; | ||
| return { | ||
| layer: Layer.succeed(LegacyGoProxy, { | ||
| exec: (args: ReadonlyArray<string>) => | ||
| Effect.sync(() => { | ||
| calls.push([...args]); | ||
| }), | ||
| }), | ||
| get calls() { | ||
| return calls; | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| const baseFlags: LegacyDbSchemaDeclarativeSyncFlags = { | ||
| noCache: false, | ||
| schema: [], | ||
| file: Option.none(), | ||
| name: Option.none(), | ||
| apply: false, | ||
| noApply: false, | ||
| }; | ||
|
|
||
| describe("legacyDbSchemaDeclarativeSync", () => { | ||
| it.live("forwards --no-apply to the Go binary", () => { | ||
| const go = mockLegacyGoProxy(); | ||
| return Effect.gen(function* () { | ||
| yield* legacyDbSchemaDeclarativeSync({ ...baseFlags, noApply: true }); | ||
| expect(go.calls).toEqual([["db", "schema", "declarative", "sync", "--no-apply"]]); | ||
| }).pipe(Effect.provide(go.layer)); | ||
| }); | ||
|
|
||
| it.live("default invocation omits --apply and --no-apply", () => { | ||
| const go = mockLegacyGoProxy(); | ||
| return Effect.gen(function* () { | ||
| yield* legacyDbSchemaDeclarativeSync({ ...baseFlags }); | ||
| expect(go.calls).toEqual([["db", "schema", "declarative", "sync"]]); | ||
| }).pipe(Effect.provide(go.layer)); | ||
| }); | ||
|
|
||
| it.live("forwards only --apply when set", () => { | ||
| const go = mockLegacyGoProxy(); | ||
| return Effect.gen(function* () { | ||
| yield* legacyDbSchemaDeclarativeSync({ ...baseFlags, apply: true }); | ||
| expect(go.calls).toEqual([["db", "schema", "declarative", "sync", "--apply"]]); | ||
| }).pipe(Effect.provide(go.layer)); | ||
| }); | ||
|
|
||
| it.live("combines --no-apply with --name and --schema in argv order", () => { | ||
| const go = mockLegacyGoProxy(); | ||
| return Effect.gen(function* () { | ||
| yield* legacyDbSchemaDeclarativeSync({ | ||
| ...baseFlags, | ||
| schema: ["public"], | ||
| name: Option.some("foo"), | ||
| noApply: true, | ||
| }); | ||
| expect(go.calls).toEqual([ | ||
| [ | ||
| "db", | ||
| "schema", | ||
| "declarative", | ||
| "sync", | ||
| "--schema", | ||
| "public", | ||
| "--name", | ||
| "foo", | ||
| "--no-apply", | ||
| ], | ||
| ]); | ||
| }).pipe(Effect.provide(go.layer)); | ||
| }); | ||
| }); |
Member
There was a problem hiding this comment.
nitpick
The integration test for the TS wrapper duplicates argv-construction coverage that's effectively a pure transformation. Per CLAUDE.md, "If a test is mostly validating a pure transformation … it should usually be a unit test instead."
Author
There was a problem hiding this comment.
Two ways to solve this:
- We extract a pure function out in the sync.handler.ts which can be unit tested separately, without the need for building a mock. This would however, follow a different pattern than all other legacy proxy handlers.
Eg:
export function buildLegacyDbSchemaDeclarativeSyncArgs(
flags: LegacyDbSchemaDeclarativeSyncFlags,
): readonly string[] {
const args: string[] = ["db", "schema", "declarative", "sync"];
if (flags.noCache) args.push("--no-cache");
....
}
export const legacyDbSchemaDeclarativeSync = Effect.fn("legacy.db.schema.declarative.sync")(
function* (flags: LegacyDbSchemaDeclarativeSyncFlags) {
const proxy = yield* LegacyGoProxy;
yield* proxy.exec(buildLegacyDbSchemaDeclarativeSyncArgs(flags));
},
);- The other legacy proxy handlers do not have any tests. So we could get rid of this sync.integration.test.ts entirely, similar to other handlers.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This change introduces a new flag called
no-applyto thedb schema declarative sync command, allowing users to generate migration files without applying them to the local database.Current behavior
The only escape hatches today:
--apply— force-applies the migration (opposite of what's wanted)true | supabase db schema declarative sync ... 2>&1 | catCloses #5218
New behavior
--no-applyis set, the command writes the migration file and skips the apply step without any prompt--no-applyoverrides global--yesand cannot be combined with--apply.