Skip to content

fix(Container): Fix unmapped components silently do nothing #88

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(Container): Fix unmapped components silently do nothing #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/components/Container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ export class Container<P extends ContainerProperties, S extends ContainerState>

if (ItemComponent) {
childComponents.push(this.connectComponentWithItem(ItemComponent, itemProps, itemKey));
} else {
console.warn(
`The server responded an item with cqType "${itemProps.cqType}" but there is no component mapped to that cqType.
Do you have a call to MapTo for that cqType? Is that code reached (eg. imported) by ui.frontend/src/index.tsx?
More info on "Map SPA components to AEM components" at https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-with-aem-headless/spa-editor/react/map-components.html`)
}
}
});
Expand Down
28 changes: 28 additions & 0 deletions test/components/Container.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
*/

import React, { Component } from 'react';
import { waitFor } from '@testing-library/dom';
import ReactDOM from 'react-dom';
import { ComponentMapping, MappedComponentProperties } from '../../src/ComponentMapping';
import { Container } from '../../src/components/Container';
Expand Down Expand Up @@ -55,6 +56,7 @@ describe('Container ->', () => {

beforeEach(() => {
ComponentMappingSpy = jest.spyOn(ComponentMapping, 'get');

rootNode = document.createElement('div');
rootNode.className = ROOT_CLASS_NAME;
document.body.appendChild(rootNode);
Expand Down Expand Up @@ -116,6 +118,32 @@ describe('Container ->', () => {
expect(childItem1).toBeDefined();
expect(childItem2).toBeDefined();
});

it('should log warning when there is no component mapped to the cqType', async () => {
// given
ComponentMappingSpy.mockReturnValue(undefined);

const errorMessageC1 =
`The server responded an item with cqType "components/c1" but there is no component mapped to that cqType.
Do you have a call to MapTo for that cqType? Is that code reached (eg. imported) by ui.frontend/src/index.tsx?
More info on "Map SPA components to AEM components" at https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-with-aem-headless/spa-editor/react/map-components.html`; // eslint-disable-line max-len

const errorMessageC2 =
`The server responded an item with cqType "components/c2" but there is no component mapped to that cqType.
Do you have a call to MapTo for that cqType? Is that code reached (eg. imported) by ui.frontend/src/index.tsx?
More info on "Map SPA components to AEM components" at https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-with-aem-headless/spa-editor/react/map-components.html`; // eslint-disable-line max-len

console.warn = jest.fn();

// when
// @ts-ignore
ReactDOM.render(<Container componentMapping={ComponentMapping} cqItems={ITEMS} cqItemsOrder={ITEMS_ORDER} cqPath={''} isInEditor={false}/>, rootNode);

// then
await waitFor(() => expect(console.warn).toHaveBeenCalledWith(errorMessageC1));
await waitFor(() => expect(console.warn).toHaveBeenCalledWith(errorMessageC2));
});

});

describe('Data attributes ->', () => {
Expand Down