@johntalton/http-util 1.0.0

package/src/multipart.js

@@ -0,0 +1,149 @@
+import { parseContentDisposition } from './content-disposition.js'
+import { parseContentType } from './content-type.js'
+
+export const DISPOSITION_FORM_DATA = 'form-data'
+
+export const BOUNDARY_MARK = '--'
+export const MULTIPART_SEPARATOR = '\r\n'
+
+export const HEADER_SEPARATOR = ':'
+
+export const EMPTY = ''
+
+export const MULTIPART_HEADER = {
+	CONTENT_DISPOSITION: 'content-disposition',
+	CONTENT_TYPE: 'content-type'
+}
+
+export const MULTIPART_STATE = {
+	BEGIN: 'begin',
+	HEADERS: 'headers',
+	VALUE: 'value',
+	BEGIN_OR_END: 'beginOrEnd'
+}
+
+export class Multipart {
+	/**
+	 * @param {string} text
+	 * @param {string} boundary
+	 * @param {string} [charset='utf8']
+	 */
+	static parse(text, boundary, charset = 'utf8') {
+		// console.log({ boundary, text })
+		const formData = new FormData()
+
+		if(text === '') {
+			// empty body
+			return formData
+		}
+
+		const lines = text.split(MULTIPART_SEPARATOR)
+
+		if(lines.length === 0) {
+			// missing body?
+			return formData
+		}
+
+		const boundaryBegin = `${BOUNDARY_MARK}${boundary}`
+		const boundaryEnd = `${BOUNDARY_MARK}${boundary}${BOUNDARY_MARK}`
+
+		let partName = undefined
+		let state = MULTIPART_STATE.BEGIN
+
+		for(const line of lines) {
+			// console.log('line', line)
+
+			if(state === MULTIPART_STATE.BEGIN) {
+				// expect boundary
+				if(line === boundaryEnd) {
+					// empty set
+					break
+				}
+
+				if(line !== boundaryBegin) {
+					throw new Error('missing beginning boundary')
+				}
+				state = MULTIPART_STATE.HEADERS
+			}
+			else if(state === MULTIPART_STATE.HEADERS) {
+				if(line === EMPTY) { state = MULTIPART_STATE.VALUE }
+				else {
+					const [ rawName, value ] = line.split(HEADER_SEPARATOR)
+					const name = rawName.toLowerCase()
+					// console.log('header', name, value)
+					if(name === MULTIPART_HEADER.CONTENT_TYPE) {
+						const contentType = parseContentType(value)
+						// console.log({ contentType })
+					}
+					else if(name === MULTIPART_HEADER.CONTENT_DISPOSITION) {
+						const disposition = parseContentDisposition(value)
+						if(disposition?.disposition !== DISPOSITION_FORM_DATA) {
+							throw new Error('disposition not form-data')
+						}
+
+						// todo: are names always quoted?
+						partName = disposition.name?.slice(1, -1)
+					}
+					else {
+						// unsupported part header - ignore
+						console.log('unsupported part header', name)
+					}
+				}
+			}
+			else if(state === MULTIPART_STATE.VALUE) {
+				// console.log('value', line)
+				if(partName === undefined) { throw new Error('unnamed part') }
+
+				formData.append(partName, line)
+				partName = undefined
+
+				state = MULTIPART_STATE.BEGIN_OR_END
+			}
+			else if(state === MULTIPART_STATE.BEGIN_OR_END) {
+				if(line === boundaryEnd) { break }
+				if(line !== boundaryBegin) {
+					throw new Error('missing boundary or end')
+				}
+				state = MULTIPART_STATE.HEADERS
+			}
+			else {
+				throw new Error('unknown state')
+			}
+
+		}
+
+		return formData
+	}
+}
+
+
+
+// const test = '--X-INSOMNIA-BOUNDARY\r\n' +
+//     'Content-Disposition: form-data; name="u"\r\n' +
+//     '\r\n' +
+//     'alice\r\n' +
+//     '--X-INSOMNIA-BOUNDARY\r\n' +
+//     'Content-Disposition: form-data; name="user"\r\n' +
+//     '\r\n' +
+//     'jeff\r\n' +
+//     '--X-INSOMNIA-BOUNDARY--\r\n'
+// const result = Multipart.parse(test, 'X-INSOMNIA-BOUNDARY')
+// console.log(result)
+
+
+// const test = [
+// 	'-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k',
+//  'Content-Disposition: form-data; '
+//    + 'name="upload_file_0"; filename="テスト.dat"',
+//  'Content-Type: application/octet-stream',
+//  '',
+//  'A'.repeat(1023),
+//  '-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--'
+// ].join('\r\n')
+// const result = Multipart.parse(test, '---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k')
+// console.log(result)
+
+
+// const test = '--X-INSOMNIA-BOUNDARY--\r\n'
+// const result = Multipart.parse(test, 'X-INSOMNIA-BOUNDARY')
+// console.log(result)

package/src/rate-limit.js

