feat: Make PostgreSql#database and PostgreSql#cloudSql optional (#8989)

* feat: Make PostgreSql#database and PostgreSql#cloudSql optional

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

Author: google-labs-jules[bot]

src/commands/dataconnect-services-list.ts

@@ -40,7 +40,7 @@ export const command = new Command("dataconnect:services:list")
       const connectors = await client.listConnectors(service.name);
       const serviceName = names.parseServiceName(service.name);
       const postgresDatasource = schema?.datasources.find((d) => d.postgresql);
-      const instanceName = postgresDatasource?.postgresql?.cloudSql.instance ?? "";
+      const instanceName = postgresDatasource?.postgresql?.cloudSql?.instance ?? "";
       const instanceId = instanceName.split("/").pop();
       const dbId = postgresDatasource?.postgresql?.database ?? "";
       const dbName = `CloudSQL Instance: ${instanceId}\nDatabase: ${dbId}`;

src/dataconnect/schemaMigration.ts

@@ -342,12 +342,14 @@ export function getIdentifiers(schema: Schema): {
   const postgresDatasource = schema.datasources.find((d) => d.postgresql);
   const databaseId = postgresDatasource?.postgresql?.database;
   if (!databaseId) {
-    throw new FirebaseError("Service does not have a postgres datasource, cannot migrate");
+    throw new FirebaseError(
+      "Data Connect schema must have a postgres datasource with a database name.",
+    );
   }
-  const instanceName = postgresDatasource?.postgresql?.cloudSql.instance;
+  const instanceName = postgresDatasource?.postgresql?.cloudSql?.instance;
   if (!instanceName) {
     throw new FirebaseError(
-      "tried to migrate schema but instance name was not provided in dataconnect.yaml",
+      "Data Connect schema must have a postgres datasource with a CloudSQL instance.",
     );
   }
   const instanceId = instanceName.split("/").pop()!;
@@ -611,10 +613,10 @@ export async function ensureServiceIsConnectedToCloudSql(
 
   const postgresDatasource = currentSchema.datasources.find((d) => d.postgresql);
   const postgresql = postgresDatasource?.postgresql;
-  if (postgresql?.cloudSql.instance !== instanceId) {
+  if (postgresql?.cloudSql?.instance !== instanceId) {
     logLabeledWarning(
       "dataconnect",
-      `Switching connected Cloud SQL instance\nFrom ${postgresql?.cloudSql.instance}\nTo ${instanceId}`,
+      `Switching connected Cloud SQL instance\nFrom ${postgresql?.cloudSql?.instance}\nTo ${instanceId}`,
     );
   }
   if (postgresql?.database !== databaseId) {

src/dataconnect/types.ts

@@ -32,8 +32,8 @@ export interface Datasource {
 export type SchemaValidation = "STRICT" | "COMPATIBLE";
 
 export interface PostgreSql {
-  database: string;
-  cloudSql: CloudSqlInstance;
+  database?: string;
+  cloudSql?: CloudSqlInstance;
   schemaValidation?: SchemaValidation | "NONE" | "SQL_SCHEMA_VALIDATION_UNSPECIFIED";
 }
 

src/deploy/dataconnect/deploy.ts

@@ -85,7 +85,7 @@ export default async function (
       .map(async (s) => {
         const postgresDatasource = s.schema.datasources.find((d) => d.postgresql);
         if (postgresDatasource) {
-          const instanceId = postgresDatasource.postgresql?.cloudSql.instance.split("/").pop();
+          const instanceId = postgresDatasource.postgresql?.cloudSql?.instance.split("/").pop();
           const databaseId = postgresDatasource.postgresql?.database;
           if (!instanceId || !databaseId) {
             return Promise.resolve();

src/deploy/dataconnect/prepare.ts

@@ -81,7 +81,7 @@ export default async function (context: any, options: DeployOptions): Promise<vo
         .map(async (s) => {
           const postgresDatasource = s.schema.datasources.find((d) => d.postgresql);
           if (postgresDatasource) {
-            const instanceId = postgresDatasource.postgresql?.cloudSql.instance.split("/").pop();
+            const instanceId = postgresDatasource.postgresql?.cloudSql?.instance.split("/").pop();
             const databaseId = postgresDatasource.postgresql?.database;
             if (!instanceId || !databaseId) {
               return Promise.resolve();

src/init/features/dataconnect/index.ts

@@ -281,7 +281,7 @@ async function promptForExistingServices(setup: Setup, info: RequiredInfo): Prom
       info.connectors = [emptyConnector];
       if (choice.schema) {
         const primaryDatasource = choice.schema.datasources.find((d) => d.postgresql);
-        if (primaryDatasource?.postgresql?.cloudSql.instance) {
+        if (primaryDatasource?.postgresql?.cloudSql?.instance) {
           const instanceName = parseCloudSQLInstanceName(
             primaryDatasource.postgresql.cloudSql.instance,
           );