@crombolo/server 0.11.0 → 0.13.1

package/src/adapters/schema-files.ts

@@ -8,7 +8,7 @@
 import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs'
 import { join, relative } from 'node:path'
 import type { PortFailure } from '@crombolo/api-management'
-import type { ContentTypeAggregate, DataTypeModel } from '@crombolo/core'
+import type { ContentTypeAggregate, DataTypeModel, FormTypes } from '@crombolo/core'
 import { currentSchemaState, type Db, updateSchemaStateHash } from '@crombolo/data'
 import {
   type ChangeClass,
@@ -18,6 +18,7 @@ import {
   loadSchemaDirectory,
   nextSchemaVersion,
   type SchemaTypeKind,
+  type SchemaUrls,
   TYPE_KIND_FILES,
   validateSchemaSet,
   writeContentType,
@@ -32,6 +33,8 @@ export interface SchemaFiles {
   schemaDir: string
   writable: boolean
   componentAliases(): ReadonlySet<string>
+  /** The form types the site's wired bundles add. */
+  formTypes?: FormTypes
   /**
    * Called after any write, so a shared schema store outlives this container.
    * Absent when the schema is a directory on disk, which needs no publishing.
@@ -54,6 +57,8 @@ export interface SchemaFileWriter {
   writeDataType(model: DataTypeModel): Promise<void>
   removeDataType(alias: string): Promise<void>
   writeLanguages(): Promise<void>
+  /** `[urls]` in `schema.toml`, the version left as it is. */
+  writeUrlOptions(urls: SchemaUrls): Promise<void>
   /** After a move or a folder change: every file, from the database, canonically. */
   rewriteAll(): Promise<void>
 }
@@ -82,7 +87,7 @@ export function createSchemaFileWriter(
     await updateSchemaStateHash(
       db,
       state.id,
-      hashSchemaSet(loadSchemaDirectory(files.schemaDir).set),
+      hashSchemaSet(loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes }).set),
     )
     await files.onChanged?.()
   }
@@ -100,10 +105,10 @@ export function createSchemaFileWriter(
 
     async bumpVersion(classification) {
       if (!managed() || !files.writable || classification === 'none') return
-      const loaded = loadSchemaDirectory(files.schemaDir)
+      const loaded = loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes })
       const next = nextSchemaVersion(loaded.set.version, classification)
       if (next === loaded.set.version) return
