Skip to content

Commit

Permalink
fix(compiler-sfc): fix script setup ref assignment codegen edge case (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
edison1105 authored Sep 5, 2021
1 parent e6fe751 commit 5594643
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 14 deletions.
15 changes: 11 additions & 4 deletions packages/compiler-core/src/transforms/transformExpression.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ export function processExpression(
// function params
asParams = false,
// v-on handler values may contain multiple statements
asRawStatements = false
asRawStatements = false,
localVars: Record<string, number> = Object.create(context.identifiers)
): ExpressionNode {
if (__BROWSER__) {
if (__DEV__) {
Expand Down Expand Up @@ -127,7 +128,7 @@ export function processExpression(
const isDestructureAssignment =
parent && isInDestructureAssignment(parent, parentStack)

if (type === BindingTypes.SETUP_CONST) {
if (type === BindingTypes.SETUP_CONST || localVars[raw]) {
return raw
} else if (type === BindingTypes.SETUP_REF) {
return `${raw}.value`
Expand All @@ -149,7 +150,13 @@ export function processExpression(
const { right: rVal, operator } = parent as AssignmentExpression
const rExp = rawExp.slice(rVal.start! - 1, rVal.end! - 1)
const rExpString = stringifyExpression(
processExpression(createSimpleExpression(rExp, false), context)
processExpression(
createSimpleExpression(rExp, false),
context,
false,
false,
knownIds
)
)
return `${context.helperString(IS_REF)}(${raw})${
context.isTS ? ` //@ts-ignore\n` : ``
Expand Down Expand Up @@ -190,6 +197,7 @@ export function processExpression(
return `$${type}.${raw}`
}
}

// fallback to ctx
return `_ctx.${raw}`
}
Expand Down Expand Up @@ -246,7 +254,6 @@ export function processExpression(
}

type QualifiedId = Identifier & PrefixMeta

const ids: QualifiedId[] = []
const parentStack: Node[] = []
const knownIds: Record<string, number> = Object.create(context.identifiers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ return { props, bar }
}"
`;
exports[`SFC compile <script setup> defineProps/defineEmits in multi-variable decalration (full removal) 1`] = `
exports[`SFC compile <script setup> defineProps/defineEmits in multi-variable declaration (full removal) 1`] = `
"export default {
props: ['item'],
emits: ['a'],
Expand All @@ -173,7 +173,7 @@ return { props, emit }
}"
`;
exports[`SFC compile <script setup> defineProps/defineEmits in multi-variable decalration 1`] = `
exports[`SFC compile <script setup> defineProps/defineEmits in multi-variable declaration 1`] = `
"export default {
props: ['item'],
emits: ['a'],
Expand Down Expand Up @@ -506,7 +506,7 @@ return (_ctx, _push, _parent, _attrs) => {
`;
exports[`SFC compile <script setup> inlineTemplate mode template assignment expression codegen 1`] = `
"import { createElementVNode as _createElementVNode, isRef as _isRef, Fragment as _Fragment, openBlock as _openBlock, createElementBlock as _createElementBlock } from \\"vue\\"
"import { createElementVNode as _createElementVNode, isRef as _isRef, unref as _unref, Fragment as _Fragment, openBlock as _openBlock, createElementBlock as _createElementBlock } from \\"vue\\"
import { ref } from 'vue'
Expand Down Expand Up @@ -534,6 +534,26 @@ return (_ctx, _cache) => {
}),
_createElementVNode(\\"div\\", {
onClick: _cache[4] || (_cache[4] = $event => (_isRef(v) ? v.value -= 1 : v -= 1))
}),
_createElementVNode(\\"div\\", {
onClick: _cache[5] || (_cache[5] = () => {
let a = '' + _unref(lett)
_isRef(v) ? v.value = a : v = a
})
}),
_createElementVNode(\\"div\\", {
onClick: _cache[6] || (_cache[6] = () => {
// nested scopes
(()=>{
let x = _ctx.a
(()=>{
let z = x
let z2 = z
})
let lz = _ctx.z
})
_isRef(v) ? v.value = _ctx.a : v = _ctx.a
})
})
], 64 /* STABLE_FRAGMENT */))
}
Expand Down
22 changes: 20 additions & 2 deletions packages/compiler-sfc/__tests__/compileScript.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ const myEmit = defineEmits(['foo', 'bar'])
emits: ['foo', 'bar'],`)
})

test('defineProps/defineEmits in multi-variable decalration', () => {
test('defineProps/defineEmits in multi-variable declaration', () => {
const { content } = compile(`
<script setup>
const props = defineProps(['item']),
Expand All @@ -112,7 +112,7 @@ const myEmit = defineEmits(['foo', 'bar'])
expect(content).toMatch(`emits: ['a'],`)
})

test('defineProps/defineEmits in multi-variable decalration (full removal)', () => {
test('defineProps/defineEmits in multi-variable declaration (full removal)', () => {
const { content } = compile(`
<script setup>
const props = defineProps(['item']),
Expand Down Expand Up @@ -517,6 +517,22 @@ defineExpose({ foo: 123 })
<div @click="lett = count"/>
<div @click="v += 1"/>
<div @click="v -= 1"/>
<div @click="() => {
let a = '' + lett
v = a
}"/>
<div @click="() => {
// nested scopes
(()=>{
let x = a
(()=>{
let z = x
let z2 = z
})
let lz = z
})
v = a
}"/>
</template>
`,
{ inlineTemplate: true }
Expand All @@ -531,6 +547,8 @@ defineExpose({ foo: 123 })
)
expect(content).toMatch(`_isRef(v) ? v.value += 1 : v += 1`)
expect(content).toMatch(`_isRef(v) ? v.value -= 1 : v -= 1`)
expect(content).toMatch(`_isRef(v) ? v.value = a : v = a`)
expect(content).toMatch(`_isRef(v) ? v.value = _ctx.a : v = _ctx.a`)
assertCode(content)
})

Expand Down
4 changes: 2 additions & 2 deletions packages/compiler-sfc/src/compileScript.ts
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ export function compileScript(
/**
* check defaults. If the default object is an object literal with only
* static properties, we can directly generate more optimzied default
* decalrations. Otherwise we will have to fallback to runtime merging.
* declarations. Otherwise we will have to fallback to runtime merging.
*/
function checkStaticDefaults() {
return (
Expand Down Expand Up @@ -895,7 +895,7 @@ export function compileScript(
}
}

// walk decalrations to record declared bindings
// walk declarations to record declared bindings
if (
(node.type === 'VariableDeclaration' ||
node.type === 'FunctionDeclaration' ||
Expand Down
6 changes: 3 additions & 3 deletions packages/runtime-core/src/apiSetupHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const warnRuntimeUsage = (method: string) =>
* })
* ```
*
* Equivalent type-based decalration:
* Equivalent type-based declaration:
* ```ts
* // will be compiled into equivalent runtime declarations
* const props = defineProps<{
Expand Down Expand Up @@ -79,7 +79,7 @@ export function defineProps() {
* const emit = defineEmits(['change', 'update'])
* ```
*
* Example type-based decalration:
* Example type-based declaration:
* ```ts
* const emit = defineEmits<{
* (event: 'change'): void
Expand Down Expand Up @@ -147,7 +147,7 @@ type PropsWithDefaults<Base, Defaults> = Base &

/**
* Vue `<script setup>` compiler macro for providing props default values when
* using type-based `defineProps` decalration.
* using type-based `defineProps` declaration.
*
* Example usage:
* ```ts
Expand Down

0 comments on commit 5594643

Please sign in to comment.