fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix(backend): Preserve url protocol when joining paths - #2745

Merged
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths
Feb 7, 2024
Merged

fix(backend): Preserve url protocol when joining paths#2745
panteliselef merged 1 commit into
mainfrom
elef/SDK-1274-fix-join-paths

Conversation

@panteliselef

@panteliselefpanteliselef commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Description

Internally when joinPaths was used to join strings that included a url protocol like https:// the utility function would remove the duplicate / from the protocol resulting in a string with this form 'https:/api.lclclerk.com/v1/organizations/org_2YRy2Bcrc05EMTY0nMY3qHTjbwj'

When this string was passed in a URL constructor like new URL(...) the URL would either be fixed automatically or throw an "Invalid URL" error.

I believe it came down to node version and different implementations of the URL class under the hood. In any case this PR ensures that absolute url string that is generated from joinPaths will keep the protocol intact.

Fixes#2706

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Feb 7, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f0e076d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
NameType
@clerk/backendPatch
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/nextjsPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Solves #2706

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Even though we should apply the change in this PR since it fixes the URL, It seems that we haven't done any change in this part of the code for a lot of time and the current code works for node@v16, node@v18, node@v20.

❯ nvm exec 16 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v16.19.0 (npm v9.2.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 18 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v18.18.2 (npm v9.8.1)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}
❯ nvm exec 20 node -e 'console.log(new URL("https:/api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/"))'
Running node v20.9.0 (npm v10.1.0)
URL {
href: 'https://api.clerk.com/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
origin: 'https://api.clerk.com/',
protocol: 'https:',
username: '',
password: '',
host: 'api.clerk.com',
hostname: 'api.clerk.com',
port: '',
pathname: '/v1/organizations/org_xxxxxxxxxxxxxxxxx/',
search: '',
searchParams: URLSearchParams {},
hash: ''
}

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

Yes, this maybe have to do with edge vs node runtime. I'm still investigating. The fix is valid but I will merge after I've successfully reproduced.

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

!snapshot

1 similar comment
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@octoper
octoperforce-pushed the elef/SDK-1274-fix-join-paths branch from f98c9ae to f0e076dCompareFebruary 7, 2024 16:06
@octoper

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @octoper - the snapshot version command generated the following package versions:

PackageVersion
@clerk/backend1.0.1-snapshot.vf0e076d
@clerk/chrome-extension1.0.1-snapshot.vf0e076d
@clerk/clerk-js5.0.1-snapshot.vf0e076d
@clerk/clerk-expo1.0.1-snapshot.vf0e076d
@clerk/fastify1.0.1-snapshot.vf0e076d
gatsby-plugin-clerk5.0.1-snapshot.vf0e076d
@clerk/localizations2.0.1-snapshot.vf0e076d
@clerk/nextjs5.0.1-snapshot.vf0e076d
@clerk/clerk-react5.0.1-snapshot.vf0e076d
@clerk/remix4.0.1-snapshot.vf0e076d
@clerk/clerk-sdk-node5.0.1-snapshot.vf0e076d
@clerk/shared2.0.1-snapshot.vf0e076d
@clerk/themes2.0.1-snapshot.vf0e076d
@clerk/types4.0.1-snapshot.vf0e076d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/backend

npm i @clerk/backend@1.0.1-snapshot.vf0e076d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.1-snapshot.vf0e076d --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.1-snapshot.vf0e076d --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.1-snapshot.vf0e076d --save-exact

@clerk/localizations

npm i @clerk/localizations@2.0.1-snapshot.vf0e076d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.1-snapshot.vf0e076d --save-exact

@clerk/remix

npm i @clerk/remix@4.0.1-snapshot.vf0e076d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.1-snapshot.vf0e076d --save-exact

@clerk/shared

npm i @clerk/shared@2.0.1-snapshot.vf0e076d --save-exact

@clerk/themes

npm i @clerk/themes@2.0.1-snapshot.vf0e076d --save-exact

@clerk/types

npm i @clerk/types@4.0.1-snapshot.vf0e076d --save-exact

@panteliselef

Copy link
Copy Markdown
ContributorAuthor

We manage to replicate this in CF workers. It seems like the implementation of the URL constructor does not auto fixe the url as node or browser runtimes do. Thanks @octoper for replicating.

@panteliselef
panteliselef added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit c2b9827Feb 7, 2024
@panteliselef
panteliselef deleted the elef/SDK-1274-fix-join-paths branch February 7, 2024 17:05
panteliselef added a commit that referenced this pull request Feb 7, 2024
github-merge-queueBot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit c2b9827)
Co-authored-by: panteliselef <panteliselef@outlook.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@clerk/backend throws: Invalid URL string

5 participants

@panteliselef@octoper@clerk-cookie@dimkl@LekoArts