@crombolo/server 0.0.0-stage → 0.10.0

package/src/form-workflows.ts

@@ -0,0 +1,397 @@
+/**
+ * Running a form's workflows. `docs/forms.md`.
+ *
+ * The submission is already stored by the time anything here runs: these are
+ * the side effects, and a side effect that fails must never cost the entry.
+ * Each run is a queue row, claimed by one node and retried with a backoff, so
+ * a mail server that is down for ten minutes delays an email rather than
+ * losing it — and a multi-node site sends it once.
+ *
+ * Three types. The XSLT ones Umbraco has are gone (`docs/forms.md` says
+ * why), and Slack is `sendToUrl` with a webhook URL rather than a type of its
+ * own.
+ */
+import {
+  allFormFields,
+  type FormValueToStore,
+  type SchemaForm,
+  type SchemaFormWorkflow,
+} from '@crombolo/core'
+import {
+  ContentTypeRepository,
+  type Db,
+  DocumentRepository,
+  FormWorkflowRepository,
+  type FormWorkflowRun,
+  type NodeSchemaState,
+} from '@crombolo/data'
+import type { EmailAttachment, EmailPort } from './email.ts'
+import { logger } from './logging.ts'
+import type { MediaFileStore } from './media-files.ts'
+
+const log = logger('forms')
+
+/** Attempts before a run is left for a person to look at. */
+export const MAX_WORKFLOW_ATTEMPTS = 5
+/** How long after each failed attempt to try again. */
+const BACKOFF_MS = [60_000, 5 * 60_000, 15 * 60_000, 60 * 60_000]
+
+export interface WorkflowContext {
+  form: SchemaForm
+  values: readonly FormValueToStore[]
+  entryId: string | null
+}
+
+export interface WorkflowDeps {
+  db: Db
+  /** Absent when the site has no e-mail; a `sendEmail` workflow then says so. */
+  email?: EmailPort
+  mediaFiles?: MediaFileStore
+  fetch?: typeof fetch
+  nodeState?: NodeSchemaState
+  nodeId?: string
+  /** Told when a workflow published something, so the cache is dropped. */
+  onContentChanged?: () => void
+}
+
+export type WorkflowResult =
+  | { ok: true; detail?: string }
+  /** `retry` false means trying again cannot help until something changes. */
+  | { ok: false; error: string; retry: boolean }
+
+// ------------------------------------------------------------------ substitution
+
+const firstValue = (values: readonly FormValueToStore[], alias: string): string =>
+  values
+    .find((value) => value.fieldAlias.toLowerCase() === alias.toLowerCase())
+    ?.values.join(', ') ?? ''
+
+/**
+ * `{fieldAlias}` in a workflow setting becomes what was submitted for it.
+ *
+ * This is all that is left of Umbraco Forms' magic strings, and deliberately:
+ * there the seven syntaxes exist because Razor cannot reach into the record. A
+ * view here is TSX and reads the model directly, so the only place substitution
+ * is needed is a workflow's own settings.
+ */
+export function substitute(text: string, values: readonly FormValueToStore[]): string {
+  return text.replace(/\{([A-Za-z][A-Za-z0-9]*)\}/g, (whole, alias: string) => {
+    const found = values.find((value) => value.fieldAlias.toLowerCase() === alias.toLowerCase())
+    // An unknown alias is left as it was written, so a stray brace in a subject
+    // line reads as itself rather than vanishing.
+    return found ? found.values.join(', ') : whole
+  })
+}
+
+const asString = (value: unknown): string | undefined =>
+  typeof value === 'string' && value.trim() !== '' ? value.trim() : undefined
+
+const asList = (value: unknown): string[] =>
+  typeof value === 'string'
+    ? value
+        .split(',')
+        .map((part) => part.trim())
+        .filter(Boolean)
+    : []
+
+/** The submission as a reader sees it: caption, then what was entered. */
+export function plainSummary(context: WorkflowContext): string {
+  const captions = new Map(
+    allFormFields(context.form).map((field) => [field.alias, field.caption || field.alias]),
+  )
+  const lines = context.values.map(
+    (value) =>
+      `${captions.get(value.fieldAlias) ?? value.fieldAlias}: ${
+        value.values.length > 0 ? value.values.join(', ') : '(not answered)'
+      }`,
+  )
+  return [`${context.form.name}`, '', ...lines].join('\n')
+}
+
+// ------------------------------------------------------------------ send email
+
+async function sendEmail(
+  workflow: SchemaFormWorkflow,
+  context: WorkflowContext,
+  deps: WorkflowDeps,
+): Promise<WorkflowResult> {
+  if (!deps.email)
+    return {
+      ok: false,
+      // Retrying cannot help: this is configuration, not weather.
+      retry: false,
+      error:
+        'This site has no e-mail provider, so the workflow cannot send. Configure CROMBOLO_EMAIL_PROVIDER, or `email` in crombolo.config.ts.',
+    }
+
+  const settings = workflow.settings
+  const to = asList(substitute(asString(settings.to) ?? '', context.values))
+  if (to.length === 0) return { ok: false, retry: false, error: 'The workflow has no recipient.' }
+
+  const attachments: EmailAttachment[] = []
+  if (settings['attach-uploads'] === true && deps.mediaFiles) {
+    const uploadAliases = new Set(
+      allFormFields(context.form)
+        .filter((field) => field.type === 'fileUpload')
+        .map((field) => field.alias),
+    )
+    for (const value of context.values) {
+      if (!uploadAliases.has(value.fieldAlias)) continue
+      for (const src of value.values) {
+        const file = await deps.mediaFiles.open(src)
+        if (!file) continue
+        attachments.push({
+          filename: src.split('/').pop() ?? 'attachment',
+          contentType: file.contentType,
+          bytes: await file.bytes(),
+        })
+      }
+    }
+  }
+
+  const result = await deps.email.send({
+    to: to.map((email) => ({ email })),
+    cc: asList(asString(settings.cc) ?? '').map((email) => ({ email })),
+    bcc: asList(asString(settings.bcc) ?? '').map((email) => ({ email })),
+    replyTo: (() => {
+      const replyTo = asString(settings['reply-to'])
+      const resolved = replyTo ? substitute(replyTo, context.values) : undefined
+      return resolved ? { email: resolved } : undefined
+    })(),
+    from: (() => {
+      const from = asString(settings.from)
+      return from ? { email: from } : undefined
+    })(),
+    subject: substitute(asString(settings.subject) ?? context.form.name, context.values),
+    text: settings.body ? substitute(String(settings.body), context.values) : plainSummary(context),
+    attachments: attachments.length > 0 ? attachments : undefined,
+  })
+  // A provider that refused is worth another go: a 500 or a timeout is weather.
+  return result.ok ? { ok: true } : { ok: false, retry: true, error: result.error }
+}
+
+// ------------------------------------------------------------------ save as content
+
+async function saveAsContent(
+  workflow: SchemaFormWorkflow,
+  context: WorkflowContext,
+  deps: WorkflowDeps,
+): Promise<WorkflowResult> {
+  const settings = workflow.settings
+  const alias = asString(settings['content-type'])
+  if (!alias) return { ok: false, retry: false, error: 'The workflow names no content type.' }
+
+  const types = new ContentTypeRepository(deps.db)
+  const type = await types.byAlias(alias)
+  if (!type) return { ok: false, retry: false, error: `There is no content type '${alias}'.` }
+
+  const parent = asString(settings.parent)
+  const map = (
+    settings.map && typeof settings.map === 'object' && !Array.isArray(settings.map)
+      ? (settings.map as Record<string, unknown>)
+      : {}
+  ) as Record<string, string>
+
+  const nameField = asString(settings['name-field'])
+  const name =
+    (nameField ? firstValue(context.values, nameField) : '') ||
+    `${context.form.name} ${new Date().toISOString().slice(0, 16).replace('T', ' ')}`
+
+  const documents = new DocumentRepository(deps.db, {
+    nodeState: deps.nodeState,
+    nodeId: deps.nodeId,
+  })
+  try {
+    const created = await documents.create({
+      key: crypto.randomUUID(),
+      contentTypeKey: type.key,
+      componentKey: null,
+      // `root` or nothing both mean the top of the tree.
+      parentKey: parent && parent !== 'root' ? parent : null,
+      values: Object.entries(map).map(([fieldAlias, propertyAlias]) => ({
+        alias: propertyAlias,
+        culture: null,
+        segment: null,
+        value: firstValue(context.values, fieldAlias),
+      })),
+      variants: [{ culture: null, segment: null, name }],
+    })
+    if (settings.publish === true) {
+      await documents.publish(created.key, null)
+      deps.onContentChanged?.()
+    }
+    return { ok: true, detail: created.key }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    // A node behind the schema cannot write; that resolves on its own when the
+    // deploy finishes, so it is worth retrying. Anything else is not.
+    const retry = message.includes('may not write') || message.includes('not published')
+    return { ok: false, retry, error: message }
+  }
+}
+
+// ------------------------------------------------------------------ send to url
+
+async function sendToUrl(
+  workflow: SchemaFormWorkflow,
+  context: WorkflowContext,
+  deps: WorkflowDeps,
+): Promise<WorkflowResult> {
+  const settings = workflow.settings
+  const url = asString(settings.url)
+  if (!url) return { ok: false, retry: false, error: 'The workflow names no URL.' }
+  const method = settings.method === 'PUT' ? 'PUT' : 'POST'
+  const headers =
+    settings.headers && typeof settings.headers === 'object' && !Array.isArray(settings.headers)
+      ? (settings.headers as Record<string, string>)
+      : {}
+
+  const fields: Record<string, string | string[]> = {}
+  for (const value of context.values)
+    fields[value.fieldAlias] =
+      value.values.length === 1 ? (value.values[0] as string) : value.values
+
+  const body: Record<string, unknown> = { fields }
+  if (settings['include-standard-fields'] !== false) {
+    body.form = context.form.alias
+    body.formName = context.form.name
+    body.entryId = context.entryId
+    body.submittedAt = new Date().toISOString()
+  }
+
+  const call = deps.fetch ?? fetch
+  try {
+    const response = await call(url, {
+      method,
+      headers: { 'content-type': 'application/json', ...headers },
+      body: JSON.stringify(body),
+    })
+    if (response.ok) return { ok: true, detail: String(response.status) }
+    const detail = (await response.text().catch(() => '')).trim().slice(0, 300)
+    // A 4xx will not fix itself; a 5xx might.
+    return {
+      ok: false,
+      retry: response.status >= 500,
+      error: `the endpoint answered ${response.status}${detail ? `: ${detail}` : ''}`,
+    }
+  } catch (error) {
+    return {
+      ok: false,
+      retry: true,
+      error: error instanceof Error ? error.message : String(error),
+    }
+  }
+}
+
+// ------------------------------------------------------------------ the runner
+
+export async function runWorkflow(
+  workflow: SchemaFormWorkflow,
+  context: WorkflowContext,
+  deps: WorkflowDeps,
+): Promise<WorkflowResult> {
+  switch (workflow.type) {
+    case 'sendEmail':
+      return sendEmail(workflow, context, deps)
+    case 'saveAsContent':
+      return saveAsContent(workflow, context, deps)
+    case 'sendToUrl':
+      return sendToUrl(workflow, context, deps)
+  }
+}
+
+export interface WorkflowRunReport {
+  claimed: number
+  done: number
+  retrying: number
+  failed: number
+}
+
+export interface WorkflowRunner {
+  /** Runs what is due. Called by the job timer, and directly by tests. */
+  runDue(now?: Date, limit?: number): Promise<WorkflowRunReport>
+}
+
+/** When to try again after this many attempts, or undefined to give up. */
+export function retryAfter(attempts: number, now: Date): Date | undefined {
+  if (attempts >= MAX_WORKFLOW_ATTEMPTS) return undefined
+  const delay = BACKOFF_MS[Math.min(attempts - 1, BACKOFF_MS.length - 1)] ?? 60_000
+  return new Date(now.getTime() + delay)
+}
+
+export function createWorkflowRunner(
+  deps: WorkflowDeps & { forms: { byKey(key: string): SchemaForm | undefined } },
+): WorkflowRunner {
+  const runs = new FormWorkflowRepository(deps.db)
+
+  const execute = async (run: FormWorkflowRun, now: Date): Promise<keyof WorkflowRunReport> => {
+    const form = deps.forms.byKey(run.formKey)
+    if (!form) {
+      // The definition is a file, and it is gone. There is nothing to run and
+      // nothing to retry, so the row records why rather than sitting pending.
+      await runs.fail(run.id, `The form '${run.formAlias}' is no longer in schema/forms/.`)
+      return 'failed'
+    }
+    const workflow = form.workflows.find(
+      (candidate) => candidate.name.toLowerCase() === run.workflowName.toLowerCase(),
+    )
+    if (!workflow) {
+      await runs.fail(run.id, `'${run.workflowName}' is no longer a workflow on this form.`)
+      return 'failed'
+    }
+
+    const context: WorkflowContext = {
+      form,
+      values: run.payload,
+      entryId: run.entryId,
+    }
+    let result: WorkflowResult
+    try {
+      result = await runWorkflow(workflow, context, deps)
+    } catch (error) {
+      // A workflow that throws is a bug, not a refusal; it is still retried,
+      // because the usual cause is something transient underneath it.
+      result = {
+        ok: false,
+        retry: true,
+        error: error instanceof Error ? (error.stack ?? error.message) : String(error),
+      }
+    }
+
+    if (result.ok) {
+      await runs.succeed(run.id)
+      return 'done'
+    }
+    const again = result.retry ? retryAfter(run.attempts, now) : undefined
+    await runs.fail(run.id, result.error, again)
+    if (again) {
+      log.warning("'{workflow}' on {form} failed and will be retried: {detail}", {
+        workflow: run.workflowName,
+        form: run.formAlias,
+        detail: result.error,
+      })
+      return 'retrying'
+    }
+    log.error("'{workflow}' on {form} failed: {detail}", {
+      workflow: run.workflowName,
+      form: run.formAlias,
+      detail: result.error,
+    })
+    return 'failed'
+  }
+
+  return {
+    async runDue(now = new Date(), limit = 25) {
+      const report: WorkflowRunReport = { claimed: 0, done: 0, retrying: 0, failed: 0 }
+      for (const due of await runs.due(now, limit)) {
+        // Another node may have taken it between the read and here, which is
+        // exactly what the claim is for.
+        const claimed = await runs.claim(due.id)
+        if (!claimed) continue
+        report.claimed++
+        report[await execute(claimed, now)]++
+      }
+      return report
+    },
+  }
+}

