feat(insights): add tests (4/4)

[eunjae-lee]

Summary

This PR adds test cases for all the related stacked PRs.

• test if insights middleware correct sets up userToken.
• test if insights middleware send event via insightsClient.
• test if insights middleware calls onEvent when it's given.
• test if sendEvent correctly called when widgets refine.
• test if sendEvent exposed to components works fine.
• test if createSendEvent*** helpers work fine.
• test if bindEvent exposed to Hits and InfiniteHits works fine with its listener.

Stacked PRs

1. introduce insights middleware
2. send events from hits and refinementList
3. implement sendEvent in all the connectors
4. add tests ← current

Next Steps

1. Update the documentation

2. When this feature is released and become stable in the future, we need to deprecate

• insightsClient property in instantSearchInstance
• public usage of getInsightsAnonymousUserToken() (now the middleware uses it internally)
• the old way of attaching events on hits

           <button ${instantsearch.insights('clickedObjectIDsAfterSearch', {
             eventName: 'click-result',
             objectIDs: [hit.objectID],
           })}>
             Click event
           </button>
           <button ${instantsearch.insights('convertedObjectIDsAfterSearch', {
             eventName: 'click-result',
             objectIDs: [hit.objectID],
           })}>
             Conversion event
           </button>

and all the helpers and listeners around that function.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d228af5:

Sandbox	Source
InstantSearch.js	Configuration

[Haroenv]

🆒

[Haroenv]

can you add a test that if some other widget causes a rerender, without changing search parameters, that it doesn't get called twice?

[eunjae-lee]

@Haroenv Can you give me an idea? What kind of situation can it be?

Initially I thought of adding a poweredBy widget. But adding a new widget calls scheduleSearch in the end.

Is there a flow where InstantSearch doesn't trigger a search but just trigger a rerender of all widgets?

[Haroenv]

for example adding a widget should indeed not cause a new view event, since the parameters are the same, but since we do a render (do we?), it could send the view event again.

[eunjae-lee]

@Haroenv Oops. I missed this and already merged this PR. I can address it somewhere else.

it could send the view event again.

Then we should somehow compare the search parameters and send view events only when they have changed. Is it similar to what you have in your mind?

[Haroenv]

can this not be local scope in this mock?

[eunjae-lee]

I guess it won't matter much, but do you see any reason for it not to be locally scoped?

[Haroenv]

maybe call this insights in all connectors? It's slightly inconsistent now

[eunjae-lee]

good call. done d228af5

[Haroenv]

tests look fine to me now, would just make the describe titles consistent :)