Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix(nuxt): provide global scope for nuxt plugin context #23667

Merged
merged 2 commits into from Oct 15, 2023
Merged

fix(nuxt): provide global scope for nuxt plugin context #23667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1629990
fix(nuxt): provide global scope for nuxt plugin context
danielroe Oct 13, 2023
ce7bb80
fix(nuxt): cleanup scope before navigating away from site
danielroe Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/nuxt/src/app/composables/router.ts
View file
Open in desktop
@@ -1,4 +1,4 @@
import { getCurrentInstance, hasInjectionContext, inject, onUnmounted } from 'vue'
import { getCurrentInstance, hasInjectionContext, inject, onScopeDispose } from 'vue'
import type { Ref } from 'vue'
import type { NavigationFailure, NavigationGuard, RouteLocationNormalized, RouteLocationPathRaw, RouteLocationRaw, Router, useRoute as _useRoute, useRouter as _useRouter } from '#vue-router'
import { sanitizeStatusCode } from 'h3'
Expand Down Expand Up @@ -30,12 +30,12 @@ export const onBeforeRouteLeave = (guard: NavigationGuard) => {
if (to === from) { return }
return guard(to, from, next)
})
onUnmounted(unsubscribe)
onScopeDispose(unsubscribe)
}

export const onBeforeRouteUpdate = (guard: NavigationGuard) => {
const unsubscribe = useRouter().beforeEach(guard)
onUnmounted(unsubscribe)
onScopeDispose(unsubscribe)
}

export interface RouteMiddleware {
Expand Down Expand Up @@ -182,6 +182,8 @@ export const navigateTo = (to: RouteLocationRaw | undefined | null, options?: Na

// Client-side redirection using vue-router
if (isExternal) {
// Run any cleanup steps for the current scope, like ending BroadcastChannel
nuxtApp._scope.stop()
if (options?.replace) {
location.replace(toPath)
} else {
Expand Down
9 changes: 6 additions & 3 deletions packages/nuxt/src/app/nuxt.ts
View file
Open in desktop
@@ -1,6 +1,6 @@
/* eslint-disable no-use-before-define */
import { getCurrentInstance, hasInjectionContext, reactive } from 'vue'
import type { App, Ref, VNode, onErrorCaptured } from 'vue'
import { effectScope, getCurrentInstance, hasInjectionContext, reactive } from 'vue'
import type { App, EffectScope, Ref, VNode, onErrorCaptured } from 'vue'
import type { RouteLocationNormalizedLoaded } from '#vue-router'
import type { HookCallback, Hookable } from 'hookable'
import { createHooks } from 'hookable'
Expand Down Expand Up @@ -98,6 +98,8 @@ interface _NuxtApp {

[key: string]: unknown

/** @internal */
_scope: EffectScope
/** @internal */
_asyncDataPromises: Record<string, Promise<any> | undefined>
/** @internal */
Expand Down Expand Up @@ -202,6 +204,7 @@ export interface CreateOptions {
export function createNuxtApp (options: CreateOptions) {
let hydratingCount = 0
const nuxtApp: NuxtApp = {
_scope: effectScope(),
provide: undefined,
globalName: 'nuxt',
versions: {
Expand All @@ -217,7 +220,7 @@ export function createNuxtApp (options: CreateOptions) {
static: {
data: {}
},
runWithContext: (fn: any) => callWithNuxt(nuxtApp, fn),
runWithContext: (fn: any) => nuxtApp._scope.run(() => callWithNuxt(nuxtApp, fn)),
isHydrating: import.meta.client,
deferHydration () {
if (!nuxtApp.isHydrating) { return () => {} }
Expand Down