Remove the ability to change the refresh API path completely, and instead, allow the users to give a prefix to the API

[rishabhpoddar]

The refresh API will always be {some-prefix}/session/refresh. The prefix can be defined by the user. This will make it easier for users to use login + sessions using us.

• We will need to remove the relevant config params, and take a new param called the apiBasePath. The default value of this will be /auth. However the user can override it by providing:
  • a full URL: https://example.com/custom-base/ => /custom-base
  • a path: /custom-base/ => /custom-base
  • empty path: / => "" OR "" => ""
  • The above can be provided with or without a leading and or trailing slash:
    • custom/base => /custom/base
    • custom/base/. => /custom/base
    • /custom/base => /custom/base
    • custom/base/ => /custom/base
    • custom/base/ => /custom/base
    • custom-base => /custom-base
    • If there are a domain, or protocol, or query or # or anything else, remove them.
• On the frontend SDKs, users will also need to provide their API domain, which they can provide via a variable apiDomain. This is a compulsory value. It can be of the form:
  • example.com => https://example.com
  • example.com/ => https://example.com
  • http://example.com => http://example.com
  • https://example.com/ => https://example.com`
  • localhost ⇒ http://localhost
  • IP Address ⇒ http://IP Address
  • If there is a path or query or #, remove them

Therefore, on the frontend, the refresh endpoint will be: ${apiDomain}${apiBasePath}/session/refresh
On the backend, the API will listen for the path ${apiBasePath}/session/refresh

Tasks

• nodejs
  • change
  • testing
• supertokens-website
  • change
  • testing
• Migration guide
  • supertokens-website
  • nodejs
• Documentation change
  • supertokens-website
  • nodejs
• Create an issue on other SDKs about this
  • flask
  • javalin
  • golang
  • laravel
  • fastapi
• Create an issue on other frontend SDKs
  • react-native
  • android
  • ios

[rishabhpoddar]

@NkxxkN I have implemented functions for normalising paths and domains in a very extensive way with many tests (as per the above spec). Please use those functions & tests, otherwise please make sure to test your functions in a very similar manner (if not better).

I prefer if the exact same function is used in all places for this, so if you want to keep yours, I can have a look at the them, and then change the one in the supertokens-website.

• Function normaliseURLDomainOrThrowError:

  • Implementation here
  • Tests here

• Function normaliseURLPathOrThrowError:

  • Implementation here
  • Tests here

[rishabhpoddar]

@NkxxkN please feel free to review the two functions above, and think of other tests I may have missed