[fix] prerendering always false in global code of hooks.js #4265#4322
Merged
Rich-Harris merged 13 commits intosveltejs:masterfrom Mar 14, 2022
Merged
[fix] prerendering always false in global code of hooks.js #4265#4322Rich-Harris merged 13 commits intosveltejs:masterfrom
Rich-Harris merged 13 commits intosveltejs:masterfrom
Conversation
🦋 Changeset detectedLatest commit: 8f9ff86 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Member
|
Thank you. There's actually a simpler fix, which is more in line with plans for future changes (namely the addition of scoped |
Rich-Harris
approved these changes
Mar 14, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
This fixes the behavior documented in #4265, where
prerenderingimported from'$app/env'is false outside the actual hooks in hooks.ts even when called during prerender.This occurs because the hooks module is imported by the same module that exports the override function that allows to set prerendering in the first place. Therefore, when the global code of the hooks module is executed as it is imported, prerendering can never be any other value than it's default value.
This PR addresses this behavior by extracting the setting of prerendering into its own module (notify_prerendering.js), which can be imported without triggering the global code of the hooks module. As the notify_prerendering.js module will never be used anywhere other than during prerendering, it is not included into the
writeServer()output of the builder.Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpx changesetand following the prompts. All changesets should bepatchuntil SvelteKit 1.0Alternatives considered
Instead of making these changes, this behavior could also be documented under $app/prerendering as people can circumvent the problem with a setup function as described in #4265.