create-acmekit-app 2.13.1

package/src/utils/prepare-project.ts

@@ -0,0 +1,325 @@
+import fs from "fs"
+import path from "path"
+import { Ora } from "ora"
+import { ExecuteResult } from "./execute.js"
+import { EOL } from "os"
+import { displayFactBox, FactBoxOptions } from "./facts.js"
+import ProcessManager from "./process-manager.js"
+import type { Client } from "@acmekit/deps/pg"
+import PackageManager from "./package-manager.js"
+import { updatePackageVersions } from "./update-package-versions.js"
+
+const ADMIN_EMAIL = "admin@acmekit-test.com"
+let STORE_CORS = "http://localhost:8000"
+let ADMIN_CORS = "http://localhost:5173,http://localhost:9000"
+const DOCS_CORS = "https://docs.acmekit.com"
+const AUTH_CORS = [ADMIN_CORS, STORE_CORS, DOCS_CORS].join(",")
+STORE_CORS += `,${DOCS_CORS}`
+ADMIN_CORS += `,${DOCS_CORS}`
+const DEFAULT_REDIS_URL = "redis://localhost:6379"
+
+type PreparePluginOptions = {
+  isPlugin: true
+  directory: string
+  projectName: string
+  spinner: Ora
+  processManager: ProcessManager
+  abortController?: AbortController
+  verbose?: boolean
+  packageManager: PackageManager
+}
+
+type PrepareProjectOptions = {
+  isPlugin: false
+  directory: string
+  dbName?: string
+  dbConnectionString: string
+  projectName: string
+  seed?: boolean
+  spinner: Ora
+  processManager: ProcessManager
+  abortController?: AbortController
+  skipDb?: boolean
+  migrations?: boolean
+  onboardingType?: "default" | "nextjs"
+  nextjsDirectory?: string
+  client: Client | null
+  verbose?: boolean
+  packageManager: PackageManager
+  version?: string
+}
+
+type PrepareOptions = PreparePluginOptions | PrepareProjectOptions
+
+export default async <
+  T extends PrepareOptions,
+  Output = T extends { isPlugin: true } ? void : string | undefined
+>(
+  prepareOptions: T
+): Promise<Output> => {
+  if (prepareOptions.isPlugin) {
+    return preparePlugin(prepareOptions) as Output
+  }
+
+  return prepareProject(prepareOptions) as Output
+}
+
+async function preparePlugin({
+  directory,
+  projectName,
+  spinner,
+  processManager,
+  abortController,
+  verbose = false,
+  packageManager,
+}: PreparePluginOptions) {
+  // initialize execution options
+  const execOptions = {
+    cwd: directory,
+    signal: abortController?.signal,
+  }
+
+  const factBoxOptions: FactBoxOptions = {
+    interval: null,
+    spinner,
+    processManager,
+    message: "",
+    title: "",
+    verbose,
+  }
+
+  // Update package.json
+  const packageJsonPath = path.join(directory, "package.json")
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"))
+
+  // Update name
+  packageJson.name = projectName
+
+  // Add packageManager field to ensure consistent version usage
+  const packageManagerString = await packageManager.getPackageManagerString()
+  if (packageManagerString) {
+    packageJson.packageManager = packageManagerString
+  }
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  factBoxOptions.interval = displayFactBox({
+    ...factBoxOptions,
+    spinner,
+    title: "Installing dependencies...",
+    processManager,
+  })
+
+  await packageManager.installDependencies(execOptions)
+
+  factBoxOptions.interval = displayFactBox({
+    ...factBoxOptions,
+    message: "Installed Dependencies",
+  })
+
+  displayFactBox({ ...factBoxOptions, message: "Finished Preparation" })
+}
+
+async function prepareProject({
+  directory,
+  projectName,
+  dbName,
+  dbConnectionString,
+  seed,
+  spinner,
+  processManager,
+  abortController,
+  skipDb,
+  migrations,
+  onboardingType = "default",
+  nextjsDirectory = "",
+  client,
+  verbose = false,
+  packageManager,
+  version,
+}: PrepareProjectOptions) {
+  // initialize execution options
+  const execOptions = {
+    cwd: directory,
+    signal: abortController?.signal,
+  }
+
+  const npxOptions = {
+    ...execOptions,
+    env: {
+      ...process.env,
+      npm_config_yes: "yes",
+    },
+  }
+
+  const factBoxOptions: FactBoxOptions = {
+    interval: null,
+    spinner,
+    processManager,
+    message: "",
+    title: "",
+    verbose,
+  }
+
+  // Update package.json
+  const packageJsonPath = path.join(directory, "package.json")
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"))
+
+  // Update name
+  packageJson.name = projectName
+
+  // Add packageManager field to ensure consistent version usage
+  const packageManagerString = await packageManager.getPackageManagerString()
+  if (packageManagerString) {
+    packageJson.packageManager = packageManagerString
+  }
+
+  // Update acmekit dependencies versions
+  if (version) {
+    updatePackageVersions(packageJson, version)
+  }
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  // initialize the invite token to return
+  let inviteToken: string | undefined = undefined
+
+  // add environment variables
+  let env = `MEDUSA_ADMIN_ONBOARDING_TYPE=${onboardingType}${EOL}STORE_CORS=${STORE_CORS}${EOL}ADMIN_CORS=${ADMIN_CORS}${EOL}AUTH_CORS=${AUTH_CORS}${EOL}REDIS_URL=${DEFAULT_REDIS_URL}${EOL}JWT_SECRET=supersecret${EOL}COOKIE_SECRET=supersecret`
+
+  if (!skipDb) {
+    if (dbName) {
+      env += `${EOL}DB_NAME=${dbName}`
+      dbConnectionString = dbConnectionString!.replace(dbName, "$DB_NAME")
+    }
+    env += `${EOL}DATABASE_URL=${dbConnectionString}`
+  }
+
+  if (nextjsDirectory) {
+    env += `${EOL}MEDUSA_ADMIN_ONBOARDING_NEXTJS_DIRECTORY=${nextjsDirectory}`
+  }
+
+  fs.appendFileSync(path.join(directory, `.env`), env)
+
+  factBoxOptions.interval = displayFactBox({
+    ...factBoxOptions,
+    spinner,
+    title: "Installing dependencies...",
+    processManager,
+  })
+
+  await packageManager.installDependencies(execOptions)
+
+  factBoxOptions.interval = displayFactBox({
+    ...factBoxOptions,
+    message: "Installed Dependencies",
+  })
+
+  if (!skipDb && migrations) {
+    factBoxOptions.interval = displayFactBox({
+      ...factBoxOptions,
+      title: "Running Migrations...",
+    })
+
+    // run migrations
+    const migrationExecResult = await packageManager.runAcmeKitCommand(
+      "db:migrate",
+      npxOptions,
+      {
+        verbose,
+        needOutput: true,
+      }
+    )
+
+    if (client) {
+      // check the migrations table is in the database
+      // to ensure that migrations ran
+      let errorOccurred = false
+      try {
+        const migrations = await client.query(
+          `SELECT count(tablename) from pg_tables WHERE tablename = 'mikro_orm_migrations'`
+        )
+        errorOccurred = migrations.rowCount == 0
+      } catch (e) {
+        // avoid error thrown if the migrations table
+        // doesn't exist
+        errorOccurred = true
+      }
+
+      // ensure that migrations actually ran in case of an uncaught error
+      if (
+        errorOccurred &&
+        (migrationExecResult.stderr || migrationExecResult.stdout)
+      ) {
+        throw new Error(
+          `An error occurred while running migrations: ${
+            migrationExecResult.stderr || migrationExecResult.stdout
+          }`
+        )
+      }
+    }
+
+    factBoxOptions.interval = displayFactBox({
+      ...factBoxOptions,
+      message: "Ran Migrations",
+    })
+
+    const userExecResult = (await packageManager.runAcmeKitCommand(
+      `user -e ${ADMIN_EMAIL} --invite`,
+      npxOptions,
+      { verbose, needOutput: true }
+    )) as ExecuteResult
+
+    // get invite token from stdout
+    const match = (userExecResult.stdout as string).match(
+      /Invite token: (?<token>.+)/
+    )
+    inviteToken = match?.groups?.token
+
+    // TODO for now we just seed the default data
+    // we should add onboarding seeding again if it makes
+    // since once we re-introduce the onboarding flow.
+    factBoxOptions.interval = displayFactBox({
+      ...factBoxOptions,
+      title: "Seeding database...",
+    })
+
+    await packageManager.runCommand("seed", execOptions)
+
+    displayFactBox({
+      ...factBoxOptions,
+      message: "Seeded database with demo data",
+    })
+  }
+
+  // if installation includes Next.js, retrieve the publishable API key
+  // from the backend and add it as an enviornment variable
+  if (nextjsDirectory && client) {
+    const apiKeys = await client.query(
+      `SELECT * FROM "api_key" WHERE type = 'publishable'`
+    )
+
+    if (apiKeys.rowCount) {
+      const nextjsEnvPath = path.join(
+        nextjsDirectory,
+        fs.existsSync(path.join(nextjsDirectory, ".env.local"))
+          ? ".env.local"
+          : ".env.template"
+      )
+
+      const originalContent = fs.readFileSync(nextjsEnvPath, "utf-8")
+
+      fs.writeFileSync(
+        nextjsEnvPath,
+        originalContent.replace(
+          "NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_test",
+          `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=${apiKeys.rows[0].token}`
+        )
+      )
+    }
+  }
+
+  displayFactBox({ ...factBoxOptions, message: "Finished Preparation" })
+
+  return inviteToken
+}

