Extract header methods & regex into a separate util

pimterry · pimterry · commit 517a2f86fbfb · 2023-07-20T12:54:07.000+02:00
This notably tweaks the regex _slightly_ too, escaping the | because it
turns out (recent change?) Chrome rejects it, since the current value
isn't compatible with the 'v' flag it now uses in input pattern
matching.
diff --git a/src/components/common/editable-headers.tsx b/src/components/common/editable-headers.tsx
@@ -3,7 +3,7 @@ import * as React from 'react';
 import { observer } from 'mobx-react';
 
 import { Headers } from '../../types';
-import { HEADER_NAME_PATTERN } from '../../model/http/http-docs';
+import { HEADER_NAME_PATTERN } from '../../util/headers';
 
 import { EditablePairs, Pair, PairsArray } from './editable-pairs';
 
diff --git a/src/components/mock/handler-config.tsx b/src/components/mock/handler-config.tsx
@@ -16,6 +16,7 @@ import {
     stringToBuffer,
     bufferToString
 } from '../../util';
+import { HEADER_NAME_REGEX } from '../../util/headers';
 
 import {
     Handler,
@@ -74,7 +75,7 @@ import {
     SendStepDefinition
 } from '../../model/rules/definitions/rtc-rule-definitions';
 
-import { getStatusMessage, HEADER_NAME_REGEX } from '../../model/http/http-docs';
+import { getStatusMessage } from '../../model/http/http-docs';
 import { MethodName, MethodNames } from '../../model/http/methods';
 import { NATIVE_ETH_TYPES } from '../../model/rules/definitions/ethereum-abi';
 import {
diff --git a/src/components/mock/matcher-config.tsx b/src/components/mock/matcher-config.tsx
@@ -11,6 +11,7 @@ import { css, styled } from '../../styles';
 
 import { tryParseJson } from '../../util';
 import { asError, UnreachableCheck } from '../../util/error';
+import { headersToFlatHeaders } from '../../util/headers';
 
 import {
     Matcher,
@@ -22,6 +23,7 @@ import {
     getRulePartKey,
     isHiddenMatcherKey
 } from "../../model/rules/rules";
+import { summarizeMatcherClass } from '../../model/rules/rule-descriptions';
 import {
     WebSocketMethodMatcher
 } from '../../model/rules/definitions/websocket-rule-definitions';
@@ -49,7 +51,6 @@ import { Select, TextInput } from '../common/inputs';
 import { EditablePairs, PairsArray } from '../common/editable-pairs';
 import { EditableHeaders } from '../common/editable-headers';
 import { ThemedSelfSizedEditor } from '../editor/base-editor';
-import { summarizeMatcherClass } from '../../model/rules/rule-descriptions';
 
 type MatcherConfigProps<M extends Matcher> = {
     matcher?: M;
@@ -778,18 +779,6 @@ class ExactQueryMatcherConfig extends MatcherConfig<matchers.ExactQueryMatcher>
     }
 }
 
-type FlatHeaders = { [key: string]: string };
-
-const headersToFlatHeaders = (headers: Headers): FlatHeaders =>
-    _.mapValues(
-        _.pickBy(headers, (key, value) => key && value),
-        (value) =>
-            _.isArray(value)
-                ? value.join(', ')
-                : value! // We know this is set because of filter above
-    );
-
-
 @observer
 class HeaderMatcherConfig extends MatcherConfig<matchers.HeaderMatcher> {
 
diff --git a/src/components/view/http/http-body-card.tsx b/src/components/view/http/http-body-card.tsx
@@ -9,9 +9,9 @@ import { ExchangeMessage, HtkResponse, HtkRequest } from '../../../types';
 import { styled } from '../../../styles';
 import { WarningIcon } from '../../../icons';
 
-import { lastHeader } from '../../../util';
-import { saveFile } from '../../../util/ui';
 import { ErrorLike } from '../../../util/error';
+import { lastHeader } from '../../../util/headers';
+import { saveFile } from '../../../util/ui';
 
 import { ViewableContentType, getCompatibleTypes, getContentEditorName } from '../../../model/events/content-types';
 import { getReadableSize } from '../../../model/events/bodies';
diff --git a/src/components/view/http/http-breakpoint-body-card.tsx b/src/components/view/http/http-breakpoint-body-card.tsx
@@ -6,11 +6,11 @@ import * as portals from 'react-reverse-portal';
 
 import { Headers } from '../../../types';
 import {
-    lastHeader,
     isProbablyUtf8,
     bufferToString,
     stringToBuffer
 } from '../../../util';
+import { lastHeader } from '../../../util/headers';
 import {
     EditableContentType,
     EditableContentTypes,
diff --git a/src/components/view/http/http-performance-card.tsx b/src/components/view/http/http-performance-card.tsx
@@ -10,7 +10,7 @@ import {
     TimingEvents,
     ExchangeMessage
 } from '../../../types';
-import { asHeaderArray } from '../../../util';
+import { asHeaderArray } from '../../../util/headers';
 import { joinAnd } from '../../../util/text';
 import { Icon, WarningIcon, SuggestionIcon } from '../../../icons';
 
diff --git a/src/model/api/openapi.ts b/src/model/api/openapi.ts
@@ -20,7 +20,8 @@ import {
     HtkResponse,
     Html
 } from "../../types";
-import { firstMatch, empty, lastHeader } from '../../util';
+import { firstMatch, empty } from '../../util';
+import { lastHeader } from '../../util/headers';
 import { formatAjvError } from '../../util/json-schema';
 
 import {
diff --git a/src/model/events/categorization.ts b/src/model/events/categorization.ts
@@ -1,8 +1,8 @@
 import * as _ from 'lodash';
 
 import { ExchangeMessage } from '../../types';
-import { lastHeader } from '../../util';
 import { Theme } from '../../styles';
+import { lastHeader } from '../../util/headers';
 
 import { getBaseContentType } from './content-types';
 
diff --git a/src/model/http/caching.ts b/src/model/http/caching.ts
@@ -8,7 +8,7 @@ import {
 } from 'date-fns';
 
 import { HttpExchange, ExchangeMessage } from '../../types';
-import { lastHeader, asHeaderArray } from '../../util';
+import { lastHeader, asHeaderArray } from '../../util/headers';
 import { joinAnd } from '../../util/text';
 
 // https://tools.ietf.org/html/draft-ietf-httpbis-semantics-04#section-7.2.3
diff --git a/src/model/http/editable-body.ts b/src/model/http/editable-body.ts
@@ -3,7 +3,7 @@ import { computed, observable, action, runInAction, reaction } from 'mobx';
 
 import { BreakpointBody } from '../../types';
 import { logError } from "../../errors";
-import { asHeaderArray } from "../../util";
+import { asHeaderArray } from "../../util/headers";
 import { observablePromise, ObservablePromise } from '../../util/observable';
 
 import { encodeBody } from "../../services/ui-worker-api";
diff --git a/src/model/http/exchange-breakpoint.ts b/src/model/http/exchange-breakpoint.ts
@@ -12,8 +12,9 @@ import {
     BreakpointBody,
     MockttpBreakpointResponseResult,
 } from "../../types";
-import { asHeaderArray, stringToBuffer } from "../../util";
+import { stringToBuffer } from '../../util';
 import { getDeferred, Deferred } from "../../util/promise";
+import { asHeaderArray } from '../../util/headers';
 import { logError } from "../../errors";
 
 import {
diff --git a/src/model/http/exchange.ts b/src/model/http/exchange.ts
@@ -19,12 +19,14 @@ import {
 import {
     fakeBuffer,
     FakeBuffer,
-    asHeaderArray,
-    lastHeader,
     stringToBuffer,
 } from '../../util';
 import { UnreachableCheck } from '../../util/error';
 import { lazyObservablePromise, ObservablePromise, observablePromise } from "../../util/observable";
+import {
+    asHeaderArray,
+    lastHeader
+} from '../../util/headers';
 
 import { logError } from '../../errors';
 
diff --git a/src/model/http/har.ts b/src/model/http/har.ts
@@ -4,7 +4,8 @@ import * as HarFormat from 'har-format';
 import * as HarValidator from 'har-validator';
 import * as querystring from 'querystring';
 
-import { lastHeader, stringToBuffer } from '../../util';
+import { stringToBuffer } from '../../util';
+import { lastHeader } from '../../util/headers';
 import { ObservablePromise } from '../../util/observable';
 import {
     Headers,
diff --git a/src/model/http/http-docs.ts b/src/model/http/http-docs.ts
@@ -997,10 +997,6 @@ const METHODS: { [key: string]: MdnDocsData | undefined } = {
     }
 };
 
-// Based RFC7230, 3.2.6:
-export const HEADER_NAME_PATTERN = '^[!#$%&\'*+\\-.^_`|~A-Za-z0-9]+$';
-export const HEADER_NAME_REGEX = new RegExp(HEADER_NAME_PATTERN);
-
 type DocsInfo = {
     url: string,
     name: string;
diff --git a/src/util/headers.ts b/src/util/headers.ts
@@ -0,0 +1,46 @@
+import * as _ from 'lodash';
+import { Headers } from '../types';
+
+// Based RFC7230, 3.2.6:
+export const HEADER_NAME_PATTERN = '^[!#$%&\'*+\\-.^_`\\|~A-Za-z0-9]+$';
+    // The \\| is required here because in 'v' flag regexes (used in HTML patterns by default) the |
+    // character seems to be disallowed unescaped in classes like this.
+export const HEADER_NAME_REGEX = new RegExp(HEADER_NAME_PATTERN);
+
+// This fairly meaningless override combo seems to be
+// required to make it ok to use this when T = X | undefined.
+export function lastHeader<T>(val: T | T[]): T;
+export function lastHeader<T>(val: T | T[] | undefined): T | undefined;
+export function lastHeader<T>(val: T | T[] | undefined): T | undefined {
+    if (Array.isArray(val)) return val[val.length - 1];
+    else return val;
+}
+
+export function asHeaderArray(val: string | string[] | undefined, sep = ','): string[] {
+    if (Array.isArray(val)) {
+        // Split individual values, as multiple headers can still have multiple values
+        return _.flatMap(val, header =>
+            header.split(sep).map(value => value.trim())
+        );
+    } else if (!val) {
+        return [];
+    } else {
+        return val.split(sep).map(value => value.trim());
+    }
+}
+
+type FlatHeaders = { [key: string]: string };
+
+/**
+ * Flatten headers, i.e. combine any duplicates into comma-separated values. Required for some APIs
+ * that don't accept duplicate headers.
+ */
+export function headersToFlatHeaders(headers: Headers): FlatHeaders {
+    return _.mapValues(
+        _.pickBy(headers, (key, value) => key && value),
+        (value) =>
+            _.isArray(value)
+                ? value.join(', ')
+                : value! // We know this is set because of filter above
+    );
+}
diff --git a/src/util/index.ts b/src/util/index.ts
@@ -22,28 +22,6 @@ export function firstMatch<R>(...tests: Array<Case<R> | R | undefined>): R | und
     }
 }
 
-// This fairly meaningless override combo seems to be
-// required to make it ok to use this when T = X | undefined.
-export function lastHeader<T>(val: T | T[]): T;
-export function lastHeader<T>(val: T | T[] | undefined): T | undefined;
-export function lastHeader<T>(val: T | T[] | undefined): T | undefined {
-    if (_.isArray(val)) return val[val.length - 1];
-    else return val;
-}
-
-export function asHeaderArray(val: string | string[] | undefined, sep = ','): string[] {
-    if (_.isArray(val)) {
-        // Split individual values, as multiple headers can still have multiple values
-        return _.flatMap(val, header =>
-            header.split(sep).map(value => value.trim())
-        );
-    } else if (!val) {
-        return [];
-    } else {
-        return val.split(sep).map(value => value.trim());
-    }
-}
-
 export function longestPrefix(baseString: string, ...strings: string[]) {
     let prefix = "";
     const shortestLength = Math.min(
