-
Notifications
You must be signed in to change notification settings - Fork 8
refactor(deps): replace url-parse with native URL API #122
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
Open
Kyzgor
wants to merge
2
commits into
permitio:main
Choose a base branch
from
Kyzgor:fix/106-remove-url-parse-dependency
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import test from 'ava'; | ||
| import axios from 'axios'; | ||
|
|
||
| import { buildOpaBaseUrl } from '../enforcement/enforcer'; | ||
| import { Permit } from '../index'; | ||
|
|
||
| // The OPA client base URL is derived from the configured PDP URL by forcing the | ||
| // OPA port (8181) and appending the OPA data path. This was previously built | ||
| // with the `url-parse` package and is now built with the native WHATWG `URL` | ||
| // (#106). These assertions lock the produced string so the refactor is proven | ||
| // behaviour-equivalent and any regression in the construction logic fails here. | ||
|
|
||
| test('buildOpaBaseUrl: default PDP', (t) => { | ||
| t.is(buildOpaBaseUrl('http://localhost:7766'), 'http://localhost:8181/v1/data/permit/'); | ||
| }); | ||
|
|
||
| test('buildOpaBaseUrl: trailing slash yields the same URL as no trailing slash', (t) => { | ||
| t.is(buildOpaBaseUrl('http://localhost:7766/'), 'http://localhost:8181/v1/data/permit/'); | ||
| }); | ||
|
|
||
| test('buildOpaBaseUrl: https host without an explicit port', (t) => { | ||
| t.is(buildOpaBaseUrl('https://pdp.example.com'), 'https://pdp.example.com:8181/v1/data/permit/'); | ||
| }); | ||
|
|
||
| test('buildOpaBaseUrl: an existing port is overridden with 8181', (t) => { | ||
| t.is( | ||
| buildOpaBaseUrl('https://pdp.example.com:1234'), | ||
| 'https://pdp.example.com:8181/v1/data/permit/', | ||
| ); | ||
| }); | ||
|
|
||
| test('buildOpaBaseUrl: a path-prefixed PDP preserves the pre-existing concatenation behaviour', (t) => { | ||
| // Pre-existing url-parse quirk: a path with no trailing slash glues onto the data path. | ||
| t.is( | ||
| buildOpaBaseUrl('http://localhost:7766/prefix'), | ||
| 'http://localhost:8181/prefixv1/data/permit/', | ||
| ); | ||
| t.is( | ||
| buildOpaBaseUrl('http://localhost:7766/prefix/'), | ||
| 'http://localhost:8181/prefix/v1/data/permit/', | ||
| ); | ||
| }); | ||
|
|
||
| test('buildOpaBaseUrl: a PDP without a scheme throws (invalid absolute URL)', (t) => { | ||
| // Scheme-less input (bare host or `//host:port`) throws at construction; `localhost:7766` is misparsed, not rejected. | ||
| t.throws(() => buildOpaBaseUrl('localhost'), { instanceOf: TypeError }); | ||
| t.throws(() => buildOpaBaseUrl('//localhost:7766'), { instanceOf: TypeError }); | ||
| }); | ||
|
|
||
| test('Enforcer wires the OPA client base URL to buildOpaBaseUrl(pdp)', (t) => { | ||
| // Guards the integration the refactor actually edits: the constructed OPA axios | ||
| // client must take its baseURL from the helper. Passing an opaAxiosInstance lets | ||
| // us read what the Enforcer set, without a live PDP or network call. | ||
| const opaAxiosInstance = axios.create(); | ||
| new Permit({ token: 'test-token', pdp: 'http://localhost:7766', opaAxiosInstance }); | ||
| t.is(opaAxiosInstance.defaults.baseURL, buildOpaBaseUrl('http://localhost:7766')); | ||
| }); |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[LOW] Scheme-less PDP input now throws instead of returning a (bad) string
new URL('localhost:7766')throwsTypeError [ERR_INVALID_URL], whereasurl-parsereturned a malformed string without throwing. Scheme-less PDP is unsupported either way, but the failure mode changed from silent-bad-string to a throw in the Enforcer constructor.Suggestion: Add a
@throwsnote tobuildOpaBaseUrl(optionally at.throwstest) so callers know a scheme-lesspdpthrows.