package/src/utils/process-manager.ts

@@ -0,0 +1,60 @@
+type ProcessOptions = {
+  process: Function
+  ignoreERESOLVE?: boolean
+}
+
+export default class ProcessManager {
+  intervals: NodeJS.Timeout[] = []
+  static MAX_RETRIES = 3
+
+  constructor() {
+    this.onTerminated(() => {
+      this.intervals.forEach((interval) => {
+        clearInterval(interval)
+      })
+    })
+  }
+
+  onTerminated(fn: () => Promise<void> | void) {
+    process.on("SIGTERM", async () => fn())
+    process.on("SIGINT", async () => fn())
+  }
+
+  addInterval(interval: NodeJS.Timeout) {
+    this.intervals.push(interval)
+  }
+
+  // when running commands with npx or npm sometimes they
+  // terminate with EAGAIN error unexpectedly
+  // this utility function allows retrying the process if
+  // EAGAIN occurs, or otherwise throw the error that occurs
+  async runProcess({ process, ignoreERESOLVE }: ProcessOptions) {
+    let processError = false
+    let retries = 0
+    do {
+      ++retries
+      try {
+        return await process()
+      } catch (error) {
+        if (
+          typeof error === "object" &&
+          error !== null &&
+          "code" in error &&
+          error?.code === "EAGAIN"
+        ) {
+          processError = true
+        } else if (
+          ignoreERESOLVE &&
+          typeof error === "object" &&
+          error !== null &&
+          "code" in error &&
+          error?.code === "ERESOLVE"
+        ) {
+          // ignore error
+        } else {
+          throw error
+        }
+      }
+    } while (processError && retries <= ProcessManager.MAX_RETRIES)
+  }
+}

