Merge #504

504: Fix umd build having no node interop r=bidoubiwa a=bidoubiwa

The bug was caused by changing the rollup typescript from the non-official [`rollup-plugin-typescript2`](https://www.npmjs.com/package/rollup-plugin-typescript2)  to the official one [`@rollup/rollup-typescript](https://github.com/rollup/plugins/tree/master/packages/typescript/#readme).`


Multiple libraries suggesting multiple bundles outputs (umd, cjs, ...) are using rollup-plugin-typescript2. Since some of the issues why we initially used this one were resolved, I made the change to go back to the official one. 
Unfortunately do a lack of tests on the builds themselves I did not realise a new issue was introduced. 

By rollbacking to the initial plugin we used, the problem seems to be fixed. Tests are added to ensure this.

Co-authored-by: Charlotte Vermandel <[email protected]>

Author: bors[bot]

jest.config.js

@@ -1,10 +1,18 @@
+const ignoreFiles = ['<rootDir>/playgrounds', '<rootDir>/tests/assets']
+
 module.exports = {
   verbose: true,
   watchPlugins: [
     'jest-watch-typeahead/filename',
     'jest-watch-typeahead/testname',
   ],
   projects: [
+    {
+      displayName: 'build',
+      testEnvironment: 'node',
+      testPathIgnorePatterns: [...ignoreFiles, '<rootDir>/tests/*.ts'],
+      testMatch: ['**/*.tests.js', '/tests/**/*.js'],
+    },
     {
       globals: {
         'ts-jest': {
@@ -13,14 +21,7 @@ module.exports = {
       },
       preset: 'ts-jest',
       displayName: 'dom',
-      // We are using jest-environment-jsdom 25 until we stop supporting node 10
-      // jest-environment-jsdom 25 uses jsdom 15 which still supports node 10
-      testEnvironment: 'jest-environment-jsdom',
-      testPathIgnorePatterns: [
-        '<rootDir>/tests/env',
-        '<rootDir>/playgrounds',
-        '<rootDir>/tests/assets',
-      ],
+      testPathIgnorePatterns: [...ignoreFiles, '<rootDir>/tests/build*'],
       testMatch: ['**/*.tests.ts', '/tests/**/*.ts'],
     },
     {
@@ -32,11 +33,7 @@ module.exports = {
       preset: 'ts-jest',
       displayName: 'node',
       testEnvironment: 'node',
-      testPathIgnorePatterns: [
-        '<rootDir>/tests/env',
-        '<rootDir>/playgrounds',
-        '<rootDir>/tests/assets',
-      ],
+      testPathIgnorePatterns: [...ignoreFiles],
       testMatch: ['**/*.tests.ts', '/tests/**/*.ts'],
     },
   ],

package.json

@@ -6,11 +6,12 @@
   "scripts": {
     "cleanup": "shx rm -rf dist/",
     "test:watch": "yarn test --watch",
-    "test": "jest --runInBand",
+    "test": "jest --runInBand --selectProjects dom --selectProjects node",
+    "test:build": "yarn build && jest --runInBand --selectProjects build",
     "test:e2e": "concurrently --kill-others -s first \"NODE_ENV=test yarn playground:javascript\" \"cypress run --env playground=javascript\"",
     "test:e2e:all": "sh scripts/e2e.sh",
     "test:e2e:watch": "concurrently --kill-others -s first \"NODE_ENV=test yarn playground:javascript\" \"cypress open --env playground=javascript\"",
-    "test:all": "yarn test:e2e:all && yarn test",
+    "test:all": "yarn test:e2e:all && yarn test && test:build",
     "playground:vue": "yarn --cwd ./playgrounds/vue && yarn --cwd ./playgrounds/vue serve",
     "playground:react": "yarn --cwd ./playgrounds/react && yarn --cwd ./playgrounds/react start",
     "playground:javascript": "yarn --cwd ./playgrounds/javascript && yarn --cwd ./playgrounds/javascript start",
@@ -59,7 +60,6 @@
     "@babel/preset-env": "^7.15.0",
     "@rollup/plugin-commonjs": "^17.1.0",
     "@rollup/plugin-node-resolve": "^11.2.0",
-    "@rollup/plugin-typescript": "^8.2.5",
     "@typescript-eslint/eslint-plugin": "^4.16.1",
     "@typescript-eslint/parser": "^4.16.1",
     "@vue/eslint-config-typescript": "^7.0.0",
@@ -86,13 +86,14 @@
     "eslint-plugin-vue": "^7.7.0",
     "instantsearch.js": "^4.16.1",
     "jest": "^26.6.3",
-    "jest-environment-jsdom": "25.5",
     "jest-watch-typeahead": "^0.6.3",
     "prettier": "^2.0.0",
     "regenerator-runtime": "^0.13.7",
     "rollup": "^2.40.0",
     "rollup-plugin-babel": "^4.4.0",
+    "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.0",
+    "rollup-plugin-typescript2": "^0.30.0",
     "shx": "^0.3.3",
     "ts-jest": "^26.5.2",
     "tslib": "^2.3.1",

rollup.config.js

@@ -3,8 +3,7 @@ import nodeResolve from '@rollup/plugin-node-resolve'
 import { resolve } from 'path'
 import babel from 'rollup-plugin-babel'
 import { terser } from 'rollup-plugin-terser'
-import typescript from '@rollup/plugin-typescript'
-
+import typescript from 'rollup-plugin-typescript2'
 import pkg from './package.json'
 
 function getOutputFileName(fileName, isProd = false) {
@@ -17,8 +16,12 @@ const INPUT = 'src/index.ts'
 
 const PLUGINS = [
   typescript({
-    tsconfig: 'tsconfig.json',
-    exclude: ['tests', '*.js', 'scripts', '**/__tests__/*.ts'],
+    useTsconfigDeclarationDir: true,
+    tsconfigOverride: {
+      includes: ['src'],
+      exclude: ['tests', '*.js', 'scripts', '**/__tests__/*.ts'],
+      esModuleInterop: true,
+    },
   }),
 ]
 module.exports = [

tests/build.tests.js

@@ -0,0 +1,40 @@
+const {
+  instantMeiliSearch: UMDinstantMeiliSearch,
+} = require('../dist/instant-meilisearch.umd')
+const {
+  instantMeiliSearch: CJSinstantMeiliSearch,
+} = require('../dist/instant-meilisearch.cjs')
+
+const UMDclient = UMDinstantMeiliSearch('http://localhost:7700', 'masterKey')
+const CJSclient = CJSinstantMeiliSearch('http://localhost:7700', 'masterKey')
+const instantsearch = require('instantsearch.js')
+
+test('UMD client should correctly created', () => {
+  expect(UMDclient.MeiliSearchClient.config.apiKey).toBe('masterKey')
+})
+
+test('CJS client should correctly created', () => {
+  expect(CJSclient.MeiliSearchClient.config.apiKey).toBe('masterKey')
+})
+
+test('CJS instantsearch client should correctly created', () => {
+  const CJSInstantSearch = instantsearch.default({
+    indexName: 'cjs_index',
+    searchClient: CJSclient,
+  })
+  expect(CJSInstantSearch.indexName).toBe('cjs_index')
+  expect(CJSInstantSearch.client.MeiliSearchClient.config.apiKey).toBe(
+    'masterKey'
+  )
+})
+
+test('UMD instantsearch client should correctly created', () => {
+  const UMDInstantSearch = instantsearch.default({
+    indexName: 'umd_index',
+    searchClient: UMDclient,
+  })
+  expect(UMDInstantSearch.indexName).toBe('umd_index')
+  expect(UMDInstantSearch.client.MeiliSearchClient.config.apiKey).toBe(
+    'masterKey'
+  )
+})