@owlmeans/server-api 0.1.18-rc.8 → 0.1.18

package/src/types.ts

@@ -1,14 +1,13 @@
 
-import type { InitializedService, Layer } from '@owlmeans/context'
+import type { InitializedService } from '@owlmeans/context'
 import type { ServerConfig, ServerContext } from '@owlmeans/server-context'
 import type { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
 import '@fastify/middie/types/index.d.ts'
+import type { MultipartFile } from '@fastify/multipart'
 
 export interface ApiServer extends InitializedService {
   server: FastifyInstance
 
-  layers: [Layer.System]
-
   listen: () => Promise<void>
 }
 
@@ -20,7 +19,42 @@ export interface ApiServerAppend {
   getApiServer: () => ApiServer
 }
 
-export interface Config extends ServerConfig { }
+export type HttpErrorExposure = 'production' | 'development'
+
+export interface HttpErrorsConfig {
+  /** Production is the safe default; development is the only mode that exposes stacks. */
+  exposure?: HttpErrorExposure
+}
+
+export interface HttpConfig {
+  errors?: HttpErrorsConfig
+}
+
+export interface Config extends ServerConfig {
+  http?: HttpConfig
+}
 
 export interface Context<C extends Config = Config> extends ServerContext<C>,
   ApiServerAppend { }
+
+export interface UploadedFile extends MultipartFile { }
+
+export interface ApiPortHoldOptions {
+  /**
+   * The one path answered 200 while the hold is in place — the app's health endpoint, so
+   * whatever supervises the process keeps a conventional liveness answer through the boot.
+   * Everything else answers 503 with the same body. Absent, everything is 503.
+   */
+  okPath?: string
+  /** Body of every answer, evaluated per request so a changing boot phase is reported live. */
+  payload?: () => unknown
+}
+
+export interface ApiPortHold {
+  /**
+   * Free the port for the real server. Awaits the actual close — `listen()` follows immediately,
+   * and a predecessor still bound makes it throw — and force-closes keep-alive sockets, so a
+   * supervisor's own poller cannot hold the release open.
+   */
+  release: () => Promise<void>
+}

package/src/utils/consts.local.ts

@@ -0,0 +1,7 @@
+export const CLIENT_ERROR_FIRST = 400
+
+export const CLIENT_ERROR_LAST = 499
+
+export const SERVER_ERROR_FIRST = 500
+
+export const SERVER_ERROR_LAST = 599

package/src/utils/consts.ts

@@ -0,0 +1 @@
+export const INCIDENT_ID_HEADER = 'X-Incident-ID'

package/src/utils/context/types.ts

@@ -0,0 +1,13 @@
+import type { Config, Context } from '../../types.js'
+
+/** Carries the serving context on one raw request. */
+export interface RequestContextHelper {
+  /** Stores the context on the request. */
+  populateContext: <C extends Config, T extends Context<C>>(context: T) => void
+  /**
+   * The context stored on the request, else `ctx`.
+   *
+   * @throws {SyntaxError} when neither is there
+   */
+  extractContext: <C extends Config, T extends Context<C>>(ctx?: T, location?: string) => T
+}

package/src/utils/context.ts

@@ -1,9 +1,14 @@
 import { assertContext } from '@owlmeans/context'
 import type { Config, Context, Request } from '../types.js'
 import { DEFAULT_ALIAS } from '../consts.js'
+import type { RequestContextHelper } from './context/types.js'
 
-export const populateContext = <C extends Config, T extends Context<C>>(req: Request, context: T): void =>
-  void ((req as any)._ctx = context)
+export const makeRequestContextHelper = (req: Request): RequestContextHelper => {
+  const populateContext = <C extends Config, T extends Context<C>>(context: T): void =>
+    void ((req as any)._ctx = context)
 
-export const extractContext = <C extends Config, T extends Context<C>>(req: Request, ctx?: T, location?: string): T =>
-  assertContext<C, T>((req as any)._ctx ?? ctx, location ?? DEFAULT_ALIAS)
+  const extractContext = <C extends Config, T extends Context<C>>(ctx?: T, location?: string): T =>
+    assertContext<C, T>((req as any)._ctx ?? ctx, location ?? DEFAULT_ALIAS)
+
+  return { populateContext, extractContext }
+}

package/src/utils/error/types.ts

@@ -0,0 +1,52 @@
+import type { FastifyReply } from 'fastify'
+import type { Config, HttpErrorExposure } from '../../types.js'
+import type { SerializedHttpError } from '../types.js'
+
+/** How the HTTP boundary answers a thrown error: its status, its wire body, its headers and its log entry. */
+export interface HttpErrorHelper {
+  /**
+   * The HTTP status an error's class declares, or `null` when it declares none that may be honoured.
+   *
+   * Read through the constructor chain — a static property is inherited, so a subclass answers what
+   * its nearest declaring ancestor says, and redeclares to change it. An integer 4xx is honoured
+   * directly. A 5xx is honoured only with `allowServerErrorStatus = true`, so a domain class must
+   * explicitly opt in to exposing a precise availability response. The read is structural, so a
+   * class from a duplicate module copy declares exactly what the imported one does.
+   */
+  declaredErrorStatus: (error: unknown) => number | null
+  /**
+   * The HTTP status an error is answered with, read off the error exactly as given.
+   *
+   * Two families reach here and both must be recognised. `AuthFailedError` / `AccessError` are this
+   * package's own, raised by the request pipeline itself. `AuthorizationError` / `AuthForbidden`
+   * come from `@owlmeans/auth` and are what the guards and gates actually throw — an unrecognised
+   * one answers 500, which reports a refused request as a crashed server: the client cannot tell
+   * "sign in again" from "the service is broken", and a consumer watching statuses concludes the
+   * application fell over. A family member is recognised by class OR by registered type name, so a
+   * class from a duplicate module copy answers the same status.
+   *
+   * **Order matters.** `AuthForbidden extends AuthorizationError`, so the 403 branch has to be
+   * tested first or every refusal of a permission is reported as a failure to authenticate. Both
+   * auth branches come before a class's own declaration, so an auth refusal can never be restated
+   * as something else. Everything that is neither an auth error nor a class declaring an allowed
+   * {@link HttpErrorHelper.declaredErrorStatus} answers 500.
+   */
+  errorStatus: (error: unknown) => number
+  /** Invalid or absent configuration always resolves to the production-safe policy. */
+  errorExposure: (config?: Pick<Config, 'http'>) => HttpErrorExposure
+  /** One central wire shape for every server error. */
+  serializeError: (error: Error, exposure?: HttpErrorExposure) => SerializedHttpError
+  /** Apply safe response metadata carried by an error without coupling its package to Fastify. */
+  applyErrorHeaders: (error: unknown, reply: FastifyReply) => void
+  /**
+   * Answer a thrown error: a status, and the marshalled `ResilientError` as the body.
+   *
+   * The status is resolved in two steps. The error AS THROWN comes first: it is the one object whose
+   * class is certainly the class that was raised, while `ResilientError.ensure` rebuilds through the
+   * registry of whichever `@owlmeans/error` copy this module loaded — under duplicate module copies
+   * that turns a perfectly recognisable auth refusal into a plain `ResilientError` answering 500.
+   * Only when the thrown error answers 500 is the ENSURED error asked, because the rebuild is what
+   * gives a status to a marshalled error that crossed a hop as a plain `Error`.
+   */
+  handleError: (error: Error, reply: FastifyReply, exposure?: HttpErrorExposure) => void
+}

package/src/utils/error.ts

@@ -1,35 +1,162 @@
-import { FORBIDDEN_ERROR, SERVER_ERROR, UNAUTHORIZED_ERROR } from '@owlmeans/api'
+import {
+  FORBIDDEN_ERROR, SERVER_ERROR, UNAUTHORIZED_ERROR, DENIAL_KIND_HEADER, ACCESS_DENIED_KIND,
+} from '@owlmeans/api'
 import type { FastifyReply } from 'fastify'
 import { AccessError, AuthFailedError } from '../errors.js'
 import { AuthForbidden, AuthorizationError } from '@owlmeans/auth'
-import { ResilientError } from '@owlmeans/error'
-
-/**
- * Map a thrown error onto an HTTP status.
- *
- * Two families reach here and both must be recognised. `AuthFailedError` / `AccessError` are this
- * package's own, raised by the request pipeline itself. `AuthorizationError` / `AuthForbidden`
- * come from `@owlmeans/auth` and are what the guards and gates actually throw — an unrecognised
- * one answers 500, which reports a refused request as a crashed server: the client cannot tell
- * "sign in again" from "the service is broken", and a consumer watching statuses concludes the
- * application fell over.
- *
- * **Order matters.** `AuthForbidden extends AuthorizationError`, so the 403 branch has to be
- * tested first or every refusal of a permission is reported as a failure to authenticate.
- */
-export const handleError = (error: Error, reply: FastifyReply) => {
-  let code: number = SERVER_ERROR
-  if (error instanceof AuthForbidden || error instanceof AccessError) {
-    // An established identity that lacks the permission. Re-authenticating changes nothing.
-    code = FORBIDDEN_ERROR
-  } else if (error instanceof AuthorizationError || error instanceof AuthFailedError) {
-    // No usable credential — absent, expired, revoked, or naming a session this server no longer
-    // holds. The caller is told to sign in, not that signing in would not help.
-    code = UNAUTHORIZED_ERROR
+import { isResilientError, ResilientError, SEPARATOR } from '@owlmeans/error'
+import { randomUUID } from 'node:crypto'
+import { fastifyLogUtils } from './log.js'
+import type { Config, HttpErrorExposure } from '../types.js'
+import { CLIENT_ERROR_FIRST, CLIENT_ERROR_LAST, SERVER_ERROR_FIRST, SERVER_ERROR_LAST } from './consts.local.js'
+import { INCIDENT_ID_HEADER } from './consts.js'
+import type { HttpStatusDeclaration, SerializedHttpError } from './types.js'
+import type { HttpErrorHelper } from './error/types.js'
+
+export const createHttpErrorHelper = (): HttpErrorHelper => {
+  const declaredErrorStatus = (error: unknown): number | null => {
+    if (error == null || typeof error !== 'object') {
+      return null
+    }
+    const declaration = error.constructor as HttpStatusDeclaration | undefined
+    const status = declaration?.httpStatus
+    if (typeof status !== 'number' || !Number.isInteger(status)) {
+      return null
+    }
+    if (status >= CLIENT_ERROR_FIRST && status <= CLIENT_ERROR_LAST) return status
+    if (status >= SERVER_ERROR_FIRST && status <= SERVER_ERROR_LAST
+      && declaration?.allowServerErrorStatus === true) return status
+
+    return null
+  }
+
+  /**
+   * The registered type names an error carries: its own `type`, and the static `typeName` of every
+   * class on its constructor chain.
+   *
+   * This is how a class is recognised when `instanceof` cannot see it. A process that loads a package
+   * twice — `bun --preserve-symlinks` over a linked workspace resolves one package through several
+   * `node_modules` paths — holds several copies of every error class, and an error built by one copy
+   * is not an instance of another. The registered names are the same in every copy. A subclass's
+   * `typeName` does not reliably embed its parent's (`EntitlementRefusal` extends `AuthForbidden`), so
+   * a family is recognised by walking the chain and matching names exactly, never by a substring.
+   */
+  const typeNamesOf = (error: object): Set<string> => {
+    const names = new Set<string>()
+    const type = (error as { type?: unknown }).type
+    if (typeof type === 'string') {
+      names.add(type)
+    }
+    let ctor: unknown = error.constructor
+    while (typeof ctor === 'function') {
+      const name = (ctor as { typeName?: unknown }).typeName
+      if (typeof name === 'string') {
+        names.add(name)
+      }
+      ctor = Object.getPrototypeOf(ctor)
+    }
+
+    return names
   }
-  if (!reply.sent) {
-    reply.code(code).send(
-      ResilientError.marshal(ResilientError.ensure(error as Error)).message
-    )
+
+  const isOfFamily = (names: Set<string>, family: string[]): boolean =>
+    family.some(typeName => names.has(typeName))
+
+  const errorStatus = (error: unknown): number => {
+    if (error == null || typeof error !== 'object') {
+      return SERVER_ERROR
+    }
+    const names = typeNamesOf(error)
+    if (error instanceof AuthForbidden || error instanceof AccessError
+      || isOfFamily(names, [AuthForbidden.typeName, AccessError.typeName])) {
+      // An established identity that lacks the permission. Re-authenticating changes nothing.
+      return FORBIDDEN_ERROR
+    }
+    if (error instanceof AuthorizationError || error instanceof AuthFailedError
+      || isOfFamily(names, [AuthorizationError.typeName, AuthFailedError.typeName])) {
+      // No usable credential — absent, expired, revoked, or naming a session this server no longer
+      // holds. The caller is told to sign in, not that signing in would not help.
+      return UNAUTHORIZED_ERROR
+    }
+
+    return declaredErrorStatus(error) ?? SERVER_ERROR
+  }
+
+  const errorExposure = (config?: Pick<Config, 'http'>): HttpErrorExposure =>
+    config?.http?.errors?.exposure === 'development' ? 'development' : 'production'
+
+  /**
+   * Preserve a typed/marshalled error when possible without asking `ensure` to convert a plain
+   * error. In particular, `ensure` deliberately rethrows SyntaxError; an HTTP boundary still has
+   * to serialize it safely and let the incident log retain the original object.
+   */
+  const normalizeForWire = (error: Error): Error => {
+    if (error instanceof SyntaxError || isResilientError(error)) {
+      return error
+    }
+    if (error.message.includes(SEPARATOR)) {
+      const ensured = ResilientError.ensure(error)
+      // The catch-all converter's legacy constructor shape shifts an ordinary error's fields.
+      // Only keep `ensure`'s result when a registered wire prefix actually rebuilt something.
+      if (ensured.type !== error.message || ensured.message !== error.stack) {
+        return ensured
+      }
+    }
+    return error
   }
+
+  const serializeError = (
+    error: Error, exposure: HttpErrorExposure = 'production'
+  ): SerializedHttpError => {
+    const normalized = normalizeForWire(error)
+    const thrown = errorStatus(error)
+    const status = thrown !== SERVER_ERROR ? thrown : errorStatus(normalized)
+    const incidentId = randomUUID()
+    // The server log owns every diagnostic. Production callers receive only its correlation key;
+    // development keeps the typed wire form so local clients can retain their usual error details.
+    Object.assign(error, { incidentId })
+    if (isResilientError(normalized)) normalized.incidentId = incidentId
+    const body = exposure === 'production'
+      ? incidentId
+      : ResilientError.marshal(normalized, { includeStack: true, incidentId }).message
+
+    return { status, body, incidentId }
+  }
+
+  const applyErrorHeaders = (error: unknown, reply: FastifyReply): void => {
+    if (error == null || typeof error !== 'object') {
+      return
+    }
+    const retryAfter = (error as { retryAfter?: unknown }).retryAfter
+    if (typeof retryAfter === 'number' && Number.isFinite(retryAfter) && retryAfter > 0) {
+      reply.header('Retry-After', String(Math.ceil(retryAfter)))
+    }
+    // Match exact registered types. EntitlementRefusal also extends AuthForbidden but is a plan
+    // decision, not a person's IAM permission denial.
+    const type = (error as { type?: unknown }).type
+    if (type === AuthForbidden.typeName || type === AccessError.typeName) {
+      reply.header(DENIAL_KIND_HEADER, ACCESS_DENIED_KIND)
+    }
+  }
+
+  const handleError = (
+    error: Error, reply: FastifyReply, exposure: HttpErrorExposure = 'production'
+  ): void => {
+    if (!reply.sent) {
+      const serialized = serializeError(error, exposure)
+      applyErrorHeaders(error, reply)
+      // The one record of a failed request: method, path and status — never what the caller sent.
+      fastifyLogUtils.failure(error, reply.request, serialized.status, serialized.incidentId)
+      reply.header(INCIDENT_ID_HEADER, serialized.incidentId)
+        .code(serialized.status)
+        .send(serialized.body)
+    }
+  }
+
+  return { declaredErrorStatus, errorStatus, errorExposure, serializeError, applyErrorHeaders, handleError }
 }
+
+export const httpErrorHelper = createHttpErrorHelper()
+
+/** @deprecated compat:factory-refactor — use `httpErrorHelper.errorStatus(…)` */
+export const errorStatus = (error: unknown): number => httpErrorHelper.errorStatus(error)

package/src/utils/guards.ts

@@ -1,15 +1,12 @@
-import { isContextWithoutIds, Layer } from '@owlmeans/context'
 import type { FastifyReply, FastifyRequest } from 'fastify'
 import type { ServerEntrypoint } from '@owlmeans/server-entrypoint'
-import type { GuardService } from '@owlmeans/entrypoint'
-import { provideResponse } from '@owlmeans/entrypoint'
-import type { ServerConfig, ServerContext } from '@owlmeans/server-context'
-import { executeResponse, provideRequest } from './payload.js'
+import { type GuardService, provideResponse } from '@owlmeans/entrypoint'
+import { payloadHelper } from './payload.js'
 import { AuthFailedError } from '../errors.js'
 import type { Auth } from '@owlmeans/auth'
+import type { Config, Context } from './types.local.js'
+import { makeEntityScope } from '@owlmeans/auth-common'
 
-type Config = ServerConfig
-interface Context<C extends Config = Config> extends ServerContext<C> { }
 
 export const authorize = async <C extends Config, T extends Context<C>>(
   context: T, module: ServerEntrypoint<FastifyRequest>,
@@ -18,7 +15,7 @@ export const authorize = async <C extends Config, T extends Context<C>>(
   const guards = module.getGuards()
   if (guards.length > 0) {
     const response = provideResponse(reply)
-    const request = provideRequest(module.alias, req)
+    const request = payloadHelper.provideRequest(module.alias, req)
 
     let guard: GuardService | undefined = undefined
     for (const alias of guards) {
@@ -26,7 +23,7 @@ export const authorize = async <C extends Config, T extends Context<C>>(
       if (await _guard.match(request, response)) {
         guard = _guard
       }
-      executeResponse(response, reply, true)
+      payloadHelper.executeResponse(response, reply, true)
       if (guard != null) {
         break
       }
@@ -40,7 +37,7 @@ export const authorize = async <C extends Config, T extends Context<C>>(
     if (!await guard.handle<boolean>(request, authResponse)) {
       throw new AuthFailedError(guard.alias)
     }
-    executeResponse(authResponse, reply, true)
+    payloadHelper.executeResponse(authResponse, reply, true)
     // Guard that returns true and does not provide an error is an optional guard
     // if (authResponse.value == null) {
     //   throw SyntaxError(`Guard that returns true and does not provide an error, should provide authorization`)
@@ -50,22 +47,15 @@ export const authorize = async <C extends Config, T extends Context<C>>(
       (req as any)._auth = request.auth
     }
 
-    if (request.auth?.entityId != null) {
-      // @TODO Probably we need to downgrade context in this case
-      if (!isContextWithoutIds(context as any)) {
-        throw SyntaxError(`Context should be without ids during authorization ${context.cfg.layer}:${context.cfg.layerId}`)
-      }
-
-      if (isContextWithoutIds(context as any) && context.cfg.layer !== Layer.Service) {
-        context = await context.updateContext(undefined, Layer.Service)
-        await context.waitForInitialized()
-      }
-      context = await context.updateContext(request.auth.entityId, Layer.Entity)
-      await context.waitForInitialized()
-
-      // We elevate module to the context level if it was changed
-      module = context.entrypoint(module.alias)
-      await module.resolve()
+    // The token names the organization by slug; everything downstream — grants, records, minted
+    // infrastructure names — keys on the entity's stable id. Resolving here, once, is what keeps a
+    // rename from being a sweep of every handler: the id arrives on the request, and a slug that
+    // has since been retired still resolves to the entity that retired it.
+    const entity = await makeEntityScope(request).attachEntity(context)
+    if (entity != null) {
+      // Carried on the raw request the same way `_auth` is, so the request the handler is given
+      // later — a different object, built after this runs — sees the same resolution.
+      ;(req as any)._entity = entity
     }
   }
   // Update context in request object

package/src/utils/index.ts

@@ -1,7 +1,12 @@
 
 export * from './error.js'
+export * from './consts.js'
+export type * from './types.js'
+export type * from './error/types.js'
+export type * from './payload/types.js'
+export type * from './context/types.js'
 export * from './server.js'
 export * from './payload.js'
-export * from './server.js'
+export * from './schema.js'
 export * from './guards.js'
 export * from './context.js'

package/src/utils/log/consts.ts

@@ -0,0 +1,18 @@
+/**
+ * Keys of a Fastify log record that carry what a caller sent. They are dropped at every depth: a
+ * request body and its raw form (`rawBody`), multipart fields and file buffers, headers (with the
+ * authorization and cookie values), cookies and the parsed query string.
+ */
+export const UNSAFE_LOG_KEYS: ReadonlySet<string> = new Set([
+  'body', 'rawBody', 'payload', 'files', 'file', 'headers', 'rawHeaders', 'trailers', 'rawTrailers',
+  'query', 'querystring', 'cookies', 'cookie', 'authorization',
+])
+
+/** Deepest nesting `safeData` walks; anything below is one marker. */
+export const SAFE_DATA_DEPTH = 4
+
+/**
+ * The query string of a path or URL inside free text (a Fastify warning names `"/x?token=…"`): the
+ * path is kept (`$1`), the query is cut.
+ */
+export const QUERY_IN_TEXT = /(\/[^\s?"'`]*)\?[^\s"'`)]+/g

package/src/utils/log/types.ts

@@ -0,0 +1,43 @@
+import type { FastifyBaseLogger, LogController } from 'fastify'
+import type { Logger } from '@owlmeans/log'
+
+/** All a log record may say about a request: its method and its path — never the query string. */
+export interface RequestSummary {
+  method?: string
+  path?: string
+}
+
+/**
+ * How the API server's Fastify instance logs: through `@owlmeans/log`, and never with what a caller
+ * sent — a body, a raw body, multipart bytes, headers, cookies or a query string.
+ */
+export interface FastifyLogUtils {
+  /**
+   * A pino-shaped logger over `log` (scope `http` by default), handed to Fastify as its
+   * `loggerInstance`. Every record's data — Fastify's own and any plugin's — passes `safeData`.
+   */
+  logger: (log?: Logger, bindings?: Record<string, unknown>) => FastifyBaseLogger
+  /**
+   * The `logController` Fastify writes its own request lines through: no per-request pair (the
+   * server writes one debug record from `onResponse`), a request the default error handler answers
+   * is `failure`, a missing route is one debug line without its query.
+   */
+  controller: () => LogController
+  /**
+   * A copy of a record's data that is safe to write: a request becomes its `RequestSummary`, a reply
+   * its status, bytes their size, any other class instance its name; the keys that carry what a
+   * caller sent (`body`, `rawBody`, `headers`, `query`, `cookies`, files…) are dropped at every depth
+   * (a number or boolean under them stays: a count, a flag), and any string loses the query of a URL
+   * it names. An `Error` passes as it is (a copy, when its message names a URL with a query) — the
+   * log writes only its name, message, code and stack.
+   */
+  safeData: (data: unknown) => unknown
+  /** The method and the path, without the query string, of a Fastify or Node request. */
+  requestOf: (request: unknown) => RequestSummary
+  /**
+   * The one record of a failed request, by what its status means: 5xx `error` with the error,
+   * 403 `warn` `access.forbidden`, 401 `debug` `auth.refused`, any other 4xx `debug` with the error's
+   * code and message. Method, path and status only — never the request's content.
+   */
+  failure: (error: Error, request: unknown, status: number, incidentId?: string) => void
+}