@johntalton/http-util 1.0.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johntalton/http-util",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -12,6 +12,9 @@
   "files": [
     "src/*.js"
   ],
+  "repository": {
+    "url": "https://github.com/johntalton/http-util"
+  },
   "dependencies": {
     "@johntalton/sse-util": "^1.0.0"
   }

package/src/content-type.js

@@ -6,6 +6,7 @@ export const MIME_TYPE_XML = 'application/xml'
 export const MIME_TYPE_URL_FORM_DATA = 'application/x-www-form-urlencoded'
 export const MIME_TYPE_MULTIPART_FORM_DATA = 'multipart/form-data'
 export const MIME_TYPE_OCTET_STREAM = 'application/octet-stream'
+export const MIME_TYPE_MESSAGE_HTTP = 'message/http'
 
 export const KNOWN_CONTENT_TYPES = [
 	'application', 'audio', 'image', 'message',

package/src/handle-stream-util.js

@@ -8,7 +8,14 @@ import {
 	ENDING,
 } from '@johntalton/sse-util'
 
-import { CHARSET_UTF8, CONTENT_TYPE_JSON, CONTENT_TYPE_TEXT } from './content-type.js'
+/** @import { IncomingHttpHeaders } from 'node:http2' */
+
+import {
+	CHARSET_UTF8,
+	CONTENT_TYPE_JSON,
+	CONTENT_TYPE_TEXT,
+	MIME_TYPE_MESSAGE_HTTP
+} from './content-type.js'
 import { ServerTiming, HTTP_HEADER_SERVER_TIMING, HTTP_HEADER_TIMING_ALLOW_ORIGIN } from './server-timing.js'
 import { HTTP_HEADER_RATE_LIMIT, HTTP_HEADER_RATE_LIMIT_POLICY, RateLimit, RateLimitPolicy } from './rate-limit.js'
 
@@ -23,7 +30,9 @@ const {
 	HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS,
 	HTTP2_HEADER_SERVER,
 	HTTP2_HEADER_RETRY_AFTER,
-	HTTP2_HEADER_CACHE_CONTROL
+	HTTP2_HEADER_CACHE_CONTROL,
+	HTTP2_HEADER_ETAG,
+	HTTP2_HEADER_ALLOW
 } = http2.constants
 
 const {
@@ -32,7 +41,8 @@ const {
 	HTTP_STATUS_UNAUTHORIZED,
 	HTTP_STATUS_NO_CONTENT,
 	HTTP_STATUS_INTERNAL_SERVER_ERROR,
-	HTTP_STATUS_TOO_MANY_REQUESTS
+	HTTP_STATUS_TOO_MANY_REQUESTS,
+	HTTP_STATUS_METHOD_NOT_ALLOWED
 } = http2.constants
 
 export const HTTP_HEADER_ORIGIN = 'origin'
@@ -63,6 +73,7 @@ export const PREFLIGHT_AGE_SECONDS = '500'
  * @property {Array<TimingsInfo>} performance
  * @property {string|undefined} servername
  * @property {string|undefined} origin
+ * @property {string|undefined} etag
  */
 
 /**
@@ -102,14 +113,13 @@ export function sendError(stream, message, meta) {
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {string|undefined} allowedOrigin
  * @param {Array<string>} methods
  * @param {Metadata} meta
  */
-export function sendPreflight(stream, allowedOrigin, methods, meta) {
+export function sendPreflight(stream, methods, meta) {
 	stream.respond({
 		[HTTP2_HEADER_STATUS]: HTTP_STATUS_OK,
-		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: allowedOrigin,
+		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: meta.origin,
 		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS]: methods.join(','),
 		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS]: ['Authorization', HTTP2_HEADER_CONTENT_TYPE].join(','),
 		[HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE]: PREFLIGHT_AGE_SECONDS,
@@ -118,6 +128,20 @@ export function sendPreflight(stream, allowedOrigin, methods, meta) {
 	stream.end()
 }
 
+/**
+ * @param {ServerHttp2Stream} stream
+ * @param {Array<string>} methods
+ * @param {Metadata} meta
+ */
+export function sendNowAllowed(stream, methods, meta) {
+	stream.respond({
+		[HTTP2_HEADER_STATUS]: HTTP_STATUS_METHOD_NOT_ALLOWED,
+		[HTTP2_HEADER_ALLOW]: methods.join(','),
+		[HTTP2_HEADER_SERVER]: meta.servername
+	})
+	stream.end()
+}
+
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Metadata} meta
@@ -188,10 +212,9 @@ export const ENCODER_MAP = new Map([
  * @param {ServerHttp2Stream} stream
  * @param {Object} obj
  * @param {string|undefined} encoding
- * @param {string|undefined} allowedOrigin
  * @param {Metadata} meta
  */
-export function sendJSON_Encoded(stream, obj, encoding, allowedOrigin, meta) {
+export function sendJSON_Encoded(stream, obj, encoding, meta) {
 	if(stream.closed) { return }
 
 	const json = JSON.stringify(obj)
@@ -210,15 +233,16 @@ export function sendJSON_Encoded(stream, obj, encoding, allowedOrigin, meta) {
 	)
 
 	stream.respond({
-		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: allowedOrigin,
+		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: meta.origin,
 		[HTTP2_HEADER_CONTENT_TYPE]: CONTENT_TYPE_JSON,
 		[HTTP2_HEADER_CONTENT_ENCODING]: actualEncoding,
 		[HTTP2_HEADER_VARY]: 'Accept, Accept-Encoding',
 		[HTTP2_HEADER_CACHE_CONTROL]: 'private',
 		[HTTP2_HEADER_STATUS]: HTTP_STATUS_OK,
 		[HTTP2_HEADER_SERVER]: meta.servername,
-		[HTTP_HEADER_TIMING_ALLOW_ORIGIN]: allowedOrigin,
-		[HTTP_HEADER_SERVER_TIMING]: ServerTiming.encode(meta.performance)
+		[HTTP_HEADER_TIMING_ALLOW_ORIGIN]: meta.origin,
+		[HTTP_HEADER_SERVER_TIMING]: ServerTiming.encode(meta.performance),
+		[HTTP2_HEADER_ETAG]: meta.etag
 	})
 
 	// stream.write(encodedData)
@@ -227,10 +251,48 @@ export function sendJSON_Encoded(stream, obj, encoding, allowedOrigin, meta) {
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {string|undefined} allowedOrigin
+ * @param {string} method
+ * @param {URL} url
+ * @param {IncomingHttpHeaders} headers
+ * @param {Metadata} meta
+ */
+export function sendTrace(stream, method, url, headers, meta) {
+	const FILTER_KEYS = [ 'authorization', 'cookie' ]
+	const HTTP_VERSION = new Map([
+		[ 'h2', 'HTTP/2' ],
+		[ 'h2c', 'HTTP/2'],
+		[ 'http/1.1', 'HTTP/1.1']
+	])
+
+	const version = HTTP_VERSION.get(stream.session?.alpnProtocol ?? 'h2')
+
+	stream.respond({
+		[HTTP2_HEADER_CONTENT_TYPE]: MIME_TYPE_MESSAGE_HTTP,
+		[HTTP2_HEADER_STATUS]: HTTP_STATUS_OK,
+		[HTTP2_HEADER_SERVER]: meta.servername,
+		[HTTP_HEADER_TIMING_ALLOW_ORIGIN]: meta.origin,
+		[HTTP_HEADER_SERVER_TIMING]: ServerTiming.encode(meta.performance),
+	})
+
+	const reconstructed = [
+		`${method} ${url.pathname}${url.search} ${version}`,
+		Object.entries(headers)
+			.filter(([ key ]) => !key.startsWith(':'))
+			.filter(([ key ]) => !FILTER_KEYS.includes(key))
+			.map(([ key, value ]) => `${key}: ${value}`)
+			.join('\n'),
+		'\n'
+		]
+		.join('\n')
+
+	stream.end(reconstructed)
+}
+
+/**
+ * @param {ServerHttp2Stream} stream
  * @param {SSEOptions & Metadata} meta
  */
-export function sendSSE(stream, allowedOrigin, meta) {
+export function sendSSE(stream, meta) {
 	// stream.setTimeout(0)
 	// stream.session?.setTimeout(0)
 	// stream.session?.socket.setTimeout(0)
@@ -244,7 +306,7 @@ export function sendSSE(stream, allowedOrigin, meta) {
 	const sendBOM = meta.bom ?? true
 
 	stream.respond({
-		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: allowedOrigin,
+		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: meta.origin,
 		[HTTP2_HEADER_CONTENT_TYPE]: SSE_MIME,
 		[HTTP2_HEADER_STATUS]: activeStream ? HTTP_STATUS_OK : HTTP_STATUS_NO_CONTENT, // SSE_INACTIVE_STATUS_CODE
 		// [HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS]: 'true'