@cedarjs/cli 8.0.0-canary.3525 → 8.0.0-canary.3526

package/dist/commands/setup/tenancy/authCodemod.js

@@ -53,12 +53,26 @@ function transform(fileInfo) {
   if (!selectFound) {
     throw new Error("CEDAR_CODEMOD_ERR_AUTH_SHAPE_NOT_FOUND");
   }
-  const tenancyExportSnippet = `export { hasOrgRole, requireMembership } from '@cedarjs/tenancy'
-`;
-  const tenancyExport = j.withParser("ts")(tenancyExportSnippet).find(j.ExportNamedDeclaration).nodes()[0];
-  root.find(j.Program).forEach((path) => {
-    path.node.body.push(tenancyExport);
+  const exported = /* @__PURE__ */ new Set();
+  root.find(j.ExportNamedDeclaration, { source: { value: "@cedarjs/tenancy" } }).forEach((path) => {
+    for (const specifier of path.node.specifiers ?? []) {
+      if (j.Identifier.check(specifier.exported)) {
+        exported.add(specifier.exported.name);
+      }
+    }
   });
+  const missing = ["hasOrgRole", "requireMembership"].filter(
+    (name) => !exported.has(name)
+  );
+  if (missing.length > 0) {
+    const tenancyExport = j.withParser("ts")(
+      `export { ${missing.join(", ")} } from '@cedarjs/tenancy'
+`
+    ).find(j.ExportNamedDeclaration).nodes()[0];
+    root.find(j.Program).forEach((path) => {
+      path.node.body.push(tenancyExport);
+    });
+  }
   return root.toSource();
 }
 export {

package/dist/commands/setup/tenancy/dbCodemod.js

@@ -2,14 +2,23 @@ import j from "jscodeshift";
 const DEFAULT_GLOBAL_MODELS = ["user", "organization", "membership"];
 function transform(fileInfo, _api, options) {
   const root = j.withParser("tsx")(fileInfo.source);
+  if (root.find(j.CallExpression, {
+    callee: { name: "createTenancyExtension" }
+  }).length > 0) {
+    return fileInfo.source;
+  }
+  const hasImport = root.find(j.ImportSpecifier, {
+    imported: { name: "createTenancyExtension" }
+  }).length > 0;
+  if (!hasImport) {
+    root.find(j.ImportDeclaration).at(-1).insertAfter(
+      j.importDeclaration(
+        [j.importSpecifier(j.identifier("createTenancyExtension"))],
+        j.literal("@cedarjs/tenancy")
+      )
+    );
+  }
   const tenantField = typeof options.tenantField === "string" ? options.tenantField : void 0;
-  const imports = root.find(j.ImportDeclaration);
-  imports.at(-1).insertAfter(
-    j.importDeclaration(
-      [j.importSpecifier(j.identifier("createTenancyExtension"))],
-      j.literal("@cedarjs/tenancy")
-    )
-  );
   const configProperties = [
     ...tenantField ? [
       j.objectProperty(

package/dist/commands/setup/tenancy/graphqlCodemod.js

@@ -47,16 +47,25 @@ function buildContextProperty() {
   return property;
 }
 function addNamedImport(root, names, source) {
+  const missing = names.filter(
+    (name) => root.find(j.ImportSpecifier, { local: { name } }).length === 0
+  );
+  if (missing.length === 0) {
+    return;
+  }
   const imports = root.find(j.ImportDeclaration);
   imports.at(-1).insertAfter(
     j.importDeclaration(
-      names.map((name) => j.importSpecifier(j.identifier(name))),
+      missing.map((name) => j.importSpecifier(j.identifier(name))),
       j.literal(source)
     )
   );
 }
 function transform(fileInfo) {
   const root = j.withParser("tsx")(fileInfo.source);
+  if (root.find(j.CallExpression, { callee: { name: "resolveCurrentOrg" } }).length > 0) {
+    return fileInfo.source;
+  }
   const handlerCalls = root.find(j.CallExpression, {
     callee: { name: "createGraphQLHandler" }
   });

package/dist/commands/setup/tenancy/schemaPrisma.js

@@ -15,7 +15,7 @@ const MEMBERSHIP_MODEL = `model Membership {
   invitedById     String?
   invitationToken String?      @unique
   createdAt       DateTime     @default(now())
-  updatedAt   DateTime     @updatedAt
+  updatedAt       DateTime     @updatedAt
   user            User?        @relation(fields: [userId], references: [id])
   organization    Organization @relation(fields: [organizationId], references: [id])
   invitedBy       Membership?  @relation("Inviter", fields: [invitedById], references: [id])
@@ -30,6 +30,10 @@ const RW_DATA_MIGRATION_MODEL = `model RW_DataMigration {
   startedAt  DateTime
   finishedAt DateTime
 }`;
+const collapseWhitespace = (text) => text.replace(/\s+/g, " ").trim();
+function hasCanonicalModel(schema, model) {
+  return collapseWhitespace(schema).includes(collapseWhitespace(model));
+}
 function hasModel(schema, modelName) {
   return new RegExp(`\\bmodel\\s+${modelName}\\s*\\{`).test(schema);
 }
@@ -37,7 +41,7 @@ function addTenancyModels(schema) {
   return [ORGANIZATION_MODEL, MEMBERSHIP_MODEL].reduce(appendModel, schema);
 }
 function appendModel(schema, model) {
-  if (schema.includes(model)) {
+  if (hasCanonicalModel(schema, model)) {
     return schema;
   }
   return `${schema.trimEnd()}
@@ -58,8 +62,8 @@ function editSchema(schema, options) {
   if (!hasModel(schema, "User")) {
     throw new Error("CEDAR_TENANCY_ERR_NO_USER_MODEL");
   }
-  const organizationIsCustomized = hasModel(schema, "Organization") && !schema.includes(ORGANIZATION_MODEL);
-  const membershipIsCustomized = hasModel(schema, "Membership") && !schema.includes(MEMBERSHIP_MODEL);
+  const organizationIsCustomized = hasModel(schema, "Organization") && !hasCanonicalModel(schema, ORGANIZATION_MODEL);
+  const membershipIsCustomized = hasModel(schema, "Membership") && !hasCanonicalModel(schema, MEMBERSHIP_MODEL);
   const modelsCustomized = organizationIsCustomized || membershipIsCustomized;
   if (modelsCustomized && !options.force) {
     return { schema: addDataMigrationModel(schema), outcome: "skipped" };
@@ -70,12 +74,70 @@ function editSchema(schema, options) {
     outcome: modelsCustomized ? "forced" : "added"
   };
 }
+const SCALAR_PLACEHOLDERS = {
+  String: "'__NAME__ __N__'",
+  Int: "__N__",
+  BigInt: "__N__",
+  Float: "__N__",
+  Decimal: "__N__",
+  Boolean: "false",
+  DateTime: "new Date()",
+  Json: "{}",
+  Bytes: "new Uint8Array()"
+};
+const FILLED_USER_FIELDS = ["email", "hashedPassword", "salt"];
+function requiredUserFields(schema) {
+  const body = schema.match(/\bmodel\s+User\s*\{([\s\S]*?)\n\}/)?.[1];
+  if (!body) {
+    return [];
+  }
+  const enumValues = (name) => schema.match(new RegExp(`\\benum\\s+${name}\\s*\\{([\\s\\S]*?)\\}`))?.[1].split("\n").map(
+    (line) => line.replace(/\/\/.*/, "").trim().match(/^([A-Za-z_]\w*)(?:\s|$)/)?.[1]
+  ).find((member) => member !== void 0);
+  const relationKeys = [
+    ...body.matchAll(/@relation\([^)]*fields:\s*\[([^\]]*)\]/g)
+  ].flatMap((match) => match[1].split(",").map((key) => key.trim()));
+  return body.split("\n").flatMap((line) => {
+    const field = line.replace(/\/\/.*/, "").trim().match(/^(\w+)\s+(\w+)(\?|\[\])?(.*)$/);
+    if (!field) {
+      return [];
+    }
+    const [, name, type, modifier, attributes] = field;
+    if (modifier || FILLED_USER_FIELDS.includes(name) || relationKeys.includes(name) || /@(default|updatedAt|relation)\b/.test(attributes)) {
+      return [];
+    }
+    const scalar = SCALAR_PLACEHOLDERS[type];
+    if (scalar) {
+      return [{ name, value: scalar.replace("__NAME__", name) }];
+    }
+    const enumValue = enumValues(type);
+    return enumValue ? [{ name, value: `'${enumValue}'` }] : [];
+  });
+}
+function addRequiredUserFields(source, fields, { firstNumber = 1 } = {}) {
+  if (fields.length === 0) {
+    return source;
+  }
+  let n = firstNumber - 1;
+  return source.replace(/^(\s*)salt: 'x',$/gm, (line, indent) => {
+    n++;
+    return [
+      line,
+      ...fields.map(
+        (field) => `${indent}${field.name}: ${field.value.replaceAll("__N__", String(n))},`
+      )
+    ].join("\n");
+  });
+}
 export {
   MEMBERSHIP_MODEL,
   ORGANIZATION_MODEL,
   RW_DATA_MIGRATION_MODEL,
   addDataMigrationModel,
+  addRequiredUserFields,
   addTenancyModels,
   editSchema,
-  hasModel
+  hasCanonicalModel,
+  hasModel,
+  requiredUserFields
 };

package/dist/commands/setup/tenancy/signupCodemod.js

@@ -110,6 +110,14 @@ function wrapCreateCall(fn) {
 }
 function transform(fileInfo) {
   const root = j.withParser("tsx")(fileInfo.source);
+  if (root.find(j.CallExpression, {
+    callee: { name: "ensureDefaultOrganization" }
+  }).length > 0) {
+    return fileInfo.source;
+  }
+  const hasImport = root.find(j.ImportSpecifier, {
+    local: { name: "ensureDefaultOrganization" }
+  }).length > 0;
   const signupOptionsDeclarators = root.find(j.VariableDeclarator, {
     id: { name: "signupOptions" }
   });
@@ -140,13 +148,14 @@ function transform(fileInfo) {
     throw new Error("CEDAR_CODEMOD_ERR_SIGNUP_SHAPE_NOT_FOUND");
   }
   addInvitationTokenToUserAttributes(root);
-  const imports = root.find(j.ImportDeclaration);
-  imports.at(-1).insertAfter(
-    j.importDeclaration(
-      [j.importSpecifier(j.identifier("ensureDefaultOrganization"))],
-      j.literal("src/services/organizations/organizations")
-    )
-  );
+  if (!hasImport) {
+    root.find(j.ImportDeclaration).at(-1).insertAfter(
+      j.importDeclaration(
+        [j.importSpecifier(j.identifier("ensureDefaultOrganization"))],
+        j.literal("src/services/organizations/organizations")
+      )
+    );
+  }
   return root.toSource();
 }
 export {

package/dist/commands/setup/tenancy/templates/ensureDefaultOrganizations.dataMigration.ts.template

@@ -11,7 +11,8 @@ const BATCH_SIZE = 100
  *
  * Run with `__DATA_MIGRATE_UP_COMMAND__`, after
  * `__PRISMA_MIGRATE_DEV_COMMAND__` has applied the
- * `Organization`/`Membership` migration.
+ * `Organization`/`Membership` migration and `__PRISMA_GENERATE_COMMAND__`
+ * has updated the Prisma client.
  */
 export default async ({ db }: { db: PrismaClient }) => {
   let cursor: string | undefined

package/dist/commands/setup/tenancy/templates/organizations.scenarios.ts.template

@@ -3,8 +3,9 @@ import type { ScenarioData } from '@cedarjs/testing/api'
 import type { Membership, Organization, Prisma } from 'src/lib/db'
 
 // This scenario assumes a dbAuth-style `User` model (`email`,
-// `hashedPassword`, `salt`). Adjust the `user` fixture below to match your
-// app's actual `User` fields if you use a different auth provider.
+// `hashedPassword`, `salt`), plus placeholders for any other fields your
+// `User` requires. Adjust the `user` fixtures below if you use a different
+// auth provider.
 export const standard = defineScenario<
   Prisma.OrganizationCreateArgs | Prisma.MembershipCreateArgs
 >({

package/dist/commands/setup/tenancy/tenancyHandler.js

@@ -11,7 +11,10 @@ import {
   addWebPackages
 } from "@cedarjs/cli-helpers/installHelpers";
 import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
-import { runTransitiveBin } from "@cedarjs/cli-helpers/packageManager/exec";
+import {
+  runBinSync,
+  runTransitiveBin
+} from "@cedarjs/cli-helpers/packageManager/exec";
 import { getDataMigrationsPath, getSchemaPath } from "@cedarjs/project-config";
 import { errorTelemetry } from "@cedarjs/telemetry";
 import { getPaths, transformTSToJS, writeFile } from "../../../lib/index.js";
@@ -23,10 +26,12 @@ import {
   noUserModelMessage
 } from "./preflight.js";
 import {
+  addRequiredUserFields,
   editSchema,
   hasModel,
   MEMBERSHIP_MODEL,
-  ORGANIZATION_MODEL
+  ORGANIZATION_MODEL,
+  requiredUserFields
 } from "./schemaPrisma.js";
 const DEFAULT_TENANT_FIELD = "organizationId";
 const AUTH_SNIPPET = `
@@ -87,14 +92,22 @@ const handler = async ({ tenantField, force }) => {
   const graphqlPath = path.join(paths.api.functions, `graphql.${ext}`);
   const functionsAuthPath = path.join(paths.api.functions, `auth.${ext}`);
   const isDbAuthProject = fs.existsSync(functionsAuthPath) && fs.readFileSync(functionsAuthPath, "utf-8").includes("DbAuthHandler");
-  const writeTemplateFile = async (templateFile, outputPath, replacements = {}) => {
+  const writtenFiles = [];
+  const keptFiles = [];
+  const writeTemplateFile = async (templateFile, outputPath, replacements = {}, transform = (content) => content) => {
     const dirname = import.meta.dirname;
     const templatePath = path.resolve(dirname, "templates", templateFile);
     let templateContent = fs.readFileSync(templatePath, "utf-8");
     for (const [token, value] of Object.entries(replacements)) {
       templateContent = templateContent.replaceAll(token, value);
     }
+    templateContent = transform(templateContent);
     const content = projectIsTypescript ? templateContent : await transformTSToJS(outputPath, templateContent);
+    if (fs.existsSync(outputPath) && !force) {
+      keptFiles.push(outputPath);
+      return;
+    }
+    writtenFiles.push(outputPath);
     return writeFile(outputPath, content, { overwriteExisting: force });
   };
   const tasks = new Listr(
@@ -153,9 +166,9 @@ Re-run with --force to have this command append its own versions beside them ins
               "`prisma format` failed, so the `memberships` relation was not added to the `User` model. Add it by hand: `memberships Membership[]` as the last field of `model User { ... }`, then re-run this command."
             );
           }
-          const membershipsOccurrences = (schema2) => (schema2.match(/memberships\s+Membership\[\]/g) ?? []).length;
           const formattedSchema = fs.readFileSync(schemaPath, "utf-8");
-          if (membershipsOccurrences(formattedSchema) <= membershipsOccurrences(editResult.schema)) {
+          const userModel = formattedSchema.match(/\bmodel\s+User\s*\{[\s\S]*?\n\}/)?.[0] ?? "";
+          if (!/^\s*memberships\s+Membership\[\]/m.test(userModel)) {
             if (editResult.outcome === "forced") {
               task.output = 'The `memberships` relation was not added to the `User` model, likely because of the clash from --force. Continuing with the rest of the setup; see "Next steps" for how to merge the appended models by hand.';
               return;
@@ -260,17 +273,28 @@ ${SIGNUP_SNIPPET}`;
         title: "Adding the organizations service...",
         task: async () => {
           const serviceDir = path.join(paths.api.services, "organizations");
+          const userFields = requiredUserFields(
+            fs.readFileSync(
+              await getSchemaPath(paths.api.prismaConfig),
+              "utf-8"
+            )
+          );
+          const withUserFields = (firstNumber) => (content) => addRequiredUserFields(content, userFields, { firstNumber });
           await writeTemplateFile(
             "organizations.ts.template",
             path.join(serviceDir, `organizations.${ext}`)
           );
           await writeTemplateFile(
             "organizations.test.ts.template",
-            path.join(serviceDir, `organizations.test.${ext}`)
+            path.join(serviceDir, `organizations.test.${ext}`),
+            {},
+            withUserFields(101)
           );
           await writeTemplateFile(
             "organizations.scenarios.ts.template",
-            path.join(serviceDir, `organizations.scenarios.${ext}`)
+            path.join(serviceDir, `organizations.scenarios.${ext}`),
+            {},
+            withUserFields(1)
           );
           await writeTemplateFile(
             "organizations.sdl.ts.template",
@@ -280,10 +304,17 @@ ${SIGNUP_SNIPPET}`;
       },
       {
         title: "Adding a data migration to backfill existing users...",
-        task: async () => {
+        task: async (_ctx, task) => {
           const dataMigrationsPath = await getDataMigrationsPath(
             paths.api.prismaConfig
           );
+          const existing = fs.existsSync(dataMigrationsPath) && fs.readdirSync(dataMigrationsPath).find(
+            (file) => /-ensure-default-organizations\.[jt]s$/.test(file)
+          );
+          if (existing) {
+            task.skip(`Already added: ${existing}`);
+            return;
+          }
           const timestamp = (/* @__PURE__ */ new Date()).toISOString().split(".")[0].replace(/\D/g, "");
           await writeTemplateFile(
             "ensureDefaultOrganizations.dataMigration.ts.template",
@@ -300,6 +331,10 @@ ${SIGNUP_SNIPPET}`;
                 "prisma",
                 "migrate",
                 "dev"
+              ]),
+              __PRISMA_GENERATE_COMMAND__: formatCedarCommand([
+                "prisma",
+                "generate"
               ])
             }
           );
@@ -327,34 +362,39 @@ ${SIGNUP_SNIPPET}`;
         }
       },
       {
-        title: "Prettifying changed files",
+        title: "Formatting and linting changed files...",
         task: async (_ctx, task) => {
-          const prettifyPaths = [
-            path.join(paths.api.lib, "db.js"),
-            path.join(paths.api.lib, "db.ts"),
-            path.join(paths.api.lib, "auth.js"),
-            path.join(paths.api.lib, "auth.ts"),
-            path.join(paths.api.functions, "graphql.js"),
-            path.join(paths.api.functions, "graphql.ts"),
-            path.join(paths.api.functions, "auth.js"),
-            path.join(paths.api.functions, "auth.ts")
-          ];
-          for (const prettifyPath of prettifyPaths) {
+          const changedFiles = [
+            ...writtenFiles,
+            ...["db", "auth"].map((name) => path.join(paths.api.lib, name)),
+            ...["graphql", "auth"].map(
+              (name) => path.join(paths.api.functions, name)
+            )
+          ].flatMap(
+            (file) => path.extname(file) ? [file] : [`${file}.js`, `${file}.ts`]
+          ).filter((file) => fs.existsSync(file));
+          const prettierOptions = await getPrettierOptions();
+          for (const file of changedFiles) {
             try {
-              if (!fs.existsSync(prettifyPath)) {
-                continue;
-              }
-              const source = fs.readFileSync(prettifyPath, "utf-8");
-              const prettierOptions = await getPrettierOptions();
-              const prettifiedApp = await format(source, {
+              const source = fs.readFileSync(file, "utf-8");
+              const formatted = await format(source, {
                 ...prettierOptions,
                 parser: "babel-ts"
               });
-              fs.writeFileSync(prettifyPath, prettifiedApp, "utf-8");
+              fs.writeFileSync(file, formatted, "utf-8");
             } catch {
               task.output = "Couldn't prettify the changes. Please reformat the files manually if needed.";
             }
           }
+          try {
+            runBinSync("eslint", ["--fix", ...changedFiles], {
+              cwd: paths.base
+            });
+          } catch {
+            task.output = `Some of the changed files still have lint errors. Run ${c.highlight(
+              formatCedarCommand(["lint"])
+            )} to see them.`;
+          }
         }
       },
       {
@@ -365,6 +405,7 @@ ${SIGNUP_SNIPPET}`;
             "migrate",
             "dev"
           ]);
+          const generateCommand = formatCedarCommand(["prisma", "generate"]);
           const dataMigrateCommand = formatCedarCommand(["data-migrate", "up"]);
           const modelsExistWarning = ctx.modelsExistOutcome === "forced" ? c.error(
             "\nschema.prisma is currently invalid (as requested by --force): merge the appended Organization/Membership blocks with your existing ones, then run `prisma format`.\n"
@@ -376,12 +417,14 @@ ${SIGNUP_SNIPPET}`;
           ${c.success("\nMulti-tenancy configured!\n")}
           ${modelsExistWarning}
           1. Run ${c.highlight(migrateCommand)} to create the Organization/Membership
-             tables, then ${c.highlight(dataMigrateCommand)} to give every existing
-             user a default organization.
+             tables and ${c.highlight(generateCommand)} to update the Prisma client,
+             then ${c.highlight(dataMigrateCommand)} to give every existing user a
+             default organization.
           2. \`db.ts\`'s tenancy extension scopes every model except
              User/Organization/Membership. For each existing model (e.g.
-             Contact) whose rows belong to one organization, add ${c.highlight("organizationId String")} plus ${c.highlight("@@index([organizationId])")}
-             to it in schema.prisma; for each one that stays global, add it
+             Contact) whose rows belong to one organization, add
+             ${c.highlight("organizationId String")} plus ${c.highlight("@@index([organizationId])")} to it in
+             schema.prisma; for each one that stays global, add it
              to the ${c.highlight("allExcept")} list in api/src/lib/db instead.
           3. Wrap your organization routes with the generated OrgScope in
              web/src/Routes.tsx:
@@ -399,7 +442,12 @@ ${SIGNUP_SNIPPET}`;
             "@cedarjs/tenancy"
           )}.
 
-          Check out the docs for more info:
+${keptFiles.length > 0 ? `
+          Kept these existing files rather than overwriting them (run with
+          ${c.highlight("--force")} to overwrite):
+${keptFiles.map((file) => `            ${path.relative(paths.base, file)}`).join("\n")}
+
+` : ""}          Check out the docs for more info:
           ${terminalLink("", "https://cedarjs.com/docs/tenancy")}
 
         `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli",
-  "version": "8.0.0-canary.3525",
+  "version": "8.0.0-canary.3526",
   "description": "The CedarJS Command Line",
   "repository": {
     "type": "git",
@@ -36,17 +36,17 @@
     "@babel/preset-typescript": "7.29.7",
     "@babel/traverse": "7.29.10",
     "@babel/types": "7.29.8",
-    "@cedarjs/api-server": "8.0.0-canary.3525",
-    "@cedarjs/babel-config": "8.0.0-canary.3525",
-    "@cedarjs/cli-helpers": "8.0.0-canary.3525",
-    "@cedarjs/internal": "8.0.0-canary.3525",
-    "@cedarjs/prerender": "8.0.0-canary.3525",
-    "@cedarjs/project-config": "8.0.0-canary.3525",
-    "@cedarjs/structure": "8.0.0-canary.3525",
-    "@cedarjs/telemetry": "8.0.0-canary.3525",
-    "@cedarjs/utils": "8.0.0-canary.3525",
-    "@cedarjs/vite": "8.0.0-canary.3525",
-    "@cedarjs/web-server": "8.0.0-canary.3525",
+    "@cedarjs/api-server": "8.0.0-canary.3526",
+    "@cedarjs/babel-config": "8.0.0-canary.3526",
+    "@cedarjs/cli-helpers": "8.0.0-canary.3526",
+    "@cedarjs/internal": "8.0.0-canary.3526",
+    "@cedarjs/prerender": "8.0.0-canary.3526",
+    "@cedarjs/project-config": "8.0.0-canary.3526",
+    "@cedarjs/structure": "8.0.0-canary.3526",
+    "@cedarjs/telemetry": "8.0.0-canary.3526",
+    "@cedarjs/utils": "8.0.0-canary.3526",
+    "@cedarjs/vite": "8.0.0-canary.3526",
+    "@cedarjs/web-server": "8.0.0-canary.3526",
     "@listr2/prompt-adapter-enquirer": "4.4.3",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/core": "2.12.0",
@@ -94,7 +94,7 @@
     "yargs": "18.2.0"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "8.0.0-canary.3525",
+    "@cedarjs/framework-tools": "8.0.0-canary.3526",
     "@prisma/dmmf": "7.10.1",
     "@types/archiver": "^7.0.0",
     "memfs": "4.80.0",