feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef
, '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

feat(astro): Add CSR support - #3911

Merged
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro
Aug 22, 2024
Merged

feat(astro): Add CSR support#3911
wobsoriano merged 95 commits into
mainfrom
rob/eco-17-explore-our-options-for-csr-only-support-in-astro

Conversation

@wobsoriano

@wobsorianowobsoriano commented Aug 6, 2024

Copy link
Copy Markdown
Member

Description

This PR adds support for static and hybrid outputs in Astro by making our control components isomorphic. A basic e2e test has been added as well.

Limitations:

  • For hybrid output, a isStatic prop is available to control which component to use. It's going to use CSR components by default (since pages are prerendered by default in hybrid output).
  • Have to separate the web components to their own files instead of putting them inside the *CSR.astro components because of some Vite issues. Please see ECO-17 for more info. Fixed here

Closes ECO-17

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 Aug 6, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: aadf639

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

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

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

@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 9daf40b to c892565CompareAugust 6, 2024 20:48
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from cf4f5c6 to ecaac43CompareAugust 8, 2024 00:16
@wobsoriano
wobsoriano changed the base branch from main to rob/eco-4-move-or-use-utilities-from-clerksharedAugust 8, 2024 16:37
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 8bfae44 to 39df490CompareAugust 8, 2024 16:37
Base automatically changed from rob/eco-4-move-or-use-utilities-from-clerkshared to mainAugust 9, 2024 14:14
@wobsoriano
wobsorianoforce-pushed the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch from 1b466bd to 3fec45bCompareAugust 9, 2024 14:25
@clerkclerk deleted a comment from clerk-cookieAug 12, 2024
@clerkclerk deleted a comment from clerk-cookieAug 20, 2024
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro1.1.0-snapshot.v17a4abb
@clerk/backend1.7.0-snapshot.v17a4abb
@clerk/chrome-extension1.2.2-snapshot.v17a4abb
@clerk/clerk-js5.15.0-snapshot.v17a4abb
@clerk/dev-cli0.0.7-snapshot.v17a4abb
@clerk/elements0.14.0-snapshot.v17a4abb
@clerk/clerk-expo2.2.0-snapshot.v17a4abb
@clerk/express0.0.29-snapshot.v17a4abb
@clerk/fastify1.0.31-snapshot.v17a4abb
@clerk/localizations2.6.0-snapshot.v17a4abb
@clerk/nextjs5.3.2-snapshot.v17a4abb
@clerk/clerk-react5.4.2-snapshot.v17a4abb
@clerk/remix4.2.15-snapshot.v17a4abb
@clerk/clerk-sdk-node5.0.28-snapshot.v17a4abb
@clerk/shared2.5.2-snapshot.v17a4abb
@clerk/tanstack-start0.2.2-snapshot.v17a4abb
@clerk/testing1.2.11-snapshot.v17a4abb
@clerk/themes2.1.21-snapshot.v17a4abb
@clerk/types4.14.0-snapshot.v17a4abb

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

npm i @clerk/astro@1.1.0-snapshot.v17a4abb --save-exact

@clerk/backend

npm i @clerk/backend@1.7.0-snapshot.v17a4abb --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.2.2-snapshot.v17a4abb --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.15.0-snapshot.v17a4abb --save-exact

@clerk/dev-cli

npm i @clerk/dev-cli@0.0.7-snapshot.v17a4abb --save-exact

@clerk/elements

npm i @clerk/elements@0.14.0-snapshot.v17a4abb --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.0-snapshot.v17a4abb --save-exact

@clerk/express

npm i @clerk/express@0.0.29-snapshot.v17a4abb --save-exact

@clerk/fastify

npm i @clerk/fastify@1.0.31-snapshot.v17a4abb --save-exact

@clerk/localizations

npm i @clerk/localizations@2.6.0-snapshot.v17a4abb --save-exact

@clerk/nextjs

npm i @clerk/nextjs@5.3.2-snapshot.v17a4abb --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.4.2-snapshot.v17a4abb --save-exact

@clerk/remix

npm i @clerk/remix@4.2.15-snapshot.v17a4abb --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.28-snapshot.v17a4abb --save-exact

@clerk/shared

npm i @clerk/shared@2.5.2-snapshot.v17a4abb --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.2.2-snapshot.v17a4abb --save-exact

@clerk/testing

npm i @clerk/testing@1.2.11-snapshot.v17a4abb --save-exact

@clerk/themes

npm i @clerk/themes@2.1.21-snapshot.v17a4abb --save-exact

@clerk/types

npm i @clerk/types@4.14.0-snapshot.v17a4abb --save-exact

Comment threadpackages/astro/src/stores/internal.ts
*
* $isLoadedStore.subscribe((authloaded => console.log(loaded))
*/
export const $isLoadedStore = computed([$csrState], state => state.isLoaded);

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.

What's the reliability issue with $clerkStore ?

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.

This could be added as JSdoc for other maintainers


<style>
clerk-signed-out[hidden] {
display: none !important;

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.

In case someone would like to animate in/out the children of <SignedOut/> would this be possible ?

@wobsorianowobsorianoAug 21, 2024

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.

Updated the control components to have class props so they can override it. We'll mention this in the CSR reference docs when added 👍🏼

If only there's a way to not have a wrapper element and dynamically render the contents, but sadly no because of how astro components works

permission?: never;
};
import { isStaticOutput } from "virtual:@clerk/astro/config";
import type { ProtectProps } from '../../types';

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.

Does this work because we now expose @clerk/astro/types ?

@wobsorianowobsorianoAug 21, 2024

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.

We are only copying the types.ts file to so that it can still be resolvable when published. We don't export the types in package.json still, though. I don't see any helpful type to export 🤔

Comment threadintegration/presets/astro.ts Outdated
.addDependency('@clerk/types', clerkTypesLocal)
.addDependency('@clerk/localizations', clerkLocalizationLocal);

const astroStatic = astroNode.clone().setName('astro-static').useTemplate(templates['astro-static']);

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.

Do we need to add an e2e template with hybrid and prerender = true ?

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.

That's a good to have but I think if we do hybrid test we can have both prerendered pages and just remove static e2e

@wobsorianowobsorianoAug 21, 2024

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.

Removed static test in favor of hybrid output test

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

Great work !!

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

Great work! 🔥

@wobsoriano
wobsoriano merged commit e3cd92b into mainAug 22, 2024
@wobsoriano
wobsoriano deleted the rob/eco-17-explore-our-options-for-csr-only-support-in-astro branch August 22, 2024 12:08
brkalow pushed a commit that referenced this pull request Aug 22, 2024
Co-authored-by: Lennart <lekoarts@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano@clerk-cookie@octoper@LekoArts@panteliselef