[FDC] Generate schema during init dataconnect flow

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Fixed multi tenancy support for SSO users in the auth emulator (#8544)
 - Add SDK autoinit capabilities to App Hosting emulator. (#8582)
 - Provision App Hosting compute service account during init flow. (#8580)
+- `firebase init dataconnect` is now integrated with Gemini in Firebase API to generate Schema based on description. (#8596)
 - Updated the Firebase Data Connect local toolkit to v2.6.1, which includes the following changes: (#8598)
   - Fixed a bug where `@transaction` continued to execute after errors and produces more confusing errors.
   - Fixed a bug where rolled-back fields in `@transaction` returned bogus data that had been invalidated by the rollback. They now correctly return null with a corresponding error "(rolled back)".

src/api.ts

@@ -5,32 +5,32 @@
 
 let commandScopes = new Set<string>();
 
 export const authProxyOrigin = () =>
   utils.envOverride("FIREBASE_AUTHPROXY_URL", "https://auth.firebase.tools");
 // "In this context, the client secret is obviously not treated as a secret"
 // https://developers.google.com/identity/protocols/OAuth2InstalledApp
 export const clientId = () =>
   utils.envOverride(
     "FIREBASE_CLIENT_ID",
     "563584335869-fgrhgmd47bqnekij5i8b5pr03ho849e6.apps.googleusercontent.com",
   );
 export const clientSecret = () =>
   utils.envOverride("FIREBASE_CLIENT_SECRET", "j9iVZfS8kkCEFUPaAeJV0sAi");
 export const cloudbillingOrigin = () =>
   utils.envOverride("FIREBASE_CLOUDBILLING_URL", "https://cloudbilling.googleapis.com");
 export const cloudloggingOrigin = () =>
   utils.envOverride("FIREBASE_CLOUDLOGGING_URL", "https://logging.googleapis.com");
 export const cloudMonitoringOrigin = () =>
   utils.envOverride("CLOUD_MONITORING_URL", "https://monitoring.googleapis.com");
 export const containerRegistryDomain = () =>
   utils.envOverride("CONTAINER_REGISTRY_DOMAIN", "gcr.io");
 
 export const developerConnectOrigin = () =>
   utils.envOverride("DEVELOPERCONNECT_URL", "https://developerconnect.googleapis.com");
 export const developerConnectP4SADomain = () =>
   utils.envOverride("DEVELOPERCONNECT_P4SA_DOMAIN", "gcp-sa-devconnect.iam.gserviceaccount.com");
 
 export const artifactRegistryDomain = () =>
   utils.envOverride("ARTIFACT_REGISTRY_DOMAIN", "https://artifactregistry.googleapis.com");
 export const appDistributionOrigin = () =>
   utils.envOverride(
@@ -91,8 +91,6 @@
 
 export const cloudbuildOrigin = () =>
   utils.envOverride("FIREBASE_CLOUDBUILD_URL", "https://cloudbuild.googleapis.com");
-export const cloudCompanionOrigin = () =>
-  utils.envOverride("CLOUD_COMPANION_URL", "https://cloudaicompanion.googleapis.com");
 export const cloudschedulerOrigin = () =>
   utils.envOverride("FIREBASE_CLOUDSCHEDULER_URL", "https://cloudscheduler.googleapis.com");
 export const cloudTasksOrigin = () =>

src/dataconnect/ensureApis.ts

@@ -1,15 +1,19 @@
 import * as api from "../api";
 import { ensure } from "../ensureApiEnabled";
 
+const prefix = "dataconnect";
+
 export async function ensureApis(projectId: string): Promise<void> {
-  const prefix = "dataconnect";
   await ensure(projectId, api.dataconnectOrigin(), prefix);
   await ensure(projectId, api.cloudSQLAdminOrigin(), prefix);
   await ensure(projectId, api.computeOrigin(), prefix);
 }
 
 export async function ensureSparkApis(projectId: string): Promise<void> {
-  const prefix = "dataconnect";
   // These are the APIs that can be enabled without a billing account.
   await ensure(projectId, api.cloudSQLAdminOrigin(), prefix);
 }
+
+export async function ensureGIFApis(projectId: string): Promise<void> {
+  await ensure(projectId, api.cloudAiCompanionOrigin(), prefix);
+}

src/gif/fdcExperience.spec.ts

@@ -0,0 +1,67 @@
+import { expect } from "chai";
+import { extractCodeBlock } from "./fdcExperience";
+
+describe("extractCodeBlock", () => {
+  it("should extract a basic GraphQL query block", () => {
+    const text =
+      'Here is a GraphQL query:\n```graphql\nquery GetUser { user(id: "1") { name email } }\n```\nThanks!';
+    const expected = 'query GetUser { user(id: "1") { name email } }';
+    expect(extractCodeBlock(text)).to.eq(expected);
+  });
+
+  it("should extract a multi-line GraphQL mutation block", () => {
+    const text = `
+    Some preamble.
+    \`\`\`graphql
+    mutation CreatePost($title: String!, $content: String!) {
+      createPost(title: $title, content: $content) {
+        id
+        title
+      }
+    }
+    \`\`\`
+    Followed by some description.
+    `;
+    const expected = `mutation CreatePost($title: String!, $content: String!) {
+      createPost(title: $title, content: $content) {
+        id
+        title
+      }
+    }`;
+    expect(extractCodeBlock(text)).to.eq(expected);
+  });
+
+  it("should extract a GraphQL fragment block", () => {
+    const text = "```graphql\nfragment UserFields on User { id name }\n```";
+    const expected = "fragment UserFields on User { id name }";
+    expect(extractCodeBlock(text)).to.eq(expected);
+  });
+
+  it("should extract an empty GraphQL code block", () => {
+    const text = "```graphql\n\n```";
+    const expected = "";
+    expect(extractCodeBlock(text)).to.eq(expected);
+  });
+
+  it("should extract a GraphQL schema definition block", () => {
+    const text = `
+    \`\`\`graphql
+    type Query {
+      hello: String
+    }
+
+    schema {
+      query: Query
+    }
+    \`\`\`
+    `;
+    const expected = `type Query {
+      hello: String
+    }
+
+    schema {
+      query: Query
+    }`;
+    expect(extractCodeBlock(text)).to.eq(expected);
+  });
+});

src/gif/fdcExperience.ts

@@ -1,7 +1,8 @@
 import { Client } from "../apiv2";
-import { cloudCompanionOrigin } from "../api";
+import { cloudAiCompanionOrigin } from "../api";
+import { FirebaseError } from "../error";
 
-const apiClient = new Client({ urlPrefix: cloudCompanionOrigin(), auth: true });
+const apiClient = new Client({ urlPrefix: cloudAiCompanionOrigin(), auth: true });
 const schemaGeneratorExperience = "/appeco/firebase/fdc-schema-generator";
 const geminiInFirebaseChatExperience = "/appeco/firebase/firebase-chat/free";
 const operationGeneratorExperience = "/appeco/firebase/fdc-query-generator";
@@ -128,3 +129,17 @@ export async function generateOperation(
   );
   return res.body.output.messages[0].content;
 }
+
+/**
+ * extractCodeBlock extracts the code block from the generated response.
+ * @param text the generated response from the service.
+ * @return the code block from the generated response.
+ */
+export function extractCodeBlock(text: string): string {
+  const regex = /```(?:[a-z]+\n)?([\s\S]*?)```/m;
+  const match = text.match(regex);
+  if (match && match[1]) {
+    return match[1].trim();
+  }
+  throw new FirebaseError(`No code block found in the generated response: ${text}`);
+}

src/init/features/dataconnect/index.ts

@@ -8,7 +8,7 @@ import { Setup } from "../..";
 import { provisionCloudSql } from "../../../dataconnect/provisionCloudSql";
 import { checkFreeTrialInstanceUsed, upgradeInstructions } from "../../../dataconnect/freeTrial";
 import * as cloudsql from "../../../gcp/cloudsql/cloudsqladmin";
-import { ensureApis, ensureSparkApis } from "../../../dataconnect/ensureApis";
+import { ensureApis, ensureGIFApis, ensureSparkApis } from "../../../dataconnect/ensureApis";
 import {
   listLocations,
   listAllServices,
@@ -19,10 +19,11 @@ import { Schema, Service, File, Platform } from "../../../dataconnect/types";
 import { parseCloudSQLInstanceName, parseServiceName } from "../../../dataconnect/names";
 import { logger } from "../../../logger";
 import { readTemplateSync } from "../../../templates";
-import { logBullet, envOverride } from "../../../utils";
+import { logBullet, envOverride, promiseWithSpinner } from "../../../utils";
 import { isBillingEnabled } from "../../../gcp/cloudbilling";
 import * as sdk from "./sdk";
 import { getPlatformFromFolder } from "../../../dataconnect/fileUtils";
+import { extractCodeBlock, generateSchema } from "../../../gif/fdcExperience";
 
 const DATACONNECT_YAML_TEMPLATE = readTemplateSync("init/dataconnect/dataconnect.yaml");
 const CONNECTOR_YAML_TEMPLATE = readTemplateSync("init/dataconnect/connector.yaml");
@@ -110,8 +111,7 @@ export async function askQuestions(setup: Setup): Promise<void> {
       default: true,
     }));
   if (shouldConfigureBackend) {
-    // TODO: Prompt for app idea and use GiF backend to generate them.
-    info = await promptForService(info);
+    info = await promptForSchema(setup, info);
     info = await promptForCloudSQL(setup, info);
 
     info.shouldProvisionCSQL = !!(
@@ -425,12 +425,34 @@ async function promptForCloudSQL(setup: Setup, info: RequiredInfo): Promise<Requ
   return info;
 }
 
-async function promptForService(info: RequiredInfo): Promise<RequiredInfo> {
+async function promptForSchema(setup: Setup, info: RequiredInfo): Promise<RequiredInfo> {
   if (info.serviceId === "") {
     info.serviceId = await input({
       message: "What ID would you like to use for this service?",
       default: basename(process.cwd()),
     });
+    if (
+      setup.projectId &&
+      (await confirm({
+        message: `Do you want Gemini to help generate a schema for your service?`,
+        default: false,
+      }))
+    ) {
+      logBullet(
+        `Check out the terms of service of Gemini in Firebase https://firebase.google.com/docs/gemini-in-firebase/set-up-gemini#required-permissions`,
+      );
+      await ensureGIFApis(setup.projectId);
+      const prompt = await input({
+        message: "Describe the app you are building:",
+        default: "movie rating app",
+      });
+      const schema = await promiseWithSpinner(
+        () => generateSchema(prompt, setup.projectId!),
+        "Generating the Data Connect Schema...",
+      );
+      info.schemaGql = [{ path: "schema.gql", content: extractCodeBlock(schema) }];
+      info.connectors = [emptyConnector];
+    }
   }
   return info;
 }