Fixing init dataconnect on some empty schema cases

CHANGELOG.md

@@ -1,2 +1,3 @@
 - Changes default CF3 runtime to nodejs22 (#8037)
 - Fixed an issue where `--import` would error for the Data Connect emulator if `dataDir` was also set.
+- Fixed an issue where `firebase init dataconnect` errored when importing a schema with no GQL files.

src/dataconnect/fileUtils.ts

@@ -8,19 +8,19 @@
 import { DataConnectMultiple } from "../firebaseConfig";
 import { load } from "./load";
 
 export function readFirebaseJson(config?: Config): DataConnectMultiple {
   if (!config?.has("dataconnect")) {
     return [];
   }
   const validator = (cfg: any) => {
     if (!cfg["source"]) {
       throw new FirebaseError("Invalid firebase.json: DataConnect requires `source`");
     }
     return {
       source: cfg["source"],
     };
   };
   const configs = config.get("dataconnect");
   if (typeof configs === "object" && !Array.isArray(configs)) {
     return [validator(configs)];
   } else if (Array.isArray(configs)) {
@@ -32,13 +32,13 @@
   }
 }
 
 export async function readDataConnectYaml(sourceDirectory: string): Promise<DataConnectYaml> {
   const file = await readFileFromDirectory(sourceDirectory, "dataconnect.yaml");
   const dataconnectYaml = await wrappedSafeLoad(file.source);
   return validateDataConnectYaml(dataconnectYaml);
 }
 
 function validateDataConnectYaml(unvalidated: any): DataConnectYaml {
   // TODO: Use json schema for validation here!
   if (!unvalidated["location"]) {
     throw new FirebaseError("Missing required field 'location' in dataconnect.yaml");
@@ -58,6 +58,9 @@
 }
 
 export async function readGQLFiles(sourceDir: string): Promise<File[]> {
+  if (!fs.existsSync(sourceDir)) {
+    return [];
+  }
   const files = await fs.readdir(sourceDir);
   // TODO: Handle files in subdirectories such as `foo/a.gql` and `bar/baz/b.gql`.
   return files

src/init/features/dataconnect/index.spec.ts

@@ -1,5 +1,6 @@
 import * as sinon from "sinon";
 import { expect } from "chai";
+import * as fs from "fs-extra";
 
 import * as init from "./index";
 import { Config } from "../../../config";
@@ -17,9 +18,11 @@ describe("init dataconnect", () => {
     const sandbox = sinon.createSandbox();
     let provisionCSQLStub: sinon.SinonStub;
     let askWriteProjectFileStub: sinon.SinonStub;
+    let ensureSyncStub: sinon.SinonStub;
 
     beforeEach(() => {
       provisionCSQLStub = sandbox.stub(provison, "provisionCloudSql");
+      ensureSyncStub = sandbox.stub(fs, "ensureFileSync");
     });
 
     afterEach(() => {
@@ -33,6 +36,7 @@ describe("init dataconnect", () => {
       expectedSource: string;
       expectedFiles: string[];
       expectCSQLProvisioning: boolean;
+      expectEnsureSchemaGQL: boolean;
     }[] = [
       {
         desc: "empty project should generate template",
@@ -47,6 +51,7 @@ describe("init dataconnect", () => {
           "dataconnect/connector/mutations.gql",
         ],
         expectCSQLProvisioning: false,
+        expectEnsureSchemaGQL: false,
       },
       {
         desc: "exiting project should use existing directory",
@@ -55,6 +60,7 @@ describe("init dataconnect", () => {
         expectedSource: "not-dataconnect",
         expectedFiles: ["not-dataconnect/dataconnect.yaml"],
         expectCSQLProvisioning: false,
+        expectEnsureSchemaGQL: false,
       },
       {
         desc: "should write schema files",
@@ -70,6 +76,7 @@ describe("init dataconnect", () => {
         expectedSource: "dataconnect",
         expectedFiles: ["dataconnect/dataconnect.yaml", "dataconnect/schema/schema.gql"],
         expectCSQLProvisioning: false,
+        expectEnsureSchemaGQL: false,
       },
       {
         desc: "should write connector files",
@@ -95,6 +102,7 @@ describe("init dataconnect", () => {
           "dataconnect/hello/queries.gql",
         ],
         expectCSQLProvisioning: false,
+        expectEnsureSchemaGQL: false,
       },
       {
         desc: "should provision cloudSQL resources ",
@@ -111,6 +119,22 @@ describe("init dataconnect", () => {
           "dataconnect/connector/mutations.gql",
         ],
         expectCSQLProvisioning: true,
+        expectEnsureSchemaGQL: false,
+      },
+      {
+        desc: "should handle schema with no files",
+        requiredInfo: mockRequiredInfo({
+          schemaGql: [],
+        }),
+        config: mockConfig({
+          dataconnect: {
+            source: "dataconnect",
+          },
+        }),
+        expectedSource: "dataconnect",
+        expectedFiles: ["dataconnect/dataconnect.yaml"],
+        expectCSQLProvisioning: false,
+        expectEnsureSchemaGQL: true,
       },
     ];
 
@@ -129,6 +153,9 @@ describe("init dataconnect", () => {
           c.requiredInfo,
         );
         expect(c.config.get("dataconnect.source")).to.equal(c.expectedSource);
+        if (c.expectEnsureSchemaGQL) {
+          expect(ensureSyncStub).to.have.been.calledWith("dataconnect/schema/schema.gql");
+        }
         expect(askWriteProjectFileStub.args.map((a) => a[0])).to.deep.equal(c.expectedFiles);
         expect(provisionCSQLStub.called).to.equal(c.expectCSQLProvisioning);
       });

src/init/features/dataconnect/index.ts

@@ -1,5 +1,6 @@
 import { join, basename } from "path";
 import * as clc from "colorette";
+import * as fs from "fs-extra";
 
 import { confirm, promptOnce } from "../../../prompt";
 import { Config } from "../../../config";
@@ -196,7 +197,11 @@ async function writeFiles(config: Config, info: RequiredInfo) {
     for (const f of info.schemaGql) {
       await config.askWriteProjectFile(join(dir, "schema", f.path), f.content);
     }
+  } else {
+    // Even if the schema is empty, lets give them an empty .gql file to get started.
+    fs.ensureFileSync(join(dir, "schema", "schema.gql"));
   }
+
   for (const c of info.connectors) {
     await writeConnectorFiles(config, c);
   }