@toa.io/extensions.exposition 1.0.0-alpha.17 → 1.0.0-alpha.170

package/source/HTTP/Server.ts

@@ -1,95 +1,135 @@
+import assert from 'node:assert'
 import fs from 'node:fs'
 import os from 'node:os'
 import * as http from 'node:http'
-import assert from 'node:assert'
 import { once } from 'node:events'
+import { setTimeout } from 'node:timers/promises'
+import { console } from 'openspan'
 import { Connector } from '@toa.io/core'
-import { promex } from '@toa.io/generic'
 import { type OutgoingMessage, write } from './messages'
 import { ClientError, Exception } from './exceptions'
-import { Context } from './Context'
-import type { IncomingMessage } from './Context'
+import { Context, type IncomingMessage } from './Context'
 
 export class Server extends Connector {
   private readonly server: http.Server = http.createServer()
   private readonly properties: Properties
-  private process?: Processing
+  private readonly authorities: Record<string, string>
+  private process?: Processor
+  private ready: boolean = false
+  private startedAt: number = 0
 
   private constructor (properties: Properties) {
     super()
 
     this.properties = properties
+    this.authorities = Object.fromEntries(Object.entries(properties.authorities).map(([key, value]) => [value, key]))
 
     this.server.on('request', (req, res) => this.listener(req, res))
-  }
-
-  public get port (): number {
-    if (this.properties.port !== 0)
-      return this.properties.port
-
-    const address = this.server.address()
 
-    if (address === null || typeof address === 'string')
-      throw new Error('Server is not listening on a port.')
+    this.server.on('clientError', (error, socket) => {
+      console.warn('Client connection error', error)
 
-    return address.port
+      if (socket.writable) socket.end('HTTP/1.1 400 Bad Request\r\n\r\n')
+      else socket.destroy()
+    })
   }
 
-  public static create (options?: Partial<Properties>): Server {
-    const properties = options === undefined
-      ? DEFAULTS
-      : { ...DEFAULTS, ...options }
+  public static create (options: Options): Server {
+    const properties: Properties = { ...DEFAULTS, ...options }
 
     return new Server(properties)
   }
 
-  public attach (process: Processing): void {
+  public attach (process: Processor): void {
     this.process = process
   }
 
   protected override async open (): Promise<void> {
+    this.startedAt = Date.now()
     this.server.listen(this.properties.port)
 
     await once(this.server, 'listening')
 
-    console.info('HTTP Server is listening.')
+    console.info('HTTP Server is listening')
+
+    await setTimeout(this.properties.delay)
+
+    this.ready = true
+
+    console.info('Ready')
   }
 
   protected override async close (): Promise<void> {
     this.server.close()
+    this.ready = false
 
-    console.info('HTTP Server stopped accepting new connections.')
+    console.info('Stopped accepting new connections')
 
     await once(this.server, 'close')
 
-    console.info('HTTP Server has been stopped.')
+    console.info('Stopped')
   }
 
   private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
+    request.once('error', (error) => {
+      console.warn('Request error', errorAttributes(request, error))
+
+      if (!response.writableEnded)
+        response.destroy()
+    })
+
+    request.socket.once('error', (error) => {
+      console.warn('Socket error', errorAttributes(request, error))
+
+      if (!response.writableEnded)
+        response.destroy()
+    })
+
+    const invalid = validate(request)
+
+    if (invalid !== null) {
+      console.warn('Invalid request', errorAttributes(request, invalid))
+
+      response.writeHead(400).end()
+
+      return
+    }
+
     if (request.method === undefined || !this.properties.methods.has(request.method)) {
       response.writeHead(501).end()
 
       return
     }
 
-    if (request.url === undefined) {
-      response.writeHead(400).end()
+    if (request.url === '/.ready') {
+      if (this.ready)
+        response.writeHead(200, { 'cache-control': 'no-store' }).end()
+      else {
+        const remaining = (Math.ceil((Date.now() - this.startedAt) / 1000)).toString()
+
+        response.writeHead(503, { 'retry-after': remaining }).end()
+      }
 
       return
     }
 
-    assert.ok(this.process !== undefined,
-      'No processing function has been attached to the server.')
+    assert(this.process !== undefined, 'Request processor is not attached')
 
-    const context = new Context(request as IncomingMessage, this.properties.trace)
+    const host = request.headers.host!
+    const authority = this.authorities[host] ?? host
+    const context = new Context(authority, request as IncomingMessage, this.properties)
 
     this.process(context)
       .then(this.success(context, response))
       .catch(this.fail(context, response))
+      .finally(() => {
+        request.removeAllListeners('error')
+        request.socket.removeAllListeners('error')
+      })
   }
 
   private success (context: Context, response: http.ServerResponse) {
-    return (message: OutgoingMessage) => {
+    return async (message: OutgoingMessage) => {
       let status = message.status
 
       if (status === undefined)
@@ -97,62 +137,118 @@ export class Server extends Connector {
           status = 404
         else if (context.request.method === 'POST')
           status = 201
-        else if (message.body === undefined)
+        else if (message.body === undefined && context.request.method !== 'HEAD')
           status = 204
         else
           status = 200
 
-      response.statusCode = message.status = status
-      write(context, response, message)
+      message.status = status
+
+      await write(context, response, message)
     }
   }
 
   private fail (context: Context, response: http.ServerResponse) {
     return async (exception: Error) => {
-      if (!context.request.complete)
-        await adam(context.request)
-
-      response.statusCode = exception instanceof Exception
-        ? exception.status
-        : 500
-
-      const message: OutgoingMessage = { status: response.statusCode }
-      const verbose = exception instanceof ClientError || this.properties.debug
+      try {
+        if (!context.request.complete)
+          await adam(context.request)
+
+        if (!response.writableEnded) {
+          response.statusCode = exception instanceof Exception ? exception.status : 500
+
+          const message: OutgoingMessage = { status: response.statusCode }
+
+          // eslint-disable-next-line max-depth
+          if (context.encoder === null)
+            message.body = undefined
+          else if (exception instanceof ClientError || this.properties.debug)
+            message.body =
+              exception instanceof Exception
+                ? exception.body
+                : exception.stack ?? exception.message
+
+          await write(context, response, message)
+        }
+      } catch (final) {
+        console.error('Error in error handler', final)
+
+        if (!response.writableEnded)
+          try {
+            response.writeHead(500).end()
+          } catch (e) {
+            // Nothing more we can do
+          }
+      }
+    }
+  }
+}
 
-      if (verbose)
-        message.body = exception instanceof Exception
-          ? exception.body
-          : (exception.stack ?? exception.message)
+function validate (request: http.IncomingMessage): null | Error {
+  try {
+    void new URL(request.url!, `https://${request.headers.host}`)
 
-      write(context, response, message)
-    }
+    return null
+  } catch (error) {
+    return error as Error
   }
 }
 
 // https://github.com/whatwg/fetch/issues/1254
 async function adam (request: http.IncomingMessage): Promise<void> {
-  const completed = promex()
   const devnull = fs.createWriteStream(os.devNull)
 
-  request
-    .on('end', completed.callback)
-    .pipe(devnull)
+  request.pipe(devnull)
 
-  return completed
+  await once(request, 'end')
 }
 
-const DEFAULTS: Properties = {
-  methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']),
+function errorAttributes (request: http.IncomingMessage, error: Error & any): RequestErrorAttributes {
+  const attributes: RequestErrorAttributes = {
+    path: request.url!,
+    method: request.method!,
+    name: error.name
+  }
+
+  if (typeof error.code === 'string')
+    attributes.code = error.code
+
+  if (typeof error.stack === 'string')
+    attributes.stack = error.stack
+
+  return attributes
+}
+
+export const PORT = 8000
+export const DELAY = 3 // seconds
+
+const DEFAULTS: Omit<Properties, 'authorities'> = {
+  methods: new Set<string>(['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE', 'LOCK', 'UNLOCK']),
   debug: false,
   trace: false,
-  port: 8000
+  port: PORT,
+  delay: DELAY * 1000
 }
 
 interface Properties {
+  authorities: Record<string, string>
   methods: Set<string>
   debug: boolean
   trace: boolean
   port: number
+  delay: number
 }
 
-export type Processing = (input: Context) => Promise<OutgoingMessage>
+export type Options = { authorities: Properties['authorities'] } & {
+  [K in Exclude<keyof Properties, 'authorities'>]?: Properties[K]
+}
+
+export type Processor = (input: Context) => Promise<OutgoingMessage>
+
+interface RequestErrorAttributes {
+  path: string
+  method: string
+  name: string
+  code?: string
+  stack?: string
+}

package/source/HTTP/exceptions.ts

@@ -36,21 +36,33 @@ export class NotFound extends ClientError {
   }
 }
 
+export class MethodNotAllowed extends ClientError {
+  public constructor () {
+    super(405)
+  }
+}
+
+export class NotAcceptable extends ClientError {
+  public constructor () {
+    super(406)
+  }
+}
+
 export class Conflict extends ClientError {
   public constructor (body?: any) {
     super(409, body)
   }
 }
 
-export class MethodNotAllowed extends ClientError {
+export class PreconditionFailed extends ClientError {
   public constructor () {
-    super(405)
+    super(412)
   }
 }
 
-export class NotAcceptable extends ClientError {
-  public constructor () {
-    super(406)
+export class RequestEntityTooLarge extends ClientError {
+  public constructor (body?: any) {
+    super(413, body)
   }
 }
 
@@ -60,8 +72,14 @@ export class UnsupportedMediaType extends ClientError {
   }
 }
 
-export class PreconditionFailed extends ClientError {
+export class UnprocessableEntity extends ClientError {
+  public constructor (body?: any) {
+    super(422, body)
+  }
+}
+
+export class TooManyRequests extends ClientError {
   public constructor () {
-    super(412)
+    super(429)
   }
 }

package/source/HTTP/formats/index.ts

@@ -1,14 +1,13 @@
-import { type Buffer } from 'node:buffer'
 import * as json from './json'
 import * as yaml from './yaml'
 import * as msgpack from './msgpack'
 import * as text from './text'
 
 export const formats: Record<string, Format> = {
-  [msgpack.type]: msgpack,
-  [yaml.type]: yaml,
   [json.type]: json,
-  [text.type]: text
+  [yaml.type]: yaml,
+  [text.type]: text,
+  [msgpack.type]: msgpack
 }
 
 export const types = Object.keys(formats)

package/source/HTTP/formats/json.ts

@@ -1,5 +1,3 @@
-import { Buffer } from 'node:buffer'
-
 export const type = 'application/json'
 export const multipart = 'multipart/json'
 

package/source/HTTP/formats/msgpack.ts

@@ -1,4 +1,3 @@
-import { type Buffer } from 'node:buffer'
 import { pack, unpack } from 'msgpackr'
 
 export function decode (buffer: Buffer): any {

package/source/HTTP/formats/text.ts

@@ -1,5 +1,3 @@
-import { Buffer } from 'node:buffer'
-
 export const type = 'text/plain'
 export const multipart = 'multipart/text'
 

package/source/HTTP/formats/yaml.ts

@@ -1,4 +1,3 @@
-import { Buffer } from 'node:buffer'
 import * as yaml from 'js-yaml'
 
 export const type = 'application/yaml'

package/source/HTTP/messages.test.ts

@@ -1,9 +1,13 @@
-import { Readable } from 'node:stream'
+import { PassThrough, Readable } from 'node:stream'
+import * as streamConsumers from 'node:stream/consumers'
+import { once } from 'node:events'
 import { generate } from 'randomstring'
 import * as msgpack from 'msgpackr'
-import { read } from './messages'
+import { multipart, read, type OutgoingMessage } from './messages'
 import { BadRequest, UnsupportedMediaType } from './exceptions'
+import { formats } from './formats'
 import { Timing } from './Timing'
+import type * as http from 'node:http'
 import type { Context } from './Context'
 
 beforeEach(() => {
@@ -69,6 +73,45 @@ describe('read', () => {
 
     await expect(read(request)).rejects.toThrow(BadRequest)
   })
+
+  it('should output correct mulitpart format', async () => {
+    const response = new class extends PassThrough {
+      public readonly headers = new Headers()
+
+      public setHeader (key: string, value: string): this {
+        this.headers.set(key, value)
+
+        return this
+      }
+    }()
+
+    const context = { encoder: formats['text/plain'] } as unknown as Context
+    const message = { body: Readable.from(['Hello', 'New', 'World']) } as unknown as OutgoingMessage
+
+    multipart(message, context, response as unknown as http.ServerResponse)
+
+    await once(message.body, 'end')
+
+    const result = await streamConsumers.text(response)
+
+    expect(result).toBe([
+      '--cut',
+      '',
+      'ACK',
+      '--cut',
+      '',
+      'Hello',
+      '--cut',
+      '',
+      'New',
+      '--cut',
+      '',
+      'World',
+      '--cut',
+      '',
+      'FIN',
+      '--cut--'].join('\r\n'))
+  })
 })
 
 export function createContext
@@ -82,6 +125,7 @@ jest.MockedObject<Context> {
       url,
       headers
     }) as unknown as Context['request'],
+    url: new URL(url, 'https://host.local'),
     timing: new Timing(false)
   }
 

package/source/HTTP/messages.ts

@@ -1,18 +1,38 @@
 import { Readable } from 'node:stream'
 import { buffer } from 'node:stream/consumers'
+import { console } from 'openspan'
 import { formats } from './formats'
 import { BadRequest, NotAcceptable, UnsupportedMediaType } from './exceptions'
 import type { Context } from './Context'
 import type * as http from 'node:http'
 
-export function write
-(context: Context, response: http.ServerResponse, message: OutgoingMessage): void {
+const server = `Exposition/${require('../../package.json').version}` +
+  ((process.env.TOA_CONTEXT === undefined ? '' : ` ${process.env.TOA_CONTEXT}`) +
+    (process.env.TOA_ENV === undefined ? '' : `/${process.env.TOA_ENV}`))
+
+const pending = new Map<string, PendingStream>()
+
+export async function write
+(context: Context, response: http.ServerResponse, message: OutgoingMessage): Promise<void> {
   for (const transform of context.pipelines.response)
-    transform(message)
+    await transform(message)
+
+  if (message?.status !== undefined)
+    response.statusCode = message.status
 
+  response.setHeader('server', server)
   message.headers?.forEach((value, key) => response.setHeader(key, value))
   context.timing.append(response)
 
+  if (response.destroyed) {
+    console.warn('Request destroyed prematurely', { path: context.url.pathname })
+
+    return
+  }
+
+  response.on('error', (exception: Error) =>
+    console.warn('HTTP response error', { path: context.url.pathname, exception }))
+
   if (message.body instanceof Readable)
     stream(message, context, response)
   else
@@ -33,7 +53,8 @@ export async function read (context: Context): Promise<any> {
 
   try {
     return format.decode(buf)
-  } catch {
+  } catch (error: unknown) {
+    console.debug('Failed to decode message', { path: context.url.pathname, error })
     throw new BadRequest()
   }
 }
@@ -41,6 +62,7 @@ export async function read (context: Context): Promise<any> {
 function send
 (message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (message.body === undefined || message.body === null) {
+    response.setHeader('content-length', '0')
     response.end()
 
     return
@@ -53,6 +75,7 @@ function send
 
   response
     .setHeader('content-type', context.encoder.type)
+    .setHeader('content-length', buf.length.toString())
     .appendHeader('vary', 'accept')
     .end(buf)
 }
@@ -66,13 +89,16 @@ function stream
   else
     multipart(message, context, response)
 
-  message.body.on('error', (e: Error) => {
-    console.error(e)
+  message.body.on('error', (exception: Error) => {
+    console.warn('Message stream error', { path: context.url.pathname, exception })
     response.end()
   })
+
+  if (context.debug)
+    debugStream(context, response)
 }
 
-function multipart
+export function multipart
 (message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (context.encoder === null)
     throw new NotAcceptable()
@@ -81,9 +107,26 @@ function multipart
 
   response.setHeader('content-type', `${encoder.multipart}; boundary=${BOUNDARY}`)
 
+  response.write(Buffer.concat([
+    CUT,
+    CRLF,
+    encoder.encode('ACK'),
+    CRLF,
+    CUT
+  ]))
+
   message.body
-    .map((part: unknown) => Buffer.concat([CUT, encoder.encode(part), CRLF]))
-    .on('end', () => response.end(FINALCUT))
+    .map((part: unknown) => Buffer.concat([
+      CRLF /* indicates no boundary headers */,
+      encoder.encode(part),
+      CRLF,
+      CUT]))
+    .on('end', () => response.end(Buffer.concat([
+      CRLF,
+      encoder.encode('FIN'),
+      CRLF,
+      FINALCUT
+    ])))
     .pipe(response)
 }
 
@@ -92,6 +135,35 @@ const CUT = Buffer.from(`--${BOUNDARY}\r\n`)
 const CRLF = Buffer.from('\r\n')
 const FINALCUT = Buffer.from(`--${BOUNDARY}--`)
 
+const PENDING_DEBUG_INTERVAL = 30000
+
+let pendingInterval: NodeJS.Timeout | null = null
+
+function debugStream (context: Context, response: http.ServerResponse): void {
+  const ctx = { method: context.request.method, path: context.url.pathname }
+
+  console.debug('Stream opened', ctx)
+  pending.set(context.id, ctx)
+
+  response.on('close', () => {
+    console.debug('Stream closed', ctx)
+    pending.delete(context.id)
+
+    if (pending.size === 0) {
+      if (pendingInterval !== null)
+        clearInterval(pendingInterval)
+
+      pendingInterval = null
+    }
+  })
+
+  if (pendingInterval === null)
+    pendingInterval = setInterval(() =>
+      console.debug('Pending streams',
+        Array.from(pending.values()).map(({ method, path }) => (`${method} ${path}`))),
+    PENDING_DEBUG_INTERVAL)
+}
+
 export interface OutgoingMessage {
   status?: number
   headers?: Headers
@@ -103,8 +175,15 @@ export interface Query {
 
   id?: string
   criteria?: string
+  search?: string
+  sample?: number
   sort?: string
   omit?: string
   limit?: string
   version?: number
 }
+
+interface PendingStream {
+  method: string
+  path: string
+}

package/source/Introspection.ts

@@ -0,0 +1,11 @@
+import type { Remote } from '@toa.io/core'
+
+export interface Introspection {
+  route?: Record<string, Schema>
+  query?: Record<string, Schema>
+  input?: Schema
+  output?: Schema
+  errors?: string[]
+}
+
+export type Schema = Awaited<ReturnType<Remote['explain']>>['input']