feat: Implement `transformItems` API #3042

francoischalifour · 2018-07-23T11:38:40Z

This adds support for the transformItems option on widgets.

How

The implementation was made at the connector level for the following reasons:

The transformation takes place before the rendering
Leverage the transformItems API in all flavors (since the connectors are/will be shared across InstantSearch libraries)

How to review

Each commit is a widget implementation. Click on the commit and add your review there.

See commits →

Supported widgets

These widgets have been selected based on whether they contain items and based on the current React InstantSearch API. Let me know if this list should be updated.

See all InstantSearch.js widgets →

React InstantSearch widgets implementing transformItems

Breadcrumb
ClearRefinements
CurrentRefinements
HierarchicalMenu
HitsPerPage
Menu
MenuSelect
NumericMenu
RefinementList
SortBy

Closes #2949

algobot · 2018-07-23T11:42:22Z

Deploy preview for algolia-instantsearch ready!

Built with commit 7c10a17

https://deploy-preview-3042--algolia-instantsearch.netlify.com

francoischalifour · 2018-07-25T14:35:20Z

Ready for review @algolia/instantsearch-for-websites.

I can cherry pick my commits to create several PRs if it makes it easier.

bobylito

Look goods. I have some questions on the hits/infiniteHits implementations. Also could you remove sinon from the test files you've modified? That'd be awesome :)

bobylito · 2018-07-27T14:21:47Z

src/connectors/hits-per-page/connectHitsPerPage.js

@@ -192,7 +194,7 @@ The first one will be picked, you should probably set only one default value`
        );
      },

-      _transformItems({ hitsPerPage }) {
+      _normalizeItems({ hitsPerPage }) {


Yes good move 👍

bobylito · 2018-07-27T14:24:10Z

src/connectors/hits/connectHits.js

-      if (widgetParams.escapeHits && results.hits && results.hits.length > 0) {
-        results.hits = escapeHits(results.hits);
+      if (results.hits && results.hits.length > 0) {
+        if (typeof widgetParams.transformItems === 'function') {


Why not provide a default implementation (identity) like in other widget and remove this if statement? Also I'd suggest to test the type sooner at the initialization.

Glad you caught that. I wasn't sure if I should have updated the code flow of the connector or should have adapted my code on the existing flow.

bobylito · 2018-07-27T14:24:43Z

src/connectors/infinite-hits/connectInfiniteHits.js

-        ) {
-          results.hits = escapeHits(results.hits);
+        if (results.hits && results.hits.length > 0) {
+          if (typeof widgetParams.transformItems === 'function') {


Same remarks than in the hits connector.

bobylito · 2018-07-27T14:28:42Z

src/connectors/menu/__tests__/connectMenu-test.js

+    });
+
+    const helper = jsHelper({}, '', widget.getConfiguration({}));
+    helper.search = sinon.stub();


When we touch a test file that is still using sinon, we try to take the opportunity to replace it with Jest mocks. Can you do that? 🙏

For sure! I initially didn't want to edit too much code as it was intended to be merged on the yet-to-be consequent feat/3.0 branch.

…Items`

francoischalifour · 2018-07-30T11:52:08Z

Tests have been migrated to Jest but rely on #3045.

bobylito · 2018-07-30T13:50:48Z

Tests have been migrated to Jest but rely on #3045.

merged :)

bobylito

Good work! Thanks for taking the time to remove sinon. I think we could do better in the usage of jest but that's fine for now.

<a name=2.10.0></a> # [2.10.0](v2.9.0...v2.10.0) (2018-08-07) ### Features * Implement API ([#3042](#3042)) ([1510a94](1510a94))

<a name=2.10.0></a> # [2.10.0](v2.9.0...v2.10.0) (2018-08-08) ### Bug Fixes * **release:** provide interactive TTY for npm publish ([#3053](#3053)) ([ede9460](ede9460)) ### Features * Implement API ([#3042](#3042)) ([1510a94](1510a94))

francoischalifour added Design: API in progress Scope: Widgets Scope: Connectors labels Jul 23, 2018

francoischalifour force-pushed the feat/transform-items branch 3 times, most recently from c49dfb2 to cfcc2c0 Compare July 25, 2018 14:30

francoischalifour removed the in progress label Jul 25, 2018

francoischalifour requested a review from a team July 25, 2018 14:33

francoischalifour changed the base branch from feat/3.0 to develop July 25, 2018 14:38

francoischalifour force-pushed the feat/transform-items branch 2 times, most recently from 16ec292 to c2bddd2 Compare July 25, 2018 14:44

francoischalifour added 13 commits July 25, 2018 17:09

feat(infinite-hits): implement transformItems

8623d6e

feat(hits): implement transformItems

56da733

feat(breadcrumb): implement transformItems

85033ec

feat(hierarchical-menu): implement transformItems

f5aec2e

feat(menu): implement transformItems

e9b2d4c

feat(menu-select): implement transformItems

e55dba2

feat(refinement-list): implement transformItems

1818edb

feat(geo-search): implement transformItems

526d308

feat(sort-by): implement transformItems

c898c4a

feat(hits-per-page): implement transformItems

ee19dd7

feat(current-refined-values): implement transformItems

93e7af4

feat(numeric-refinement-list): implement transformItems

b0f8611

feat(numeric-selector): implement transformItems

63840dc

francoischalifour force-pushed the feat/transform-items branch from c2bddd2 to 63840dc Compare July 25, 2018 15:10

bobylito reviewed Jul 27, 2018

View reviewed changes

francoischalifour added 11 commits July 27, 2018 17:01

refactor(hits): use default identity function for transformItems

01e3bb4

refactor(infinite-hits): use default identity function for `transform…

ca82ede

…Items`

test(hits-per-page): migrate to Jest

547f028

test(menu): migrate to Jest

b23df37

test(numeric-refinement-list): migrate to Jest

7ffc09b

test(sort-by-selector): migrate to Jest

d74fe50

test(infinite-hits): migrate to Jest

9dd9064

test(refinement-list): migrate to Jest

54b30cf

test(hits): migrate to Jest

80ad6e5

test(hierarchical-menu): migrate to Jest

a8e58b3

test(current-refined-values): migrate to Jest and remove Lodash imports

dcaf3ca

bobylito and others added 2 commits July 30, 2018 15:50

Merge branch 'develop' into feat/transform-items

4be30e9

test(refinement-list): update snapshots

7c10a17

bobylito approved these changes Aug 7, 2018

View reviewed changes

bobylito merged commit 1510a94 into develop Aug 7, 2018

bobylito deleted the feat/transform-items branch August 7, 2018 09:03

bobylito pushed a commit that referenced this pull request Aug 7, 2018

v2.10.0

8390c17

<a name=2.10.0></a> # [2.10.0](v2.9.0...v2.10.0) (2018-08-07) ### Features * Implement API ([#3042](#3042)) ([1510a94](1510a94))

Haroenv mentioned this pull request Aug 10, 2018

feat: add transformItems to all widgets algolia/instantsearch-specs#66

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement `transformItems` API #3042

feat: Implement `transformItems` API #3042

francoischalifour commented Jul 23, 2018 •

edited

Loading

algobot commented Jul 23, 2018 •

edited

Loading

francoischalifour commented Jul 25, 2018

bobylito left a comment

bobylito Jul 27, 2018

bobylito Jul 27, 2018

francoischalifour Jul 27, 2018

bobylito Jul 27, 2018

bobylito Jul 27, 2018

francoischalifour Jul 27, 2018

francoischalifour commented Jul 30, 2018 •

edited

Loading

bobylito commented Jul 30, 2018

bobylito left a comment

feat: Implement transformItems API #3042

feat: Implement transformItems API #3042

Conversation

francoischalifour commented Jul 23, 2018 • edited Loading

How

How to review

Supported widgets

algobot commented Jul 23, 2018 • edited Loading

francoischalifour commented Jul 25, 2018

bobylito left a comment

Choose a reason for hiding this comment

bobylito Jul 27, 2018

Choose a reason for hiding this comment

bobylito Jul 27, 2018

Choose a reason for hiding this comment

francoischalifour Jul 27, 2018

Choose a reason for hiding this comment

bobylito Jul 27, 2018

Choose a reason for hiding this comment

bobylito Jul 27, 2018

Choose a reason for hiding this comment

francoischalifour Jul 27, 2018

Choose a reason for hiding this comment

francoischalifour commented Jul 30, 2018 • edited Loading

bobylito commented Jul 30, 2018

bobylito left a comment

Choose a reason for hiding this comment

feat: Implement `transformItems` API #3042

feat: Implement `transformItems` API #3042

francoischalifour commented Jul 23, 2018 •

edited

Loading

algobot commented Jul 23, 2018 •

edited

Loading

francoischalifour commented Jul 30, 2018 •

edited

Loading