fix(umami): prevent SSR crash by guarding window access in use()

[DrMartinGonzo]

Not very familiar with the codebase, but here goes, it fixed my problems after many hours of not finding useful logs :)

📚 Description

This PR fixes a fatal SSR crash (window is not defined) that occurs when using the Umami Analytics script registry in universal rendering mode.

Currently, the use() method in packages/script/src/runtime/registry/umami-analytics.ts eagerly attempts to return window.umami without an environment check. If this method is called within a component's setup phase, it crashes the Node.js/Nitro server during the initial render.

I simply added an import.meta.client guard to the use() method in the Umami registry.

During server-side execution, it now safely bypasses the window access, preventing the crash while preserving the expected behavior on the client.

[vercel]

@DrMartinGonzo is attempting to deploy a commit to the Nuxt Team on Vercel.

A member of the Team first needs to authorize it.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@nuxt/scripts@815

commit: 5505bc8

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e9296995-47bc-47e6-9422-2c5bf2e5f680

📥 Commits

Reviewing files that changed from the base of the PR and between 9d5ccb1 and 5505bc8.

📒 Files selected for processing (1)

• packages/script/src/runtime/registry/umami-analytics.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/script/src/runtime/registry/umami-analytics.ts

---

📝 Walkthrough

Walkthrough

The Umami analytics script integration now guards access to the window.umami API behind a client-side environment check. The scriptOptions.use() function conditionally returns window.umami only when running in a browser context (import.meta.client is true) and returns undefined in non-browser environments. This change prevents reference errors when the script executes in server-side rendering or other environments where window is unavailable.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main fix: preventing an SSR crash by guarding window access in the use() method.
Description check	✅ Passed	The description is directly related to the changeset, explaining the SSR crash issue and how the import.meta.client guard resolves it.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[harlan-zw]

.use() shouldn't be called server-side, do you have any reproduction code? there's possibly a root issue to fix

[DrMartinGonzo]

I was suspecting that. Thank you for your answer Harlan.
I will try to strip my project to the bare minimum and see if I can reproduce. Will share once its done.

[DrMartinGonzo]

Thank you for putting me in the right direction.
After some digging, I've been able to set a minimal repro.
I found out a very particular setup causes the problem.

Having "@nuxtjs/seo" and "@nuxt/scripts" enabled.
Using experimental viteEnvironmentApi: true and ssr: true in nuxt.config.ts.

And for some reason, only fails when building in a docker container based on node-alpine, ok outside. (node and pnpm both being the same version as on my computer). I don't know how to debug this further.

Since this is related to an experimental nuxt feature, I guess we can close this.