feat(rendering): Expose createElement (#85)

* feat: return createElement and Fragment * feat: return createElement and Fragment for fallback * feat: use Renderer * feat: add tests * Update packages/recommend-vdom/src/types/FacetsViewProps.ts Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-vdom/src/types/ViewProps.ts Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * fix: missing import * fix: typings * fix: lint * fix: size limit * fix: add more tests * fix: remove useless if * Update packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/trendingItems.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/trendingItems.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/trendingItems.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/trendingItems.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/trendingItems.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/relatedProducts.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * Update packages/recommend-js/src/__tests__/relatedProducts.test.tsx Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com> * fix: naming in test Co-authored-by: Sarah Dayan <5370675+sarahdayan@users.noreply.github.com>
algolia · Jun 21, 2022 · ea6e668 · ea6e668
1 parent 52a47e9
commit ea6e668
Show file tree

Hide file tree

Showing 15 changed files with 875 additions and 21 deletions.
diff --git a/bundlesize.config.json b/bundlesize.config.json
@@ -6,7 +6,7 @@
     },
     {
       "path": "packages/recommend-js/dist/umd/index.js",
-      "maxSize": "7.30 kB"
+      "maxSize": "7.35 kB"
     },
     {
       "path": "packages/recommend-react/dist/umd/index.js",

diff --git a/packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx b/packages/recommend-js/src/__tests__/frequentlyBoughtTogether.test.tsx
@@ -0,0 +1,207 @@
+/** @jsx h */
+import { ObjectWithObjectID } from '@algolia/client-search';
+import { waitFor, within } from '@testing-library/dom';
+import { h } from 'preact';
+
+import { createMultiSearchResponse } from '../../../../test/utils/createApiResponse';
+import {
+  createRecommendClient,
+  hit,
+} from '../../../../test/utils/createRecommendClient';
+import { frequentlyBoughtTogether } from '../frequentlyBoughtTogether';
+
+function createMockedRecommendClient(recommendations: ObjectWithObjectID[]) {
+  const recommendClient = createRecommendClient({
+    getFrequentlyBoughtTogether: jest.fn(() =>
+      Promise.resolve(
+        createMultiSearchResponse({
+          hits: recommendations,
+        })
+      )
+    ),
+  });
+
+  return recommendClient;
+}
+
+describe('frequentlyBoughtTogether', () => {
+  beforeEach(() => {
+    document.body.innerHTML = '';
+  });
+
+  describe('rendering the header and items', () => {
+    test('renders JSX templates', async () => {
+      const container = document.createElement('div');
+
+      const recommendClient = createMockedRecommendClient(hit.recommendations);
+
+      document.body.appendChild(container);
+
+      frequentlyBoughtTogether<ObjectWithObjectID>({
+        container,
+        recommendClient,
+        indexName: 'products',
+        objectIDs: ['D06270-9132-995'],
+        headerComponent: () => <h1>FBT</h1>,
+        itemComponent: ({ item }) => <div>{item.objectID}</div>,
+      });
+
+      await waitFor(() => {
+        expect(within(container).getAllByRole('listitem')).not.toBeNull();
+        expect(container).toMatchInlineSnapshot(`
+          <div>
+            <section
+              class="auc-Recommend"
+            >
+              <h1>
+                FBT
+              </h1>
+              <div
+                class="auc-Recommend-container"
+              >
+                <ol
+                  class="auc-Recommend-list"
+                >
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    <div>
+                      1
+                    </div>
+                  </li>
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    <div>
+                      2
+                    </div>
+                  </li>
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    <div>
+                      3
+                    </div>
+                  </li>
+                </ol>
+              </div>
+            </section>
+          </div>
+        `);
+      });
+    });
+
+    test('renders using `createElement` and `Fragment`', async () => {
+      const container = document.createElement('div');
+
+      const recommendClient = createMockedRecommendClient(hit.recommendations);
+
+      document.body.appendChild(container);
+
+      frequentlyBoughtTogether<ObjectWithObjectID>({
+        container,
+        recommendClient,
+        indexName: 'products',
+        objectIDs: ['D06270-9132-995'],
+        headerComponent: ({ createElement }) =>
+          createElement('h1', null, 'FBT'),
+        itemComponent: ({ item, createElement, Fragment }) =>
+          createElement(Fragment, null, item.objectID),
+      });
+
+      await waitFor(() => {
+        expect(within(container).getAllByRole('listitem')).not.toBeNull();
+        expect(container).toMatchInlineSnapshot(`
+          <div>
+            <section
+              class="auc-Recommend"
+            >
+              <h1>
+                FBT
+              </h1>
+              <div
+                class="auc-Recommend-container"
+              >
+                <ol
+                  class="auc-Recommend-list"
+                >
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    1
+                  </li>
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    2
+                  </li>
+                  <li
+                    class="auc-Recommend-item"
+                  >
+                    3
+                  </li>
+                </ol>
+              </div>
+            </section>
+          </div>
+        `);
+      });
+    });
+  });
+
+  describe('rendering `fallbackComponent`', () => {
+    test('renders JSX templates', async () => {
+      const container = document.createElement('div');
+
+      const recommendClient = createMockedRecommendClient([]);
+
+      document.body.appendChild(container);
+
+      frequentlyBoughtTogether<ObjectWithObjectID>({
+        container,
+        recommendClient,
+        indexName: 'products',
+        objectIDs: ['D06270-9132-995'],
+        itemComponent: ({ item }) => <div>{item.objectID}</div>,
+        fallbackComponent: () => <div>Fallback component</div>,
+      });
+
+      await waitFor(() => {
+        expect(within(container).getByText('Fallback component'))
+          .toMatchInlineSnapshot(`
+          <div>
+            Fallback component
+          </div>
+        `);
+      });
+    });
+
+    test('renders using `createElement` and `Fragment`', async () => {
+      const container = document.createElement('div');
+
+      const recommendClient = createMockedRecommendClient([]);
+
+      document.body.appendChild(container);
+
+      frequentlyBoughtTogether<ObjectWithObjectID>({
+        container,
+        recommendClient,
+        indexName: 'products',
+        objectIDs: ['D06270-9132-995'],
+        itemComponent: ({ item, createElement }) =>
+          createElement('div', null, item.objectID),
+        fallbackComponent: ({ createElement, Fragment }) =>
+          createElement(Fragment, null, 'Fallback component'),
+      });
+
+      await waitFor(() => {
+        expect(within(container).getByText('Fallback component'))
+          .toMatchInlineSnapshot(`
+          <div>
+            Fallback component
+          </div>
+          `);
+      });
+    });
+  });
+});