pipework 0.261.2 → 0.263.0

package/src/infra/alerts/handle.ts

@@ -1,4 +1,4 @@
-import { sql } from '../../data/db/sql.js'
+import { sql, textArrayParam } from '../../data/db/sql.js'
 import { pipeSystem } from '../../data/db/db.js'
 import { fitting } from '../../request/di/index.js'
 import { getContext } from '../../request/context/store.js'
@@ -323,10 +323,6 @@ function pickList<T extends string>(fn: string, name: string, value: T | readonl
 /** Key prefix of the alert raised when deliveries to a sink are given up; never queued to the sink named after it. */
 export const UNDELIVERABLE_PREFIX = 'pipework.alerts.undeliverable:'
 
-function pgTextArray(values: readonly string[]): string {
-  return `{${values.map(v => `"${v.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`).join(',')}}`
-}
-
 export function createAlerts(config: AlertsConfig): Alerts {
   if (config.sinks.length === 0) throw new Error('[pipework] alerts.create needs at least one sink.')
   const sinks = new Map<string, AlertSink>()
@@ -334,11 +330,11 @@ export function createAlerts(config: AlertsConfig): Alerts {
     if (sinks.has(s.name)) throw new Error(`[pipework] alerts.create: two sinks are named "${s.name}"; give each its own name.`)
     sinks.set(s.name, s)
   }
-  const sinkNames = pgTextArray([...sinks.keys()])
+  const sinkNames = textArrayParam([...sinks.keys()])
   function sinksFor(key: string): string {
     if (!key.startsWith(UNDELIVERABLE_PREFIX)) return sinkNames
     const excluded = key.slice(UNDELIVERABLE_PREFIX.length)
-    return pgTextArray([...sinks.keys()].filter(n => n !== excluded))
+    return textArrayParam([...sinks.keys()].filter(n => n !== excluded))
   }
   const digestEveryMs = config.digest?.everyMs ?? null
   if (config.digest !== undefined) {
@@ -351,7 +347,7 @@ export function createAlerts(config: AlertsConfig): Alerts {
     }
     if (config.digest.severities?.length === 0) throw new Error('[pipework] alerts.create: digest.severities needs at least one severity, or leave it out for warning.')
   }
-  const digestSeverities = pgTextArray(config.digest === undefined ? [] : [...new Set(config.digest.severities ?? ['warning'])])
+  const digestSeverities = textArrayParam(config.digest === undefined ? [] : [...new Set(config.digest.severities ?? ['warning'])])
   const retention = checkRetention('alerts.create', config)
   const jobType = config.jobType ?? 'pipework.alerts'
   const maxAttempts = config.maxAttempts ?? 10
@@ -396,7 +392,7 @@ export function createAlerts(config: AlertsConfig): Alerts {
     const resendStored = storedMs('resendAfterMs', options.resendAfterMs)
     const quietStored = storedMs('resolveAfterQuietMs', options.resolveAfterQuietMs)
     const traceId = getContext()?.trace?.id ?? null
-    const traceArray = traceId === null ? '{}' : pgTextArray([traceId])
+    const traceArray = traceId === null ? '{}' : textArrayParam([traceId])
     const subject = options.subject === undefined ? null : JSON.stringify(options.subject)
     const context = options.context === undefined ? null : JSON.stringify(redactJson(options.context, redactExtra))
     const message = redactText(options.message, redactExtra)
@@ -543,9 +539,9 @@ export function createAlerts(config: AlertsConfig): Alerts {
     const cursor = options.cursor === undefined ? null : readCursor('list', options.cursor)
     const rows = await db().execute(sql`
       SELECT *, ${exact('last_seen_at')} AS exact_at FROM pipework_alerts
-      WHERE (${statuses === null}::boolean OR status = ANY(${pgTextArray(statuses ?? [])}::text[]))
-        AND (${severities === null}::boolean OR severity = ANY(${pgTextArray(severities ?? [])}::text[]))
-        AND (${owners === null}::boolean OR owner = ANY(${pgTextArray([...(owners ?? [])])}::text[]))
+      WHERE (${statuses === null}::boolean OR status = ANY(${textArrayParam(statuses ?? [])}::text[]))
+        AND (${severities === null}::boolean OR severity = ANY(${textArrayParam(severities ?? [])}::text[]))
+        AND (${owners === null}::boolean OR owner = ANY(${textArrayParam([...(owners ?? [])])}::text[]))
         AND (${cursor === null}::boolean OR last_seen_at < ${cursor?.[0] ?? null}::timestamptz
              OR (last_seen_at = ${cursor?.[0] ?? null}::timestamptz AND key > ${cursor?.[1] ?? null}::text))
       ORDER BY last_seen_at DESC, key ASC

package/src/infra/audit/namespace.ts

@@ -10,7 +10,7 @@ export const audit = {
   /** Queries the framework-managed `audit_record` table. Tenant-scoped via the active Flow. `{ entity, entityId }` returns one row's history from an index; build a composite key's `entityId` with `audit.entityId`. */
   query,
   /**
-   * The `entityId` filter text for a written table's row: the primary key's value as text, or for a composite key a compact JSON array of the key values as strings in key order (`["a","7"]`). Pass the table and a row (or just its key fields). Dates become ISO strings.
+   * The `entityId` filter text for a written table's row: the primary key's value as text, or for a composite key a compact JSON array of the key values as strings in key order (`["a","7"]`). Pass the table and a row (or just its key fields). Dates become ISO strings. A table declared `auditEntityId: 'hashed'` gets the lowercase hex SHA-256 of that text, which is what its audit rows store.
    */
   entityId: auditEntityId,
   /** The newest record's `{ seq, hash }` in the tenant's audit hash chain (blueprint `audit.chain`), to store outside the database; `null` when empty. */

package/src/infra/email/inbound.ts

@@ -2,7 +2,7 @@ import { createHash, randomUUID } from 'node:crypto'
 import { copyFile, mkdir, readdir, readFile, stat, unlink } from 'node:fs/promises'
 import { basename, join } from 'node:path'
 import { Readable } from 'node:stream'
-import { sql } from '../../data/db/sql.js'
+import { sql, textArrayParam } from '../../data/db/sql.js'
 import { pipeSystem } from '../../data/db/db.js'
 import { schema } from '../../data/schema/namespace.js'
 import { fitting } from '../../request/di/index.js'
@@ -293,11 +293,6 @@ function toDate(value: unknown): Date {
   return new Date(/(Z|[+-]\d\d(:?\d\d)?)$/.test(text) ? text : `${text.replace(' ', 'T')}Z`)
 }
 
-/** A Postgres text-array literal, sent as one parameter and cast with `::text[]`. */
-function textArray(values: readonly string[]): string {
-  return `{${values.map(v => `"${v.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`).join(',')}}`
-}
-
 function verdictsOf(receipt: Record<string, unknown>): EmailVerdicts {
   const status = (key: string): string | null => {
     const v = receipt[key] as { status?: unknown } | undefined
@@ -419,11 +414,11 @@ export function createInbound(config: InboundConfig): Inbound {
       })
       const received = await db.execute(sql`
         SELECT message_id_header AS id, conversation_id FROM pipework_email_inbound
-        WHERE message_id_header = ANY(${textArray(ids)}::text[]) AND conversation_id IS NOT NULL
+        WHERE message_id_header = ANY(${textArrayParam(ids)}::text[]) AND conversation_id IS NOT NULL
           AND (${tenantId}::uuid IS NULL OR tenant_id IS NULL OR tenant_id = ${tenantId}::uuid)`)
       const sent = sesLocals.length === 0 ? [] : await db.execute(sql`
         SELECT provider_message_id AS id, conversation_id FROM pipework_email_messages
-        WHERE provider_message_id = ANY(${textArray(sesLocals)}::text[]) AND conversation_id IS NOT NULL`)
+        WHERE provider_message_id = ANY(${textArrayParam(sesLocals)}::text[]) AND conversation_id IS NOT NULL`)
       const byId = new Map<string, string>()
       for (const r of received) byId.set(r['id'] as string, r['conversation_id'] as string)
       const bySes = new Map<string, string>()

package/src/infra/email/mail.ts

@@ -1,4 +1,4 @@
-import { sql } from '../../data/db/sql.js'
+import { sql, textArrayParam } from '../../data/db/sql.js'
 import type { DB } from '../../data/db/index.js'
 import { pipeSystem } from '../../data/db/db.js'
 import { insert, remove } from '../../data/write/index.js'
@@ -137,6 +137,8 @@ export interface Mail<T extends EmailTemplates> {
   unsubscribe(db: DB, address: string, list: string): Promise<void>
   /** True when `address` (any case) has opted out of `list`. */
   unsubscribed(db: DB, address: string, list: string): Promise<boolean>
+  /** The `addresses` (as given) that have opted out of `list`, trimmed and lowercased to compare, read in one query. */
+  unsubscribedAmong(db: DB, addresses: Iterable<string>, list: string): Promise<Set<string>>
   /** Removes the opt-out of `address` from `list`, so its mail is delivered again. Writes like `unsubscribe`. */
   resubscribe(db: DB, address: string, list: string): Promise<void>
   /**
@@ -445,6 +447,22 @@ export function createMail<T extends EmailTemplates>(config: MailConfig<T>): Mai
       requireList(list)
       return isUnsubscribed(requireUnscopedExecutor(handle, 'mail.unsubscribed()', 'an opt-out is not tenant data'), address, list)
     },
+    async unsubscribedAmong(handle, addresses, list) {
+      requireList(list)
+      const executor = requireUnscopedExecutor(handle, 'mail.unsubscribedAmong()', 'an opt-out is not tenant data')
+      const given = new Map<string, string[]>()
+      for (const address of addresses) {
+        const key = normalizeAddress(address)
+        const spellings = given.get(key)
+        if (spellings === undefined) given.set(key, [address])
+        else spellings.push(address)
+      }
+      const out = new Set<string>()
+      if (given.size === 0) return out
+      const rows = await executor.execute(sql`SELECT address FROM pipework_email_unsubscribes WHERE list = ${list} AND address = ANY(${textArrayParam([...given.keys()])}::text[])`)
+      for (const row of rows) for (const spelling of given.get(row['address'] as string) ?? []) out.add(spelling)
+      return out
+    },
     async resubscribe(_db, address, list) {
       requireList(list)
       await remove(emailUnsubscribes).where(and(eq(emailUnsubscribes.address, normalizeAddress(address)), eq(emailUnsubscribes.list, list))!)

package/src/infra/email/schema.ts

@@ -50,6 +50,8 @@ export const emailSuppressions = define('pipework_email_suppressions', {
   reason: field.enum(SUPPRESSION_REASONS),
   detail: field.jsonb(schema.check.json()).nullable(),
   createdAt: field.timestamp().default('now'),
+}, {
+  auditEntityId: 'hashed',
 })
 
 // One row per (address, list) that opted out of a list's mail. Address lowercased.
@@ -59,6 +61,7 @@ export const emailUnsubscribes = define('pipework_email_unsubscribes', {
   createdAt: field.timestamp().default('now'),
 }, {
   primaryKey: ['address', 'list'],
+  auditEntityId: 'hashed',
 })
 
 // One row per received message. Bodies are not stored here: the raw message is

package/src/request/http/rate-limit-classes.ts

@@ -17,6 +17,8 @@ export const rateLimitCounts = define('pipework_rate_limit_counts', {
   key: field.text().primaryKey(),
   count: field.integer().default(0),
   windowStart: field.timestamp().default('now'),
+}, {
+  auditEntityId: 'hashed',
 })
 
 const WINDOWS: readonly RateLimitWindowName[] = ['perUser', 'perTenant', 'perAddress', 'total']