package/src/utils/project-creator/acmekit-plugin-creator.ts

@@ -0,0 +1,127 @@
+import { track } from "@acmekit/telemetry"
+import boxen from "boxen"
+import chalk from "chalk"
+import { emojify } from "node-emoji"
+import { EOL } from "os"
+import { runCloneRepo } from "../clone-repo.js"
+import { isAbortError } from "../create-abort-controller.js"
+import { displayFactBox } from "../facts.js"
+import logMessage from "../log-message.js"
+import prepareProject from "../prepare-project.js"
+import {
+  BaseProjectCreator,
+  ProjectCreator,
+  ProjectOptions,
+} from "./creator.js"
+import terminalLink from "terminal-link"
+
+// Plugin Project Creator
+export class PluginProjectCreator
+  extends BaseProjectCreator
+  implements ProjectCreator
+{
+  constructor(projectName: string, options: ProjectOptions, args: string[]) {
+    super(projectName, options, args)
+    this.setupProcessManager()
+  }
+
+  async create(): Promise<void> {
+    track("CREATE_CLI_CMP")
+
+    logMessage({
+      message: `${emojify(
+        ":rocket:"
+      )} Starting plugin setup, this may take a few minutes.`,
+    })
+
+    this.spinner.start()
+    this.factBoxOptions.interval = displayFactBox({
+      ...this.factBoxOptions,
+      title: "Setting up plugin...",
+    })
+
+    try {
+      await this.cloneAndPreparePlugin()
+      this.spinner.succeed(chalk.green("Plugin Prepared"))
+      this.showSuccessMessage()
+    } catch (e: any) {
+      this.handleError(e)
+    }
+  }
+
+  private async cloneAndPreparePlugin(): Promise<void> {
+    await runCloneRepo({
+      projectName: this.projectPath,
+      repoUrl: this.options.repoUrl ?? "",
+      abortController: this.abortController,
+      spinner: this.spinner,
+      verbose: this.options.verbose,
+      isPlugin: true,
+    })
+
+    this.factBoxOptions.interval = displayFactBox({
+      ...this.factBoxOptions,
+      message: "Created plugin directory",
+    })
+
+    await prepareProject({
+      isPlugin: true,
+      directory: this.projectPath,
+      projectName: this.projectName,
+      spinner: this.spinner,
+      processManager: this.processManager,
+      abortController: this.abortController,
+      verbose: this.options.verbose,
+      packageManager: this.packageManager,
+    })
+  }
+
+  private handleError(e: any): void {
+    if (isAbortError(e)) {
+      process.exit()
+    }
+
+    this.spinner.stop()
+    logMessage({
+      message: `An error occurred while preparing plugin: ${e}`,
+      type: "error",
+    })
+  }
+
+  protected showSuccessMessage(): void {
+    logMessage({
+      message: boxen(
+        chalk.green(
+          `Change to the \`${
+            this.projectName
+          }\` directory to explore your AcmeKit plugin.${EOL}${EOL}Check out the ${terminalLink(
+            "AcmeKit plugin documentation",
+            "https://docs.acmekit.com/learn/fundamentals/plugins"
+          )} to start your development.${EOL}${EOL}Star us on ${terminalLink(
+            "GitHub",
+            "https://github.com/acmekit/acmekit/stargazers"
+          )} if you like what we're building.`
+        ),
+        {
+          titleAlignment: "center",
+          textAlignment: "center",
+          padding: 1,
+          margin: 1,
+          float: "center",
+        }
+      ),
+    })
+  }
+
+  protected setupProcessManager(): void {
+    this.processManager.onTerminated(async () => {
+      this.spinner.stop()
+
+      if (!this.printedMessage && this.isProjectCreated) {
+        this.printedMessage = true
+        this.showSuccessMessage()
+      }
+      return
+    })
+  }
+}