Skip to content
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.

Sign up for GitHub

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

fix: Snippet config extra params reactivity #1628

Merged
merged 3 commits into from
Oct 3, 2024
Merged

fix: Snippet config extra params reactivity #1628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97d3e28
fix: check if extraParams are really changing
annacv Sep 30, 2024
d60636a
test: refactor tests to avoid repeating stuff
annacv Sep 30, 2024
1c8e58a
feat: update workaround checking params value
annacv Oct 2, 2024
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
122 changes: 55 additions & 67 deletions ...nents/src/x-modules/extra-params/components/__tests__/snippet-config-extra-params.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,56 @@
import { Dictionary } from '@empathyco/x-utils';
import { mount, Wrapper } from '@vue/test-utils';
import { DeepPartial, Dictionary } from '@empathyco/x-utils';
import { createLocalVue, mount, Wrapper } from '@vue/test-utils';
import Vuex, { Store } from 'vuex';
import Vue from 'vue';
import { installNewXPlugin } from '../../../../__tests__/utils';
import { getXComponentXModuleName, isXComponent } from '../../../../components';
import { XPlugin } from '../../../../plugins';
import { WirePayload } from '../../../../wiring';
import { extraParamsXModule } from '../../x-module';
import SnippetConfigExtraParams from '../snippet-config-extra-params.vue';
import { SnippetConfig } from '../../../../x-installer/api/api.types';

