-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
fix: throw when a store is used outside of a Nuxt-aware context. #2857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pguilbert
wants to merge
11
commits into
vuejs:v3
Choose a base branch
from
pguilbert:error-usage-after-await
base: v3
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e9ce9c8
docs: update prop comment
posva 0c8f207
docs: local search and nav links (#2909)
posva 702ca40
docs: update badges
posva c6018be
build: use v2 as the default npm tag
posva a20f11e
build: fix name cannot be version range
posva f78f59e
fix: throw when a store is used outside of a Nuxt-aware context.
pguilbert f14eb56
test: improve tests
pguilbert dfe8589
feat: use pinia instance from nuxt only in dev mode
pguilbert 068e512
chore: restore
posva 5e74248
chore: restore
posva fd75a3d
refactor: review
posva File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| // Global compile-time constants | ||
| declare var __TEST__: boolean | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <script lang="ts" setup> | ||
| async function useFancyCounter() { | ||
| await new Promise((resolve) => setTimeout(resolve, 0)) | ||
|
|
||
| // ❌ bad usage: the use of a store after an await could lead to using the wrong pinia instance. | ||
| return useCounter() | ||
| } | ||
|
|
||
| const event = useRequestEvent() | ||
| useNuxtApp().hook('vue:error', (error) => { | ||
| if (event) { | ||
| setResponseStatus(event, 500, String(error)) | ||
| } | ||
| }) | ||
|
|
||
| const counter = await useFancyCounter() | ||
| </script> | ||
|
|
||
| <template> | ||
| <div> | ||
| <p>Count: {{ counter.$state.count }}</p> | ||
| <button @click="counter.increment()">+</button> | ||
| </div> | ||
| </template> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,33 @@ | ||
| import { useNuxtApp } from '#app' | ||
| import type { Pinia } from 'pinia' | ||
| import { | ||
| defineStore as _defineStore, | ||
| type Pinia, | ||
| type StoreGeneric, | ||
| } from 'pinia' | ||
| export * from 'pinia' | ||
|
|
||
| export const usePinia = () => useNuxtApp().$pinia as Pinia | ||
| export const usePinia = () => useNuxtApp().$pinia as Pinia | undefined | ||
|
|
||
| export const defineStore: typeof _defineStore = | ||
| process.env.NODE_ENV === 'production' && !__TEST__ | ||
| ? _defineStore | ||
| : ((( | ||
| ...args: Parameters<typeof _defineStore> | ||
| ): ReturnType<typeof _defineStore> => { | ||
| if (!import.meta.server) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This condition can be probably be moved up so we simply return |
||
| return _defineStore(...args) | ||
| } | ||
|
|
||
| const originalUseStore = _defineStore(...args) | ||
| function useStore( | ||
| pinia?: Pinia | null, | ||
| hot?: StoreGeneric | ||
| ): StoreGeneric { | ||
| return originalUseStore(pinia || usePinia(), hot) | ||
| } | ||
|
|
||
| useStore.$id = originalUseStore.$id | ||
| useStore._pinia = originalUseStore._pinia | ||
|
|
||
| return useStore | ||
| }) as typeof _defineStore) | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any way to get rid of this? I don't think we should need this