ref(core): Improve URL parsing utilities #15882
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AbhiPrasad
requested review from
mydea and
andreiborza
and removed request for
a team
size-limit report 📦
|
AbhiPrasad
force-pushed
the
abhi-ref-parse-string-to-url
branch
from
2718fd1 to
a2d3ae6
Compare
lforst
approved these changes
Mar 31, 2025
|
|
||
| type URLObject = RelativeURL | URL; | ||
|
|
||
| // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html |
andreiborza
approved these changes
Mar 31, 2025
13 tasks
onurtemizkan
pushed a commit
that referenced
this pull request
Apr 3, 2025
The bottleneck of many of the tasks written down in our Node SDK performance improvement task #15861 is `parseUrl`, defined here: https://github.com/getsentry/sentry-javascript/blob/3d63621714b31c1ea4c2ab2d90d5684a36805a43/packages/core/src/utils-hoist/url.ts#L17 We created #15767 to track removal of `parseUrl`. See more details in the GH issue. While working on tasks for #15767, I initially PR'd #15768, which introduced a `parseStringToURL` method as a replacement for `parseUrl`. While trying to implement that method though I realized `parseStringToURL` has a lot of downsides. This PR removes `parseStringToURL` in favor of a new `parseStringToURLObject`. Given `parseStringToURL` was never exported by the core SDK, this is not a breaking change. To understand `parseStringToURLObject`, let's first look at it's method signature: ```ts function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined ``` `parseStringToURLObject` takes a string URL and turns it into a `URLObject`, that is typed like so: ```ts type RelativeURL = { isRelative: true; pathname: URL['pathname']; search: URL['search']; hash: URL['hash']; }; type URLObject = RelativeURL | URL; ``` the JavaScript URL built-in does not handle relative URLs, so we need to use a separate object to to track relative URLs. Luckily it's pretty small surface area, we only need to worry about `pathname`, `search`, and `hash`. For ease of usage of this function, I also introduced a `isURLObjectRelative` helper. This will make sure that users can handle both relative and absolute URLs with ease. Given `packages/core/src/fetch.ts` was using `parseStringToURL`, I refactored that file to use `parseStringToURLObject`. The change feels way better to me, much easier to read and understand what is going on.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The bottleneck of many of the tasks written down in our Node SDK performance improvement task #15861 is
parseUrl, defined here:sentry-javascript/packages/core/src/utils-hoist/url.ts
Line 17 in 3d63621
We created #15767 to track removal of
parseUrl. See more details in the GH issue.While working on tasks for #15767, I initially PR'd #15768, which introduced a
parseStringToURLmethod as a replacement forparseUrl. While trying to implement that method though I realizedparseStringToURLhas a lot of downsides.This PR removes
parseStringToURLin favor of a newparseStringToURLObject. GivenparseStringToURLwas never exported by the core SDK, this is not a breaking change.To understand
parseStringToURLObject, let's first look at it's method signature:parseStringToURLObjecttakes a string URL and turns it into aURLObject, that is typed like so:the JavaScript URL built-in does not handle relative URLs, so we need to use a separate object to to track relative URLs. Luckily it's pretty small surface area, we only need to worry about
pathname,search, andhash.For ease of usage of this function, I also introduced a
isURLObjectRelativehelper. This will make sure that users can handle both relative and absolute URLs with ease.Given
packages/core/src/fetch.tswas usingparseStringToURL, I refactored that file to useparseStringToURLObject. The change feels way better to me, much easier to read and understand what is going on.