chore(nextjs): Add deprecation warning for app-beta subpath export - #1829

Merged
dimkl merged 3 commits into
mainfrom
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged

chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom
cleanups-nextjs-clerkv5

Conversation

@dimkl

@dimkldimkl commented Oct 4, 2023

Copy link
Copy Markdown
Contributor

Description

The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.

In this PR the following hacks were applied to add JSDocs and console warnings deprecations:

  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta

Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.

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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore

@dimkldimkl self-assigned this Oct 4, 2023
@dimkl
dimkl requested a review from a team as a code ownerOctober 4, 2023 22:09
@changeset-bot

changeset-botBot commented Oct 4, 2023•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 78eb66f

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

This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch

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

@dimkldimkl changed the title chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts reviewed Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx Outdated
@dimkl
dimklforce-pushed the cleanups-nextjs-clerkv5 branch from 7fb289e to ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed the fix-nextjs-shared-deps branch from 63f77bd to 25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed the cleanups-nextjs-clerkv5 branch from ebfd84a to 77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed the fix-nextjs-shared-deps branch from 9acaa62 to 319d166CompareOctober 5, 2023 12:01
Base automatically changed from fix-nextjs-shared-deps to mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed the cleanups-nextjs-clerkv5 branch from 77ff3da to f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl requested a review from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl enabled auto-merge October 5, 2023 16:38
@brkalow

brkalow commented Oct 5, 2023

Copy link
Copy Markdown
Member

@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?

@dimkl

dimkl commented Oct 6, 2023

Copy link
Copy Markdown
ContributorAuthor

@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.
I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.
The following steps were applied:

  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56

@dimkl
dimklforce-pushed the cleanups-nextjs-clerkv5 branch from 7beee2a to 78eb66fCompareOctober 6, 2023 12:12
@LekoArts

LekoArts commented Oct 6, 2023

Copy link
Copy Markdown
Contributor

Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.

@dimkl
dimkl added this pull request to the merge queue Oct 6, 2023
Merged via the queue into main with commit de5e2f5Oct 6, 2023
@dimkl
dimkl deleted the cleanups-nextjs-clerkv5 branch October 6, 2023 17:31
@clerk-cookieclerk-cookie mentioned this pull request Oct 6, 2023
Merged
@clerk-cookie

clerk-cookie commented Oct 6, 2024

Copy link
Copy Markdown
Collaborator

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@clerkclerk locked as resolved and limited conversation to collaborators Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie
, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie

, '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
chore(nextjs): Add deprecation warning for app-beta subpath export - #1829
Merged
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Oct 6, 2023
Merged
chore(nextjs): Add deprecation warning for app-beta subpath export#1829
dimkl merged 3 commits into
mainfrom 
cleanups-nextjs-clerkv5
Conversation
@dimkl
@dimkldimkl
commented
Oct 4, 2023

Copy link


Copy Markdown

Contributor
Description
The implementation in app-beta was an attempt to support the NextJS app-router early on. Since the app-router release is stable we will deprecate the @clerk/nextjs/app-beta subpath export and suggest using the stable @clerk/nextjs exports instead.
In this PR the following hacks were applied to add JSDocs and console warnings deprecations:
  • we could not add a single deprecation warning in the app-beta/index.ts because it did not work so deprecated was added in each file
  • Replaced import from @clerk/clerk-react with module to show deprecation warning (see: packages/nextjs/src/app-beta/client/clerk-react.ts)
  • Use import with aliases for re-exported modules of @clerk/clerk-react to add JSDoc deprecations only for the exports from the app-beta
Since the whole folder app-beta will be removed in the next major version, there is no need to worry about those hacks.
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/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore
@dimkldimkl
self-assigned this
Oct 4, 2023
@dimkl
dimkl
requested a review
from a team
as a code ownerOctober 4, 2023 22:09
@changeset-bot
changeset-botBot
commented
Oct 4, 2023•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 78eb66f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch
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
@dimkldimkl
changed the title
chore(nextjs): Drop app-beta chore(nextjs): Add deprecation warning for app-beta subpath exportOct 4, 2023
LekoArts
LekoArts
reviewed
Oct 5, 2023
View reviewed changes
Comment threadpackages/nextjs/src/app-beta/ClerkProvider.tsx
Outdated

@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7fb289e to
ebfd84aCompareOctober 5, 2023 09:54
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
63f77bd to
25e6acdCompareOctober 5, 2023 10:36
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
ebfd84a to
77ff3daCompareOctober 5, 2023 10:40
@dimkl
dimklforce-pushed
the
fix-nextjs-shared-deps
branch
from
9acaa62 to
319d166CompareOctober 5, 2023 12:01

Base automatically changed from
fix-nextjs-shared-deps to
mainOctober 5, 2023 16:24
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
77ff3da to
f521c21CompareOctober 5, 2023 16:38
@dimkl
dimkl
requested a review
from LekoArtsOctober 5, 2023 16:38
@dimkl
dimkl
enabled auto-merge
October 5, 2023 16:38
@brkalow
brkalow
commented
Oct 5, 2023

Copy link


Copy Markdown

Member
@dimkl What were the issues you ran into with adding the deprecation warning to app-beta/index?
@dimkl
dimkl
commented
Oct 6, 2023

Copy link


Copy Markdown

ContributorAuthor
@brkalow , @LekoArts adding a deprecation in the app-beta/index.ts seems to be ignored.

I have created the following screenshots to showcase that add a warning to the module, the warning is visible to the console but the warning in the index.ts is not.

The following steps were applied:
  • add deprecation warning to index.ts and to auth.ts and a console.log
  • <javascript_repo> git status to show that those changes were saved
  • <javascript_repo> npm run build -- --force && npm run yalc:all to create clean build and push that build to the playground
  • <javascript_repo>/playground/nextjs npm run dev to start an application with NextJS app-beta
  • navigate to http://localhost:4011 to trigger application logs
  • Search for deprecation warnings and console log in the application logs
Screenshot 2023-10-06 at 13 04 47Screenshot 2023-10-06 at 13 28 24Screenshot 2023-10-06 at 13 29 56
@dimkl
dimklforce-pushed
the
cleanups-nextjs-clerkv5
branch
from
7beee2a to
78eb66fCompareOctober 6, 2023 12:12
@LekoArts
LekoArts
commented
Oct 6, 2023

Copy link


Copy Markdown

Contributor
Ok, makes sense 👍 I'd need to dive deeper into how you could run a side-effect when a module is imported. With a quick search I couldn't find previous art on this.
@dimkl
dimkl
added this pull request to the merge queue
Oct 6, 2023

Merged
via the queue into
main
with commit de5e2f5Oct 6, 2023
@dimkl
dimkl
deleted the

cleanups-nextjs-clerkv5

branch
October 6, 2023 17:31
@clerk-cookieclerk-cookie
mentioned this pull request
Oct 6, 2023
 Merged

@clerk-cookie
clerk-cookie
commented
Oct 6, 2024

Copy link


Copy Markdown

Collaborator
This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
@clerkclerk
locked as resolved and limited conversation to collaborators
Oct 6, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@brkalowbrkalowbrkalow approved these changes
@LekoArtsLekoArtsAwaiting requested review from LekoArts

Assignees

@dimkldimkl

Labels

nextjs

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@dimkl@brkalow@LekoArts@clerk-cookie