Commit dc3394d4 authored by Natalia Tepluhina's avatar Natalia Tepluhina

Merge branch 'docs-remove-create-local-vue-from-apollo-docs' into 'master'

Remove reference to `localVue` in Apollo docs

See merge request gitlab-org/gitlab!74019
parents 8e9b83f5 f2e0d67b
...@@ -1100,17 +1100,15 @@ To test the logic of Apollo cache updates, we might want to mock an Apollo Clien ...@@ -1100,17 +1100,15 @@ To test the logic of Apollo cache updates, we might want to mock an Apollo Clien
To separate tests with mocked client from 'usual' unit tests, create an additional factory and pass the created `mockApollo` as an option to the `createComponent`-factory. This way we only create Apollo Client instance when it's necessary. To separate tests with mocked client from 'usual' unit tests, create an additional factory and pass the created `mockApollo` as an option to the `createComponent`-factory. This way we only create Apollo Client instance when it's necessary.
We need to inject `VueApollo` to the Vue local instance and, likewise, it is recommended to call `localVue.use()` in `createMockApolloProvider()` to only load it when it is necessary. We need to inject `VueApollo` into the Vue instance by calling `Vue.use(VueApollo)`. This will install `VueApollo` globally for all the tests in the file. It is recommended to call `Vue.use(VueApollo)` just after the imports.
```javascript ```javascript
import VueApollo from 'vue-apollo'; import VueApollo from 'vue-apollo';
import { createLocalVue } from '@vue/test-utils'; import Vue from 'vue';
const localVue = createLocalVue(); Vue.use(VueApollo);
function createMockApolloProvider() { function createMockApolloProvider() {
localVue.use(VueApollo);
return createMockApollo(requestHandlers); return createMockApollo(requestHandlers);
} }
...@@ -1118,7 +1116,6 @@ function createComponent(options = {}) { ...@@ -1118,7 +1116,6 @@ function createComponent(options = {}) {
const { mockApollo } = options; const { mockApollo } = options;
... ...
return shallowMount(..., { return shallowMount(..., {
localVue,
apolloProvider: mockApollo, apolloProvider: mockApollo,
... ...
}); });
...@@ -1188,7 +1185,6 @@ describe('Some component', () => { ...@@ -1188,7 +1185,6 @@ describe('Some component', () => {
const { mockApollo } = options; const { mockApollo } = options;
return shallowMount(Index, { return shallowMount(Index, {
localVue,
apolloProvider: mockApollo, apolloProvider: mockApollo,
}); });
} }
...@@ -1275,7 +1271,6 @@ function createComponent(options = {}) { ...@@ -1275,7 +1271,6 @@ function createComponent(options = {}) {
const { mockApollo } = options; const { mockApollo } = options;
return shallowMount(Index, { return shallowMount(Index, {
localVue,
apolloProvider: mockApollo, apolloProvider: mockApollo,
}); });
} }
...@@ -1408,7 +1403,6 @@ const createComponentWithApollo = ({ props = {} } = {}) => { ...@@ -1408,7 +1403,6 @@ const createComponentWithApollo = ({ props = {} } = {}) => {
mockApollo = createMockApollo([], mockResolvers); // resolvers are the second parameter mockApollo = createMockApollo([], mockResolvers); // resolvers are the second parameter
wrapper = shallowMount(MyComponent, { wrapper = shallowMount(MyComponent, {
localVue,
propsData: {}, propsData: {},
apolloProvider: mockApollo, apolloProvider: mockApollo,
// ... // ...
...@@ -1476,7 +1470,6 @@ function createComponent(options = {}) { ...@@ -1476,7 +1470,6 @@ function createComponent(options = {}) {
const { mockApollo } = options; const { mockApollo } = options;
return shallowMount(Index, { return shallowMount(Index, {
localVue,
apolloProvider: mockApollo, apolloProvider: mockApollo,
}); });
} }
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment