feat(cms): improved seed process

closed COD-235, COD-243

Author: hakalb

README.md

@@ -26,11 +26,10 @@
 - [Startup Payload multi-tenant in dev mode](#startup-payload-multi-tenant-in-dev-mode)
   - [Terminal 1: Start Postgres and admin UI](#terminal-1-start-postgres-and-admin-ui)
   - [Terminal 2: Start web client](#terminal-2-start-web-client)
-  - [Terminal 3: Start reverse proxy](#terminal-3-start-reverse-proxy)
+  - [Terminal 3: Start reverse proxy to simulate multi-tenancy](#terminal-3-start-reverse-proxy-to-simulate-multi-tenancy)
 - [Development Tools \& Services](#development-tools--services)
   - [Infisical Secrets Management](#infisical-secrets-management)
   - [Fly.io Deployment](#flyio-deployment)
-    - [Connect to the database on local machine](#connect-to-the-database-on-local-machine)
   - [Release Management](#release-management)
 
 ## Packages
@@ -95,25 +94,40 @@ The Payload suite consists of
 
 ### Terminal 1: Start Postgres and admin UI
 
-Start a Docker container
+#### Start Postgres in Docker <!-- omit in toc -->
 
 ```sh
 nx dx:postgres cms
 ```
 
-Make sure database is in a fresh state (when needed)
+#### Serve admin UI <!-- omit in toc -->
 
 ```sh
-nx payload cms migrate:fresh
+nx serve cms
 ```
 
-Start the admin UI with live-reload
+> [!NOTE]
+> Database is auto-seeded with static data when the admin UI is started.
+
+#### Optional <!-- omit in toc -->
+
+##### Clear database and run migrations <!-- omit in toc -->
 
 ```sh
-nx serve cms
+nx payload cms migrate:fresh
 ```
 
-:bulb: Database auto-seed will run
+##### Generate seed data <!-- omit in toc -->
+
+Seed data is stored in environment-specific TypeScript files in
+
+- `libs/shared/data-access/seed/src/lib/seed-data`.
+
+You can remove the existing seed data and save the empty object to the file to generate new seed data.
+
+```sh
+nx seed cms
+```
 
 ### Terminal 2: Start web client
 
@@ -124,37 +138,32 @@ nx serve cms
 nx start web
 ```
 
-### Terminal 3: Start reverse proxy
+### Terminal 3: Start reverse proxy to simulate multi-tenancy
 
 ```sh
 nx payload-proxy
-
-# stop the proxy
-nx payload-proxy:down
-
-# or extended command to restart
-nx proxy-cmd shared-util-payload restart
 ```
 
 > [!NOTE]
 > You can now access the different web sites as different tenants:
 >
-> **Admin UI** - Aimed for different maintainers  
 > 🌐 `cms.localhost`
 >
 > :pouting_face: `system@local.dev` @ `dev`
->
-> :pouting_face: `web-one.admin@local.dev` @ `dev`  
-> :pouting_face: `web-one.user@local.dev` @ `dev`
->
-> :pouting_face: `web-two.admin@local.dev` @ `dev`  
-> :pouting_face: `web-two.user@local.dev` @ `dev`
->
-> **Tenant 1**  
-> 🌐 `web-one.localhost`
->
-> **Tenant 2**  
-> 🌐 `web-two.localhost`
+
+#### Optional <!-- omit in toc -->
+
+##### Stop the proxy <!-- omit in toc -->
+
+```sh
+nx payload-proxy:down
+```
+
+##### Restart the proxy <!-- omit in toc -->
+
+```sh
+nx proxy-cmd shared-util-payload restart
+```
 
 ## Development Tools & Services
 
@@ -245,7 +254,7 @@ For deployments to preview the applications will be attached to the Postgres clu
 > fly postgres create --name pg-preview --org codeware --region arn --vm-size shared-cpu-1x --volume-size 1 --initial-cluster-size 1
 > ```
 
-##### Connect to the database on local machine
+##### Connect to the database on local machine <!-- omit in toc -->
 
 Forward server port `5432` to local port `5433` to avoid conflicts with local Postgres running in Docker.
 

apps/cms/README.md

@@ -2,48 +2,41 @@
 
 Payload application generated by Nx plugin [`@cdwr/nx-payload`](https://github.com/codeware-sthlm/codeware/tree/master/packages/nx-payload).
 
-## Start the application in Docker
+## Getting started
+
+### Start Postgres database in Docker
 
 ```sh
-npx nx start cms
+npx nx dx:start postgres
 ```
 
-Visit <http://localhost:3000>
-
-### Stop and remove Docker containers
+### Serve the application in development mode
 
 ```sh
-npx nx stop cms
+npx nx serve cms
 ```
 
-> Database is stored in persistent volume, so containers can be stopped and started without loosing the data
+Visit <http://localhost:3000>
 
-## Serve application in development mode
+## Maintenance
 
-First start the database in Docker when needed
+### Delete database and run migrations
 
 ```sh
-npx nx mongodb cms
+npx nx payload cms migrate:fresh
 ```
 
-or
+### Generate seed data
 
-```sh
-npx nx postgres cms
-```
+Seed data is stored in environment-specific TypeScript files in
 
-Then serve the application
+- `libs/shared/data-access/seed/src/lib/seed-data`.
 
-```sh
-npx nx serve cms
-```
-
-## Running tests
+You can remove the existing seed data and save the empty object to the file to generate new seed data.
 
 ```sh
-npx nx test cms
-```
+npx nx seed cms
 
-```sh
-npx nx lint cms
+# specific environment
+DEPLOY_ENV=preview npx nx seed cms
 ```

apps/cms/project.json

@@ -10,7 +10,7 @@
     "serve-fresh": {
       "executor": "nx:run-commands",
       "options": {
-        "commands": ["nx payload cms migrate:fresh", "nx serve cms"],
+        "commands": ["echo 'y' | nx payload cms migrate:fresh", "nx serve cms"],
         "parallel": false
       }
     },
@@ -42,6 +42,19 @@
           "PAYLOAD_CONFIG_PATH": "src/payload.config.ts"
         }
       }
+    },
+    "seed": {
+      "metadata": {
+        "description": "Ad-hoc seed process using the local-api only. This is useful for testing the seed process without spinning up the entire server."
+      },
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "echo 'y' | npx tsx src/utils/seed.ts",
+        "cwd": "apps/cms",
+        "env": {
+          "CWD": "../.."
+        }
+      }
     }
   }
 }

apps/cms/src/access/can-mutate-tenant-scope.ts

@@ -1,7 +1,6 @@
+import { getId, hasRole } from '@codeware/shared/util/payload';
 import type { Access } from 'payload/types';
 
-import { getId } from '../utils/get-id';
-import { hasRole } from '../utils/has-role';
 import { resolveTenant } from '../utils/resolve-tenant';
 
 /**

apps/cms/src/access/can-read-tenant-scope.ts

@@ -1,7 +1,6 @@
+import { getTenantAccessIDs, hasRole } from '@codeware/shared/util/payload';
 import type { Access, Where } from 'payload/types';
 
-import { getTenantAccessIDs } from '../utils/get-tenant-access-ids';
-import { hasRole } from '../utils/has-role';
 import { resolveTenant } from '../utils/resolve-tenant';
 
 /**

apps/cms/src/access/system-user.ts

@@ -1,6 +1,5 @@
 import type { User } from '@codeware/shared/util/payload';
-
-import { hasRole } from '../utils/has-role';
+import { hasRole } from '@codeware/shared/util/payload';
 
 /**
  * Access control reading the request for the logged in user.

apps/cms/src/collections/tenants/access/can-mutate-tenant.ts

@@ -1,9 +1,7 @@
 import type { User } from '@codeware/shared/util/payload';
+import { getId, hasRole } from '@codeware/shared/util/payload';
 import type { Access } from 'payload/types';
 
-import { getId } from '../../../utils/get-id';
-import { hasRole } from '../../../utils/has-role';
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const canMutateTenant: Access<any, User> = (args) => {
   const {

apps/cms/src/collections/tenants/access/can-read-tenant.ts

@@ -1,10 +1,11 @@
 import type { User } from '@codeware/shared/util/payload';
+import {
+  getTenantAccessIDs,
+  hasRole,
+  parseCookies
+} from '@codeware/shared/util/payload';
 import type { Access, Where } from 'payload/types';
 
-import { getTenantAccessIDs } from '../../../utils/get-tenant-access-ids';
-import { hasRole } from '../../../utils/has-role';
-import { parseCookies } from '../../../utils/parse-cookies';
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const canReadTenant: Access<any, User> = (args) => {
   const {

apps/cms/src/collections/users/access/can-create-users.ts

@@ -1,9 +1,7 @@
 import type { User } from '@codeware/shared/util/payload';
+import { getTenantAccessIDs, hasRole } from '@codeware/shared/util/payload';
 import type { Access } from 'payload/types';
 
-import { getTenantAccessIDs } from '../../../utils/get-tenant-access-ids';
-import { hasRole } from '../../../utils/has-role';
-
 /**
  * Permission to create users
  *

apps/cms/src/collections/users/access/can-delete-users.ts

@@ -1,9 +1,7 @@
 import type { User } from '@codeware/shared/util/payload';
+import { getTenantAccessIDs, hasRole } from '@codeware/shared/util/payload';
 import type { Access, Where } from 'payload/types';
 
-import { getTenantAccessIDs } from '../../../utils/get-tenant-access-ids';
-import { hasRole } from '../../../utils/has-role';
-
 /**
  * Permission to delete users
  *