@cedarjs/cli 6.0.0-rc.189 → 6.0.0-rc.241

package/dist/commands/serve.js

@@ -10,6 +10,14 @@ import * as webServerCLIConfig from "@cedarjs/web-server";
 import { getPaths, getConfig } from "../lib/index.js";
 import { serverFileExists } from "../lib/project.js";
 import { webSsrServerHandler } from "./serveWebHandler.js";
+function refuseServerFileUnderUD() {
+  console.error(
+    c.error(
+      "\n api/src/server.ts was detected, but a custom server file is not supported with --ud. It is a Fastify concept \u2014 anything registered there (Realtime, custom plugins, custom middleware) would silently be skipped if serving continued.\n"
+    )
+  );
+  process.exit(1);
+}
 function resolveUDEntryPath() {
   const base = path.join(getPaths().api.dist, "ud", "index");
   for (const ext of [".mjs", ".js"]) {
@@ -90,17 +98,13 @@ const builder = async (yargs) => {
           process.exit(1);
         }
         if (serverFileExists()) {
-          console.warn(
-            c.warning(
-              "\n Note: api/src/server.ts was detected. This file is a Fastify concept and will be ignored when using --ud. You are testing the experimental UD support, so the behavior will not match your production Fastify setup.\n"
-            )
-          );
+          refuseServerFileUnderUD();
         }
         const { getAPIHost, getAPIPort, getWebHost, getWebPort } = await import("@cedarjs/api-server/cliHelpers");
         const apiPort = argv.apiPort ?? getAPIPort();
         const apiHost = argv.apiHost ?? getAPIHost();
-        const webPort = argv.webPort ?? getWebPort();
-        const webHost = argv.webHost ?? getWebHost();
+        const webPort = argv.webPort ?? getWebPort({ isPublicSide: true });
+        const webHost = argv.webHost ?? getWebHost({ isPublicSide: true });
         const apiRootPath = argv.apiRootPath ?? "/";
         const apiTarget = `http://${apiHost.includes(":") ? `[${apiHost}]` : apiHost}:${apiPort}`;
         const { serveStatic } = await import("srvx/static");
@@ -187,7 +191,15 @@ const builder = async (yargs) => {
         socket: argv.socket,
         apiRootPath: argv.apiRootPath
       });
+      const { getAPIHost, getAPIPort } = await import("@cedarjs/api-server/cliHelpers");
+      const apiPort = argv.port ?? getAPIPort({ isPublicSide: true });
+      const apiHost = argv.host ?? getAPIHost({ isPublicSide: true });
+      argv.port = apiPort;
+      argv.host = apiHost;
       if (argv.ud) {
+        if (serverFileExists()) {
+          refuseServerFileUnderUD();
+        }
         const udEntryPath = resolveUDEntryPath();
         if (!udEntryPath) {
           console.error(
@@ -197,8 +209,6 @@ const builder = async (yargs) => {
           );
           process.exit(1);
         }
-        const apiPort = argv.port ?? parseInt(process.env.PORT ?? "8911", 10);
-        const apiHost = argv.host ?? process.env.HOST ?? "localhost";
         process.stdout.write(
           `API server starting at http://${apiHost}:${apiPort}...`
         );

package/dist/commands/serveBothHandler.js

@@ -27,8 +27,8 @@ const bothServerFileHandler = async (argv) => {
   } else {
     argv.apiPort ??= getAPIPort();
     argv.apiHost ??= getAPIHost();
-    argv.webPort ??= getWebPort();
-    argv.webHost ??= getWebHost();
+    argv.webPort ??= getWebPort({ isPublicSide: true });
+    argv.webHost ??= getWebHost({ isPublicSide: true });
     const apiRootPath = argv.apiRootPath ?? getAPIRootPath();
     const apiProxyTarget = [
       "http://",

package/dist/commands/setup/database/database.js

@@ -0,0 +1,15 @@
+import { terminalLink } from "termi-link";
+import * as setupDatabasePostgres from "./postgres.js";
+const command = "database <command>";
+const description = "Switch your project's database";
+const builder = (yargs) => yargs.command(setupDatabasePostgres).demandCommand().epilogue(
+  `Also see the ${terminalLink(
+    "CedarJS CLI Reference",
+    "https://cedarjs.com/docs/cli-commands#setup"
+  )}`
+);
+export {
+  builder,
+  command,
+  description
+};

package/dist/commands/setup/database/postgres.js

@@ -0,0 +1,19 @@
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+const command = "postgres";
+const description = "Switch your project from SQLite to PostgreSQL (schema, dependencies, and database adapter)";
+function builder(yargs) {
+  return yargs;
+}
+async function handler() {
+  recordTelemetryAttributes({
+    command: "setup database postgres"
+  });
+  const { handler: handler2 } = await import("./postgresHandler.js");
+  return handler2();
+}
+export {
+  builder,
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/database/postgresHandler.js

@@ -0,0 +1,194 @@
+import fs from "node:fs";
+import path from "node:path";
+import execa from "execa";
+import { Listr } from "listr2";
+import { colors, getPaths, installPackages } from "@cedarjs/cli-helpers";
+import { prettyPrintCedarCommand } from "@cedarjs/cli-helpers/packageManager";
+import { addWorkspacePackages } from "@cedarjs/cli-helpers/packageManager/packages";
+import { resolveFile } from "@cedarjs/project-config";
+import { errorTelemetry } from "@cedarjs/telemetry";
+function checkProjectShape(cedarPaths) {
+  const schemaPath = path.join(cedarPaths.api.base, "db", "schema.prisma");
+  const dbPath = resolveFile(path.join(cedarPaths.api.lib, "db"));
+  if (!fs.existsSync(schemaPath)) {
+    return blocked(`Could not find ${schemaPath}.`);
+  }
+  if (!dbPath) {
+    return blocked(`No ${path.join(cedarPaths.api.lib, "db")} file found`);
+  }
+  const schemaContent = fs.readFileSync(schemaPath, "utf-8");
+  const hasPgAdapter = fs.readFileSync(dbPath, "utf-8").includes("PrismaPg");
+  if (schemaContent.includes('provider = "postgresql"') && hasPgAdapter) {
+    return {
+      ok: false,
+      alreadyConverted: true,
+      message: "This project is already configured for PostgreSQL."
+    };
+  }
+  if (!schemaContent.includes('provider = "sqlite"') || hasPgAdapter) {
+    return blocked(
+      "This command only converts a project that is still on SQLite, with the default adapter in api/src/lib/db.ts (or db.js) untouched. This project doesn't match that shape (a different provider, or a partial previous conversion). Please switch it over to PostgreSQL manually."
+    );
+  }
+  return { ok: true, dbPath };
+}
+function blocked(message) {
+  return { ok: false, alreadyConverted: false, message };
+}
+function getSqliteToPostgresTasks({
+  dbPath
+}) {
+  const cedarPaths = getPaths();
+  const schemaPath = path.join(cedarPaths.api.base, "db", "schema.prisma");
+  const rootPkgPath = path.join(cedarPaths.base, "package.json");
+  const apiPkgPath = path.join(cedarPaths.api.base, "package.json");
+  const dbTsTemplatePath = path.join(
+    import.meta.dirname,
+    "templates",
+    "db.ts.template"
+  );
+  return [
+    {
+      title: "Removing SQLite dependencies from api/package.json",
+      task: () => {
+        const pkg = JSON.parse(fs.readFileSync(apiPkgPath, "utf-8"));
+        if (pkg.dependencies) {
+          delete pkg.dependencies["better-sqlite3"];
+          delete pkg.dependencies["@prisma/adapter-better-sqlite3"];
+        }
+        fs.writeFileSync(apiPkgPath, JSON.stringify(pkg, null, 2) + "\n");
+      }
+    },
+    {
+      title: "Removing better-sqlite3 dependenciesMeta",
+      task: () => {
+        if (!fs.existsSync(rootPkgPath)) {
+          return;
+        }
+        const pkg = JSON.parse(fs.readFileSync(rootPkgPath, "utf-8"));
+        if (pkg.dependenciesMeta?.["better-sqlite3"]) {
+          delete pkg.dependenciesMeta["better-sqlite3"];
+          if (Object.keys(pkg.dependenciesMeta).length === 0) {
+            delete pkg.dependenciesMeta;
+          }
+          fs.writeFileSync(rootPkgPath, JSON.stringify(pkg, null, 2) + "\n");
+        }
+      }
+    },
+    {
+      title: "Switching Prisma schema to PostgreSQL",
+      task: () => {
+        const schemaContent = fs.readFileSync(schemaPath, "utf-8");
+        fs.writeFileSync(
+          schemaPath,
+          schemaContent.replace(
+            'provider = "sqlite"',
+            'provider = "postgresql"'
+          )
+        );
+      }
+    },
+    {
+      title: "Updating database adapter",
+      task: () => {
+        const pgDbTs = fs.readFileSync(dbTsTemplatePath, "utf-8");
+        fs.writeFileSync(dbPath, pgDbTs);
+      }
+    },
+    {
+      title: "Adding required api packages...",
+      task: async () => {
+        await addWorkspacePackages("api", ["@prisma/adapter-pg@7.8.0"], {
+          cwd: cedarPaths.api.base
+        });
+      }
+    }
+  ];
+}
+function readEnvVar(envContent, name) {
+  return envContent.match(new RegExp(`^${name}=(.*)$`, "m"))?.[1] || void 0;
+}
+async function handler() {
+  const cedarPaths = getPaths();
+  const shape = checkProjectShape(cedarPaths);
+  if (!shape.ok) {
+    if (shape.alreadyConverted) {
+      console.log(colors.note(shape.message));
+      return;
+    }
+    console.error(colors.error(shape.message));
+    process.exit(1);
+  }
+  const envPath = path.join(cedarPaths.base, ".env");
+  const envContent = fs.existsSync(envPath) ? fs.readFileSync(envPath, "utf-8") : "";
+  const databaseUrl = readEnvVar(envContent, "DATABASE_URL");
+  const tasks = new Listr(
+    [
+      ...getSqliteToPostgresTasks({ dbPath: shape.dbPath }),
+      installPackages,
+      {
+        title: "Running Prisma migrations",
+        skip: () => {
+          if (!databaseUrl) {
+            return `No DATABASE_URL found in \`.env\`. Set it to your PostgreSQL connection string, then run \`${prettyPrintCedarCommand(["prisma", "migrate", "dev"])}\``;
+          }
+          return false;
+        },
+        task: () => {
+          const result = execa.commandSync(
+            "yarn cedar prisma migrate dev --name init-postgres",
+            {
+              cwd: cedarPaths.base,
+              stdio: ["inherit", "inherit", "pipe"],
+              reject: false
+            }
+          );
+          if (result.exitCode !== 0) {
+            throw new Error(
+              "Prisma migration failed:\n\n" + result.stderr + `
+
+You can try running it manually:
+  ${prettyPrintCedarCommand(["prisma", "migrate", "dev", "--name", "init-postgres"])}`
+            );
+          }
+        }
+      }
+    ],
+    {
+      exitOnError: false,
+      collectErrors: "minimal"
+    }
+  );
+  try {
+    await tasks.run();
+    if (tasks.errors.length > 0) {
+      for (const error of tasks.errors) {
+        if (isErrorWithMessage(error)) {
+          errorTelemetry(process.argv, error.message);
+          console.error(colors.error(error.message));
+        }
+      }
+      process.exit(1);
+    }
+  } catch (e) {
+    if (isErrorWithMessage(e)) {
+      errorTelemetry(process.argv, e.message);
+      console.error(colors.error(e.message));
+    }
+    if (isErrorWithExitCode(e)) {
+      process.exit(e.exitCode);
+    }
+    process.exit(1);
+  }
+}
+function isErrorWithMessage(e) {
+  return !!e && typeof e === "object" && "message" in e;
+}
+function isErrorWithExitCode(e) {
+  return !!e && typeof e === "object" && "exitCode" in e && typeof e.exitCode === "number";
+}
+export {
+  checkProjectShape,
+  getSqliteToPostgresTasks,
+  handler
+};

package/dist/commands/setup/deploy/providers/renderHandler.js

@@ -5,13 +5,7 @@ import { recordTelemetryAttributes, colors as c } from "@cedarjs/cli-helpers";
 import { getPaths, getPrismaSchemas } from "@cedarjs/project-config";
 import { errorTelemetry } from "@cedarjs/telemetry";
 import { writeFilesTask, printSetupNotes } from "../../../../lib/index.js";
-import { addFilesTask } from "../helpers/index.js";
-import {
-  POSTGRES_YAML,
-  RENDER_HEALTH_CHECK,
-  RENDER_YAML,
-  SQLITE_YAML
-} from "../templates/render.js";
+import { POSTGRES_YAML, RENDER_YAML, SQLITE_YAML } from "../templates/render.js";
 const { getConfig } = prismaInternals;
 const getRenderYamlContent = async (database) => {
   if (database === "none") {
@@ -54,14 +48,9 @@ const getRenderYamlContent = async (database) => {
 const notes = [
   "You are ready to deploy to Render!\n",
   "Go to https://dashboard.render.com/iacs to create your account and deploy to Render",
-  "Check out the deployment docs at https://render.com/docs/deploy-redwood for detailed instructions",
-  "Note: After first deployment to Render update the rewrite rule destination in `./render.yaml`"
-];
-const additionalFiles = [
-  {
-    path: path.join(getPaths().base, "api/src/functions/healthz.js"),
-    content: RENDER_HEALTH_CHECK
-  }
+  "Check out the deployment docs at https://cedarjs.com/docs/deploy/render for detailed instructions",
+  "Note: After first deployment to Render update the rewrite rule destination in `./render.yaml`",
+  "Note: The api service now health checks `/graphql/health`. If a previous setup left an unused `api/src/functions/healthz.js` behind, you can delete it"
 ];
 const handler = async ({
   force,
@@ -83,11 +72,6 @@ const handler = async ({
           return writeFilesTask(files, { overwriteExisting: force });
         }
       },
-      // Add health check api function
-      addFilesTask({
-        files: additionalFiles,
-        force
-      }),
       printSetupNotes(notes)
     ],
     { rendererOptions: { collapseSubtasks: false } }

package/dist/commands/setup/deploy/templates/render.js

@@ -5,13 +5,15 @@ const PROJECT_NAME = path.basename(getPaths().base);
 const RENDER_YAML = (database) => {
   const apiUrl = getUserApiUrl().replace(/\/$/, "");
   return `# Quick links to the docs:
-# - Redwood on Render: https://render.com/docs/deploy-redwood
-# - Render's Blueprint spec: https://render.com/docs/yaml-spec
+# - Deploying Cedar: https://cedarjs.com/docs/deploy/render
+# - Render's own walkthrough (uses \`yarn rw\`, but just swap in \`yarn cedar\`):
+#   https://render.com/docs/deploy-redwood
+# - Render's Blueprint spec: https://render.com/docs/blueprint-spec
 
 services:
 - name: ${PROJECT_NAME}-web
   type: web
-  env: static
+  runtime: static
   buildCommand: npm install --global corepack && yarn install && yarn cedar deploy render web
   staticPublishPath: ./web/dist
 
@@ -22,11 +24,16 @@ services:
   routes:
   - type: rewrite
     source: ${apiUrl}/*
-    # Replace \`destination\` here after your first deploy:
+    # Replace \`destination\` after your first deploy, with the api service's
+    # URL from the Render dashboard:
     #
     # \`\`\`
-    # destination: https://my-redwood-project-api.onrender.com/*
+    # destination: https://${PROJECT_NAME}-api.onrender.com/*
     # \`\`\`
+    #
+    # This can't be filled in automatically \u2014 Render's \`fromService\` only
+    # resolves service hosts into \`envVars\`, not into a static site's route
+    # destination.
     destination: replace_with_api_url/*
   - type: rewrite
     source: /*
@@ -35,11 +42,22 @@ services:
 - name: ${PROJECT_NAME}-api
   type: web
   plan: free
-  env: node
+  runtime: node
   region: oregon
   buildCommand: npm install --global corepack && yarn install && yarn cedar build api
   startCommand: yarn cedar deploy render api
 
+  # Proves the GraphQL server is actually serving, not just that the process
+  # is alive. Returns 200 with an \`x-yoga-id\` response header.
+  #
+  # The route is \`<apiRootPath><graphiQLEndpoint>/health\`, and the value below
+  # assumes both defaults (\`/\` and \`/graphql\`). Update it to match if you
+  # customize either \u2014 by setting \`CEDAR_API_ROOT_PATH\` in the envVars below,
+  # by passing \`apiRootPath\` to \`createServer\` in \`api/src/server.ts\`, or by
+  # setting \`graphiQLEndpoint\` in \`api/src/functions/graphql.ts\`. A mismatch
+  # here 404s, and Render will not promote the deploy.
+  healthCheckPath: /graphql/health
+
   envVars:
 ${database}
 `;
@@ -58,17 +76,9 @@ const SQLITE_YAML = `  - key: DATABASE_URL
     name: sqlite-data
     mountPath: /opt/render/project/src/api/db/data
     sizeGB: 1`;
-const RENDER_HEALTH_CHECK = `// render-health-check
-export const handler = async () => {
-  return {
-    statusCode: 200,
-  }
-}
-`;
 export {
   POSTGRES_YAML,
   PROJECT_NAME,
-  RENDER_HEALTH_CHECK,
   RENDER_YAML,
   SQLITE_YAML
 };

package/dist/commands/setup/docker/templates/Dockerfile.yarn

@@ -94,11 +94,8 @@ ENV NODE_ENV=production
 
 # default api serve command
 # ---------
-# If you are using a custom server file, you must use the following
-# command to launch your server instead of the default api-server below.
-# This is important if you intend to configure GraphQL to use Realtime.
-#
-# CMD [ "./api/dist/server.js" ]
+# See https://cedarjs.com/docs/server-file for customizing the api server
+# (Realtime, custom Fastify plugins, etc).
 CMD ["node_modules/.bin/cedarjs-server", "api"]
 
 # web serve

package/dist/commands/setup/docker/templates/docker-compose.dev.yml

@@ -18,7 +18,7 @@ services:
       - SESSION_SECRET=super_secret_session_key_change_me_in_production_please
       - CI=
       - NODE_ENV=development
-      - REDWOOD_API_HOST=0.0.0.0
+      - CEDAR_API_HOST=0.0.0.0
 
   db:
     image: postgres:18-bookworm

package/dist/commands/setup/docker/templates/docker-compose.prod.yml

@@ -4,11 +4,8 @@ services:
       context: .
       dockerfile: ./Dockerfile
       target: api_serve
-    # Without a command specified, the Dockerfile's api_serve CMD will be used.
-    # If you are using a custom server file, you should either use the following
-    # command to launch your server or update the Dockerfile to do so.
-    # This is important if you intend to configure GraphQL to use Realtime.
-    # command: "./api/dist/server.js"
+    # See https://cedarjs.com/docs/server-file for customizing the api
+    # server (Realtime, custom Fastify plugins, etc).
     ports:
       - '8911:8911'
     depends_on: