[FDC] Deploy should provision Cloud SQL async #9004

fredzqm · 2025-08-20T01:15:48Z

Description

firebase deploy will no longer hang due to Cloud SQL provision delay.

Similar to Firebase console, it would save the Cloud SQL metadata in FDC Schema, then starts a UpdateSchema(MIGRATE_COMPATIBLE) LRO to wait for Cloud SQL creation and setup SQL schema afterwards.

During the Cloud SQL provision window, firebase deploy would fail because there is a blocking LRO on Schema. That's expected. During that period, customers can still use the ephermeral database to prototype.

`firebase init dataconnect`

`firebase deploy` right after that

Update dataconnect.yaml and then run `firebase deploy`

`firebase deploy` Again

gemini-code-assist

Summary of Changes

Hello @fredzqm, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces significant improvements to the Firebase Data Connect deployment process, primarily by making Cloud SQL instance and database provisioning asynchronous. This change allows deployments to proceed more quickly, providing immediate feedback to the user while the Cloud SQL resources are being set up in the background, with data temporarily stored until the instance is ready. Beyond this core enhancement, the PR includes refactorings to simplify IAM user setup, clarifies logging messages during schema migrations, and refines deployment confirmation prompts for better user control and safety.

Highlights

Asynchronous Cloud SQL Provisioning: Cloud SQL instance and database creation during deployment are now asynchronous, allowing the deployment process to continue without waiting for these long-running operations to complete.
Simplified IAM User Setup: The setupIAMUsers function has been refactored to no longer require the databaseId parameter, streamlining its usage across the codebase.
Enhanced Schema Migration Logging: Logging messages related to schema generation and compatibility checks have been updated for improved clarity and user feedback.
Improved Cloud SQL Connection Management: The logic for ensuring service connectivity to Cloud SQL instances has been made more robust, including better handling of instance/database switching and the introduction of an ephemeral property for PostgreSQL datasources.
Refined Deployment Prompts: The confirmation prompt for deleting services not present in firebase.json has been adjusted, explicitly setting the force option to false and adding a default false response, preventing accidental deletions.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request refactors the Cloud SQL provisioning process to be asynchronous, which is a significant improvement for the user experience during deployment. The code is generally well-structured, with logic broken down into smaller, more manageable functions. I've identified a potential bug in the schema migration logic and an opportunity to refactor some duplicated code for better maintainability. My detailed feedback is in the comments below.

src/dataconnect/schemaMigration.ts

src/dataconnect/provisionCloudSql.ts

fredzqm · 2025-08-20T17:52:03Z

src/dataconnect/schemaMigration.ts

-  let diffs: Diff[] = [];
-
-  // Make sure database is setup.
-  await setupSchemaIfNecessary(instanceId, databaseId, options);


NOTE: This should never be here.

firebase dataconnect:sql:diff must not mutate SQL state, as it's a read-only command.

setupSchemaIfNecessary may update some SQL schema.

fredzqm · 2025-08-20T18:55:30Z

src/dataconnect/schemaMigration.ts

-      `Only users with 'roles/cloudsql.admin' can grant SQL roles. If you do not have this role, ask your database administrator to run this command or manually grant ${fdcSqlRole} to ${user}`,
-    );
-  }
+  await ensureServiceIsConnectedToCloudSql(


Added this so that dataconnect:sql:grant would error out quick if Cloud SQL is still being created.

fredzqm · 2025-08-20T18:58:31Z

src/gcp/cloudsql/permissionsSetup.ts

@@ -121,7 +120,6 @@ export async function setupSQLPermissions(
      `Missing required IAM permission to setup SQL schemas. SQL schema setup requires 'roles/cloudsql.admin' or an equivalent role.`,
    );
  }
-  await setupIAMUsers(instanceId, databaseId, options);


This was repetitive.

The caller is responsive to make sure IAM users are already setup.

It's used in two places, both with the same flow:

setupIAMUsers getSchemaMetadata setupSQLPermissions

joehan

LGTM with some minor changelog fixes

CHANGELOG.md

Co-authored-by: Joe Hanley <[email protected]>

fredzqm added 3 commits August 19, 2025 13:40

save

7040228

merge

f8be3f4

save

5d96cff

github-project-automation bot added this to [Cloud] Extensions + Functions Aug 20, 2025

gemini-code-assist bot reviewed Aug 20, 2025

View reviewed changes

src/dataconnect/schemaMigration.ts Outdated Show resolved Hide resolved

src/dataconnect/provisionCloudSql.ts Outdated Show resolved Hide resolved

working

7a0ced3

fredzqm requested a review from joehan August 20, 2025 02:37

fredzqm added 6 commits August 19, 2025 19:40

changelog

39d9024

tweaks

09454ae

Merge remote-tracking branch 'origin/master' into fz/fdc-deploy

4263d93

tweaks

4185376

error handling

cd4562c

Merge remote-tracking branch 'origin/master' into fz/fdc-deploy

a9bb354

fredzqm commented Aug 20, 2025

View reviewed changes

joehan approved these changes Aug 20, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

github-project-automation bot moved this to Approved [PR] in [Cloud] Extensions + Functions Aug 20, 2025

fredzqm and others added 3 commits August 20, 2025 12:58

Update CHANGELOG.md

5918e0c

Co-authored-by: Joe Hanley <[email protected]>

Update CHANGELOG.md

578f2c5

Co-authored-by: Joe Hanley <[email protected]>

Merge branch 'master' into fz/fdc-deploy

8857ecb

joehan enabled auto-merge (squash) August 20, 2025 21:01

Merge branch 'master' into fz/fdc-deploy

ee57e5b

joehan merged commit 785536e into master Aug 20, 2025
48 checks passed

joehan deleted the fz/fdc-deploy branch August 20, 2025 21:45

github-project-automation bot moved this from Approved [PR] to Done in [Cloud] Extensions + Functions Aug 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[FDC] Deploy should provision Cloud SQL async #9004

[FDC] Deploy should provision Cloud SQL async #9004

Uh oh!

fredzqm commented Aug 20, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

fredzqm Aug 20, 2025

Uh oh!

fredzqm Aug 20, 2025

Uh oh!

fredzqm Aug 20, 2025

Uh oh!

joehan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[FDC] Deploy should provision Cloud SQL async #9004

[FDC] Deploy should provision Cloud SQL async #9004

Uh oh!

Conversation

fredzqm commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

firebase init dataconnect

firebase deploy right after that

Update dataconnect.yaml and then run firebase deploy

firebase deploy Again

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

fredzqm Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

fredzqm Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

fredzqm Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

joehan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fredzqm commented Aug 20, 2025 •

edited

Loading

`firebase init dataconnect`

`firebase deploy` right after that

Update dataconnect.yaml and then run `firebase deploy`

`firebase deploy` Again