fix(normaliseUrlDomain): allow custom url scheme

zaosoula commented 4 months ago

Summary of change

Refactor the code of normaliseUrlDomainOrThrowError to accept schemes other than http://, https://, supertokens:// (A few sentences about this PR)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

[ ] Changelog has been updated
[ ] coreDriverInterfaceSupported.json file has been updated (if needed)
- Along with the associated array in lib/ts/version.ts
[ ] frontendDriverInterfaceSupported.json file has been updated (if needed)
[ ] Changes to the version if needed
- In package.json
- In package-lock.json
- In lib/ts/version.ts
[x] Had run npm run build-pretty
[x] Had installed and ran the pre-commit hook
[ ] If new thirdparty provider is added,
- [ ] update switch statement in recipe/thirdparty/providers/configUtils.ts file, createProvider function.
- [ ] add an icon on the user management dashboard.
[ ] Issue this PR against the latest non released version branch.
- To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
- If no such branch exists, then create one from the latest released branch.
[ ] If have added a new web framework, update the add-ts-no-check.js file to include that
[ ] If added a new recipe / api interface, then make sure that the implementation of it uses NON arrow functions only (like someFunc: function () {..}).
[ ] If added a new recipe, then make sure to expose it inside the recipe folder present in the root of this repo. We also need to expose its types.

Remaining TODOs for this PR

[ ] Setup the testing env to ensure that no breaking change has been introduced

	:rocket: This PR description was created by Ellipsis for commit e6c547703bebc6d7c6e378a78d9a394abe92a3ea.

Summary:

The PR modifies the normaliseURLDomainOrThrowError function to accept URL schemes other than http://, https://, and supertokens://, by adding a default protocol if none is provided, and returning the URL string with the appropriate protocol and host.

Key points:

Modified normaliseURLDomainOrThrowError function in /lib/build/normalisedURLDomain.js and /lib/ts/normalisedURLDomain.ts files.
The function now checks if the input starts with a protocol and adds a default one if not.
If the input starts with localhost or is an IP address, http:// is added. Otherwise, https:// is added.
The function tries to create a new URL object with the input. If successful, it returns the URL string with the appropriate protocol and host. If the URL object creation fails, it throws an error.

Generated with :heart: by ellipsis.dev

netlify[bot] commented 4 months ago

Deploy Preview for astounding-pegasus-21c111 canceled.

Name	Link
Latest commit	f6c37a66f2de4ddb7e2cbf551275ff593ddf2c9f
Latest deploy log	https://app.netlify.com/sites/astounding-pegasus-21c111/deploys/665df5567170e00008b4342e

netlify[bot] commented 4 months ago

Deploy Preview for precious-marshmallow-968a81 canceled.

Name	Link
Latest commit	f6c37a66f2de4ddb7e2cbf551275ff593ddf2c9f
Latest deploy log	https://app.netlify.com/sites/precious-marshmallow-968a81/deploys/665df556ca13910008268a04

zaosoula commented 4 months ago

@rishabhpoddar Here is the pr, unfortunatly I'm unable to launch the test env for now, so if you can give it a try

rishabhpoddar commented 4 months ago

@zaosoula i'll probably try it out later today or sometime this week. In the meantime, you can use your forked version of the sdk instead of the one from npm in your app and see if it works well. Also, you may have to make a similar change to the frontend sdk as well cause that too has the same normalised domain class

rishabhpoddar commented 2 months ago

Hey @ellipsis, give me a code review

ellipsis-dev[bot] commented 2 months ago

OK! Reviewing this PR...

Responding to this comment by @rishabhpoddar. For more information about Ellipsis, check the documentation.

zaosoula commented 1 month ago

@rishabhpoddar I fixed the issues

(@ellipsis-dev)

supertokens / supertokens-node