Skip to content

feat(runtime-vapor): add normalizeNode to support non-block nodes #13287

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
wants to merge 13 commits into
base: minor
Choose a base branch
from
Open
26 changes: 15 additions & 11 deletions packages/runtime-vapor/__tests__/component.spec.ts
Original file line number Diff line number Diff line change
@@ -331,25 +331,29 @@ describe('component', () => {
__DEV__ = true
})

it('warn if functional vapor component not return a block', () => {
define(() => {
return () => {}
it('functional vapor component return a object', () => {
const { host } = define(() => {
return {}
}).render()

expect(
'Functional vapor component must return a block directly',
).toHaveBeenWarned()
expect(host.textContent).toBe(`[object Object]`)
})

it('warn if setup return a function and no render function', () => {
define({
it('functional vapor component return a function', () => {
const { host } = define(() => {
return () => ({})
}).render()

expect(host.textContent).toBe(`() => ({})`)
})

it('setup return a function and no render function', () => {
const { host } = define({
setup() {
return () => []
},
}).render()

expect(
'Vapor component setup() returned non-block value, and has no render function',
).toHaveBeenWarned()
expect(host.textContent).toBe(`() => []`)
})
})
25 changes: 25 additions & 0 deletions packages/runtime-vapor/__tests__/dom/node.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { createTextNode, normalizeNode } from '../../src/dom/node'
import { VaporFragment } from '../../src'

describe('dom node', () => {
test('normalizeNode', () => {
// null / undefined -> []
expect(normalizeNode(null)).toBeInstanceOf(Array)
expect(normalizeNode(undefined)).toBeInstanceOf(Array)

// boolean -> []
expect(normalizeNode(true)).toBeInstanceOf(Array)
expect(normalizeNode(false)).toBeInstanceOf(Array)

// array -> Fragment
expect(normalizeNode(['foo'])).toBeInstanceOf(VaporFragment)

// VNode -> VNode
const vnode = createTextNode('div')
expect(normalizeNode(vnode)).toBe(vnode)

// primitive types
expect(normalizeNode('foo')).toMatchObject(createTextNode('foo'))
expect(normalizeNode(1)).toMatchObject(createTextNode('1'))
})
})
1 change: 0 additions & 1 deletion packages/runtime-vapor/__tests__/errorHandling.spec.ts
Original file line number Diff line number Diff line change
@@ -182,7 +182,6 @@ describe('error handling', () => {

define(Comp).render()
expect(fn).toHaveBeenCalledWith(err, 'setup function')
expect(`returned non-block value`).toHaveBeenWarned()
})

test('in render function', () => {
37 changes: 16 additions & 21 deletions packages/runtime-vapor/src/component.ts
Original file line number Diff line number Diff line change
@@ -23,9 +23,8 @@ import {
simpleSetCurrentInstance,
startMeasure,
unregisterHMR,
warn,
} from '@vue/runtime-dom'
import { type Block, DynamicFragment, insert, isBlock, remove } from './block'
import { type Block, DynamicFragment, insert, remove } from './block'
import {
type ShallowRef,
markRaw,
@@ -64,6 +63,7 @@ import {
insertionParent,
resetInsertionState,
} from './insertionState'
import { normalizeNode } from './dom/node'

export { currentInstance } from '@vue/runtime-dom'

@@ -206,26 +206,21 @@ export function createComponent(
}

const setupFn = isFunction(component) ? component : component.setup
const setupResult = setupFn
? callWithErrorHandling(setupFn, instance, ErrorCodes.SETUP_FUNCTION, [
instance.props,
instance,
]) || EMPTY_OBJ
: EMPTY_OBJ

if (__DEV__ && !isBlock(setupResult)) {
if (isFunction(component)) {
warn(`Functional vapor component must return a block directly.`)
instance.block = []
} else if (!component.render) {
warn(
`Vapor component setup() returned non-block value, and has no render function.`,
)
instance.block = []
const setupResult =
setupFn &&
callWithErrorHandling(setupFn, instance, ErrorCodes.SETUP_FUNCTION, [
instance.props,
instance,
])

if (__DEV__) {
if (isFunction(component) || !component.render) {
instance.block = normalizeNode(setupResult)
} else {
instance.devtoolsRawSetupState = setupResult
// TODO make the proxy warn non-existent property access during dev
instance.setupState = proxyRefs(setupResult)
instance.setupState = proxyRefs(
(instance.devtoolsRawSetupState = setupResult || EMPTY_OBJ),
)
devRender(instance)

// HMR
@@ -247,7 +242,7 @@ export function createComponent(
)
} else {
// in prod result can only be block
instance.block = setupResult as Block
instance.block = normalizeNode(setupResult)
}
}

23 changes: 23 additions & 0 deletions packages/runtime-vapor/src/dom/node.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import { type Block, VaporFragment, isBlock } from '../block'
import { isArray } from '@vue/shared'

/*! #__NO_SIDE_EFFECTS__ */
export function createTextNode(value = ''): Text {
return document.createTextNode(value)
@@ -27,3 +30,23 @@ export function nthChild(node: Node, i: number): Node {
export function next(node: Node): Node {
return node.nextSibling!
}

type NodeChildAtom = Node | string | number | boolean | null | undefined | void

export type NodeArrayChildren = Array<NodeArrayChildren | NodeChildAtom>

export type NodeChild = NodeChildAtom | NodeArrayChildren

export function normalizeNode(node: NodeChild): Block {
if (node == null || typeof node === 'boolean') {
return []
} else if (isArray(node) && node.length) {
// fragment
return new VaporFragment(node.map(normalizeNode))
} else if (isBlock(node)) {
return node
} else {
// strings and numbers
return createTextNode(String(node))
}
}