Skip to content

Commit

Permalink
fix(runtime-core): fix SSR memoery leak due to props normalization cache
Browse files Browse the repository at this point in the history
fix #2225

The previous props/emits normlaization was caching normalized result per
app instance, but during SSR there is a new app instance created for
every request.

The fix now de-opts props/emits normlaization caching when there are
props/emits declared in global mixins - which is a very rare use case.
  • Loading branch information
yyx990803 committed Oct 6, 2020
1 parent cf2c9f6 commit a66e53a
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 29 deletions.
16 changes: 15 additions & 1 deletion packages/runtime-core/src/apiCreateApp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,16 @@ export interface AppContext {
components: Record<string, Component>
directives: Record<string, Directive>
provides: Record<string | symbol, any>
reload?: () => void // HMR only
/**
* Flag for de-optimizing props normalization
* @internal
*/
deopt?: boolean
/**
* HMR only
* @internal
*/
reload?: () => void
}

type PluginInstallFunction = (app: App, ...options: any[]) => any
Expand Down Expand Up @@ -169,6 +178,11 @@ export function createAppAPI<HostElement>(
if (__FEATURE_OPTIONS_API__) {
if (!context.mixins.includes(mixin)) {
context.mixins.push(mixin)
// global mixin with props/emits de-optimizes props/emits
// normalization caching.
if (mixin.props || mixin.emits) {
context.deopt = true
}
} else if (__DEV__) {
warn(
'Mixin has already been applied to target app' +
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime-core/src/component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ export interface ComponentInternalOptions {
/**
* @internal
*/
__props?: Record<number, NormalizedPropsOptions>
__props?: NormalizedPropsOptions
/**
* @internal
*/
__emits?: Record<number, ObjectEmitsOptions | null>
__emits?: ObjectEmitsOptions | null
/**
* @internal
*/
Expand Down
11 changes: 4 additions & 7 deletions packages/runtime-core/src/componentEmits.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,8 @@ export function normalizeEmitsOptions(
appContext: AppContext,
asMixin = false
): ObjectEmitsOptions | null {
const appId = appContext.app ? appContext.app._uid : -1
const cache = comp.__emits || (comp.__emits = {})
const cached = cache[appId]
if (cached !== undefined) {
return cached
if (!appContext.deopt && comp.__emits !== undefined) {
return comp.__emits
}

const raw = comp.emits
Expand All @@ -138,15 +135,15 @@ export function normalizeEmitsOptions(
}

if (!raw && !hasExtends) {
return (cache[appId] = null)
return (comp.__emits = null)
}

if (isArray(raw)) {
raw.forEach(key => (normalized[key] = null))
} else {
extend(normalized, raw)
}
return (cache[appId] = normalized)
return (comp.__emits = normalized)
}

// Check if an incoming prop key is a declared emit event listener.
Expand Down
32 changes: 13 additions & 19 deletions packages/runtime-core/src/componentProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -328,11 +328,8 @@ export function normalizePropsOptions(
appContext: AppContext,
asMixin = false
): NormalizedPropsOptions {
const appId = appContext.app ? appContext.app._uid : -1
const cache = comp.__props || (comp.__props = {})
const cached = cache[appId]
if (cached) {
return cached
if (!appContext.deopt && comp.__props) {
return comp.__props
}

const raw = comp.props
Expand Down Expand Up @@ -360,7 +357,7 @@ export function normalizePropsOptions(
}

if (!raw && !hasExtends) {
return (cache[appId] = EMPTY_ARR)
return (comp.__props = EMPTY_ARR)
}

if (isArray(raw)) {
Expand Down Expand Up @@ -398,7 +395,16 @@ export function normalizePropsOptions(
}
}

return (cache[appId] = [normalized, needCastKeys])
return (comp.__props = [normalized, needCastKeys])
}

function validatePropName(key: string) {
if (key[0] !== '$') {
return true
} else if (__DEV__) {
warn(`Invalid prop name: "${key}" is a reserved property.`)
}
return false
}

// use function string name to check type constructors
Expand Down Expand Up @@ -441,18 +447,6 @@ function validateProps(props: Data, instance: ComponentInternalInstance) {
}
}

/**
* dev only
*/
function validatePropName(key: string) {
if (key[0] !== '$') {
return true
} else if (__DEV__) {
warn(`Invalid prop name: "${key}" is a reserved property.`)
}
return false
}

/**
* dev only
*/
Expand Down

0 comments on commit a66e53a

Please sign in to comment.