Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(http): remove allocations checking upgrade and connection header values #17727

Merged
merged 6 commits into from
Feb 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions cli/tests/unit/http_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ import {
} from "./test_util.ts";
import { join } from "../../../test_util/std/path/mod.ts";

const {
buildCaseInsensitiveCommaValueFinder,
// @ts-expect-error TypeScript (as of 3.7) does not support indexing namespaces by symbol
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be done via a mapped type:https://discord.com/channels/684898665143206084/688040863313428503/1055570626787672165

Not relevant for this PR though.

} = Deno[Deno.internal];

async function writeRequestAndReadResponse(conn: Deno.Conn): Promise<string> {
const encoder = new TextEncoder();
const decoder = new TextDecoder();
Expand Down Expand Up @@ -2612,6 +2617,30 @@ Deno.test({
},
});

Deno.test("case insensitive comma value finder", async (t) => {
const cases = /** @type {[string, boolean][]} */ ([
["websocket", true],
["wEbSOcKET", true],
[",wEbSOcKET", true],
[",wEbSOcKET,", true],
[", wEbSOcKET ,", true],
["test, wEbSOcKET ,", true],
["test ,\twEbSOcKET\t\t ,", true],
["test , wEbSOcKET", true],
["test, asdf,web,wEbSOcKET", true],
["test, asdf,web,wEbSOcKETs", false],
["test, asdf,awebsocket,wEbSOcKETs", false],
]);

const findValue = buildCaseInsensitiveCommaValueFinder("websocket");
for (const [input, expected] of cases) {
await t.step(input.toString(), () => {
const actual = findValue(input);
assertEquals(actual, expected);
});
}
});

async function httpServerWithErrorBody(
listener: Deno.Listener,
compression: boolean,
Expand Down
92 changes: 80 additions & 12 deletions ext/http/01_http.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
const core = globalThis.Deno.core;
const internals = globalThis.__bootstrap.internals;
const primordials = globalThis.__bootstrap.primordials;
const { BadResourcePrototype, InterruptedPrototype, ops } = core;
import * as webidl from "internal:deno_webidl/00_webidl.js";
Expand Down Expand Up @@ -40,18 +41,18 @@ import {
} from "internal:deno_web/06_streams.js";
const {
ArrayPrototypeIncludes,
ArrayPrototypeMap,
ArrayPrototypePush,
ArrayPrototypeSome,
Error,
ObjectPrototypeIsPrototypeOf,
SafeSetIterator,
Set,
SetPrototypeAdd,
SetPrototypeDelete,
StringPrototypeCharCodeAt,
StringPrototypeIncludes,
StringPrototypeToLowerCase,
StringPrototypeSplit,
StringPrototypeTrim,
Symbol,
SymbolAsyncIterator,
TypeError,
Expand Down Expand Up @@ -389,15 +390,13 @@ function createRespondWith(
}

const _ws = Symbol("[[associated_ws]]");
const websocketCvf = buildCaseInsensitiveCommaValueFinder("websocket");
const upgradeCvf = buildCaseInsensitiveCommaValueFinder("upgrade");

function upgradeWebSocket(request, options = {}) {
const upgrade = request.headers.get("upgrade");
const upgradeHasWebSocketOption = upgrade !== null &&
ArrayPrototypeSome(
StringPrototypeSplit(upgrade, ","),
(option) =>
StringPrototypeToLowerCase(StringPrototypeTrim(option)) === "websocket",
);
websocketCvf(upgrade);
if (!upgradeHasWebSocketOption) {
throw new TypeError(
"Invalid Header: 'upgrade' header must contain 'websocket'",
Expand All @@ -406,11 +405,7 @@ function upgradeWebSocket(request, options = {}) {

const connection = request.headers.get("connection");
const connectionHasUpgradeOption = connection !== null &&
ArrayPrototypeSome(
StringPrototypeSplit(connection, ","),
(option) =>
StringPrototypeToLowerCase(StringPrototypeTrim(option)) === "upgrade",
);
upgradeCvf(connection);
if (!connectionHasUpgradeOption) {
throw new TypeError(
"Invalid Header: 'connection' header must contain 'Upgrade'",
Expand Down Expand Up @@ -471,4 +466,77 @@ function upgradeHttp(req) {
return req[_deferred].promise;
}

const spaceCharCode = StringPrototypeCharCodeAt(" ", 0);
Copy link
Member Author

@dsherret dsherret Feb 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like it's reasonable to only check for plain old spaces instead of all whitespace? I couldn't find anywhere that explained exactly how this is supposed to work though. See past git history when it was checking all kinds of whitespace (and still faster).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://greenbytes.de/tech/webdav/rfc7230.html#whitespace

At least that particular spec website defines that horizontal tab is also allowed as whitespace.

const tabCharCode = StringPrototypeCharCodeAt("\t", 0);
const commaCharCode = StringPrototypeCharCodeAt(",", 0);

/** Builds a case function that can be used to find a case insensitive
* value in some text that's separated by commas.
*
* This is done because it doesn't require any allocations.
* @param checkText {string} - The text to find. (ex. "websocket")
*/
function buildCaseInsensitiveCommaValueFinder(checkText) {
const charCodes = ArrayPrototypeMap(
StringPrototypeSplit(
StringPrototypeToLowerCase(checkText),
"",
),
(c) => [c.charCodeAt(0), c.toUpperCase().charCodeAt(0)],
);
/** @type {number} */
let i;
/** @type {number} */
let char;

/** @param value {string} */
return function (value) {
for (i = 0; i < value.length; i++) {
char = value.charCodeAt(i);
skipWhitespace(value);

if (hasWord(value)) {
skipWhitespace(value);
if (i === value.length || char === commaCharCode) {
return true;
}
} else {
skipUntilComma(value);
}
}

return false;
};

/** @param value {string} */
function hasWord(value) {
for (const [cLower, cUpper] of charCodes) {
if (cLower === char || cUpper === char) {
char = StringPrototypeCharCodeAt(value, ++i);
} else {
return false;
}
}
return true;
}

/** @param value {string} */
function skipWhitespace(value) {
while (char === spaceCharCode || char === tabCharCode) {
char = StringPrototypeCharCodeAt(value, ++i);
}
}

/** @param value {string} */
function skipUntilComma(value) {
while (char !== commaCharCode && i < value.length) {
char = StringPrototypeCharCodeAt(value, ++i);
}
}
}

// Expose this function for unit tests
internals.buildCaseInsensitiveCommaValueFinder =
buildCaseInsensitiveCommaValueFinder;

export { _ws, HttpConn, upgradeHttp, upgradeWebSocket };