package/src/forms.ts

@@ -0,0 +1,170 @@
+/**
+ * What the backoffice reads about forms. `docs/forms.md`.
+ *
+ * Non-contract, under the plugin path, because there is no form operation in
+ * the vendored OpenAPI document — Umbraco Forms ships its own API and its own
+ * client, and neither is here.
+ *
+ * Definitions come from the loaded schema rather than the database: the files
+ * are the truth, and reading them here means the picker cannot disagree with
+ * what a render would use.
+ */
+
+import type { FormEntryState } from '@crombolo/data'
+import { allFormFields, type SchemaForm, storingFormFields } from '@crombolo/schema'
+
+/** A form as the picker and the tree list it. */
+export interface FormSummary {
+  key: string
+  alias: string
+  name: string
+  /** How many fields collect something, which is the useful size of a form. */
+  fieldCount: number
+  pageCount: number
+  storeEntries: boolean
+  requiresApproval: boolean
+  workflowCount: number
+}
+
+export function formSummary(form: SchemaForm): FormSummary {
+  return {
+    // A form with no key in its file still has to be addressable, and its alias
+    // is unique within the set, so it stands in until a key is written.
+    key: form.key ?? form.alias,
+    alias: form.alias,
+    name: form.name,
+    fieldCount: storingFormFields(form).length,
+    pageCount: form.pages.length,
+    storeEntries: form.storeEntries,
+    requiresApproval: form.requiresApproval,
+    workflowCount: form.workflows.length,
+  }
+}
+
+/** The full definition, for the designer and for an entries view's columns. */
+export function formDetail(form: SchemaForm): Record<string, unknown> {
+  return {
+    ...formSummary(form),
+    notes: form.notes ?? null,
+    theme: form.theme ?? null,
+    submitLabel: form.submitLabel ?? null,
+    messageOnSubmit: form.messageOnSubmit ?? null,
+    redirectTo: form.redirectTo ?? null,
+    honeypot: form.honeypot,
+    maxEntries: form.maxEntries ?? null,
+    fields: allFormFields(form).map((field) => ({
+      alias: field.alias,
+      type: field.type,
+      caption: field.caption,
+      mandatory: field.mandatory,
+      sensitive: field.sensitive,
+      values: field.values,
+    })),
+    workflows: form.workflows.map((workflow) => ({
+      type: workflow.type,
+      name: workflow.name,
+      on: workflow.on,
+    })),
+  }
+}
+
+/** Which forms a site has, by key, so an entry can be matched to its definition. */
+export function formsByKey(forms: readonly SchemaForm[]): Map<string, SchemaForm> {
+  const out = new Map<string, SchemaForm>()
+  for (const form of forms) out.set(form.key ?? form.alias, form)
+  return out
+}
+
+/**
+ * Redacts the values of sensitive fields unless the reader may see them.
+ *
+ * Done here rather than in the UI: the values must not reach a browser that is
+ * not allowed them, so the redaction is on the way out of the server.
+ */
+export function redactSensitive(
+  entry: { values: { fieldAlias: string; values: string[] }[] },
+  form: SchemaForm | undefined,
+  maySeeSensitive: boolean,
+): { fieldAlias: string; values: string[]; redacted: boolean }[] {
+  const sensitive = new Set(
+    (form ? allFormFields(form) : [])
+      .filter((field) => field.sensitive)
+      .map((field) => field.alias.toLowerCase()),
+  )
+  return entry.values.map((value) => {
+    const hide = !maySeeSensitive && sensitive.has(value.fieldAlias.toLowerCase())
+    return {
+      fieldAlias: value.fieldAlias,
+      values: hide ? [] : value.values,
+      redacted: hide,
+    }
+  })
+}
+
+/** The states the entries view may filter by, validated off the query string. */
+export function parseEntryState(value: string | null): FormEntryState | undefined {
+  return value === 'submitted' || value === 'approved' || value === 'rejected' ? value : undefined
+}
+
+// ------------------------------------------------------------------ export
+
+/** A CSV cell: quoted when it has to be, and never able to start a formula. */
+function csvCell(value: string): string {
+  // A leading =, +, - or @ makes a spreadsheet treat the cell as a formula, so
+  // an exported answer could run when somebody opens the file.
+  const safe = /^[=+\-@\t\r]/.test(value) ? `'${value}` : value
+  return /[",\n\r]/.test(safe) ? `"${safe.replaceAll('"', '""')}"` : safe
+}
+
+export interface EntriesCsvOptions {
+  /** Without it, a sensitive column is refused rather than silently blank. */
+  includeSensitive: boolean
+}
+
+export type EntriesCsvResult =
+  | { ok: true; csv: string; fileName: string }
+  | { ok: false; reason: string }
+
+/**
+ * A form's entries as CSV, one row per entry.
+ *
+ * A sensitive field makes the whole export refuse rather than exporting blanks:
+ * a file that looks complete and quietly is not is worse than an error, because
+ * somebody will act on it. The permission, not the column, is the thing to fix.
+ */
+export function entriesCsv(
+  form: SchemaForm,
+  entries: readonly {
+    createDate: Date
+    state: string
+    spam: boolean
+    values: { fieldAlias: string; values: string[] }[]
+  }[],
+  options: EntriesCsvOptions,
+): EntriesCsvResult {
+  const fields = storingFormFields(form)
+  const sensitive = fields.filter((field) => field.sensitive)
+  if (sensitive.length > 0 && !options.includeSensitive)
+    return {
+      ok: false,
+      reason: `This form has sensitive fields (${sensitive
+        .map((field) => field.caption || field.alias)
+        .join(', ')}), so exporting it needs sensitive-data access.`,
+    }
+
+  const header = ['Submitted', 'State', 'Spam', ...fields.map((f) => f.caption || f.alias)]
+  const rows = entries.map((entry) => [
+    entry.createDate.toISOString(),
+    entry.state,
+    String(entry.spam),
+    ...fields.map((field) =>
+      (entry.values.find((value) => value.fieldAlias === field.alias)?.values ?? []).join('; '),
+    ),
+  ])
+  return {
+    ok: true,
+    // CRLF, which is what the format says and what Excel wants.
+    csv: [header, ...rows].map((row) => row.map(csvCell).join(',')).join('\r\n'),
+    fileName: `${form.alias}-entries.csv`,
+  }
+}