describe('testing snippet config extra params component', () => {
function renderSnippetConfigExtraParams({
values,
excludedExtraParams
}: RenderSnippetConfigExtraParamsOptions = {}): RenderSnippetConfigExtraParamsApi {
XPlugin.resetInstance();
const [, localVue] = installNewXPlugin();
XPlugin.registerXModule(extraParamsXModule);
const snippetConfig = Vue.observable({ warehouse: 1234, callbacks: {} });

const wrapper = mount(
{
template: `
<SnippetConfigExtraParams :values="values" :excludedExtraParams="excludedExtraParams"/>
`,
components: {
SnippetConfigExtraParams
},
props: ['values', 'excludedExtraParams'],
provide() {
return {
snippetConfig
};
}
},
{
localVue,
propsData: {
values,
excludedExtraParams
}
}
);

function setSnippetConfig(newValue: Dictionary<unknown>): Promise<void> {
Object.assign(snippetConfig, newValue);
return localVue.nextTick();
import { RootXStoreState } from '../../../../store/index';
import { SnippetConfig } from '../../../../x-installer/index';

function renderSnippetConfigExtraParams({
values = {},
excludedExtraParams = ['callbacks', 'productId', 'uiLang']
}: RenderSnippetConfigExtraParamsOptions = {}): RenderSnippetConfigExtraParamsApi {
const snippetConfig = Vue.observable({ warehouse: 1234, callbacks: {} });
const localVue = createLocalVue();
localVue.use(Vuex);

const store = new Store<DeepPartial<RootXStoreState>>({});
installNewXPlugin({ store }, localVue);
XPlugin.registerXModule(extraParamsXModule);

const extraParamsProvidedCallback: jest.Mock = jest.fn();
XPlugin.bus.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);

const wrapper = mount(SnippetConfigExtraParams, {
localVue,
store,
provide: {
snippetConfig
},
propsData: {
values,
excludedExtraParams
}
});

return {
wrapper: wrapper.findComponent(SnippetConfigExtraParams),
setSnippetConfig
};
async function setSnippetConfig(newValue: Dictionary<unknown>): Promise<void> {
Object.assign(snippetConfig, newValue);
await Vue.nextTick();
}

return {
wrapper: wrapper.findComponent(SnippetConfigExtraParams),
setSnippetConfig,
extraParamsProvidedCallback
};
}

describe('testing snippet config extra params component', () => {
it('is an XComponent which has an XModule', () => {
const { wrapper } = renderSnippetConfigExtraParams();
expect(isXComponent(wrapper.vm)).toEqual(true);
Expand All @@ -62,10 +59,8 @@ describe('testing snippet config extra params component', () => {

// eslint-disable-next-line max-len
it('emits the ExtraParamsProvided event when the component is loaded, when the values prop changes, and when the snippet config changes', async () => {
const { wrapper, setSnippetConfig } = renderSnippetConfigExtraParams();
const extraParamsProvidedCallback = jest.fn();

wrapper.vm.$x.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);
const { wrapper, setSnippetConfig, extraParamsProvidedCallback } =
renderSnippetConfigExtraParams();

expect(extraParamsProvidedCallback).toHaveBeenNthCalledWith<[WirePayload<Dictionary<unknown>>]>(
1,
Expand Down Expand Up @@ -95,11 +90,9 @@ describe('testing snippet config extra params component', () => {

// eslint-disable-next-line max-len
it('emits the ExtraParamsProvided event with the values from the snippet config and the extra params', () => {
const { wrapper } = renderSnippetConfigExtraParams({ values: { scope: 'mobile' } });

const extraParamsProvidedCallback = jest.fn();

wrapper.vm.$x.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);
const { extraParamsProvidedCallback } = renderSnippetConfigExtraParams({
values: { scope: 'mobile' }
});

expect(extraParamsProvidedCallback).toHaveBeenNthCalledWith<[WirePayload<Dictionary<unknown>>]>(
1,
Expand All @@ -111,10 +104,7 @@ describe('testing snippet config extra params component', () => {

// eslint-disable-next-line max-len
it('does not emit ExtraParamsProvided when any no extra params in the snippet config changes', async () => {
const { wrapper, setSnippetConfig } = renderSnippetConfigExtraParams();
const extraParamsProvidedCallback = jest.fn();

wrapper.vm.$x.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);
const { setSnippetConfig, extraParamsProvidedCallback } = renderSnippetConfigExtraParams();

expect(extraParamsProvidedCallback).toHaveBeenNthCalledWith<[WirePayload<Dictionary<unknown>>]>(
1,
Expand All @@ -138,10 +128,7 @@ describe('testing snippet config extra params component', () => {
});

it('not includes the callback configuration as extra params', () => {
const { wrapper } = renderSnippetConfigExtraParams();
const extraParamsProvidedCallback = jest.fn();

wrapper.vm.$x.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);
const { extraParamsProvidedCallback } = renderSnippetConfigExtraParams();

expect(extraParamsProvidedCallback).toHaveBeenNthCalledWith<[WirePayload<Dictionary<unknown>>]>(
1,
Expand All @@ -152,17 +139,14 @@ describe('testing snippet config extra params component', () => {
});

it('allows to configure excluded params', () => {
const { wrapper } = renderSnippetConfigExtraParams({
const { extraParamsProvidedCallback } = renderSnippetConfigExtraParams({
values: {
xEngineId: 'motive',
currency: 'EUR'
},
excludedExtraParams: ['currency', 'warehouse', 'callbacks']
});

const extraParamsProvidedCallback = jest.fn();
wrapper.vm.$x.on('ExtraParamsProvided', true).subscribe(extraParamsProvidedCallback);

expect(extraParamsProvidedCallback).toHaveBeenNthCalledWith<[WirePayload<Dictionary<unknown>>]>(
1,
expect.objectContaining({
Expand Down Expand Up @@ -190,5 +174,9 @@ interface RenderSnippetConfigExtraParamsApi {
/** The wrapper for the snippet config component. */
wrapper: Wrapper<Vue>;
/** Helper method to change the snippet config. */
setSnippetConfig: (newSnippetConfig: Dictionary<unknown>) => void | Promise<void>;
setSnippetConfig: (
newSnippetConfig: Dictionary<unknown>
) => void | Promise<void> /** Jest mock function for the ExtraParamsProvided callback. */;
/** Jest mock function for the ExtraParamsProvided callback. */
extraParamsProvidedCallback: jest.Mock;
}
4 changes: 2 additions & 2 deletions packages/x-components/src/x-modules/extra-params/components/snippet-config-extra-params.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
},
setup(props) {
const snippetConfig = inject('snippetConfig') as SnippetConfig;
const extraParams = ref({});
const extraParams = ref<Record<string, any>>({});

watch(
[() => snippetConfig, () => props.values],
() => {
forEach({ ...props.values, ...snippetConfig }, (name, value) => {
if (!props.excludedExtraParams.includes(name)) {
if (!props.excludedExtraParams.includes(name) && extraParams.value[name] !== value) {
extraParams.value = { ...extraParams.value, [name]: value };
}
});
Expand Down
Loading