Suggest DNS friendly service ids

CHANGELOG.md

@@ -1,2 +1,3 @@
 - Updated `cross-env` and `cross-spawn` dependencies to avoid vulnerable versions. (#7979)
 - Fixed an issue with the Data Connect emulator where `dataDir` and `--export` were relative to the current directory insead of `firebase.json`.
+- `init dataconnect` now suggests DNS compatible service IDs.

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

@@ -54,7 +54,7 @@
         expectEnsureSchemaGQL: false,
       },
       {
-        desc: "exiting project should use existing directory",
+        desc: "existing project should use existing directory",
         requiredInfo: mockRequiredInfo(),
         config: mockConfig({ dataconnect: { source: "not-dataconnect" } }),
         expectedSource: "not-dataconnect",
@@ -156,14 +156,49 @@
         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);
       });
     }
   });
+
+  describe("toDNSCompatibleId", () => {
+    const cases: { description: string; input: string; expected: string }[] = [
+      {
+        description: "Should noop compatible strings",
+        input: "this-is-compatible",
+        expected: "this-is-compatible",
+      },
+      {
+        description: "Should lower case",
+        input: "This-Is-Compatible",
+        expected: "this-is-compatible",
+      },
+      {
+        description: "Should strip special characters",
+        input: "this-is-compatible?~!@#$%^&*()_+=",
+        expected: "this-is-compatible",
+      },
+      {
+        description: "Should strip trailing and leading -",
+        input: "---this-is-compatible---",
+        expected: "this-is-compatible",
+      },
+      {
+        description: "Should cut to 63 characters",
+        input: "a".repeat(1000),
+        expected: "a".repeat(63),
+      },
+    ];
+    for (const c of cases) {
+      it(c.description, () => {
+        expect(init.toDNSCompatibleId(c.input)).to.equal(c.expected);
+      });
+    }
+  });
 });
 
 function mockConfig(data: Record<string, any> = {}): Config {
   return new Config(data, {});
 }
 function mockRequiredInfo(info: Partial<init.RequiredInfo> = {}): init.RequiredInfo {

src/init/features/dataconnect/index.ts

@@ -70,7 +70,7 @@
 const defaultSchema = { path: "schema.gql", content: SCHEMA_TEMPLATE };
 
 // doSetup is split into 2 phases - ask questions and then actuate files and API calls based on those answers.
 export async function doSetup(setup: Setup, config: Config): Promise<void> {
   const isBillingEnabled = setup.projectId ? await checkBillingEnabled(setup.projectId) : false;
   if (setup.projectId) {
     isBillingEnabled ? await ensureApis(setup.projectId) : await ensureSparkApis(setup.projectId);
@@ -78,8 +78,8 @@
   const info = await askQuestions(setup, isBillingEnabled);
   // Most users will want to perist data between emulator runs, so set this to a reasonable default.
 
   const dir: string = config.get("dataconnect.source", "dataconnect");
   const dataDir = config.get("emulators.dataconnect.dataDir", `${dir}/.dataconnect/pgliteData`);
   config.set("emulators.dataconnect.dataDir", dataDir);
   await actuate(setup, config, info);
 
@@ -141,7 +141,9 @@
       }))
     );
   } else {
-    info.serviceId = info.serviceId || basename(process.cwd());
+    // Ensure that the suggested name is DNS compatible
+    const defaultServiceId = toDNSCompatibleId(basename(process.cwd()));
+    info.serviceId = info.serviceId || defaultServiceId;
     info.cloudSqlInstanceId = info.cloudSqlInstanceId || `${info.serviceId || "app"}-fdc`;
     info.locationId = info.locationId || `us-central1`;
     info.cloudSqlDatabase = info.cloudSqlDatabase || `fdcdb`;
@@ -151,7 +153,7 @@
 
 // actuate writes product specific files and makes product specifc API calls.
 // It does not handle writing firebase.json and .firebaserc
 export async function actuate(setup: Setup, config: Config, info: RequiredInfo) {
   await writeFiles(config, info);
 
   if (setup.projectId && info.shouldProvisionCSQL) {
@@ -160,15 +162,15 @@
       locationId: info.locationId,
       instanceId: info.cloudSqlInstanceId,
       databaseId: info.cloudSqlDatabase,
       configYamlPath: join(config.get("dataconnect.source"), "dataconnect.yaml"),
       enableGoogleMlIntegration: false,
       waitForCreation: false,
     });
   }
 }
 
 async function writeFiles(config: Config, info: RequiredInfo) {
   const dir: string = config.get("dataconnect.source") || "dataconnect";
   const subbedDataconnectYaml = subDataconnectYamlValues({
     ...info,
     connectorDirs: info.connectors.map((c) => c.path),
@@ -447,3 +449,20 @@
     ];
   }
 }
+
+/**
+ * Converts any string to a DNS friendly service ID.
+ */
+export function toDNSCompatibleId(id: string): string {
+  let defaultServiceId = basename(id)
+    .toLowerCase()
+    .replaceAll(/[^a-z0-9-]/g, "")
+    .slice(0, 63);
+  while (defaultServiceId.endsWith("-") && defaultServiceId.length) {
+    defaultServiceId = defaultServiceId.slice(0, defaultServiceId.length - 1);
+  }
+  while (defaultServiceId.startsWith("-") && defaultServiceId.length) {
+    defaultServiceId = defaultServiceId.slice(1, defaultServiceId.length);
+  }
+  return defaultServiceId || "app";
+}