fix: stop stubs leaking with localVue (#1056)

Author: eddyerburgh

Diff for: packages/create-instance/add-hook.js

@@ -1,12 +1,11 @@
-import { addHook } from './add-hook'
+import { BEFORE_RENDER_LIFECYCLE_HOOK } from 'shared/consts'
 
 export function addStubs (_Vue, stubComponents) {
   function addStubComponentsMixin () {
     Object.assign(this.$options.components, stubComponents)
   }
 
-  addHook(_Vue.options, 'beforeMount', addStubComponentsMixin)
-  // beforeCreate is for components created in node, which
-  // never mount
-  addHook(_Vue.options, 'beforeCreate', addStubComponentsMixin)
+  _Vue.mixin({
+    [BEFORE_RENDER_LIFECYCLE_HOOK]: addStubComponentsMixin
+  })
 }

Diff for: packages/create-instance/add-stubs.js

@@ -1,5 +1,4 @@
 // @flow
-import { addHook } from './add-hook'
 
 export function logEvents (
   vm: Component,
@@ -15,10 +14,11 @@ export function logEvents (
 }
 
 export function addEventLogger (_Vue: Component): void {
-  addHook(_Vue.options, 'beforeCreate', function () {
-    this.__emitted = Object.create(null)
-    this.__emittedByOrder = []
-    logEvents(this, this.__emitted, this.__emittedByOrder)
-  }
-  )
+  _Vue.mixin({
+    beforeCreate: function () {
+      this.__emitted = Object.create(null)
+      this.__emittedByOrder = []
+      logEvents(this, this.__emitted, this.__emittedByOrder)
+    }
+  })
 }

Diff for: packages/create-instance/log-events.js

@@ -1,8 +1,8 @@
 import { createStubFromComponent } from './create-component-stubs'
 import { resolveComponent, semVerGreaterThan } from 'shared/util'
 import { isReservedTag } from 'shared/validators'
-import { addHook } from './add-hook'
 import Vue from 'vue'
+import { BEFORE_RENDER_LIFECYCLE_HOOK } from 'shared/consts'
 
 const isWhitelisted = (el, whitelist) => resolveComponent(el, whitelist)
 const isAlreadyStubbed = (el, stubs) => stubs.has(el)
@@ -11,9 +11,6 @@ const isDynamicComponent = cmp => typeof cmp === 'function' && !cmp.cid
 const CREATE_ELEMENT_ALIAS = semVerGreaterThan(Vue.version, '2.1.5')
   ? '_c'
   : '_h'
-const LIFECYCLE_HOOK = semVerGreaterThan(Vue.version, '2.1.8')
-  ? 'beforeCreate'
-  : 'beforeMount'
 
 function shouldExtend (component, _Vue) {
   return (
@@ -126,5 +123,7 @@ export function patchRender (_Vue, stubs, stubAllComponents) {
     vm.$createElement = createElement
   }
 
-  addHook(_Vue.options, LIFECYCLE_HOOK, patchRenderMixin)
+  _Vue.mixin({
+    [BEFORE_RENDER_LIFECYCLE_HOOK]: patchRenderMixin
+  })
 }

Diff for: packages/create-instance/patch-render.js

@@ -1,4 +1,5 @@
 import Vue from 'vue'
+import { semVerGreaterThan } from './util'
 
 export const NAME_SELECTOR = 'NAME_SELECTOR'
 export const COMPONENT_SELECTOR = 'COMPONENT_SELECTOR'
@@ -10,3 +11,8 @@ export const VUE_VERSION = Number(
 )
 export const FUNCTIONAL_OPTIONS =
   VUE_VERSION >= 2.5 ? 'fnOptions' : 'functionalOptions'
+
+export const BEFORE_RENDER_LIFECYCLE_HOOK =
+  semVerGreaterThan(Vue.version, '2.1.8')
+    ? 'beforeCreate'
+    : 'beforeMount'

Diff for: packages/test-utils/src/consts.js renamed to packages/shared/consts.js

@@ -5,7 +5,7 @@ import {
   DOM_SELECTOR,
   REF_SELECTOR,
   COMPONENT_SELECTOR
-} from './consts'
+} from 'shared/consts'
 import { throwError, vueVersion } from 'shared/util'
 import { matches } from './matches'
 

Diff for: packages/test-utils/src/find.js

@@ -13,7 +13,7 @@ import {
   NAME_SELECTOR,
   DOM_SELECTOR,
   INVALID_SELECTOR
-} from './consts'
+} from 'shared/consts'
 
 function getSelectorType (
   selector: Selector

Diff for: packages/test-utils/src/get-selector.js

@@ -2,7 +2,7 @@ import {
   DOM_SELECTOR,
   COMPONENT_SELECTOR,
   FUNCTIONAL_OPTIONS
-} from './consts'
+} from 'shared/consts'
 
 export function vmMatchesName (vm, name) {
   return !!name && (

Diff for: packages/test-utils/src/matches.js

@@ -1,6 +1,6 @@
 // @flow
 
-import { VUE_VERSION } from './consts'
+import { VUE_VERSION } from 'shared/consts'
 
 function setDepsSync (dep): void {
   dep.subs.forEach(setWatcherSync)

Diff for: packages/test-utils/src/set-watchers-to-sync.js

@@ -5,7 +5,7 @@ import getSelector from './get-selector'
 import {
   REF_SELECTOR,
   FUNCTIONAL_OPTIONS
-} from './consts'
+} from 'shared/consts'
 import config from './config'
 import WrapperArray from './wrapper-array'
 import ErrorWrapper from './error-wrapper'

Diff for: packages/test-utils/src/wrapper.js

@@ -4,7 +4,7 @@ import {
   isRunningPhantomJS,
   vueVersion
 } from '~resources/utils'
-import { createLocalVue } from '~vue/test-utils'
+import { createLocalVue, shallowMount, mount } from '~vue/test-utils'
 import { itSkipIf, itRunIf, itDoNotRunIf } from 'conditional-specs'
 import Vuex from 'vuex'
 
@@ -196,4 +196,21 @@ describeWithMountingMethods('options.localVue', mountingMethod => {
       }
       expect(wrapper.findAll(ChildComponent).length).to.equal(1)
     })
+
+  itRunIf(
+    mountingMethod.name === 'mount',
+    'does not affect future tests', () => {
+      const ChildComponent = {
+        template: '<span></span>'
+      }
+      const TestComponent = {
+        template: '<child-component />',
+        components: { ChildComponent }
+      }
+      const localVue = createLocalVue()
+      localVue.use(Vuex)
+      shallowMount(TestComponent, { localVue })
+      const wrapper = mount(TestComponent, { localVue })
+      expect(wrapper.html()).to.contain('span')
+    })
 })