feat(portal): SSR support for portal disabled prop

yyx990803 · yyx990803 · commit 9ed9bf3687a7 · 2020-03-30T11:24:29.000-04:00
diff --git a/packages/compiler-core/src/utils.ts b/packages/compiler-core/src/utils.ts
@@ -184,13 +184,14 @@ export function findDir(
 export function findProp(
   node: ElementNode,
   name: string,
-  dynamicOnly: boolean = false
+  dynamicOnly: boolean = false,
+  allowEmpty: boolean = false
 ): ElementNode['props'][0] | undefined {
   for (let i = 0; i < node.props.length; i++) {
     const p = node.props[i]
     if (p.type === NodeTypes.ATTRIBUTE) {
       if (dynamicOnly) continue
-      if (p.name === name && p.value) {
+      if (p.name === name && (p.value || allowEmpty)) {
         return p
       }
     } else if (p.name === 'bind' && p.exp && isBindKey(p.arg, name)) {
diff --git a/packages/compiler-ssr/__tests__/ssrPortal.spec.ts b/packages/compiler-ssr/__tests__/ssrPortal.spec.ts
@@ -9,8 +9,33 @@ describe('ssr compile: portal', () => {
       return function ssrRender(_ctx, _push, _parent) {
         _ssrRenderPortal(_push, (_push) => {
           _push(\`<div></div>\`)
-        }, _ctx.target, _parent)
+        }, _ctx.target, false, _parent)
       }"
     `)
   })
+
+  test('disabled prop handling', () => {
+    expect(compile(`<portal :target="target" disabled><div/></portal>`).code)
+      .toMatchInlineSnapshot(`
+    "const { ssrRenderPortal: _ssrRenderPortal } = require(\\"@vue/server-renderer\\")
+
+    return function ssrRender(_ctx, _push, _parent) {
+      _ssrRenderPortal(_push, (_push) => {
+        _push(\`<div></div>\`)
+      }, _ctx.target, true, _parent)
+    }"
+  `)
+
+    expect(
+      compile(`<portal :target="target" :disabled="foo"><div/></portal>`).code
+    ).toMatchInlineSnapshot(`
+    "const { ssrRenderPortal: _ssrRenderPortal } = require(\\"@vue/server-renderer\\")
+
+    return function ssrRender(_ctx, _push, _parent) {
+      _ssrRenderPortal(_push, (_push) => {
+        _push(\`<div></div>\`)
+      }, _ctx.target, _ctx.foo, _parent)
+    }"
+  `)
+  })
 })
diff --git a/packages/compiler-ssr/src/transforms/ssrTransformPortal.ts b/packages/compiler-ssr/src/transforms/ssrTransformPortal.ts
@@ -1,11 +1,11 @@
 import {
   ComponentNode,
   findProp,
-  JSChildNode,
   NodeTypes,
   createSimpleExpression,
   createFunctionExpression,
-  createCallExpression
+  createCallExpression,
+  ExpressionNode
 } from '@vue/compiler-dom'
 import {
   SSRTransformContext,
@@ -27,12 +27,14 @@ export function ssrProcessPortal(
     return
   }
 
-  let target: JSChildNode
-  if (targetProp.type === NodeTypes.ATTRIBUTE && targetProp.value) {
-    target = createSimpleExpression(targetProp.value.content, true)
-  } else if (targetProp.type === NodeTypes.DIRECTIVE && targetProp.exp) {
-    target = targetProp.exp
+  let target: ExpressionNode | undefined
+  if (targetProp.type === NodeTypes.ATTRIBUTE) {
+    target =
+      targetProp.value && createSimpleExpression(targetProp.value.content, true)
   } else {
+    target = targetProp.exp
+  }
+  if (!target) {
     context.onError(
       createSSRCompilerError(
         SSRErrorCodes.X_SSR_NO_PORTAL_TARGET,
@@ -42,6 +44,13 @@ export function ssrProcessPortal(
     return
   }
 
+  const disabledProp = findProp(node, 'disabled', false, true /* allow empty */)
+  const disabled = disabledProp
+    ? disabledProp.type === NodeTypes.ATTRIBUTE
+      ? `true`
+      : disabledProp.exp || `false`
+    : `false`
+
   const contentRenderFn = createFunctionExpression(
     [`_push`],
     undefined, // Body is added later
@@ -55,6 +64,7 @@ export function ssrProcessPortal(
       `_push`,
       contentRenderFn,
       target,
+      disabled,
       `_parent`
     ])
   )
diff --git a/packages/runtime-core/src/components/Portal.ts b/packages/runtime-core/src/components/Portal.ts
@@ -23,6 +23,9 @@ export const enum PortalMoveTypes {
   REORDER // moved in the main view
 }
 
+const isDisabled = (props: VNode['props']): boolean =>
+  props && (props.disabled || props.disabled === '')
+
 const movePortal = (
   vnode: VNode,
   container: RendererElement,
@@ -43,7 +46,7 @@ const movePortal = (
   // if this is a re-order and portal is enabled (content is in target)
   // do not move children. So the opposite is: only move children if this
   // is not a reorder, or the portal is disabled
-  if (!isReorder || (props && props.disabled)) {
+  if (!isReorder || isDisabled(props)) {
     // Portal has either Array children or no children.
     if (shapeFlag & ShapeFlags.ARRAY_CHILDREN) {
       for (let i = 0; i < (children as VNode[]).length; i++) {
@@ -83,7 +86,7 @@ export const PortalImpl = {
     } = internals
 
     const targetSelector = n2.props && n2.props.target
-    const disabled = n2.props && n2.props.disabled
+    const disabled = isDisabled(n2.props)
     const { shapeFlag, children } = n2
     if (n1 == null) {
       if (__DEV__ && isString(targetSelector) && !querySelector) {
@@ -140,7 +143,7 @@ export const PortalImpl = {
       const mainAnchor = (n2.anchor = n1.anchor)!
       const target = (n2.target = n1.target)!
       const targetAnchor = (n2.targetAnchor = n1.targetAnchor)!
-      const wasDisabled = n1.props && n1.props.disabled
+      const wasDisabled = isDisabled(n1.props)
       const currentContainer = wasDisabled ? container : target
       const currentAnchor = wasDisabled ? mainAnchor : targetAnchor
 
diff --git a/packages/server-renderer/__tests__/ssrPortal.spec.ts b/packages/server-renderer/__tests__/ssrPortal.spec.ts
@@ -17,16 +17,42 @@ describe('ssrRenderPortal', () => {
               _push(`<div>content</div>`)
             },
             '#target',
+            false,
             _parent
           )
         }
       }),
       ctx
     )
-    expect(html).toBe('<!--portal-->')
+    expect(html).toBe('<!--portal start--><!--portal end-->')
     expect(ctx.portals!['#target']).toBe(`<div>content</div><!---->`)
   })
 
+  test('portal rendering (compiled + disabled)', async () => {
+    const ctx: SSRContext = {}
+    const html = await renderToString(
+      createApp({
+        data() {
+          return { msg: 'hello' }
+        },
+        ssrRender(_ctx, _push, _parent) {
+          ssrRenderPortal(
+            _push,
+            _push => {
+              _push(`<div>content</div>`)
+            },
+            '#target',
+            true,
+            _parent
+          )
+        }
+      }),
+      ctx
+    )
+    expect(html).toBe('<!--portal start--><div>content</div><!--portal end-->')
+    expect(ctx.portals!['#target']).toBe(`<!---->`)
+  })
+
   test('portal rendering (vnode)', async () => {
     const ctx: SSRContext = {}
     const html = await renderToString(
@@ -39,10 +65,27 @@ describe('ssrRenderPortal', () => {
       ),
       ctx
     )
-    expect(html).toBe('<!--portal-->')
+    expect(html).toBe('<!--portal start--><!--portal end-->')
     expect(ctx.portals!['#target']).toBe('<span>hello</span><!---->')
   })
 
+  test('portal rendering (vnode + disabled)', async () => {
+    const ctx: SSRContext = {}
+    const html = await renderToString(
+      h(
+        Portal,
+        {
+          target: `#target`,
+          disabled: true
+        },
+        h('span', 'hello')
+      ),
+      ctx
+    )
+    expect(html).toBe('<!--portal start--><span>hello</span><!--portal end-->')
+    expect(ctx.portals!['#target']).toBe(`<!---->`)
+  })
+
   test('multiple portals with same target', async () => {
     const ctx: SSRContext = {}
     const html = await renderToString(
@@ -58,7 +101,9 @@ describe('ssrRenderPortal', () => {
       ]),
       ctx
     )
-    expect(html).toBe('<div><!--portal--><!--portal--></div>')
+    expect(html).toBe(
+      '<div><!--portal start--><!--portal end--><!--portal start--><!--portal end--></div>'
+    )
     expect(ctx.portals!['#target']).toBe(
       '<span>hello</span><!---->world<!---->'
     )
diff --git a/packages/server-renderer/src/helpers/ssrRenderPortal.ts b/packages/server-renderer/src/helpers/ssrRenderPortal.ts
@@ -1,25 +1,42 @@
 import { ComponentInternalInstance, ssrContextKey } from 'vue'
-import { SSRContext, createBuffer, PushFn } from '../renderToString'
+import {
+  SSRContext,
+  createBuffer,
+  PushFn,
+  SSRBufferItem
+} from '../renderToString'
 
 export function ssrRenderPortal(
   parentPush: PushFn,
   contentRenderFn: (push: PushFn) => void,
   target: string,
+  disabled: boolean,
   parentComponent: ComponentInternalInstance
 ) {
-  parentPush('<!--portal-->')
-  const { getBuffer, push } = createBuffer()
-  contentRenderFn(push)
-  push(`<!---->`) // portal end anchor
+  parentPush('<!--portal start-->')
+
+  let portalContent: SSRBufferItem
+
+  if (disabled) {
+    contentRenderFn(parentPush)
+    portalContent = `<!---->`
+  } else {
+    const { getBuffer, push } = createBuffer()
+    contentRenderFn(push)
+    push(`<!---->`) // portal end anchor
+    portalContent = getBuffer()
+  }
 
   const context = parentComponent.appContext.provides[
     ssrContextKey as any
   ] as SSRContext
   const portalBuffers =
     context.__portalBuffers || (context.__portalBuffers = {})
   if (portalBuffers[target]) {
-    portalBuffers[target].push(getBuffer())
+    portalBuffers[target].push(portalContent)
   } else {
-    portalBuffers[target] = [getBuffer()]
+    portalBuffers[target] = [portalContent]
   }
+
+  parentPush('<!--portal end-->')
 }
diff --git a/packages/server-renderer/src/renderToString.ts b/packages/server-renderer/src/renderToString.ts
@@ -366,6 +366,7 @@ function renderPortalVNode(
   parentComponent: ComponentInternalInstance
 ) {
   const target = vnode.props && vnode.props.target
+  const disabled = vnode.props && vnode.props.disabled
   if (!target) {
     warn(`[@vue/server-renderer] Portal is missing target prop.`)
     return []
@@ -386,6 +387,7 @@ function renderPortalVNode(
       )
     },
     target,
+    disabled || disabled === '',
     parentComponent
   )
 }

Original file line number	Diff line number	Diff line change
`@@ -366,6 +366,7 @@ function renderPortalVNode(`
`366`	`366`	`parentComponent: ComponentInternalInstance`
`367`	`367`	`) {`
`368`	`368`	`const target = vnode.props && vnode.props.target`
	`369`	`+ const disabled = vnode.props && vnode.props.disabled`
`369`	`370`	`if (!target) {`
`370`	`371`	warn(`[@vue/server-renderer] Portal is missing target prop.`)
`371`	`372`	`return []`
`@@ -386,6 +387,7 @@ function renderPortalVNode(`
`386`	`387`	`)`
`387`	`388`	`},`
`388`	`389`	`target,`
	`390`	`+ disabled \|\| disabled === '',`
`389`	`391`	`parentComponent`
`390`	`392`	`)`
`391`	`393`	`}`