Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(ssr): avoid triggering onScopeDispose during SSR cleanup #14673

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

Closed
edison1105 wants to merge 1 commit into from
Closed

fix(ssr): avoid triggering onScopeDispose during SSR cleanup #14673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/reactivity/src/effectScope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export class EffectScope {
}
}

stop(fromParent?: boolean): void {
stop(fromParent?: boolean, allowScopeCleanups = true): void {
if (this._active) {
this._active = false
let i, l
Expand All @@ -138,14 +138,16 @@ export class EffectScope {
}
this.effects.length = 0

for (i = 0, l = this.cleanups.length; i < l; i++) {
this.cleanups[i]()
if (allowScopeCleanups) {
for (i = 0, l = this.cleanups.length; i < l; i++) {
this.cleanups[i]()
}
}
this.cleanups.length = 0

if (this.scopes) {
for (i = 0, l = this.scopes.length; i < l; i++) {
this.scopes[i].stop(true)
this.scopes[i].stop(true, allowScopeCleanups)
}
this.scopes.length = 0
}
Expand Down
19 changes: 13 additions & 6 deletions packages/server-renderer/__tests__/render.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,24 +1004,27 @@ function testRender(type: string, render: typeof renderToString) {
expect(html).toBe(`<div>hello</div>`)
})

test('cleans up component effect scopes after each render', async () => {
test('stops component effect scopes after each render without triggering onScopeDispose', async () => {
let instanceScope: any
const cleanups: number[] = []
const app = createApp({
setup() {
instanceScope = getCurrentInstance()!.scope
onScopeDispose(() => {
cleanups.push(1)
})
return () => h('div', 'ok')
},
})

expect(cleanups).toEqual([])
expect(await render(app)).toBe(`<div>ok</div>`)
expect(cleanups).toEqual([1])
expect(instanceScope.active).toBe(false)
expect(cleanups).toEqual([])
})

test('concurrent renders isolate scope cleanup ownership', async () => {
test('concurrent renders isolate effect scope disposal ownership', async () => {
const cleaned: string[] = []
const scopes: Record<string, any> = {}

const deferred = () => {
let resolve!: () => void
Expand All @@ -1037,6 +1040,7 @@ function testRender(type: string, render: typeof renderToString) {
const makeApp = (id: string, gate: ReturnType<typeof deferred>) =>
createApp({
async setup() {
scopes[id] = getCurrentInstance()!.scope
onScopeDispose(() => {
cleaned.push(id)
})
Expand All @@ -1050,11 +1054,14 @@ function testRender(type: string, render: typeof renderToString) {

gateB.resolve()
expect(await pB).toBe(`<div>B</div>`)
expect(cleaned).toEqual(['B'])
expect(scopes.B.active).toBe(false)
expect(scopes.A.active).toBe(true)
expect(cleaned).toEqual([])

gateA.resolve()
expect(await pA).toBe(`<div>A</div>`)
expect(cleaned.sort()).toEqual(['A', 'B'])
expect(scopes.A.active).toBe(false)
expect(cleaned).toEqual([])
})

test('detached scopes created during SSR are not auto-stopped', async () => {
Expand Down
8 changes: 6 additions & 2 deletions packages/server-renderer/src/render.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ export type SSRContext = {
/**
* @internal
*/
__instanceScopes?: { stop: () => void }[]
__instanceScopes?: {
stop: (fromParent?: boolean, allowScopeCleanups?: boolean) => void
}[]
}

export function cleanupContext(context: SSRContext): void {
Expand All @@ -77,7 +79,9 @@ export function cleanupContext(context: SSRContext): void {
if (context.__instanceScopes) {
for (const scope of context.__instanceScopes) {
try {
scope.stop()
// SSR should dispose component-owned effects/scopes without invoking
// user cleanup callbacks registered via onScopeDispose().
scope.stop(false, false)
} catch (err) {
if (firstError === undefined) firstError = err
}
Expand Down
Loading