-      writeFileSync(join(files.schemaDir, 'schema.toml'), writeSchemaVersion(next))
+      writeFileSync(join(files.schemaDir, 'schema.toml'), writeSchemaVersion(next, loaded.set.urls))
       logger('schema').info('Schema version {from} → {to} ({classification})', {
         from: loaded.set.version,
         to: next,
@@ -113,7 +118,10 @@ export function createSchemaFileWriter(
 
     async write(aggregate, previousAlias) {
       if (!managed() || !files.writable) return
-      const set = await exportSchemaSet(db, loadSchemaDirectory(files.schemaDir).set.version)
+      const set = await exportSchemaSet(
+        db,
+        loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes }).set.version,
+      )
       const list =
         kind === 'document'
           ? set.contentTypes
@@ -122,7 +130,10 @@ export function createSchemaFileWriter(
             : (set.memberTypes ?? [])
       const type = list.find((t) => t.key === aggregate.key)
       if (!type) return
-      const problems = validateSchemaSet(set, { componentAliases: files.componentAliases() })
+      const problems = validateSchemaSet(set, {
+        componentAliases: files.componentAliases(),
+        types: files.formTypes,
+      })
       if (problems.length > 0) {
         const detail = problems.map((p) => `${p.file}: ${p.message}`).join('; ')
         logger('schema').error('Not writing {file}: {detail}', {
@@ -146,7 +157,10 @@ export function createSchemaFileWriter(
 
     async writeDataType(model) {
       if (!managed() || !files.writable || !model.alias) return
-      const set = await exportSchemaSet(db, loadSchemaDirectory(files.schemaDir).set.version)
+      const set = await exportSchemaSet(
+        db,
+        loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes }).set.version,
+      )
       const dataType = set.dataTypes.find((d) => d.key === model.key)
       // An unchanged built-in has no file; a changed one does.
       if (!dataType) {
@@ -157,7 +171,10 @@ export function createSchemaFileWriter(
       // The same guard `write` applies to a content type: a set that does not
       // validate never reaches the disk, because the file is what every other
       // node reads and what a deploy boots from.
-      const problems = validateSchemaSet(set, { componentAliases: files.componentAliases() })
+      const problems = validateSchemaSet(set, {
+        componentAliases: files.componentAliases(),
+        types: files.formTypes,
+      })
       if (problems.length > 0) {
         const detail = problems.map((p) => `${p.file}: ${p.message}`).join('; ')
         logger('schema').error('Not writing {file}: {detail}', {
@@ -182,16 +199,29 @@ export function createSchemaFileWriter(
 
     async writeLanguages() {
       if (!managed() || !files.writable) return
-      const set = await exportSchemaSet(db, loadSchemaDirectory(files.schemaDir).set.version)
+      const set = await exportSchemaSet(
+        db,
+        loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes }).set.version,
+      )
       writeFileSync(join(files.schemaDir, 'languages.toml'), writeLanguages(set.languages))
       await settle()
     },
 
+    async writeUrlOptions(urls) {
+      if (!managed() || !files.writable) return
+      const { version } = loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes }).set
+      writeFileSync(join(files.schemaDir, 'schema.toml'), writeSchemaVersion(version, urls))
+      await settle()
+    },
+
     async rewriteAll() {
       if (!managed() || !files.writable) return
-      const loaded = loadSchemaDirectory(files.schemaDir)
+      const loaded = loadSchemaDirectory(files.schemaDir, { formTypes: files.formTypes })
       const set = await exportSchemaSet(db, loaded.set.version)
-      const problems = validateSchemaSet(set, { componentAliases: files.componentAliases() })
+      const problems = validateSchemaSet(set, {
+        componentAliases: files.componentAliases(),
+        types: files.formTypes,
+      })
       if (problems.length > 0) {
         const detail = problems.map((p) => `${p.file}: ${p.message}`).join('; ')
         logger('schema').error('Not rewriting the schema files: {detail}', { detail })

package/src/adapters/schema-proposals.ts

@@ -18,6 +18,7 @@ import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
 import { dirname, join } from 'node:path'
 import type { SchemaProposalPort } from '@crombolo/assistant'
 import type { Db } from '@crombolo/data'
+import type { SyncReport } from '@crombolo/schema'
 import {
   fileNameFor,
   loadSchemaDirectory,
@@ -32,6 +33,7 @@ import {
   writeSchemaVersion,
 } from '@crombolo/schema'
 import type { CromboloConfig } from '../config.ts'
+import { formTypesFor } from '../form-types.ts'
 import { logger } from '../logging.ts'
 import { componentAliasesIn, importSchema } from '../schema.ts'
 
@@ -48,6 +50,8 @@ export interface SchemaProposalOptions {
   config: CromboloConfig
   /** The node's identity and state, refreshed in place by an import. */
   boot: { nodeId: string; nodeState: { version: string; revision: string } }
+  /** After an import applies: what a change to how URLs are built needs. */
+  afterSync?(report: SyncReport | undefined): Promise<void>
 }
 
 export function createSchemaProposals(options: SchemaProposalOptions): SchemaProposalPort {
@@ -70,12 +74,12 @@ export function createSchemaProposals(options: SchemaProposalOptions): SchemaPro
           ? parsed.problems
           : [{ file, path: '', message: 'the file defines no data type' }]
       }
-      const set = loadSchemaDirectory(config.schemaDir).set
+      const set = loadSchemaDirectory(config.schemaDir, { formTypes: formTypesFor(config) }).set
       const dataTypes = [
         ...set.dataTypes.filter((existing) => existing.alias !== dataType.alias),
         dataType,
       ]
-      return validateSchemaSet({ ...set, dataTypes })
+      return validateSchemaSet({ ...set, dataTypes }, { types: formTypesFor(config) })
     }
 
     const parsed = parseContentType(file, toml)
@@ -85,14 +89,14 @@ export function createSchemaProposals(options: SchemaProposalOptions): SchemaPro
         ? parsed.problems
         : [{ file, path: '', message: 'the file defines no content type' }]
     }
-    const set = loadSchemaDirectory(config.schemaDir).set
+    const set = loadSchemaDirectory(config.schemaDir, { formTypes: formTypesFor(config) }).set
     const contentTypes = [
       ...set.contentTypes.filter((existing) => existing.alias !== contentType.alias),
       contentType,
     ]
     return validateSchemaSet(
       { ...set, contentTypes },
-      { componentAliases: componentAliasesIn(config.componentsDir) },
+      { componentAliases: componentAliasesIn(config.componentsDir), types: formTypesFor(config) },
     )
   }
 
@@ -140,9 +144,11 @@ export function createSchemaProposals(options: SchemaProposalOptions): SchemaPro
       // import lands at a version the other nodes already have and they never
       // learn they are behind.
       const ahead = await importSchema(options.db, config, options.boot, { dryRun: true })
-      const version = loadSchemaDirectory(config.schemaDir).set.version
+      const { version, urls } = loadSchemaDirectory(config.schemaDir, {
+        formTypes: formTypesFor(config),
+      }).set
       const next = nextSchemaVersion(version, ahead.classification)
-      if (next !== version) await writeFile(versionFile, writeSchemaVersion(next), 'utf8')
+      if (next !== version) await writeFile(versionFile, writeSchemaVersion(next, urls), 'utf8')
 
       const result = await importSchema(options.db, config, options.boot)
       if (result.report && result.report.action !== 'applied') {
@@ -154,6 +160,7 @@ export function createSchemaProposals(options: SchemaProposalOptions): SchemaPro
           error: result.report.reason ?? `the import was ${result.report.action}`,
         }
       }
+      await options.afterSync?.(result.report)
       log.info('{alias} applied from a proposal: {classification}, schema at {version}', {
         alias,
         classification: ahead.classification,

package/src/adapters/webhooks.ts

@@ -0,0 +1,76 @@
+/** Webhooks, shaped for the Management API: secrets masked, logs as Umbraco's client reads them. */
+import type { WebhookPort, WebhookPortView } from '@crombolo/api-management'
+import { nameBasedUuid, type WebhookLogEntry } from '@crombolo/data'
+import { envReference } from '../webhook-files.ts'
+import { MASKED, type WebhookService, type WebhookView } from '../webhooks.ts'
+
+/** A typed-in secret never leaves the server; an `env:` reference is not a secret. */
+const masked = (headers: Record<string, string>) =>
+  Object.fromEntries(
+    Object.entries(headers).map(([name, value]) => [name, envReference(value) ? value : MASKED]),
+  )
+
+function toView(webhook: WebhookView): WebhookPortView {
+  return {
+    id: webhook.key,
+    name: webhook.name,
+    description: webhook.description,
+    url: webhook.url,
+    enabled: webhook.enabled,
+    events: webhook.events,
+    contentTypeKeys: webhook.contentTypeKeys,
+    headers: masked(webhook.headers),
+  }
+}
+
+/** A bundle's handler has no webhook key, so its log rows take a stable one of their own. */
+const subscriberKey = (subscriber: string) =>
+  subscriber.startsWith('bundle:') ? nameBasedUuid(subscriber) : subscriber
+
+function toLog(entry: WebhookLogEntry) {
+  return {
+    key: entry.key,
+    webhookKey: subscriberKey(entry.subscriber),
+    statusCode: entry.exception
+      ? 'Exception'
+      : entry.statusCode === null
+        ? entry.success
+          ? 'Handled'
+          : 'Failed'
+        : String(entry.statusCode),
+    httpStatusCode: entry.statusCode,
+    isSuccessStatusCode: entry.success,
+    date: entry.date.toISOString(),
+    eventAlias: entry.eventAlias,
+    url: entry.url,
+    retryCount: entry.retryCount,
+    requestHeaders: entry.requestHeaders,
+    requestBody: entry.requestBody,
+    responseHeaders: entry.responseHeaders,
+    responseBody: entry.responseBody,
+    exceptionOccured: entry.exception,
+  }
+}
+
+export function createWebhookPort(service: WebhookService): WebhookPort {
+  return {
+    list: async () => (await service.list()).map(toView),
+    async get(id) {
+      const webhook = await service.get(id)
+      return webhook ? toView(webhook) : undefined
+    },
+    async create(input) {
+      const result = await service.create({ ...input, key: input.id ?? crypto.randomUUID() })
+      return result.ok ? { ok: true, id: result.key } : result
+    },
+    async update(id, input) {
+      const result = await service.update(id, { ...input, key: id })
+      return result.ok ? { ok: true, id: result.key } : result
+    },
+    remove: (id) => service.remove(id),
+    async logs(id, paging) {
+      const result = await service.logs(id?.toLowerCase(), paging)
+      return { total: result.total, items: result.items.map(toLog) }
+    },
+  }
+}

package/src/approvals-api.ts

@@ -0,0 +1,189 @@
+/**
+ * The Workflow section's and the page tab's reads and actions (story 028),
+ * under `<backoffice>/crombolo/api/approvals/`, and saving a workflow drawn in
+ * the designer back to `schema/workflows/`. docs/workflows.md.
+ *
+ * A workflow is written as its file, validated against the whole set first,
+ * then synced at once, so the gate follows it without a restart; the file is
+ * the truth, as for forms, and a read-only schema directory refuses the save.
+ */
+import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+import type { Principal } from '@crombolo/api-management'
+import type { SchemaWorkflow } from '@crombolo/core'
+import { type Db, readWorkflows, syncWorkflows, UserGroupRepository } from '@crombolo/data'
+import {
+  fileNameFor,
+  loadSchemaDirectory,
+  parseWorkflow,
+  validateWorkflows,
+  workflowVersion,
+  writeWorkflow,
+} from '@crombolo/schema'
+import { ApprovalRefused, type Approvals } from './approvals.ts'
+
+export interface ApprovalsApiContext {
+  db: Db
+  approvals: Approvals
+  principal: Principal
+  schemaDir: string
+  /** False on a deployed node with no schema store: a save would not last. */
+  writable: boolean
+  onChanged?: () => Promise<void>
+}
+
+const json = (body: unknown, status = 200) => Response.json(body, { status })
+
+/** The workflows in `schema/workflows/`, synced into the database: what the gate reads. */
+export async function syncWorkflowFiles(db: Db, schemaDir: string) {
+  const workflows = loadSchemaDirectory(schemaDir).set.workflows ?? []
+  return syncWorkflows(
+    db,
+    workflows.map((workflow) => ({ workflow, version: workflowVersion(workflow) })),
+  )
+}
+
+/** What saving a workflow would do to the requests in flight under it. */
+async function changePreview(approvals: Approvals, principal: Principal, workflow: SchemaWorkflow) {
+  const id = workflow.key ?? workflow.alias
+  const stored = (await approvals.workflows()).find(
+    (s) => (s.workflow.key ?? s.workflow.alias) === id,
+  )
+  const version = workflowVersion(workflow)
+  if (stored && stored.version === version) return []
+  const waiting = (await approvals.inFlight(principal)).filter(
+    (r) => (r.workflow.key ?? r.workflow.alias) === id,
+  )
+  return waiting.map((r) => ({ key: r.key, page: r.nodeName, outcome: workflow.onChange }))
+}
+
+export async function handleApprovalsApi(
+  request: Request,
+  path: string,
+  ctx: ApprovalsApiContext,
+): Promise<Response | undefined> {
+  const { approvals, principal } = ctx
+  const body = async () => (await request.json().catch(() => ({}))) as Record<string, unknown>
+  const text = (value: unknown) => (typeof value === 'string' ? value : undefined)
+  try {
+    let match = /^page\/([^/]+)$/.exec(path)
+    if (match && request.method === 'GET')
+      return json(await approvals.forPage(principal, decodeURIComponent(match[1] as string)))
+
+    match = /^page\/([^/]+)\/send$/.exec(path)
+    if (match && request.method === 'POST') {
+      const b = await body()
+      const cultures = Array.isArray(b.cultures) ? b.cultures.map(String) : null
+      return json(
+        await approvals.send(
+          principal,
+          decodeURIComponent(match[1] as string),
+          b.action === 'unpublish' ? 'unpublish' : 'publish',
+          cultures && cultures.length > 0 ? cultures : null,
+          text(b.comment),
+        ),
+      )
+    }
+
+    match = /^request\/([^/]+)\/(approve|send-back|withdraw)$/.exec(path)
+    if (match && request.method === 'POST') {
+      const key = decodeURIComponent(match[1] as string)
+      const b = await body()
+      if (match[2] === 'approve')
+        return json(await approvals.approve(principal, key, text(b.stage), text(b.comment)))
+      if (match[2] === 'send-back')
+        return json(await approvals.sendBack(principal, key, text(b.stage), text(b.comment)))
+      return json(await approvals.withdraw(principal, key))
+    }
+
+    if (path === 'waiting' && request.method === 'GET')
+      return json({ items: await approvals.waitingFor(principal) })
+    if (path === 'in-flight' && request.method === 'GET')
+      return json({ items: await approvals.inFlight(principal) })
+    if (path === 'history' && request.method === 'GET') {
+      const url = new URL(request.url)
+      const skip = Math.max(0, Number(url.searchParams.get('skip') ?? 0) || 0)
+      const take = Math.min(100, Math.max(1, Number(url.searchParams.get('take') ?? 25) || 25))
+      return json(await approvals.finished(principal, skip, take))
+    }
+
+    if (path === 'workflows' && request.method === 'GET') {
+      const loaded = loadSchemaDirectory(ctx.schemaDir)
+      return json({
+        items: (await readWorkflows(ctx.db)).map((s) => s.workflow),
+        editable: ctx.writable && principal.isAdmin,
+        groups: (await new UserGroupRepository(ctx.db).all()).map((g) => ({
+          alias: g.alias,
+          name: g.name,
+        })),
+        contentTypes: loaded.set.contentTypes.map((t) => ({ alias: t.alias, name: t.name })),
+      })
+    }
+
+    match = /^workflows\/([^/]+)(\/preview)?$/.exec(path)
+    if (match) {
+      if (!principal.isAdmin)
+        return json({ ok: false, message: 'Only administrators change workflows.' }, 403)
+      const alias = decodeURIComponent(match[1] as string)
+      const file = join(ctx.schemaDir, 'workflows', fileNameFor(alias))
+      if (request.method === 'DELETE') {
+        if (!ctx.writable) return readOnly()
+        if (!existsSync(file))
+          return json({ ok: false, message: 'There is no such workflow.' }, 404)
+        rmSync(file)
+        await ctx.onChanged?.()
+        return json({ ok: true, report: await syncWorkflowFiles(ctx.db, ctx.schemaDir) })
+      }
+      if (request.method !== 'PUT' && request.method !== 'POST') return undefined
+      const b = await body()
+      // Through the file and the strict parser, as a hand-written one would be.
+      const source = writeWorkflow(b.workflow as SchemaWorkflow)
+      const parsed = parseWorkflow(`schema/workflows/${fileNameFor(alias)}`, source)
+      if (!parsed.value) return json({ ok: false, problems: parsed.problems }, 400)
+      const workflow = parsed.value
+      const loaded = loadSchemaDirectory(ctx.schemaDir)
+      const others = (loaded.set.workflows ?? []).filter(
+        (w) => w.alias !== alias && w.alias !== workflow.alias,
+      )
+      const problems = validateWorkflows(
+        [...others, workflow],
+        new Set(loaded.set.contentTypes.map((t) => t.alias)),
+      )
+      const groups = new Set((await new UserGroupRepository(ctx.db).all()).map((g) => g.alias))
+      workflow.stages.forEach((stage, i) => {
+        for (const approver of stage.approvers)
+          if (!groups.has(approver))
+            problems.push({
+              file: `schema/workflows/${fileNameFor(workflow.alias)}`,
+              path: `stage[${i}].approvers`,
+              message: `there is no user group "${approver}"`,
+            })
+      })
+      if (problems.length > 0) return json({ ok: false, problems }, 400)
+      const affected = await changePreview(approvals, principal, workflow)
+      if (match[2]) return json({ ok: true, affected })
+      if (!ctx.writable) return readOnly()
+      mkdirSync(join(ctx.schemaDir, 'workflows'), { recursive: true })
+      // A renamed workflow leaves its old file behind otherwise.
+      if (alias !== workflow.alias && existsSync(file)) rmSync(file)
+      writeFileSync(join(ctx.schemaDir, 'workflows', fileNameFor(workflow.alias)), source, 'utf8')
+      await ctx.onChanged?.()
+      return json({ ok: true, affected, report: await syncWorkflowFiles(ctx.db, ctx.schemaDir) })
+    }
+  } catch (error) {
+    if (error instanceof ApprovalRefused)
+      return json({ ok: false, message: error.message }, error.status)
+    throw error
+  }
+  return undefined
+}
+
+const readOnly = () =>
+  json(
+    {
+      ok: false,
+      message:
+        'The schema directory is read-only on this server, so a workflow cannot be saved here. Change the file in the repository and deploy it.',
+    },
+    409,
+  )