src: implement whatwg's URLPattern spec

[anonrig]

Co-authored-by: Daniel Lemire (@lemire)

Blocked

This is blocked from landing due to the old macOS machines we use in our infrastructure (cc @nodejs/build)

19:50:46 ../deps/ada/ada.h:8457:10: fatal error: 'ranges' file not found
19:50:46 #include <ranges>
19:50:46          ^~~~~~~~
19:50:46   /usr/local/bin/ccache cc -o /Users/iojs/build/workspace/node-test-commit-osx/nodes/osx11-

Notes:

• Ada now requires C++20
• URLPattern is now a global class.
• URLPattern is also exposed in node:url module
• Ada now enables exceptions just like V8. This is done because std::regex, the default regex library of C++ does not have any non-exception API surface like std::filesystem. The alternative to not enabling exceptions is to bundle Ada with a regex library or implementing it's own regex parser, which is too much work for URLPattern at this stage. Further Ada releases can support such changes to disable exceptions.

TODOs

• Pass all web-platform tests
• Release Ada v3 before landing this PR
• Make sure to split all changes to multiple commits
• Add @lemire as co-author to all commits
• Land upstream pull-request implement URLPattern ada-url/ada#785
• Add documentation for global and node:url module declarations.

cc @nodejs/cpp-reviewers

Fixes #40844

[nodejs-github-bot]

Review requested:

• @nodejs/gyp
• @nodejs/security-wg
• @nodejs/startup
• @nodejs/url
• @nodejs/web-standards

[targos]

Ada now enables exceptions just like UV and V8

Can you elaborate? libuv is a C library so I don't think exceptions exist there, and I'm pretty sure V8 is built with exceptions disabled.

[anonrig]

Ada now enables exceptions just like UV and V8

Can you elaborate? libuv is a C library so I don't think exceptions exist there, and I'm pretty sure V8 is built with exceptions disabled.

My bad UV does not enable exceptions. Referencing v8.gyp file:

{
  'target_name': 'torque_base',
  'type': 'static_library',
  'toolsets': ['host', 'target'],
  'sources': [
    '<!@pymod_do_main(GN-scraper "<(V8_ROOT)/BUILD.gn"  "\\"torque_base.*?sources = ")',
  ],
  'dependencies': [
    'v8_shared_internal_headers',
    'v8_libbase',
  ],
  'defines!': [
    '_HAS_EXCEPTIONS=0',
    'BUILDING_V8_SHARED=1',
  ],
  'cflags_cc!': ['-fno-exceptions'],
  'cflags_cc': ['-fexceptions'],
  'xcode_settings': {
    'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',  # -fexceptions
  },
  'msvs_settings': {
    'VCCLCompilerTool': {
      'RuntimeTypeInfo': 'true',
      'ExceptionHandling': 1,
    },
  },
}

[targos]

This is not really V8. It's a build-time executable (torque) used to generate code for V8

[jasnell]

I think the key challenge here is that this will copy the string on every call. Any chance of memoizing the string once created.

[jasnell]

We likely should introduce this as experimental in the first release, even if it graduates from experimental quickly. There should likely be a warning emitted on the first construction.

[anonrig]

AFAIK: There is no easy way to emit an experimental warning in C++ that can be dismissed using the CLI command. For now, I have made it experimental on the nodejs doc.

[jasnell]

Can you also include a fairly simple benchmark?

[codecov]

Codecov Report

Attention: Patch coverage is 82.87796% with 94 lines in your changes missing coverage. Please review.

Project coverage is 88.70%. Comparing base (7b472fd) to head (676ee51).
Report is 139 commits behind head on main.

Files with missing lines	Patch %	Lines
src/node_url_pattern.cc	82.89%	41 Missing and 51 partials ⚠️
src/node_url_pattern.h	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #56452      +/-   ##
==========================================
- Coverage   89.16%   88.70%   -0.46%     
==========================================
  Files         661      665       +4     
  Lines      191421   192522    +1101     
  Branches    36845    36718     -127     
==========================================
+ Hits       170673   170780     +107     
- Misses      13615    14517     +902     
- Partials     7133     7225      +92     

Files with missing lines	Coverage Δ
...internal/bootstrap/web/exposed-window-or-worker.js	93.89% <100.00%> (+0.19%)	⬆️
lib/internal/url.js	95.79% <100.00%> (-1.89%)	⬇️
lib/url.js	98.94% <100.00%> (-1.06%)	⬇️
src/node_binding.cc	83.66% <ø> (ø)
src/node_errors.h	85.00% <ø> (ø)
src/node_external_reference.h	100.00% <ø> (ø)
src/node_url_pattern.h	0.00% <0.00%> (ø)
src/node_url_pattern.cc	82.89% <82.89%> (ø)

... and 166 files with indirect coverage changes

[mcollina]

I don’t think this is a good pattern to land in Node.js. Specifically, a server using this will create one per route and iterate in a loop. This will be slow, specifically if you need to match the last of the list.

(This feedback was provided when URLPattern was standardized and essentially ignored).

For this to be useful, we would need to have a Node.js-specific API to organize these URLPattern in a radix prefix trie and actually do the matching all at once.

I can possibly be persuaded that we need this for Web platform compatibility, but it’s not that popular either (unlike fetch()).

[mcollina]

@jasnell I’ll try to build this and get a benchmark going against the ecosystem routers.

[anonrig]

@jasnell I’ll try to build this and get a benchmark going against the ecosystem routers.

Right now, this pull-request does not pass WPT, and not at all optimized. Any benchmarks will not be beneficial.

[mcollina]

What's the status with WPTs?
Did you perform any optimizations?

[anonrig]

What's the status with WPTs?

There is currently 19 failing tests, and 8 of them are invalid, and needs to be fixed in WPT. I have an open PR: web-platform-tests/wpt#49782

Did you perform any optimizations?

Not at the moment. My goal is to pass almost all WPT and land this pull-request before optimizing it. Passing all WPT will give us the confidence to optimize more aggressively.

[anonrig]

cc @nodejs/cpp-reviewers @nodejs/url can you review? we now pass all valid WPT.

[jasnell]

Only remaining nit... this should be marked as Experimental here also... just like in url.js