@johntalton/http-core 1.0.3 → 1.0.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@johntalton/http-core",
   "type": "module",
-  "version": "1.0.3",
+  "version": "1.0.7",
   "license": "MIT",
   "exports": {
     ".": "./src/index.js"
@@ -13,9 +13,13 @@
     "url": "https://github.com/johntalton/http-core"
   },
   "scripts": {
+    "lint": "biome check"
   },
   "dependencies": {
-    "@johntalton/http-util": "^5.1.2",
+    "@johntalton/http-util": "^6.1.0",
     "@johntalton/sse-util": "^1.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.15"
   }
 }

package/src/epilogue.js

@@ -24,7 +24,7 @@ function addSSEPortHandler(stream, port, streamId, shutdownSignal) {
 		port.close()
 	}))
 
-	shutdownSignal.addEventListener('abort', signalHandler)
+	shutdownSignal.addEventListener('abort', signalHandler, { once: true })
 
 	// ServerSentEvents.messageToEventStreamLines({
 	// 		comment: 'Welcome',
@@ -47,17 +47,17 @@ function addSSEPortHandler(stream, port, streamId, shutdownSignal) {
 export function epilogue(state) {
 	const { type, stream, meta, streamId } = state
 
-	meta.customHeaders.push([ 'X-Request-Id', streamId ])
+	meta.customHeaders?.push([ 'X-Request-Id', streamId ])
 
 	switch(type) {
 		//
 		case 'trace': { Response.trace(stream, state.method, state.url, state.headers, meta) } break
 		//
 		case 'preflight': { Response.preflight(stream, state.methods, state.supportedQueryTypes, undefined, meta) } break
-		case 'no-content': { Response.noContent(stream, state.etag, meta)} break
+		case 'no-content': { Response.noContent(stream, state.etag, state.lastModified, meta)} break
 		// case 'accepted': { Response.accepted(stream, meta) } break
-		case 'created': { Response.created(stream, new URL(state.location, meta.origin), state.etag, meta) } break
-		case 'not-modified': { Response.notModified(stream, state.etag, state.age, { priv: true, maxAge: 60 }, meta) } break
+		case 'created': { Response.created(stream, new URL(state.location, meta.origin), state.etag, state.lastModified, meta) } break
+		case 'not-modified': { Response.notModified(stream, state.etag, state.lastModified, state.age, state.cacheControl ?? {}, meta) } break
 
 		//
 		// case 'multiple-choices': { Response.multipleChoices(stream, meta) } break
@@ -74,7 +74,7 @@ export function epilogue(state) {
 		case 'not-acceptable': { Response.notAcceptable(stream, state.acceptableMediaTypes ?? [], meta)} break
 		case 'unsupported-media': { Response.unsupportedMediaType(stream, state.acceptableMediaTypes, state.supportedQueryTypes, meta) } break
 		case 'unprocessable': { Response.unprocessable(stream, meta) } break
-		case 'precondition-failed': { Response.preconditionFailed(stream, meta) } break
+		case 'precondition-failed': { Response.preconditionFailed(stream, state.etag, state.lastModified, meta) } break
 		case 'not-satisfiable': { Response.rangeNotSatisfiable(stream, { size: state.contentLength }, meta) } break
 		case 'content-too-large': { Response.contentTooLarge(stream, meta) } break
 		case 'insufficient-storage': { Response.insufficientStorage(stream, meta) } break
@@ -94,10 +94,10 @@ export function epilogue(state) {
 		}
 		break
 		case 'json': {
-			const { obj, accept, etag } = state
+			const { obj, accept, etag, lastModified } = state
 
 			if(accept.type === MIME_TYPE_JSON) {
-				Response.json(stream, obj, accept.encoding, etag, state.age, { priv: true, maxAge: 60 }, state.supportedQueryTypes, meta)
+				Response.json(stream, obj, accept.encoding, etag, lastModified, state.age, state.cacheControl ?? {}, state.supportedQueryTypes, meta)
 			}
 			else {
 				// todo: but we did process the request - is that ok?
@@ -105,8 +105,8 @@ export function epilogue(state) {
 			}
 		}
 		break
-		case 'partial-bytes': { Response.partialContent(stream, state.contentType, state.objs, state.contentLength, undefined, state.etag, state.age, { maxAge: state.maxAge }, meta) } break
-		case 'bytes': { Response.bytes(stream, state.contentType, state.obj, state.contentLength, 'identity', state.etag, state.age, { maxAge: state.maxAge }, state.acceptRanges, meta) } break
+		case 'partial-bytes': { Response.partialContent(stream, state.contentType, state.objs, state.contentLength, undefined, state.etag, state.lastModified, state.age, state.cacheControl ?? {}, meta) } break
+		case 'bytes': { Response.bytes(stream, state.contentType, state.obj, state.contentLength, 'identity', state.etag, state.lastModified, state.age, state.cacheControl ?? {}, state.acceptRanges, meta) } break
 
 		//
 		case 'error': {

package/src/index.js

@@ -42,8 +42,19 @@ export const KNOWN_METHODS = [
 
 /** @import { Metadata } from '@johntalton/http-util/response' */
 /** @import { BodyFuture } from '@johntalton/http-util/body' */
-/** @import { EtagItem, IMFFixDate, ContentRangeDirective, RateLimitPolicyInfo, RateLimitInfo, ChallengeItem } from '@johntalton/http-util/headers' */
+/** @import {
+ EtagItem,
+ IMFFixDate,
+ IMFFixDateInput,
+ ContentRangeDirective,
+ RateLimitPolicyInfo,
+ RateLimitInfo,
+ ChallengeItem,
+ CacheControlOptions
+} from '@johntalton/http-util/headers' */
 /** @import { SendBody } from '@johntalton/http-util/response' */
+/** @import { SecFetchSite, SecFetchMode, SecFetchDest } from '@johntalton/http-util/headers' */
+
 
 /** @typedef {(state: RouteRequest|RouteAction) => Promise<RouteAction>} Router */
 
@@ -100,6 +111,20 @@ export const KNOWN_METHODS = [
  * @property {AbortSignal} shutdownSignal
  */
 
+/**
+ * @typedef {Object} RouteRequestAccept
+ * @property {string|undefined} type
+ * @property {string|undefined} encoding
+ * @property {string|undefined} language
+ */
+
+/**
+ * @typedef {Object} RouteRemoteClient
+ * @property {string|undefined} family
+ * @property {string|undefined} ip
+ * @property {number|undefined} port
+ */
+
 /**
  * @typedef {Object} RouteRequestBase
  * @property {'request'} type
@@ -110,6 +135,7 @@ export const KNOWN_METHODS = [
  * @property {RouteRequestAccept} accept
  * @property {RouteRemoteClient} client
  * @property {RouteConditions} conditions
+ * @property {SecFetchMetadata} secFetchMetadata
  * @property {string} SNI
  */
 /** @typedef {RouteBase & RouteRequestBase} RouteRequest */
@@ -138,24 +164,9 @@ export const KNOWN_METHODS = [
  * @property {URL} url
  * @property {IncomingHttpHeaders} headers
  * @property {number} maxForwards
- * @property {RouteRequestAccept} accept
  */
 /** @typedef {RouteBase & RouteTraceBase} RouteTrace */
 
-/**
- * @typedef {Object} RouteRequestAccept
- * @property {string|undefined} type
- * @property {string|undefined} encoding
- * @property {string|undefined} language
- */
-
-/**
- * @typedef {Object} RouteRemoteClient
- * @property {string|undefined} family
- * @property {string|undefined} ip
- * @property {number|undefined} port
- */
-
 /**
  * @typedef {Object} RouteConditions
  * @property {Array<EtagItem>} match
@@ -165,6 +176,14 @@ export const KNOWN_METHODS = [
  * @property {IMFFixDate|EtagItem|undefined} [range]
  */
 
+/**
+ * @typedef {Object} SecFetchMetadata
+ * @property {SecFetchSite|undefined} site
+ * @property {SecFetchMode|undefined} mode
+ * @property {SecFetchDest|undefined} dest
+ */
+
+
 /**
  * @typedef {Object} RoutePreflightBase
  * @property {'preflight'} type
@@ -180,9 +199,10 @@ export const KNOWN_METHODS = [
  * @property {'json'} type
  * @property {RouteRequestAccept} accept
  * @property {Record<any, any>} obj
- * @property {IMFFixDate|string|undefined} [lastModified]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  * @property {EtagItem|undefined} [etag]
  * @property {number|undefined} [age]
+ * @property {CacheControlOptions|undefined} [cacheControl]
  * @property {Array<string>|undefined} [supportedQueryTypes]
  */
 /** @typedef {RouteBase & RouteJSONBase} RouteJSON */
@@ -201,6 +221,7 @@ export const KNOWN_METHODS = [
  * @property {'created'} type
  * @property {URL|string} location
  * @property {EtagItem|undefined} [etag]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  */
 /** @typedef {RouteBase & RouteCreatedBase} RouteCreated */
 
@@ -217,7 +238,9 @@ export const KNOWN_METHODS = [
  * @property {'not-modified'} type
  * @property {number} age
  * @property {EtagItem|undefined} [etag]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  * @property {number|undefined} [age]
+ * @property {CacheControlOptions|undefined} [cacheControl]
  */
 /** @typedef {RouteBase & RouteNotModifiedBase} RouteNotModified */
 
@@ -225,6 +248,7 @@ export const KNOWN_METHODS = [
  * @typedef {Object} RoutePreconditionFailedBase
  * @property {'precondition-failed'} type
  * @property {EtagItem|undefined} [etag]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  */
 /** @typedef {RouteBase & RoutePreconditionFailedBase} RoutePreconditionFailed */
 
@@ -272,10 +296,10 @@ export const KNOWN_METHODS = [
  * @property {string} contentType
  * @property {number|undefined} [contentLength]
  * @property {SendBody|undefined} obj
- * @property {IMFFixDate|string|undefined} [lastModified]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  * @property {EtagItem|undefined} [etag]
  * @property {number|undefined} [age]
- * @property {number|undefined} [maxAge]
+ * @property {CacheControlOptions|undefined} [cacheControl]
  * @property {'bytes'|'none'|undefined} [acceptRanges]
  */
 /** @typedef {RouteBase & RouteBytesBase} RouteBytes */
@@ -298,8 +322,9 @@ export const KNOWN_METHODS = [
  * @property {string} contentType
  * @property {number|undefined} [contentLength]
  * @property {EtagItem|undefined} [etag]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  * @property {number|undefined} [age]
- * @property {number|undefined} [maxAge]
+ * @property {CacheControlOptions|undefined} [cacheControl]
  */
 /** @typedef {RouteBase & RoutePartialBytesBase} RoutePartialBytes */
 
@@ -342,6 +367,7 @@ export const KNOWN_METHODS = [
  * @typedef {Object} RouteNoContentBase
  * @property {'no-content'} type
  * @property {EtagItem|undefined} [etag]
+ * @property {IMFFixDateInput|string|undefined} [lastModified]
  */
 /** @typedef {RouteBase & RouteNoContentBase} RouteNoContent */
 
@@ -396,7 +422,6 @@ export const KNOWN_METHODS = [
  * @property {boolean} active
  * @property {boolean} bom
  * @property {MessagePort} port
- * @property {RouteRequestAccept} accept
  */
 /** @typedef {RouteBase & RouteSSEBase} RouteSSE */
 
@@ -604,7 +629,14 @@ export class H2CoreServer {
 			if(!isServerStream(stream)) { return }
 
 			// const start = performance.now()
-			const state = preamble(this.#h2Options.config, streamId, stream, headers, this.#h2Options.serverName, this.#controller.signal)
+			const state = preamble({
+					config: this.#h2Options.config,
+					streamId,
+					stream,
+					shutdownSignal: this.#controller.signal
+				},
+				headers,
+				this.#h2Options.serverName)
 			router(state)
 				.then(epilogue)
 				.catch(e => epilogue({ ...state, type: 'error', cause: e.message, error: e }))

package/src/preamble.js

@@ -1,3 +1,4 @@
+/** biome-ignore-all lint/nursery/noExcessiveLinesPerFile: does all the work */
 import http2 from 'node:http2'
 import { TLSSocket } from 'node:tls'
 
@@ -8,6 +9,7 @@ import {
 	AcceptLanguage,
 
 	Conditional,
+	ContentType,
 	ETag,
 
 	FORWARDED_KEY_FOR,
@@ -19,18 +21,21 @@ import {
 	MIME_TYPE_MESSAGE_HTTP,
 	MIME_TYPE_TEXT,
 	MIME_TYPE_XML,
-	parseContentType
+	SecFetch
 } from '@johntalton/http-util/headers'
 import {
 	ENCODER_MAP,
 	HTTP_HEADER_FORWARDED,
-	HTTP_HEADER_ORIGIN
+	HTTP_HEADER_ORIGIN,
+	HTTP_HEADER_SEC_FETCH_DEST,
+	HTTP_HEADER_SEC_FETCH_MODE,
+	HTTP_HEADER_SEC_FETCH_SITE
 } from '@johntalton/http-util/response'
 
 import { isValidHeader, isValidLikeHeader, isValidMethod } from './index.js'
 
 /** @import { ServerHttp2Stream, IncomingHttpHeaders } from 'node:http2' */
-/** @import { Config, RouteRequest, RouteAction, StreamID, RouteConditions } from './index.js' */
+/** @import { Config, RouteRequest, RouteAction, StreamID, RouteConditions, SecFetchMetadata } from './index.js' */
 
 const { HTTP2_METHOD_OPTIONS, HTTP2_METHOD_TRACE } = http2.constants
 
@@ -94,16 +99,24 @@ const BODY_BYTE_LENGTH = BYTE_PER_K * BYTE_PER_K
 // }
 
 /**
- * @param {Config} config
- * @param {StreamID} streamId
- * @param {ServerHttp2Stream} stream
+ * @typedef {Object} PreState
+ * @property {Config} config
+ * @property {StreamID} streamId
+ * @property {ServerHttp2Stream} stream
+ * @property {AbortSignal} shutdownSignal
+ */
+
+/**
+ * @param {PreState} preState
  * @param {IncomingHttpHeaders} headers
  * @param {string|undefined} servername
- * @param {AbortSignal} shutdownSignal
  * @returns {RouteRequest|RouteAction}
  */
-export function preamble(config, streamId, stream, headers, servername, shutdownSignal) {
+
+// biome-ignore lint/complexity/noExcessiveCognitiveComplexity: work horse
+export  function preamble(preState, headers, servername) {
 	const preambleStart = performance.now()
+	const { stream, shutdownSignal } = preState
 
 	//
 	const method = headers[HTTP2_HEADER_METHOD]
@@ -142,9 +155,9 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	// const secUA = header[HTTP_HEADER_SEC_CH_UA]
 	// const secPlatform = header[HTTP_HEADER_SEC_CH_PLATFORM]
 	// const secMobile = header[HTTP_HEADER_SEC_CH_MOBILE]
-	// const secFetchSite = header[HTTP_HEADER_SEC_FETCH_SITE]
-	// const secFetchMode = header[HTTP_HEADER_SEC_FETCH_MODE]
-	// const secFetchDest = header[HTTP_HEADER_SEC_FETCH_DEST]
+	const secFetchSite = headers[HTTP_HEADER_SEC_FETCH_SITE]
+	const secFetchMode = headers[HTTP_HEADER_SEC_FETCH_MODE]
+	const secFetchDest = headers[HTTP_HEADER_SEC_FETCH_DEST]
 
 	//
 	const allowedOrigin = (ALLOWED_ORIGINS.includes('*') || ((origin !== undefined) && URL.canParse(origin) && ALLOWED_ORIGINS.includes(origin))) ? origin : undefined
@@ -154,16 +167,13 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	const state = {
 		type: 'error',
 		cause: 'initialize',
-		config,
-		streamId,
-		stream,
+		...preState,
 		meta: {
 			servername,
 			performance: [],
 			origin: allowedOrigin,
 			customHeaders: []
-		},
-		shutdownSignal
+		}
 	}
 
 	if(shutdownSignal.aborted) {
@@ -200,6 +210,15 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	const requestUrl = new URL(fullPathAndQuery, `${scheme}://${authority}`)
 
+	// Sec Fetch Metadata
+	/** @type {SecFetchMetadata} */
+	const secFetchMetadata = {
+		site: SecFetch.parseSite(secFetchSite),
+		mode: SecFetch.parseMode(secFetchMode),
+		dest: SecFetch.parseDestination(secFetchDest)
+	}
+
+
 	//
 	/** @type {RouteConditions} */
 	const conditions = {
@@ -240,7 +259,7 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	// content negotiation
 	//
-	const contentType = parseContentType(fullContentType)
+	const contentType = ContentType.parse(fullContentType)
 	const acceptedEncoding = AcceptEncoding.select(fullAcceptEncoding, DEFAULT_SUPPORTED_ENCODINGS)
 	const accept = Accept.select(fullAccept, DEFAULT_SUPPORTED_MIME_TYPES)
 	const acceptedLanguage = AcceptLanguage.select(fullAcceptLanguage, DEFAULT_SUPPORTED_LANGUAGES)
@@ -255,11 +274,11 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	if(method === HTTP2_METHOD_TRACE) {
 		if(!ALLOW_TRACE) { return { ...state, type: 'not-allowed', method, methods: [], url: requestUrl }}
-		const maxForwardsValue = maxForwards !== undefined ? Number.parseInt(maxForwards) : 0
+		const maxForwardsValue = maxForwards === undefined ? 0 : Number.parseInt(maxForwards)
 		const preambleEnd = performance.now()
 		state.meta.performance.push({ name: 'preamble-trace', duration: preambleEnd - preambleStart })
 		if(acceptObject.type !== MIME_TYPE_MESSAGE_HTTP) { return { ...state, type: 'not-acceptable', acceptableMediaTypes: [ MIME_TYPE_MESSAGE_HTTP ] } }
-		return { ...state, type: 'trace', method, headers, url: requestUrl, maxForwards: maxForwardsValue, accept: acceptObject }
+		return { ...state, type: 'trace', method, headers, url: requestUrl, maxForwards: maxForwardsValue }
 	}
 
 	//
@@ -294,6 +313,7 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 		body,
 		// tokens,
 		conditions,
+		secFetchMetadata,
 		accept: acceptObject,
 		client: { family, ip, port },
 		SNI