chore(test): use real search-insights to test the insights middleware

[eunjae-lee]

Summary

This PR adds the real search-insights library as a devDependency and uses it to test the insights middleware.
Before, we've been using a fake insightsClient which is just a shell with some mocked methods.
However the fake insightsClient mimiking the behavior of search-insights could lead to false positive situations.
Before we end up implementing all the logic into the fake insightsClient, we'd better use the real library.

Result

It works the same as before.

[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 2ad3cc0:

Sandbox	Source
InstantSearch.js	Configuration

[eunjae-lee]

The change in this test case is technically a breaking change, but the previous behavior was wrong. If user calls init twice, the second init shouldn't override the previous usertoken with anonymous usertoken (ref: algolia/search-insights.js#251)

[tkrugg]

this is great 👍
Left one comment, I'm thinking maybe there are more part of the library we can use off the source instead of mocking them here: eg processQueue, getFunctionInterface

[tkrugg]

In the same spirit of now having to rewrite insights logic here, shouldn't we get some of theses fonctions from the lib ? https://github.com/algolia/search-insights.js/blob/6c58e24abdc8cb7cb334b067a743619c28469db4/lib/_processQueue.ts

[eunjae-lee]

rel: algolia/search-insights.js#252 (comment)

I'm trying to import directly from the source. I need to do something with the jest configuration. Applying many different suggestions online is not working well 😅 I might try more.

[Haroenv]

this is perfect!

[Haroenv]

ts seems to fail because of things in node_modules. possibly fixable like this? microsoft/TypeScript#17042 (comment) (considering we likely don't want to check here), or is it possible to do skipLibCheck for imports from within tests only?

[eunjae-lee]

ts seems to fail because of things in node_modules. possibly fixable like this? microsoft/TypeScript#17042 (comment) (considering we likely don't want to check here), or is it possible to do skipLibCheck for imports from within tests only?

it's probably about jest + ts + esm combination.

jestjs/jest#9860
jestjs/jest#9395

[eunjae-lee]

I've tried

// jest.config.js

  transform: {
    '<rootDir>/scripts/jest/setupTests.ts': 'ts-jest',
    'node_modules/search-insights/.+\\.(j|t)sx?$': 'ts-jest',
  },
  transformIgnorePatterns: [
    '<rootDir>/scripts/jest/setupTests.ts',
    'node_modules/search-insights/.+\\.(j|t)sx?$',
  ],

yarn test --testPathPattern src/middlewares/__tests__/createInsightsMiddleware.ts

and got

    Jest encountered an unexpected token

    This usually means that you are trying to import a file which Jest cannot parse, e.g. it's not plain JavaScript.

    By default, if Jest sees a Babel config, it will use that to transform your files, ignoring "node_modules".

    Here's what you can do:
     • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
     • If you need a custom transformation specify a "transform" option in your config.
     • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

    You'll find more details and examples of these config options in the docs:
    https://jestjs.io/docs/en/configuration.html

    Details:

    /Users/eunjaelee/workspace/instantsearch.js/scripts/jest/setupTests.ts:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,global,jest){import Enzyme from 'enzyme';
                                                                                             ^^^^^^

    SyntaxError: Cannot use import statement outside a module

      at Runtime.createScriptFromCode (node_modules/jest-runtime/build/index.js:1059:14)
          at Array.forEach (<anonymous>)

I'm stuck with setupTests.ts` file at the moment.

• SyntaxError: Cannot use import statement outside a module jestjs/jest#9395 (comment)
• https://stackoverflow.com/questions/61781271/jest-wont-transform-the-module-syntaxerror-cannot-use-import-statement-outsi

[Haroenv]

seeing the ts fail, I wonder if skipLibFiles should be true

[Haroenv]

lgtm pending this :)

[eunjae-lee]

updated 2ad3cc0