fix(astro): ignore prerendered pages in middleware

[jlengstorf]

fixes #4639

Description

Checklist

• pnpm test runs as expected.
• pnpm 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 detected

Latest commit: 8b9eff5

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

This PR includes changesets to release 1 package

Name	Type
@clerk/astro	Patch

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 24, 2024 6:44pm

[tmilewski]

Thanks, @jlengstorf!

[wobsoriano]

Thanks @jlengstorf!

In case you still want to protect CSR pages, you can use the exported stores:

---
export async function getStaticPaths() {
  // other code
}
---

<!-- other code -->

<script>
import { $authStore } from '@clerk/astro/client'

$authStore.subscribe((auth) => {
  if (auth.userId === undefined) {
    // loading
  } else if (auth.userId === null) {
    // redirect to sign-in page
  }
})
</script>

[mlafeldt]

As far as I know, isPrerendered will be added in Astro 5, right?

Right now, the property is called _isPrerendered.

See withastro/astro#11756

[wobsoriano]

As far as I know, isPrerendered will be added in Astro 5, right?

Right now, the property is called _isPrerendered.

See withastro/astro#11756

Thanks for this! Is main branch v4? I think they ported isPrerendered to v4 here

Okay, I can confirm it's still _isPrerendered in latest v4 version. Will do a follow up PR.

[mlafeldt]

Thanks for this! Is main branch v4? I think they ported isPrerendered to v4 here

Hm, I don't think so. I'm using Astro v4.16.16 and all I see is _isPrerendered.

❯ rg --no-ignore isPrerendered node_modules/astro
node_modules/astro/dist/actions/runtime/middleware.js
11:  if (context._isPrerendered) {

node_modules/astro/dist/core/render-context.js
95:    const isPrerendered = !serverLike || this.routeData.prerender;
104:    const apiContext = this.createAPIContext(props, isPrerendered);
185:  createAPIContext(props, isPrerendered) {
198:      _isPrerendered: isPrerendered

node_modules/astro/dist/core/render-context.d.ts
46:    createAPIContext(props: APIContext['props'], isPrerendered: boolean): APIContext;

See https://github.com/withastro/astro/blob/astro%404.16.16/packages/astro/src/core/render-context.ts#L248

[mlafeldt]

Okay, I can confirm it's still _isPrerendered in latest v4 version. Will do a follow up PR.

@wobsoriano Cool. Something like this should work for all versions:

const isPrerendered = (context: any) => context._isPrerendered || context.isPrerendered

[jlengstorf]

sorry about that! I'm using Astro 5 😅