refactor(e2e-tests): import the instantsearch-e2e-tests repo

.circleci/config.yml

@@ -175,7 +175,7 @@ jobs:
       - *restore_yarn_cache
       - *run_yarn_install
       - run:
-          name: End-2-End tests
+          name: End-to-end tests
           command: yarn run test:e2e:saucelabs
       - store_test_results:
           path: junit/wdio/

.eslintrc.js

@@ -115,6 +115,50 @@ module.exports = {
         ],
       },
     },
+    {
+      files: ['tests/e2e/**/*'],
+      parserOptions: {
+        project: 'tests/e2e/tsconfig.json',
+      },
+      rules: {
+        'valid-jsdoc': 'off',
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: 'WebdriverIOAsync',
+            ignoreRestSiblings: true,
+          },
+        ],
+        '@typescript-eslint/no-floating-promises': 'error',
+      },
+    },
+    {
+      files: [
+        'tests/e2e/specs/**/*.spec.ts',
+        'tests/e2e/all-flavors.spec.ts',
+        'tests/e2e/helpers/**/*.ts',
+        'tests/e2e/wdio.*.conf.js',
+      ],
+      extends: ['plugin:wdio/recommended'],
+      plugins: ['wdio'],
+      env: {
+        jasmine: true,
+      },
+      rules: {
+        // we are exporting test "factories", so we need to allow export
+        'jest/no-export': 0,
+        // we use jasmine
+        'jest/expect-expect': 0,
+        '@typescript-eslint/no-namespace': 0,
+      },
+    },
+    {
+      files: ['tests/e2e/**/*.js'],
+      rules: {
+        'import/no-commonjs': 0,
+      },
+    },
   ],
   settings: {
     react: {

CONTRIBUTING.md

@@ -171,6 +171,26 @@ To run the test continuously based on what you changed (useful when developing o
 yarn test --watch
 ```
 
+### End-to-end tests
+
+End-to-end tests are defined in [tests/e2e](./tests/e2e/README.md).
+
+To run them locally:
+
+```sh
+yarn test:e2e:local
+```
+
+To run them on Sauce Labs:
+```sh
+yarn test:e2e:saucelabs
+```
+
+> **Note**
+>Make sure to set up Sauce Labs credentials with the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables.
+
+For more info, including how to write end-to-end tests, check the `tests/e2e` [CONTRIBUTING](./tests/e2e/CONTRIBUTING.md) and [README](./tests/e2e/README.md) files.
+
 ### Type checks
 
 Type checks ensure code is correctly typed both for code quality and TypeScript compatibility.

jest.config.js

@@ -10,6 +10,7 @@ const config = {
   testPathIgnorePatterns: [
     '<rootDir>/packages/*/node_modules/',
     '<rootDir>/packages/*/dist*',
+    '<rootDir>/tests/e2e/*',
   ],
   watchPathIgnorePatterns: [
     '<rootDir>/packages/*/cjs',

package.json

@@ -15,7 +15,7 @@
     "website:examples": "lerna run website:examples",
     "lint": "eslint --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --ext .js,.ts,.tsx --fix .",
-    "type-check": "tsc",
+    "type-check": "tsc && lerna run type-check",
     "type-check:v3": "tsc --project tsconfig.v3.json",
     "test": "jest",
     "test:size": "bundlesize",
@@ -46,14 +46,6 @@
     "@types/storybook__addon-actions": "3.4.2",
     "@typescript-eslint/eslint-plugin": "5.38.1",
     "@typescript-eslint/parser": "4.15.1",
-    "@wdio/cli": "5.16.9",
-    "@wdio/jasmine-framework": "5.16.5",
-    "@wdio/junit-reporter": "5.16.11",
-    "@wdio/local-runner": "5.16.9",
-    "@wdio/sauce-service": "5.16.5",
-    "@wdio/selenium-standalone-service": "5.16.5",
-    "@wdio/spec-reporter": "5.16.5",
-    "@wdio/static-server-service": "5.16.5",
     "algoliasearch": "4.11.0",
     "algoliasearch-v3": "npm:[email protected]",
     "babel-eslint": "10.0.3",
@@ -76,7 +68,7 @@
     "eslint-plugin-prettier": "3.4.0",
     "eslint-plugin-react": "7.18.0",
     "eslint-plugin-react-hooks": "2.3.0",
-    "instantsearch-e2e-tests": "algolia/instantsearch-e2e-tests#feat/monorepo",
+    "eslint-plugin-wdio": "5.11.0",
     "jest": "27.1.0",
     "jest-diff": "27.1.0",
     "jest-environment-jsdom": "27.1.0",

packages/instantsearch.js/package.json

@@ -50,8 +50,6 @@
     "build:types": "scripts/typescript/extract.js",
     "storybook": "start-storybook --quiet --port 6006 --ci --static-dir .storybook/static",
     "storybook:build": "build-storybook --quiet --output-dir ../../website/stories/js --static-dir .storybook/static",
-    "type-check": "tsc",
-    "type-check:v3": "tsc --project tsconfig.v3.json",
     "test": "jest",
     "test:exports": "node test/module/is-es-module.mjs",
     "version": "./scripts/version/update-version.js"

scripts/wdio/local.conf.js

@@ -1,5 +1,6 @@
 /* eslint-disable import/no-commonjs */
 
-const { local } = require('instantsearch-e2e-tests');
-
-exports.config = local;
+exports.config = {
+  ...require('@instantsearch/e2e-tests').local,
+  // you can override the default options if needed here
+};

scripts/wdio/saucelabs.conf.js

@@ -1,5 +1,5 @@
 /* eslint-disable import/no-commonjs */
 
-const { saucelabs } = require('instantsearch-e2e-tests');
-
-exports.config = saucelabs;
+exports.config = {
+  ...require('@instantsearch/e2e-tests').saucelabs,
+};

tests/e2e/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+npm-debug.log
+yarn-error.log
+.DS_Store
+tests/*
+!tests/*.sh

tests/e2e/CHANGELOG.md

@@ -0,0 +1,159 @@
+## [3.0.0](https://github.com/algolia/instantsearch-e2e-tests/compare/v2.0.1...v2.0.2) (2022-11-23)
+
+
+### Features
+
+* **tests:** migrate to the InstantSearch monorepo ([#38](https://github.com/algolia/instantsearch-e2e-tests/issues/38))
+
+## [2.0.2](https://github.com/algolia/instantsearch-e2e-tests/compare/v2.0.1...v2.0.2) (2022-02-03)
+
+
+### Bug Fixes
+
+* **spec:** reduce flakiness related to range slider manipulation ([#33](https://github.com/algolia/instantsearch-e2e-tests/issues/33)) ([a008f38](https://github.com/algolia/instantsearch-e2e-tests/commit/a008f38))
+
+
+
+## [2.0.1](https://github.com/algolia/instantsearch-e2e-tests/compare/v2.0.0...v2.0.1) (2022-01-18)
+
+
+### Bug Fixes
+
+* correctly output junit report in target repository ([#32](https://github.com/algolia/instantsearch-e2e-tests/issues/32)) ([d3e9e1b](https://github.com/algolia/instantsearch-e2e-tests/commit/d3e9e1b))
+
+
+
+# [2.0.0](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.3.0...v2.0.0) (2022-01-17)
+
+
+### Features
+
+* generate junit test reports by default with saucelabs ([#29](https://github.com/algolia/instantsearch-e2e-tests/issues/29)) ([5f2c0b3](https://github.com/algolia/instantsearch-e2e-tests/commit/5f2c0b3))
+
+
+### BREAKING CHANGES
+
+* tested projects now require `@wdio/junit-reporter`.
+
+
+
+# [1.3.0](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.2.4...v1.3.0) (2020-04-17)
+
+
+### Bug Fixes
+
+* **spec:** improve specs reliability to minimize flackyness ([#21](https://github.com/algolia/instantsearch-e2e-tests/issues/21)) ([44bae68](https://github.com/algolia/instantsearch-e2e-tests/commit/44bae68))
+* **test:** change InstantSearch.js test branch to `master` ([#19](https://github.com/algolia/instantsearch-e2e-tests/issues/19)) ([1c34d8d](https://github.com/algolia/instantsearch-e2e-tests/commit/1c34d8d))
+
+
+### Features
+
+* **spec:** add custom error messages for timeouts ([#18](https://github.com/algolia/instantsearch-e2e-tests/issues/18)) ([617a22d](https://github.com/algolia/instantsearch-e2e-tests/commit/617a22d))
+* **webdriverio:** add retry for Sauce Connect tunnel ([#17](https://github.com/algolia/instantsearch-e2e-tests/issues/17)) ([9e398c2](https://github.com/algolia/instantsearch-e2e-tests/commit/9e398c2))
+
+
+
+## [1.2.4](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.2.3...v1.2.4) (2019-11-26)
+
+
+### Bug Fixes
+
+* **setSearchBoxValue:** reset searchbox before editing ([#15](https://github.com/algolia/instantsearch-e2e-tests/issues/15)) ([b52ea34](https://github.com/algolia/instantsearch-e2e-tests/commit/b52ea3468594c86168b155bb0fcab1230ff86672)), closes [/app.saucelabs.com/tests/4518f96fdfd447e998786d0ff463658a#54](https://github.com//app.saucelabs.com/tests/4518f96fdfd447e998786d0ff463658a/issues/54)
+
+
+
+## [1.2.3](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.2.2...v1.2.3) (2019-10-14)
+
+
+### Bug Fixes
+
+* **helper:** fix helpers to handle RangeSlider in vue-instantsearch ([#12](https://github.com/algolia/instantsearch-e2e-tests/issues/12)) ([143a59b](https://github.com/algolia/instantsearch-e2e-tests/commit/143a59b))
+
+
+
+## [1.2.2](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.2.1...v1.2.2) (2019-09-12)
+
+
+### Bug Fixes
+
+* **spec:** fix specs to match fixed slider behavior ([#10](https://github.com/algolia/instantsearch-e2e-tests/issues/10)) ([d7bce97](https://github.com/algolia/instantsearch-e2e-tests/commit/d7bce97))
+
+
+
+## [1.2.1](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.2.0...v1.2.1) (2019-09-11)
+
+
+### Bug Fixes
+
+* **helper:** fix helpers to handle RangeSlider in react-instantsearch ([#9](https://github.com/algolia/instantsearch-e2e-tests/issues/9)) ([c2de700](https://github.com/algolia/instantsearch-e2e-tests/commit/c2de700))
+
+
+
+# [1.2.0](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.1.0...v1.2.0) (2019-09-06)
+
+### Bug Fixes
+
+- **helper:** fix getSelectedHierarchicalMenuItems to wait for the elements ([5a2456b](https://github.com/algolia/instantsearch-e2e-tests/commit/5a2456b))
+- **helper:** fix getTextFromElements helper to use getText selector ([272a7ec](https://github.com/algolia/instantsearch-e2e-tests/commit/272a7ec))
+- **helper:** fix helpers to scroll to elements before attempting to click on it ([#6](https://github.com/algolia/instantsearch-e2e-tests/issues/6)) ([cd87be6](https://github.com/algolia/instantsearch-e2e-tests/commit/cd87be6))
+- **helper:** fix dragRangeSliderLowerBoundTo offset calculation ([#7](https://github.com/algolia/instantsearch-e2e-tests/issues/7)) ([3291000](https://github.com/algolia/instantsearch-e2e-tests/commit/3291000))
+- **spec:** fix price-range spec to match new slider behavior ([#8](https://github.com/algolia/instantsearch-e2e-tests/issues/8)) ([7a566d5](https://github.com/algolia/instantsearch-e2e-tests/commit/7a566d5))
+- **webdriverio:** fix mount paths for static server so rewritten urls works ([2f9490e](https://github.com/algolia/instantsearch-e2e-tests/commit/2f9490e))
+
+### Features
+
+- **helper:** add clickToggleRefinement helper ([fa0a0bb](https://github.com/algolia/instantsearch-e2e-tests/commit/fa0a0bb))
+- **helper:** add clickClearRefinements helper ([4c996b0](https://github.com/algolia/instantsearch-e2e-tests/commit/4c996b0))
+- **helper:** add getHitsPerPage helper ([28a6d5f](https://github.com/algolia/instantsearch-e2e-tests/commit/28a6d5f))
+- **helper:** add getHitsTitles helper ([9da7cd9](https://github.com/algolia/instantsearch-e2e-tests/commit/9da7cd9))
+- **helper:** add getCurrentPage helper ([d1e79fc](https://github.com/algolia/instantsearch-e2e-tests/commit/d1e79fc))
+- **helper:** add getRangeSliderLowerBoundValue helper ([cc30634](https://github.com/algolia/instantsearch-e2e-tests/commit/cc30634))
+- **helper:** add getRangeSliderUpperBoundValue helper ([99c336b](https://github.com/algolia/instantsearch-e2e-tests/commit/99c336b))
+- **helper:** add getSelectedRatingMenuItem helper ([1d1dcc6](https://github.com/algolia/instantsearch-e2e-tests/commit/1d1dcc6))
+- **helper:** add getSearchBoxValue helper ([cfd44fb](https://github.com/algolia/instantsearch-e2e-tests/commit/cfd44fb))
+- **helper:** add getSelectedHierarchicalMenuItems helper ([90e0e1c](https://github.com/algolia/instantsearch-e2e-tests/commit/90e0e1c))
+- **helper:** add getSelectedRefinementListItem helper ([278babd](https://github.com/algolia/instantsearch-e2e-tests/commit/278babd))
+- **helper:** add getSortByValue helper ([c71da3c](https://github.com/algolia/instantsearch-e2e-tests/commit/c71da3c))
+- **helper:** add getToggleRefinementStatus helper ([3c8d36d](https://github.com/algolia/instantsearch-e2e-tests/commit/3c8d36d))
+- **helper:** add setHitsPerPage helper ([6f12380](https://github.com/algolia/instantsearch-e2e-tests/commit/6f12380))
+- **helper:** add clickNextPage helper ([6838b66](https://github.com/algolia/instantsearch-e2e-tests/commit/6838b66))
+- **helper:** add clickPage helper ([77b3299](https://github.com/algolia/instantsearch-e2e-tests/commit/77b3299))
+- **helper:** add clickPreviousPage helper ([53eda61](https://github.com/algolia/instantsearch-e2e-tests/commit/53eda61))
+- **helper:** add dragRangeSliderLowerBoundTo helper ([21534d1](https://github.com/algolia/instantsearch-e2e-tests/commit/21534d1))
+- **helper:** add dragRangeSliderUpperBoundTo helper ([a165c05](https://github.com/algolia/instantsearch-e2e-tests/commit/a165c05))
+- **helper:** add clickRatingMenuItem helper ([ce36250](https://github.com/algolia/instantsearch-e2e-tests/commit/ce36250))
+- **helper:** add setSearchBoxValue helper ([5897191](https://github.com/algolia/instantsearch-e2e-tests/commit/5897191))
+- **helper:** add clickHierarchicalMenuItem helper ([6c4b3e2](https://github.com/algolia/instantsearch-e2e-tests/commit/6c4b3e2))
+- **helper:** add clickRefinementListItem helper ([8fe93f2](https://github.com/algolia/instantsearch-e2e-tests/commit/8fe93f2))
+- **helper:** add setSortByValue helper ([57fc5d4](https://github.com/algolia/instantsearch-e2e-tests/commit/57fc5d4))
+- **helper:** add waitForElement helper ([b33b28b](https://github.com/algolia/instantsearch-e2e-tests/commit/b33b28b))
+- **spec:** add spec for initializing the state from the route ([#4](https://github.com/algolia/instantsearch-e2e-tests/issues/4)) ([f92238e](https://github.com/algolia/instantsearch-e2e-tests/commit/f92238e))
+- **spec:** add spec for pagination ([#2](https://github.com/algolia/instantsearch-e2e-tests/issues/2)) ([a75e917](https://github.com/algolia/instantsearch-e2e-tests/commit/a75e917))
+- **spec:** add spec for search on specific category ([#3](https://github.com/algolia/instantsearch-e2e-tests/issues/3)) ([cdd9247](https://github.com/algolia/instantsearch-e2e-tests/commit/cdd9247))
+
+# [1.1.0](https://github.com/algolia/instantsearch-e2e-tests/compare/v1.0.0...v1.1.0) (2019-08-19)
+
+### Bug Fixes
+
+- **helper:** fix dragAndDropByOffset helper Internet Explorer 11 compatibility ([393f27a](https://github.com/algolia/instantsearch-e2e-tests/commit/393f27a))
+- **spec:** fix Internet Explorer 11 compatibility for test on brand and query filtering ([57a0ece](https://github.com/algolia/instantsearch-e2e-tests/commit/57a0ece))
+- **spec:** wait for the browser to be maximized before running the test on brand an query filtering ([5db981e](https://github.com/algolia/instantsearch-e2e-tests/commit/5db981e))
+
+### Features
+
+- **helper:** add getTextFromElements helper ([5c4ec78](https://github.com/algolia/instantsearch-e2e-tests/commit/5c4ec78))
+- **webdriverio:** add Internet Explorer 11 to the Sauce Labs configuration ([fdc32db](https://github.com/algolia/instantsearch-e2e-tests/commit/fdc32db))
+
+# 1.0.0 (2019-08-12)
+
+### Bug Fixes
+
+- **spec:** fix stale element reference exceptions ([e347fc8](https://github.com/algolia/instantsearch-e2e-tests/commit/e347fc8))
+- **typescript:** fix TypeScript configuration to transpile tests when in node_modules ([0d88b76](https://github.com/algolia/instantsearch-e2e-tests/commit/0d88b76))
+
+### Features
+
+- **spec:** add spec for search on specific brand and query filtering ([39f0ea0](https://github.com/algolia/instantsearch-e2e-tests/commit/39f0ea0))
+- **spec:** add spec for search on specific price range ([5345c09](https://github.com/algolia/instantsearch-e2e-tests/commit/5345c09))
+- **webdriverio:** add WebdriverIO local configuration ([e35cab5](https://github.com/algolia/instantsearch-e2e-tests/commit/e35cab5))
+- **webdriverio:** add WebdriverIO Sauce Labs configuration ([9e044da](https://github.com/algolia/instantsearch-e2e-tests/commit/9e044da))