fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@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(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl - #3361

Merged
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
nikosdouvlis merged 2 commits into
mainfrom
nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton

Conversation

@nikosdouvlis

@nikosdouvlisnikosdouvlis commented May 10, 2024

Copy link
Copy Markdown
Member

Description

This PR updates the buildSignInUrl and buildSignUpUrl methods to correctly propagate the redirect props via URL search params. This allows the SignInButton and SignUpButton components to be configurable via their props as well.

Additionally, this PR:

  • simplifies the RedirectUrl class by dropping the concern of appending params to the URL. This is now handled by the low-level buildUrl util
  • it fixes an issues when serializing initial values in the buildSignInUrl and buildSignUpUrl helpers. Search params need to be snake_cased in order to be respected
  • buildUrl now accepts a new hashSearchParams prop and it snake_cases all search params by default

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:

@changeset-bot

changeset-botBot commented May 10, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a4ef2c6

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

This PR includes changesets to release 7 packages
NameType
@clerk/clerk-jsPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/clerk-expoPatch
@clerk/elementsPatch
@clerk/nextjsPatch
@clerk/remixPatch

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

return sameOrigin ? stripOrigin(url) : `${url}`;
};

export const appendAsQueryParams = (

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Killed this as we no longer need it

}

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

All search params appended by clerk-js are snake_cased. Moved the logic here to make sure that the caller has to remember/think about this detail

// Keep just the pathname and the search
// Merge search params from the hashSearchParams object
if (hashSearchParams) {
const paramsArr = Array.isArray(hashSearchParams) ? hashSearchParams : [hashSearchParams];

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Previously, the util supported passing hash params as a string only but the best way here is to simply pass a URLSearchParams object instead. I added the new functionality but kept the old one, will refactor all usages to the new format in a new PR

);
}

#flattenAll() {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I decided to stick with a more verbose approach here instead of a a more complex loop of some sort, let me know if you this is is too much

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.

I like it

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 7697adb to e607864CompareMay 10, 2024 14:07
@nikosdouvlis
nikosdouvlis marked this pull request as ready for review May 10, 2024 14:07
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from 03ee073 to 7cd88d6CompareMay 10, 2024 14:23

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👏

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch 2 times, most recently from a73f777 to b73c18eCompareMay 10, 2024 22:16
@LekoArtsLekoArts changed the title Respect props passed to buildSignInUrl and buildSignUpUrlfix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrlMay 13, 2024
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/core/clerk.ts Outdated
Comment threadpackages/clerk-js/src/ui/router/RouteContext.tsx
Comment threadpackages/clerk-js/src/utils/__tests__/url.test.ts
Comment threadpackages/react/src/components/__tests__/SignInButton.test.tsx Outdated
Comment thread.changeset/wet-peaches-grow.md Outdated
@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from b73c18e to 99372dbCompareMay 13, 2024 08:50
@desiprisg

Copy link
Copy Markdown
Contributor

!preview

@clerk-cookie

clerk-cookie commented May 13, 2024

Copy link
Copy Markdown
Collaborator

Hey @desiprisg, your preview is available.

StatusPreviewUpdated (UTC)
🍪 DeployedVisit previewMay 13, 2024 09:09 AM

@desiprisg

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/chrome-extension1.0.8-snapshot.v99372db
@clerk/clerk-js5.2.4-snapshot.v99372db
@clerk/elements0.3.4-snapshot.v99372db
@clerk/clerk-expo1.0.8-snapshot.v99372db
gatsby-plugin-clerk5.0.0-beta.45
@clerk/nextjs5.0.8-snapshot.v99372db
@clerk/clerk-react5.0.5-snapshot.v99372db
@clerk/remix4.0.6-snapshot.v99372db

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

npm i @clerk/chrome-extension@1.0.8-snapshot.v99372db --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.2.4-snapshot.v99372db --save-exact

@clerk/elements

npm i @clerk/elements@0.3.4-snapshot.v99372db --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@1.0.8-snapshot.v99372db --save-exact

gatsby-plugin-clerk

npm i gatsby-plugin-clerk@5.0.0-beta.45 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.0.8-snapshot.v99372db --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.0.5-snapshot.v99372db --save-exact

@clerk/remix

npm i @clerk/remix@4.0.6-snapshot.v99372db --save-exact

@nikosdouvlis
nikosdouvlisforce-pushed the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch from 99372db to a4ef2c6CompareMay 13, 2024 09:18

@desiprisgdesiprisg 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.

LGTM but let's state that this won't work with core-2 app and core-1 account portal.

@nikosdouvlis
nikosdouvlis merged commit bcbb2c9 into mainMay 13, 2024
@nikosdouvlis
nikosdouvlis deleted the nikos/sdk-1720-forceredirecturl-is-not-working-when-using-signinbutton branch May 13, 2024 13:12
@clerk-cookieclerk-cookie mentioned this pull request May 13, 2024
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

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.

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@nikosdouvlis@desiprisg@clerk-cookie@brkalow@dimkl@LekoArts