@noego/dinner
v2.4.1
Published
Portable v1 backend executor
Readme
@noego/dinner
Portable backend executor for noego projects. @noego/app compiles an
OpenAPI document (paths, x-controller / x-action, x-middleware,
schemas) into an executable binding; dinner turns that binding into a
(request: Request, context) => Promise<Response> application that runs
unchanged on Node and Cloudflare Workers.
import { createBackendApplication } from '@noego/dinner';
const application = createBackendApplication(binding, {
contextBuilder, // per-request scoped IoC container
controllerBuilder, // DI-instantiate the controller class
});Controllers are classes; an action receives an Express-ish compat pair:
import type { CompatRequest, CompatResponse } from '@noego/dinner';
export default class TodosController {
async getTodos({ req, res }: { req: CompatRequest; res: CompatResponse }) {
return res.json({ items: [] });
}
}Request validation uses Ajv against the operation schemas; builds may
supply precompiled standalone validators (route.validators) for runtimes
that forbid code generation (Workers).
Portable middleware uses this contract:
type PortableMiddleware = (
context: BackendRequestContext,
next: () => Promise<Response | void>,
) => Response | void | Promise<Response | void>;Middleware may return a Response, await and return next(), or return
nothing when the surrounding pipeline is responsible for the final response.
Error replies (exposeErrors, onDefect)
Anything thrown inside a matched request (middleware, controller, hooks,
IoC scope) and dinner's own configuration 500s (missing x-action, unknown
action, unbound/unresolvable controller) become a 500 JSON reply. Whether
that reply carries the real message is decided by exposeErrors, resolved
once when createBackendApplication is called:
exposeErrors: true | falsepassed tocreateBackendApplicationwins.- Otherwise
NODE_ENV, read at runtime fromprocess.env(a bundlerdefineofprocess.env.NODE_ENVis not seen — passexposeErrorsinstead):developmentortestexposes; any other value (production,staging, ...) hides. - Otherwise (
NODE_ENVunset, noprocessat all — Cloudflare Workers withoutnodejs_compat, browsers — or an env read that throws, e.g. Deno without--allow-env) messages are hidden.
| | reply body |
|---|---|
| exposed | { "error": true, "message": "<error.message>", "statusCode": 500 } (plus cleanupFailures if an owned request scope failed to close) |
| hidden | { "error": true, "message": "Internal Server Error", "statusCode": 500 } |
The real error is always written server-side with console.error
([dinner] GET /route: unhandled error ...), whatever the flag says.
onDefect(error, context) is called for thrown failures (not the
configuration 500s, not 400s — those go to onRequestError) before the
default reply is built. Return a Response to shape the reply, or nothing
for the default 500. A throwing onDefect is logged and falls back to the
default 500.
createBackendApplication(binding, {
exposeErrors: env.NODE_ENV === 'development', // optional: overrides NODE_ENV detection
onDefect: (error, context) => Response.json({ code: 'INTERNAL' }, { status: 500 }),
});Exports: createBackendApplication, computeOperationSchemas,
VALIDATION_AJV_OPTIONS, createCompatPair, matchRoute,
allowedMethods, and the binding/route types.
