Skip to content

perf: faster encode_url and decode_url #441

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

perf: faster encode_url and decode_url #441

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dbd2df
perf: faster `encode_url` and `decode_url`
D-Sketon Oct 3, 2025
3721771
feat: rm regexp
D-Sketon Oct 13, 2025
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
11 changes: 9 additions & 2 deletions lib/decode_url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
import { parse, format } from 'url';
import { format } from 'url';
import { unescape } from 'querystring';

const PROTOCOL_RE = /^[a-z0-9.+-]+:/i;

const hasProtocolLikeNode = (str: unknown): boolean => {
if (typeof str !== 'string') throw new TypeError('url must be a string');
return PROTOCOL_RE.test(str.trim());
};

const decodeURL = (str: string) => {
if (parse(str).protocol) {
if (hasProtocolLikeNode(str)) {
Copy link
Member

@SukkaW SukkaW Oct 10, 2025

Choose a reason for hiding this comment

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

If we are going to implement some loose check, why not just if (str.includes('://')?

Copy link
Member Author

@D-Sketon D-Sketon Oct 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

No, using str.includes('://') fails the unit tests.
{92E0351B-DE8D-4E55-87E9-7367053CFC09}

Copy link
Member

@SukkaW SukkaW Oct 11, 2025

Choose a reason for hiding this comment

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

I am still not a fan of copying some regexp. How would we know if it is spec-compliant or not?

Copy link
Member Author

@D-Sketon D-Sketon Oct 11, 2025

Choose a reason for hiding this comment

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

This regexp is from nodejs https://github.com/nodejs/node/blob/a1244f04dea9148c44fd6daf60b5105f7a85ea12/lib/url.js#L96, and it is stricter than the one in RFC 3986 (https://www.rfc-editor.org/rfc/rfc3986#appendix-B). The regex in RFC 3986 is /^(([^:/?#]+):)/.

Copy link
Member

@SukkaW SukkaW Oct 13, 2025

Choose a reason for hiding this comment

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

But whathappened if Node.js changes their implementation (maybe a ReDoS attack is discovered, maybe a CSRF PoC is created, and there is a new CVE created), how can we make sure our copied regexp is up to date?

Copy link
Member Author

@D-Sketon D-Sketon Oct 13, 2025

Choose a reason for hiding this comment

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

Since there is such a concern, let's consider a less radical optimization method.

const parsed = new URL(str);

// Exit if input is a data url
Expand Down
11 changes: 9 additions & 2 deletions lib/encode_url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
import { parse, format } from 'url';
import { format } from 'url';
import { unescape } from 'querystring';

const PROTOCOL_RE = /^[a-z0-9.+-]+:/i;

const hasProtocolLikeNode = (str: unknown): boolean => {
if (typeof str !== 'string') throw new TypeError('url must be a string');
return PROTOCOL_RE.test(str.trim());
};

const encodeURL = (str: string) => {
if (parse(str).protocol) {
if (hasProtocolLikeNode(str)) {
const parsed = new URL(str);

// Exit if input is a data url
Expand Down
Loading