File Explorer

1'use strict'2 3const { InvalidArgumentError } = require('../core/errors')4const { runtimeFeatures } = require('../util/runtime-features.js')5 6/**7 * @typedef {Object} HeaderFilters8 * @property {Set<string>} ignore - Set of headers to ignore for matching9 * @property {Set<string>} exclude - Set of headers to exclude from matching10 * @property {Set<string>} match - Set of headers to match (empty means match11 */12 13/**14 * Creates cached header sets for performance15 *16 * @param {import('./snapshot-recorder').SnapshotRecorderMatchOptions} matchOptions - Matching options for headers17 * @returns {HeaderFilters} - Cached sets for ignore, exclude, and match headers18 */19function createHeaderFilters (matchOptions = {}) {20  const { ignoreHeaders = [], excludeHeaders = [], matchHeaders = [], caseSensitive = false } = matchOptions21 22  return {23    ignore: new Set(ignoreHeaders.map(header => caseSensitive ? header : header.toLowerCase())),24    exclude: new Set(excludeHeaders.map(header => caseSensitive ? header : header.toLowerCase())),25    match: new Set(matchHeaders.map(header => caseSensitive ? header : header.toLowerCase()))26  }27}28 29const crypto = runtimeFeatures.has('crypto')30  ? require('node:crypto')31  : null32 33/**34 * @callback HashIdFunction35 * @param {string} value - The value to hash36 * @returns {string} - The base64url encoded hash of the value37 */38 39/**40 * Generates a hash for a given value41 * @type {HashIdFunction}42 */43const hashId = crypto?.hash44  ? (value) => crypto.hash('sha256', value, 'base64url')45  : (value) => Buffer.from(value).toString('base64url')46 47/**48 * @typedef {(url: string) => boolean} IsUrlExcluded Checks if a URL matches any of the exclude patterns49 */50 51/** @typedef {{[key: Lowercase<string>]: string}} NormalizedHeaders */52/** @typedef {Array<string>} UndiciHeaders */53/** @typedef {Record<string, string|string[]>} Headers */54 55/**56 * @param {*} headers57 * @returns {headers is UndiciHeaders}58 */59function isUndiciHeaders (headers) {60  return Array.isArray(headers) && (headers.length & 1) === 061}62 63/**64 * Factory function to create a URL exclusion checker65 * @param {Array<string| RegExp>} [excludePatterns=[]] - Array of patterns to exclude66 * @returns {IsUrlExcluded} - A function that checks if a URL matches any of the exclude patterns67 */68function isUrlExcludedFactory (excludePatterns = []) {69  if (excludePatterns.length === 0) {70    return () => false71  }72 73  return function isUrlExcluded (url) {74    let urlLowerCased75 76    for (const pattern of excludePatterns) {77      if (typeof pattern === 'string') {78        if (!urlLowerCased) {79          // Convert URL to lowercase only once80          urlLowerCased = url.toLowerCase()81        }82        // Simple string match (case-insensitive)83        if (urlLowerCased.includes(pattern.toLowerCase())) {84          return true85        }86      } else if (pattern instanceof RegExp) {87        // Regex pattern match88        if (pattern.test(url)) {89          return true90        }91      }92    }93 94    return false95  }96}97 98/**99 * Normalizes headers for consistent comparison100 *101 * @param {Object|UndiciHeaders} headers - Headers to normalize102 * @returns {NormalizedHeaders} - Normalized headers as a lowercase object103 */104function normalizeHeaders (headers) {105  /** @type {NormalizedHeaders} */106  const normalizedHeaders = {}107 108  if (!headers) return normalizedHeaders109 110  // Handle array format (undici internal format: [name, value, name, value, ...])111  if (isUndiciHeaders(headers)) {112    for (let i = 0; i < headers.length; i += 2) {113      const key = headers[i]114      const value = headers[i + 1]115      if (key && value !== undefined) {116        // Convert Buffers to strings if needed117        const keyStr = Buffer.isBuffer(key) ? key.toString() : key118        const valueStr = Buffer.isBuffer(value) ? value.toString() : value119        normalizedHeaders[keyStr.toLowerCase()] = valueStr120      }121    }122    return normalizedHeaders123  }124 125  // Handle object format126  if (headers && typeof headers === 'object') {127    for (const [key, value] of Object.entries(headers)) {128      if (key && typeof key === 'string') {129        normalizedHeaders[key.toLowerCase()] = Array.isArray(value) ? value.join(', ') : String(value)130      }131    }132  }133 134  return normalizedHeaders135}136 137const validSnapshotModes = /** @type {const} */ (['record', 'playback', 'update'])138 139/** @typedef {typeof validSnapshotModes[number]} SnapshotMode */140 141/**142 * @param {*} mode - The snapshot mode to validate143 * @returns {asserts mode is SnapshotMode}144 */145function validateSnapshotMode (mode) {146  if (!validSnapshotModes.includes(mode)) {147    throw new InvalidArgumentError(`Invalid snapshot mode: ${mode}. Must be one of: ${validSnapshotModes.join(', ')}`)148  }149}150 151module.exports = {152  createHeaderFilters,153  hashId,154  isUndiciHeaders,155  normalizeHeaders,156  isUrlExcludedFactory,157  validateSnapshotMode158}159