First pass at auto generating sdk configs

src/commands/apps-create.ts

@@ -1,5 +1,4 @@
 import * as clc from "colorette";
-import * as ora from "ora";
 
 import { Command } from "../command";
 import { needProjectId } from "../projectUtils";
@@ -8,44 +7,16 @@
   AndroidAppMetadata,
   AppMetadata,
   AppPlatform,
-  createAndroidApp,
-  createIosApp,
-  createWebApp,
   getAppPlatform,
   IosAppMetadata,
+  sdkInit,
   WebAppMetadata,
 } from "../management/apps";
-import { prompt, promptOnce, Question } from "../prompt";
+import { promptOnce } from "../prompt";
 import { requireAuth } from "../requireAuth";
 import { logger } from "../logger";
 
-const DISPLAY_NAME_QUESTION: Question = {
-  type: "input",
-  name: "displayName",
-  default: "",
-  message: "What would you like to call your app?",
-};
-
-interface CreateFirebaseAppOptions {
-  project: string;
-  nonInteractive: boolean;
-  displayName?: string;
-}
-
-interface CreateIosAppOptions extends CreateFirebaseAppOptions {
-  bundleId?: string;
-  appStoreId?: string;
-}
-
-interface CreateAndroidAppOptions extends CreateFirebaseAppOptions {
-  packageName: string;
-}
-
-interface CreateWebAppOptions extends CreateFirebaseAppOptions {
-  displayName: string;
-}
-
-function logPostAppCreationInformation(
+export function logPostAppCreationInformation(
   appMetadata: IosAppMetadata | AndroidAppMetadata | WebAppMetadata,
   appPlatform: AppPlatform,
 ): void {
@@ -72,93 +43,6 @@
   logger.info(`  firebase apps:sdkconfig ${appPlatform} ${appMetadata.appId}`);
 }
 
-async function initiateIosAppCreation(options: CreateIosAppOptions): Promise<IosAppMetadata> {
-  if (!options.nonInteractive) {
-    await prompt(options, [
-      DISPLAY_NAME_QUESTION,
-      {
-        type: "input",
-        default: "",
-        name: "bundleId",
-        message: "Please specify your iOS app bundle ID:",
-      },
-      {
-        type: "input",
-        default: "",
-        name: "appStoreId",
-        message: "Please specify your iOS app App Store ID:",
-      },
-    ]);
-  }
-  if (!options.bundleId) {
-    throw new FirebaseError("Bundle ID for iOS app cannot be empty");
-  }
-
-  const spinner = ora("Creating your iOS app").start();
-  try {
-    const appData = await createIosApp(options.project, {
-      displayName: options.displayName,
-      bundleId: options.bundleId,
-      appStoreId: options.appStoreId,
-    });
-    spinner.succeed();
-    return appData;
-  } catch (err: any) {
-    spinner.fail();
-    throw err;
-  }
-}
-
-async function initiateAndroidAppCreation(
-  options: CreateAndroidAppOptions,
-): Promise<AndroidAppMetadata> {
-  if (!options.nonInteractive) {
-    await prompt(options, [
-      DISPLAY_NAME_QUESTION,
-      {
-        type: "input",
-        default: "",
-        name: "packageName",
-        message: "Please specify your Android app package name:",
-      },
-    ]);
-  }
-  if (!options.packageName) {
-    throw new FirebaseError("Package name for Android app cannot be empty");
-  }
-
-  const spinner = ora("Creating your Android app").start();
-  try {
-    const appData = await createAndroidApp(options.project, {
-      displayName: options.displayName,
-      packageName: options.packageName,
-    });
-    spinner.succeed();
-    return appData;
-  } catch (err: any) {
-    spinner.fail();
-    throw err;
-  }
-}
-
-async function initiateWebAppCreation(options: CreateWebAppOptions): Promise<WebAppMetadata> {
-  if (!options.nonInteractive) {
-    await prompt(options, [DISPLAY_NAME_QUESTION]);
-  }
-  if (!options.displayName) {
-    throw new FirebaseError("Display name for Web app cannot be empty");
-  }
-  const spinner = ora("Creating your Web app").start();
-  try {
-    const appData = await createWebApp(options.project, { displayName: options.displayName });
-    spinner.succeed();
-    return appData;
-  } catch (err: any) {
-    spinner.fail();
-    throw err;
-  }
-}
-
 export const command = new Command("apps:create [platform] [displayName]")
   .description(
     "create a new Firebase app. [platform] can be IOS, ANDROID or WEB (case insensitive).",
@@ -169,14 +53,14 @@
   .before(requireAuth)
   .action(
     async (
       platform: string = "",
       displayName: string | undefined,
       options: any,
     ): Promise<AppMetadata> => {
       const projectId = needProjectId(options);
 
       if (!options.nonInteractive && !platform) {
         platform = await promptOnce({
           type: "list",
           message: "Please choose the platform of the app:",
           choices: [
@@ -193,22 +77,8 @@
       }
 
       logger.info(`Create your ${appPlatform} app in project ${clc.bold(projectId)}:`);
       options.displayName = displayName; // add displayName into options to pass into prompt function
-      let appData;
-      switch (appPlatform) {
-        case AppPlatform.IOS:
-          appData = await initiateIosAppCreation(options);
-          break;
-        case AppPlatform.ANDROID:
-          appData = await initiateAndroidAppCreation(options);
-          break;
-        case AppPlatform.WEB:
-          appData = await initiateWebAppCreation(options);
-          break;
-        default:
-          throw new FirebaseError("Unexpected error. This should not happen");
-      }
-
+      const appData = await sdkInit(appPlatform, options);
       logPostAppCreationInformation(appData, appPlatform);
       return appData;
     },

src/commands/apps-sdkconfig.ts

@@ -1,56 +1,24 @@
-import * as ora from "ora";
 import * as fs from "fs-extra";
 
 import { Command } from "../command";
 import {
-  AppConfigurationData,
-  AppMetadata,
+  AppConfig,
   AppPlatform,
-  getAppConfig,
   getAppConfigFile,
   getAppPlatform,
-  listFirebaseApps,
+  getPlatform,
+  getSdkConfig,
+  getSdkOutputPath,
+  sdkInit,
+  writeConfigToFile,
 } from "../management/apps";
-import { needProjectId } from "../projectUtils";
-import { getOrPromptProject } from "../management/projects";
-import { FirebaseError } from "../error";
 import { requireAuth } from "../requireAuth";
 import { logger } from "../logger";
-import { promptOnce } from "../prompt";
 import { Options } from "../options";
+import * as path from "path";
 
-function checkForApps(apps: AppMetadata[], appPlatform: AppPlatform): void {
-  if (!apps.length) {
-    throw new FirebaseError(
-      `There are no ${appPlatform === AppPlatform.ANY ? "" : appPlatform + " "}apps ` +
-        "associated with this Firebase project",
-    );
-  }
-}
-
-async function selectAppInteractively(
-  apps: AppMetadata[],
-  appPlatform: AppPlatform,
-): Promise<AppMetadata> {
-  checkForApps(apps, appPlatform);
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const choices = apps.map((app: any) => {
-    return {
-      name:
-        `${app.displayName || app.bundleId || app.packageName}` +
-        ` - ${app.appId} (${app.platform})`,
-      value: app,
-    };
-  });
-
-  return await promptOnce({
-    type: "list",
-    message:
-      `Select the ${appPlatform === AppPlatform.ANY ? "" : appPlatform + " "}` +
-      "app to get the configuration data:",
-    choices,
-  });
+interface AppsSdkConfigOptions extends Options {
+  out?: string | boolean;
 }
 
 export const command = new Command("apps:sdkconfig [platform] [appId]")
@@ -59,79 +27,66 @@
       "[platform] can be IOS, ANDROID or WEB (case insensitive)",
   )
   .option("-o, --out [file]", "(optional) write config output to a file")
+  // Note: Command behaves weirdly with optional string flags - when `--out`, options.out is a boolean
+  // but when `--out myFile.json`, options.out is a string
   .before(requireAuth)
-  .action(async (platform = "", appId = "", options: Options): Promise<AppConfigurationData> => {
-    let appPlatform = getAppPlatform(platform);
-
-    if (!appId) {
-      let projectId = needProjectId(options);
-      if (options.nonInteractive && !projectId) {
-        throw new FirebaseError("Must supply app and project ids in non-interactive mode.");
-      } else if (!projectId) {
-        const result = await getOrPromptProject(options);
-        projectId = result.projectId;
+  .action(
+    async (
+      platform: AppPlatform = AppPlatform.PLATFORM_UNSPECIFIED,
+      appId = "",
+      options: AppsSdkConfigOptions,
+    ): Promise<AppConfig> => {
+      const config = options.config;
+      const appDir = process.cwd();
+      if (!platform) {
+        // Auto-detect platform based on current directory if not specified
+        platform = await getPlatform(appDir, config);
       }
 
-      const apps = await listFirebaseApps(projectId, appPlatform);
-      // Fail out early if there's no apps.
-      checkForApps(apps, appPlatform);
-      // if there's only one app, we don't need to prompt interactively
-      if (apps.length === 1) {
-        // If there's only one, use it.
-        appId = apps[0].appId;
-        appPlatform = apps[0].platform;
-      } else if (options.nonInteractive) {
-        // If there's > 1 and we're non-interactive, fail.
-        throw new FirebaseError(`Project ${projectId} has multiple apps, must specify an app id.`);
-      } else {
-        // > 1, ask what the user wants.
-        const appMetadata: AppMetadata = await selectAppInteractively(apps, appPlatform);
-        appId = appMetadata.appId;
-        appPlatform = appMetadata.platform;
+      let sdkConfig: AppConfig | undefined;
+      while (sdkConfig === undefined) {
+        try {
+          sdkConfig = await getSdkConfig(options, getAppPlatform(platform), appId);
+        } catch (e) {
+          if ((e as Error).message.includes("associated with this Firebase project")) {
+            await sdkInit(platform as unknown as AppPlatform, options);
+          } else {
+            throw e;
+          }
+        }
       }
-    }
 
-    let configData;
-    const spinner = ora(
-      `Downloading configuration data of your Firebase ${appPlatform} app`,
-    ).start();
-    try {
-      configData = await getAppConfig(appId, appPlatform);
-    } catch (err: any) {
-      spinner.fail();
-      throw err;
-    }
-    spinner.succeed();
-
-    const fileInfo = getAppConfigFile(configData, appPlatform);
-    if (appPlatform === AppPlatform.WEB) {
-      fileInfo.sdkConfig = configData;
-    }
-
-    if (options.out === undefined) {
-      logger.info(fileInfo.fileContents);
-      return fileInfo;
-    }
-
-    const shouldUseDefaultFilename = options.out === true || options.out === "";
-    const filename = shouldUseDefaultFilename ? configData.fileName : options.out;
-    if (fs.existsSync(filename)) {
-      if (options.nonInteractive) {
-        throw new FirebaseError(`${filename} already exists`);
+      let writeToFile = false;
+      let outputPath: string = "";
+      if (typeof options.out === "boolean") {
+        writeToFile = options.out;
+        outputPath = getSdkOutputPath(appDir, platform);
+      } else if (typeof options.out === "string") {
+        writeToFile = true;
+        outputPath = options.out;
       }
-      const overwrite = await promptOnce({
-        type: "confirm",
-        default: false,
-        message: `${filename} already exists. Do you want to overwrite?`,
-      });
 
-      if (!overwrite) {
-        return configData;
+      if (writeToFile) {
+        const outputDir = path.dirname(outputPath!);
+        fs.mkdirpSync(outputDir);
+        const fileInfo = getAppConfigFile(sdkConfig, platform);
+        await writeConfigToFile(outputPath!, options.nonInteractive, fileInfo.fileContents);
+        if (platform === AppPlatform.WEB) {
+          logger.info(`
+        How to use your JS SDK Config:
+        ES Module:
+        import { initializeApp } from 'firebase/app';
+        import json from './firebase-js-config.json';
+        initializeApp(json);
+        // CommonJS Module:
+        const { initializeApp } = require('firebase/app');
+        const json = require('./firebase-js-config.json');
+        initializeApp(json);// instead of initializeApp(config);
+        `);
+        }
+        logger.info(`App configuration is written in ${fileInfo}`);
       }
-    }
-
-    fs.writeFileSync(filename, fileInfo.fileContents);
-    logger.info(`App configuration is written in ${filename}`);
 
-    return configData;
-  });
+      return sdkConfig;
+    },
+  );

src/dataconnect/fileUtils.ts

@@ -110,6 +110,7 @@ export async function pickService(
 // case insensitive exact match indicators for supported app platforms
 const WEB_INDICATORS = ["package.json", "package-lock.json", "node_modules"];
 const IOS_INDICATORS = ["info.plist", "podfile", "package.swift"];
+// Note: build.gradle can be nested inside android/ and android/app.
 const ANDROID_INDICATORS = ["androidmanifest.xml", "build.gradle", "build.gradle.kts"];
 const DART_INDICATORS = ["pubspec.yaml", "pubspec.lock"];