Skip to content

fix(stubs): function in props should be rendered as a deterministic string #1237

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

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions packages/create-instance/create-component-stubs.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import {
} from '../shared/validators'
import { compileTemplate, compileFromString } from '../shared/compile-template'

const FUNCTION_PLACEHOLDER = '[Function]'

function isVueComponentStub(comp): boolean {
return (comp && comp.template) || isVueComponent(comp)
}
Expand Down Expand Up @@ -98,15 +100,15 @@ export function createStubFromComponent(
{
attrs: componentOptions.functional
? {
...context.props,
...shapeStubProps(context.props),
...context.data.attrs,
class: createClassString(
context.data.staticClass,
context.data.class
)
}
: {
...this.$props
...shapeStubProps(this.$props)
}
},
context ? context.children : this.$options._renderChildren
Expand Down Expand Up @@ -139,6 +141,27 @@ function validateStub(stub) {
}
}

function shapeStubProps(props) {
const shapedProps: Object = {}
for (const propName in props) {
if (typeof props[propName] === 'function') {
shapedProps[propName] = FUNCTION_PLACEHOLDER
continue
}

if (Array.isArray(props[propName])) {
shapedProps[propName] = props[propName].map(value => {
return typeof value === 'function' ? FUNCTION_PLACEHOLDER : value
})
continue
}

shapedProps[propName] = props[propName]
}

return shapedProps
}

export function createStubsFromStubsObject(
originalComponents: Object = {},
stubs: Object,
Expand Down
65 changes: 65 additions & 0 deletions test/specs/mounting-options/stubs.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -546,4 +546,69 @@ describeWithShallowAndMount('options.stub', mountingMethod => {
expect(wrapper.find(ToStub).exists()).to.be.false
expect(wrapper.find(Stub).exists()).to.be.true
})

it('should render functions in props as a deterministic string', () => {
const ChildComponent = {
name: 'child-component',
props: {
foo: {
type: Function,
required: true
},
bar: {
type: Array,
required: true
},
qux: {
type: String,
required: true
}
},
template: '<div />'
}

const FunctionalChildComponent = {
...ChildComponent,
name: 'functional-child-component',
functional: true
}

const ParentComponent = {
components: {
ChildComponent,
FunctionalChildComponent
},
name: 'parent-component',
template: `
<div>
<child-component
:foo="foo"
:bar="bar"
:qux="qux" />
<functional-child-component
:foo="foo"
:bar="bar"
:qux="qux" />
</div>
`,
data() {
return {
foo: () => 42,
bar: [1, 'string', () => true],
qux: 'qux'
}
}
}

const wrapper = mountingMethod(ParentComponent, {
stubs: ['child-component', 'functional-child-component']
})

expect(wrapper.html()).to.equal(
`<div>\n` +
` <child-component-stub foo="[Function]" bar="1,string,[Function]" qux="qux"></child-component-stub>\n` +
` <functional-child-component-stub foo="[Function]" bar="1,string,[Function]" qux="qux"></functional-child-component-stub>\n` +
`</div>`
)
})
})