FastifyAdapter

Kind: Class

Source: packages/platform-fastify/adapters/fastify-adapter.ts

Part of: Platform Fastify

FastifyAdapter bridges the framework’s HTTP abstractions to a Fastify server instance. It initializes the Fastify application, registers request/response lifecycle hooks, exposes common HTTP route methods, and starts the server through overloaded listen() methods.

Extends: AbstractHttpAdapter

Methods

Properties

Where it refuses work

• FastifyAdapter stops the work with Error when !isString(value) && !Array.isArray(value) — “Version constraint should be a string or an array of strings.”.
• FastifyAdapter stops the work with an early return when Array.isArray(version).
• FastifyAdapter stops the work with an early return when this.versioningOptions?.type === VersioningType.CUSTOM.
• FastifyAdapter stops the work with an early return when this.isMiddieRegistered.
• FastifyAdapter stops the work with an early return when err.code !== 'ERR_SERVER_NOT_RUNNING'.
• FastifyAdapter stops the work with an early return when this._isParserRegistered.

When something fails

• FastifyAdapter handles failure in 2 places: it lets it reach the caller in all 2.

Diagram

mermaid
graph LR
  App[Application] --> Adapter[FastifyAdapter]
  Adapter --> Hooks[Request / Response Hooks]
  Adapter --> Routes[GET / POST / HEAD / DELETE Routes]
  Adapter --> Fastify[Fastify Server]
  Fastify --> Client[HTTP Clients]

Usage

ts
import { FastifyAdapter } from '@platform-fastify/adapters/fastify-adapter';

const adapter = new FastifyAdapter();

adapter.setOnRequestHook(async (request, reply) => {
  request.log.info({ url: request.url }, 'Incoming request');

  // Example authentication guard
  if (request.headers['x-api-key'] !== process.env.API_KEY) {
    return reply.code(401).send({ message: 'Unauthorized' });
  }
});

adapter.setOnResponseHook(async (request, reply) => {
  request.log.info(
    { url: request.url, statusCode: reply.statusCode },
    'Response sent',
  );
});

adapter.get('/health', async () => {
  return { status: 'ok' };
});

adapter.post('/users', async (request, reply) => {
  const user = request.body;

  reply.code(201);
  return { user };
});

await adapter.init();
adapter.listen(3000);

AI Coding Instructions

• Register lifecycle hooks with setOnRequestHook() and setOnResponseHook() before calling init() or listen().
• Use the adapter’s route helpers (get, post, head, and delete) instead of registering routes directly on the underlying Fastify instance when working within the abstraction.
• Ensure handlers return serializable response values or explicitly send a response through Fastify’s reply object.
• Call init() before starting the server when initialization is not handled automatically by the surrounding application bootstrap.
• Preserve Fastify request/reply semantics in hooks and route handlers, including returning early after sending an error response.

Relationships

• IMPORTS → HttpStatus
• IMPORTS → Logger
• IMPORTS → RawBodyRequest
• IMPORTS → RequestMethod
• IMPORTS → StreamableFile
• IMPORTS → VERSION_NEUTRAL
• IMPORTS → VersioningOptions
• IMPORTS → VersioningType
• IMPORTS → VersionValue
• IMPORTS → loadPackage
• IMPORTS → isString
• IMPORTS → isUndefined
• IMPORTS → AbstractHttpAdapter
• IMPORTS → LegacyRouteConverter