@@ -0,0 +1,84 @@
+export  const HTTP_HEADER_RATE_LIMIT = 'RateLimit'
+export const HTTP_HEADER_RATE_LIMIT_POLICY = 'RateLimit-Policy'
+
+/**
+ * @typedef {Object} RateLimitInfo
+ * @property {string} name
+ * @property {number} remaining
+ * @property {number} resetSeconds
+ * @property {string} partitionKey
+ */
+
+/**
+ * @typedef {Object} RateLimitPolicyInfo
+ * @property {string} name
+ * @property {number} quota
+ * @property {number} size
+ * @property {number} quotaUnits
+ * @property {number} windowSeconds
+ * @property {string} [partitionKey]
+ */
+
+export const LIMIT_PARAMETERS = {
+	REMAINING_QUOTA: 'r',
+	TIME_TILL_RESET_SECONDS: 't',
+	PARTITION_KEY: 'pk'
+}
+
+export const POLICY_PARAMETER = {
+	QUOTA: 'q',
+	QUOTA_UNITS: 'qu',
+	WINDOW_SECONDS: 'w',
+	PARTITION_KEY: 'pk'
+}
+
+export const QUOTA_UNIT = {
+	REQUEST: 'request',
+	BYTES: 'content-bytes',
+	CONCURRENT: 'concurrent-requests'
+}
+
+export class RateLimit {
+	/**
+	 * @param {RateLimitInfo} limitInfo
+	 */
+	static from(limitInfo) {
+		const { name, remaining, resetSeconds, partitionKey } = limitInfo
+
+		if(name === undefined || remaining === undefined) { return undefined }
+
+		const rs = resetSeconds ? `;${LIMIT_PARAMETERS.TIME_TILL_RESET_SECONDS}=${resetSeconds}` : ''
+		const pk = partitionKey ? `'${LIMIT_PARAMETERS.PARTITION_KEY}=${partitionKey}` : ''
+		return `"${name}";${LIMIT_PARAMETERS.REMAINING_QUOTA}=${remaining}${rs}${pk}`
+	}
+}
+
+export class RateLimitPolicy {
+	/**
+	 * @param {...RateLimitPolicyInfo} policies
+	 */
+	static from(...policies) {
+		if(policies === undefined) { return undefined }
+
+		return policies
+			.filter(policy => policy.name !== undefined && policy.quota !== undefined)
+			.map(policy => {
+				const {
+					name,
+					quota,
+					quotaUnits,
+					windowSeconds,
+					partitionKey
+				} = policy
+
+				const q = quota ? `${POLICY_PARAMETER.QUOTA}=${quota}` : undefined
+				const qu = quotaUnits ? `${POLICY_PARAMETER.QUOTA_UNITS}="${quotaUnits}"` : undefined
+				const ws = windowSeconds ? `${POLICY_PARAMETER.WINDOW_SECONDS}=${windowSeconds}` : undefined
+				const pk = partitionKey ? `${POLICY_PARAMETER.PARTITION_KEY}=${partitionKey}` : undefined
+				return [ `"${name}"`, q, qu, ws, pk ]
+					.filter(item => item !== undefined)
+					.join(';')
+			})
+			.join(',')
+	}
+}

package/src/server-timing.js

@@ -0,0 +1,51 @@
+export const SERVER_TIMING_KEY_DURATION = 'dur' // common in milliseconds
+export const SERVER_TIMING_KEY_DESCRIPTION = 'desc'
+
+export const HTTP_HEADER_SERVER_TIMING = 'Server-Timing'
+export const HTTP_HEADER_TIMING_ALLOW_ORIGIN = 'Timing-Allow-Origin'
+
+export const SERVER_TIMING_SEPARATOR = {
+	METRIC: ',',
+	PARAMETER: ';',
+	KVP: '='
+}
+
+/**
+ * @typedef {Object} TimingsInfo
+ * @property {string} name
+ * @property {number|undefined} duration
+ * @property {string|undefined} [description]
+ */
+
+export class ServerTiming {
+	/**
+	 * @param {Array<TimingsInfo>} timings
+	 */
+	static encode(timings) {
+		if(timings === undefined) { return undefined }
+		if(timings.length <= 0) { return undefined }
+
+		return timings
+			.map(({ name, duration, description }) => [
+					`${name}`,
+					description !== undefined ? `${SERVER_TIMING_KEY_DESCRIPTION}${SERVER_TIMING_SEPARATOR.KVP}"${description}"` : undefined,
+					duration !== undefined ? `${SERVER_TIMING_KEY_DURATION}${SERVER_TIMING_SEPARATOR.KVP}${Math.trunc(duration * 10) / 10}` : undefined
+				]
+				.filter(item => item !== undefined)
+				.join(SERVER_TIMING_SEPARATOR.PARAMETER))
+			.join(SERVER_TIMING_SEPARATOR.METRIC)
+	}
+}
+
+
+// console.log(ServerTiming.encode([{ name: 'missedCache' }]))
+// console.log(ServerTiming.encode([{ name: 'cpu', duration: 2.4 }]))
+
+// // cache;desc="Cache Read";dur=23.2
+// console.log(ServerTiming.encode([{ name: 'cache', duration: 23.2, description: "Cache Read" }]))
+
+// // db;dur=53, app;dur=47.2
+// console.log(ServerTiming.encode([
+// 	{ name: 'db', duration: 54 },
+// 	{ name: 'app', duration: 47.2 }
+// ]))