feat(sdk): embedding cli opens the metabase store to get trial token …

…and applies the license (metabase#46810)

* open metabase store to get trial token

* remove license env from instance setup as we provide the license key later

* activate metabase license

* fix password field missing

* fix formatting for generated component files message

* activate license key

* add missing auth options for postgres

* add function to print with padding

* prevent infinite loop and update section representation

* show the activate license error in red

* rename variable

enterprise/frontend/src/embedding-sdk/cli/constants/database.ts

@@ -21,6 +21,13 @@ export const CLI_SHOWN_DB_FIELDS = [
   "password",
   "ssl",
 
+  // PostgreSQL fields - support authentication providers
+  "use-auth-provider",
+  "auth-provider",
+  "azure-managed-identity-client-id",
+  "oauth-token-url",
+  "oauth-token-headers",
+
   // Snowflake fields
   "use-hostname",
   "account",

enterprise/frontend/src/embedding-sdk/cli/constants/messages.ts

@@ -30,6 +30,11 @@ export const EMBEDDING_FAILED_MESSAGE = `
 export const PREMIUM_TOKEN_REQUIRED_MESSAGE =
   "  Don't forget to add your premium token to your Metabase instance in the admin settings! The embedding demo will not work without a license.";
 
+export const getGeneratedComponentFilesMessage = (path: string) => `
+  Generated example React components files in "${path}".
+  You can import the <AnalyticsPage /> component in your React app.
+`;
+
 export const getMetabaseInstanceSetupCompleteMessage = (instanceUrl: string) =>
   // eslint-disable-next-line no-unconditional-metabase-links-render -- link for the CLI message
   `

enterprise/frontend/src/embedding-sdk/cli/run.ts

@@ -6,7 +6,6 @@ import {
 } from "./constants/messages";
 import {
   addDatabaseConnectionStep,
-  addEmbeddingToken,
   checkIfReactProject,
   checkIsDockerRunning,
   checkSdkAvailable,
@@ -16,6 +15,7 @@ import {
   generateReactComponentFiles,
   pickDatabaseTables,
   pollMetabaseInstance,
+  setupLicense,
   setupMetabaseInstance,
   showMetabaseCliTitle,
   startLocalMetabaseContainer,
@@ -27,7 +27,6 @@ export const CLI_STEPS = [
   { id: "showMetabaseCliTitle", executeStep: showMetabaseCliTitle },
   { id: "checkIfReactProject", executeStep: checkIfReactProject },
   { id: "checkSdkAvailable", executeStep: checkSdkAvailable },
-  { id: "addEmbeddingToken", executeStep: addEmbeddingToken },
   { id: "checkIsDockerRunning", executeStep: checkIsDockerRunning },
   { id: "generateCredentials", executeStep: generateCredentials },
   {
@@ -44,6 +43,7 @@ export const CLI_STEPS = [
     id: "generateReactComponentFiles",
     executeStep: generateReactComponentFiles,
   },
+  { id: "setupLicense", executeStep: setupLicense },
 ] as const;
 
 export async function runCli() {

enterprise/frontend/src/embedding-sdk/cli/steps/generate-component-files.ts

@@ -2,6 +2,7 @@ import fs from "fs/promises";
 
 import { input } from "@inquirer/prompts";
 
+import { getGeneratedComponentFilesMessage } from "../constants/messages";
 import { ANALYTICS_CSS_SNIPPET } from "../snippets/analytics-css-snippet";
 import type { CliStepMethod } from "../types/cli";
 import { getComponentSnippets } from "../utils/get-component-snippets";
@@ -59,9 +60,7 @@ export const generateReactComponentFiles: CliStepMethod = async state => {
 
   await fs.writeFile(`${path}/index.js`, exportIndexContent);
 
-  printSuccess(
-    `Generated example React components files in "${path}". You can import the <AnalyticsPage /> component in your React app from this path.`,
-  );
+  printSuccess(getGeneratedComponentFilesMessage(path));
 
   return [{ type: "done" }, state];
 };

enterprise/frontend/src/embedding-sdk/cli/steps/index.ts

@@ -1,4 +1,3 @@
-export * from "./add-embedding-token";
 export * from "./check-docker-running";
 export * from "./create-api-key";
 export * from "./generate-credentials";
@@ -12,3 +11,4 @@ export * from "./add-database-connection";
 export * from "./pick-database-tables";
 export * from "./create-models-and-xrays";
 export * from "./generate-component-files";
+export * from "./setup-license";

enterprise/frontend/src/embedding-sdk/cli/steps/setup-license.ts

@@ -0,0 +1,91 @@
+import { input, select } from "@inquirer/prompts";
+import chalk from "chalk";
+import toggle from "inquirer-toggle";
+import open from "open";
+
+import type { CliStepMethod } from "embedding-sdk/cli/types/cli";
+
+import { printEmptyLines, printInfo, printWithPadding } from "../utils/print";
+import { propagateErrorResponse } from "../utils/propagate-error-response";
+
+const trialUrl = `https://store.metabase.com/checkout?plan=pro&deployment=self-hosted`;
+const trialUrlWithUtm = `${trialUrl}&utm_source=product&utm_medium=checkout&utm_campaign=embedding-sdk&utm_content=embedding-sdk-cli`;
+
+export const setupLicense: CliStepMethod = async state => {
+  const hasLicenseKey = await toggle({
+    message: "Do you already have a Metabase Pro license key?",
+    default: false,
+  });
+
+  if (!hasLicenseKey) {
+    printEmptyLines(1);
+    printWithPadding(
+      `Please sign up for a free trial of Metabase Pro self-hosted or purchase a license.`,
+    );
+
+    const shouldOpenInBrowser = await toggle({
+      message: `Open the store to get a license key?`,
+      default: true,
+    });
+
+    if (shouldOpenInBrowser) {
+      try {
+        await open(trialUrlWithUtm);
+        printWithPadding(`Opened ${chalk.blue(trialUrl)} in your browser.`);
+      } catch (error) {
+        printInfo(`Please visit ${chalk.blue(trialUrl)} to get a license key.`);
+      }
+    }
+  }
+
+  // Activate the license
+  // eslint-disable-next-line no-constant-condition -- ask until user provides a valid license key
+  while (true) {
+    try {
+      const token = await input({
+        message: "Enter your Metabase Pro license key:",
+        required: true,
+        validate: value => {
+          if (value.length !== 64 || !/^[0-9A-Fa-f]+$/.test(value)) {
+            return "License key must be a 64-character hexadecimal string.";
+          }
+
+          return true;
+        },
+      });
+
+      const endpoint = `${state.instanceUrl}/api/setting/premium-embedding-token`;
+
+      const res = await fetch(endpoint, {
+        method: "PUT",
+        body: JSON.stringify({ value: token.trim() }),
+        headers: {
+          "content-type": "application/json",
+          cookie: state.cookie ?? "",
+        },
+      });
+
+      await propagateErrorResponse(res);
+
+      return [{ type: "success" }, { ...state, token }];
+    } catch (error) {
+      const reason = error instanceof Error ? error.message : String(error);
+
+      printWithPadding(
+        chalk.red(`Failed to activate license. Reason: ${reason}`),
+      );
+
+      const skipLicenseSetup = await select({
+        message: `Do you want to try another license key?`,
+        choices: [
+          { name: "Try another license key.", value: false },
+          { name: "I'll activate the license later.", value: true },
+        ],
+      });
+
+      if (skipLicenseSetup) {
+        return [{ type: "success" }, state];
+      }
+    }
+  }
+};

enterprise/frontend/src/embedding-sdk/cli/steps/setup-metabase-instance.ts

@@ -4,19 +4,14 @@ import toggle from "inquirer-toggle";
 import ora from "ora";
 import { promisify } from "util";
 
-import type { CliOutput, CliStepMethod } from "embedding-sdk/cli/types/cli";
-import {
-  OUTPUT_STYLES,
-  printEmptyLines,
-  printInfo,
-} from "embedding-sdk/cli/utils/print";
-
 import { CONTAINER_NAME, SITE_NAME } from "../constants/config";
 import { EMBEDDING_DEMO_SETUP_TOKEN } from "../constants/env";
 import {
   EMBEDDING_FAILED_MESSAGE,
   INSTANCE_CONFIGURED_MESSAGE,
 } from "../constants/messages";
+import type { CliOutput, CliStepMethod } from "../types/cli";
+import { OUTPUT_STYLES, printEmptyLines } from "../utils/print";
 import { retry } from "../utils/retry";
 
 const exec = promisify(execCallback);
@@ -38,10 +33,9 @@ export const setupMetabaseInstance: CliStepMethod = async state => {
   // If the instance we are configuring is not clean,
   // therefore we cannot ensure the setup steps are performed.
   const onInstanceConfigured = async (): Promise<CliOutput> => {
-    spinner.fail();
     printEmptyLines();
-    printInfo(
-      "The instance is already configured. Do you want to delete the container and start over?",
+    console.log(
+      "  The instance is already configured. Delete the container and start over?",
     );
     const shouldRestartSetup = await toggle({
       message: `${OUTPUT_STYLES.error("WARNING: This will delete all data.")}`,

enterprise/frontend/src/embedding-sdk/cli/steps/start-local-metabase-container.ts

@@ -96,10 +96,6 @@ export const startLocalMetabaseContainer: CliStepMethod = async state => {
       ...METABASE_INSTANCE_DEFAULT_ENVS,
     };
 
-    if (state.token) {
-      envVars.MB_PREMIUM_EMBEDDING_TOKEN = state.token;
-    }
-
     // Pass default configuration as environment variables
     const envFlags = Object.entries(envVars)
       .map(([key, value]) => `-e ${key}='${value}'`)

enterprise/frontend/src/embedding-sdk/cli/utils/ask-for-db-connection-info.ts

@@ -11,6 +11,8 @@ import type { Engine, EngineField } from "metabase-types/api";
 
 import { CLI_SHOWN_DB_FIELDS } from "../constants/database";
 
+import { printWithPadding } from "./print";
+
 interface Options {
   engine: Engine;
   engineKey: string;
@@ -33,13 +35,26 @@ export async function askForDatabaseConnectionInfo(options: Options) {
       continue;
     }
 
+    const visibleIf = field["visible-if"];
+
+    const shouldShowField =
+      !visibleIf ||
+      Object.entries(visibleIf).every(
+        ([key, expected]) => connection[key] === expected,
+      );
+
+    // Skip fields that should be hidden
+    if (!shouldShowField) {
+      continue;
+    }
+
     const name = field["display-name"];
     const helperText = field["helper-text"];
 
     const message = `${name}:`;
 
     if (helperText) {
-      console.log(`  ${chalk.gray(helperText)}`);
+      printWithPadding(`${chalk.gray(helperText)}`);
     }
 
     const value = await askForConnectionValue(field, message, engineKey);
@@ -72,6 +87,13 @@ const askForConnectionValue = (
 
       return fs.readFile(path, "utf-8");
     })
+    .with("select", () => {
+      return select({
+        message,
+        choices: field.options ?? [],
+        default: field.default,
+      });
+    })
     .with("section", () => askSectionChoice(field))
     .otherwise(() =>
       input({
@@ -94,29 +116,42 @@ const getIntegerFieldDefault = (field: EngineField, engine: string) => {
 };
 
 const askSectionChoice = async (field: EngineField) => {
-  // Snowflake allows to connect with either hostname or account name.
-  if (field.name === "use-hostname") {
+  // Postgres allows connecting with either password or an authentication provider.
+  if (field.name === "use-auth-provider") {
     const choice = await select({
-      message: "Do you want to connect with hostname or account name?",
+      message:
+        "Do you want to connect with password or an authentication provider?",
       choices: [
-        { name: "Hostname", value: "hostname" },
-        { name: "Account name", value: "account" },
+        { name: "Password", value: "password" },
+        { name: "Auth Provider", value: "auth-provider" },
       ],
+      default: "password",
     });
 
-    return choice === "hostname";
+    return choice === "auth-provider";
   }
 
-  // MongoDB allows to connect with either hostname or connection string.
+  // Snowflake allows connecting with either hostname or account name.
+  if (field.name === "use-hostname") {
+    return select({
+      message: "Do you want to connect with hostname or account name?",
+      choices: [
+        { name: "Hostname", value: true },
+        { name: "Account name", value: false },
+      ],
+      default: field.default,
+    });
+  }
+
+  // MongoDB allows connecting with either hostname or connection string.
   if (field.name === "use-conn-uri") {
-    const choice = await select({
+    return select({
       message: "Do you want to connect with hostname or connection string?",
       choices: [
-        { name: "Hostname", value: "hostname" },
-        { name: "Connection String", value: "conn-uri" },
+        { name: "Hostname", value: false },
+        { name: "Connection String", value: true },
       ],
+      default: field.default,
     });
-
-    return choice === "conn-uri";
   }
 };

enterprise/frontend/src/embedding-sdk/cli/utils/print.ts

@@ -42,3 +42,7 @@ export const printSuccess = (message: string) =>
 
 export const printInfo = (message: string) =>
   _print(OUTPUT_STYLES.info, message);
+
+/** Aligns the message with the rest of the input prompt. */
+export const printWithPadding = (message: string) =>
+  console.log(`  ` + message);

package.json

@@ -273,6 +273,7 @@
     "mysql2": "^3.9.8",
     "node-polyfill-webpack-plugin": "2.0.1",
     "null-loader": "^4.0.1",
+    "open": "^10.1.0",
     "open-cli": "^8.0.0",
     "patch-package": "^8.0.0",
     "pg": "^8.8.0",

yarn.lock

@@ -17812,7 +17812,7 @@ open-cli@^8.0.0:
     open "^10.0.0"
     tempy "^3.1.0"
 
-open@^10.0.0:
+open@^10.0.0, open@^10.1.0:
   version "10.1.0"
   resolved "https://registry.yarnpkg.com/open/-/open-10.1.0.tgz#a7795e6e5d519abe4286d9937bb24b51122598e1"
   integrity sha512-mnkeQ1qP5Ue2wd+aivTD3NHd/lZ96Lu0jgf0pwktLPtx6cTZiH7tyeGRRHs0zX0rbrahXPnXlUnbeXyaBBuIaw==