Skip to content

sql:migrate --force should ignore invalid connector #7199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 21, 2024
Merged

sql:migrate --force should ignore invalid connector #7199

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ba6f445
force sql:migrate
fredzqm May 21, 2024
ea68811
switch back to pg.Pool
fredzqm May 21, 2024
2374c9e
m
fredzqm May 21, 2024
391686b
m
fredzqm May 21, 2024
7d82217
Merge branch 'fz/pool' into fz/migrate-force
fredzqm May 21, 2024
c026939
wording
fredzqm May 21, 2024
6e523de
wording
fredzqm May 21, 2024
c729056
Merge branch 'master' into fz/migrate-force
fredzqm May 21, 2024
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
54 changes: 34 additions & 20 deletions src/dataconnect/schemaMigration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,11 @@ export async function migrateSchema(args: {

const shouldDeleteInvalidConnectors = await promptForInvalidConnectorError(
options,
serviceName,
invalidConnectors,
validateOnly,
);
if (!shouldDeleteInvalidConnectors && invalidConnectors.length) {
const cmd = suggestedCommand(serviceName, invalidConnectors);
throw new FirebaseError(
`Command aborted. Try deploying those connectors first with ${clc.bold(cmd)}`,
);
}

const migrationMode = incompatible
? await promptForSchemaMigration(
options,
Expand All @@ -112,11 +108,13 @@ export async function migrateSchema(args: {
});
}

if (invalidConnectors.length) {
if (shouldDeleteInvalidConnectors) {
await deleteInvalidConnectors(invalidConnectors);
}
// Then, try to upsert schema again. If there still is an error, just throw it now
await upsertSchema(schema, validateOnly);
if (!validateOnly) {
// Then, try to upsert schema again. If there still is an error, just throw it now
await upsertSchema(schema, validateOnly);
}
return diffs;
}
return [];
Expand Down Expand Up @@ -212,7 +210,7 @@ async function promptForSchemaMigration(
): Promise<"none" | "safe" | "all"> {
displaySchemaChanges(err);
if (!options.nonInteractive) {
// Always prompt in interactive mode. Desturctive migrations are too potentially dangerous to not prompt for with --force
// Always prompt in interactive mode. Destructive migrations are too potentially dangerous to not prompt for with --force
const choices = err.destructive
? [
{ name: "Execute all changes (including destructive changes)", value: "all" },
Expand Down Expand Up @@ -250,6 +248,7 @@ async function promptForSchemaMigration(

async function promptForInvalidConnectorError(
options: Options,
serviceName: string,
invalidConnectors: string[],
validateOnly: boolean,
): Promise<boolean> {
Expand All @@ -258,18 +257,33 @@ async function promptForInvalidConnectorError(
}
displayInvalidConnectors(invalidConnectors);
if (validateOnly) {
return false;
} else if (
options.force ||
(!options.nonInteractive &&
(await confirm({
...options,
message: "Would you like to delete and recreate these connectors?",
})))
if (options.force) {
// `firebase dataconnect:sql:migrate --force` ignores invalid connectors.
return false;
}
// `firebase dataconnect:sql:migrate` aborts if there are invalid connectors.
throw new FirebaseError(
`Command aborted. If you'd like to migrate it anyway, you may override with --force.`,
);
}
if (options.force) {
// `firebase deploy --force` will delete invalid connectors without prompting.
return true;
}
// `firebase deploy` prompts in case of invalid connectors.
if (
!options.nonInteractive &&
(await confirm({
...options,
message: `Would you like to delete and recreate these connectors? This will cause ${clc.red(`downtime.`)}.`,
}))
) {
return true;
}
return false;
const cmd = suggestedCommand(serviceName, invalidConnectors);
throw new FirebaseError(
`Command aborted. Try deploying those connectors first with ${clc.bold(cmd)}`,
);
}

async function deleteInvalidConnectors(invalidConnectors: string[]): Promise<void[]> {
Expand All @@ -284,7 +298,7 @@ function displayInvalidConnectors(invalidConnectors: string[]) {
);
logLabeledWarning(
"dataconnect",
`This is a ${clc.red("breaking")} change and will cause a brief downtime.`,
`This is a ${clc.red("breaking")} change and may break existing apps.`,
);
}

Expand Down