test(helper): integrate unit and integration tests into main jest configuration

.eslintrc.js

@@ -429,7 +429,10 @@ const config = {
       },
     },
     {
-      files: ['packages/algoliasearch-helper/test/**/*.js'],
+      files: [
+        'packages/algoliasearch-helper/__tests__/**/*.js',
+        'packages/algoliasearch-helper/test/**/*.js',
+      ],
       rules: {
         'no-console': 'off',
         'jest/no-done-callback': 'off',

jest.config.js

@@ -1,22 +1,28 @@
 // @ts-check
 
+const enableIntegrationTest =
+  process.env.ONLY_UNIT !== 'true' &&
+  process.env.INTEGRATION_TEST_API_KEY &&
+  process.env.INTEGRATION_TEST_APPID;
+
 /** @type {import('@jest/types').Config.InitialOptions} */
 const config = {
   rootDir: process.cwd(),
   testRunner: 'jest-circus',
   testEnvironment: 'node',
   setupFilesAfterEnv: ['./tests/utils/setupTests.ts'],
+  globalTeardown: './tests/utils/teardownTests.ts',
   testPathIgnorePatterns: [
     '<rootDir>/node_modules/',
     '<rootDir>/packages/*/node_modules/',
     '<rootDir>/packages/*/dist*',
     '<rootDir>/tests/e2e/*',
     '<rootDir>/examples/',
-    '<rootDir>/packages/algoliasearch-helper',
     '<rootDir>/packages/create-instantsearch-app',
     '<rootDir>/packages/react-instantsearch-hooks-router-nextjs',
     '/__utils__/',
-  ],
+    enableIntegrationTest ? '' : '/integration-spec/',
+  ].filter(Boolean),
   watchPathIgnorePatterns: [
     '<rootDir>/packages/*/cjs',
     '<rootDir>/packages/*/dist',

package.json

@@ -29,7 +29,7 @@
     "test:e2e": "yarn test:e2e:local",
     "test:e2e:local": "wdio scripts/wdio/local.conf.js",
     "test:e2e:saucelabs": "wdio scripts/wdio/saucelabs.conf.js",
-    "test:v3": "lerna run test:v3",
+    "test:v3": "./scripts/retry.sh 3 'jest --maxWorkers=4 --ci' && lerna run test:v3 --concurrency=1",
     "release": "shipjs prepare",
     "prepare": "lerna run prepare && patch-package",
     "prepare-vue3": "./scripts/prepare-vue3.js"

packages/algoliasearch-helper/test/integration-spec/helper.derive.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.derive.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.distinct.facet.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.distinct.facet.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.filters.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.filters.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.geo.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.geo.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.highlight.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.highlight.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.insights.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.insights.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.numerics.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.numerics.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.results.getFacetValues.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.results.getFacetValues.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.searchForFacetValues.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.searchForFacetValues.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.searchOnce.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.searchOnce.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/integration-spec/helper.tags.js → packages/algoliasearch-helper/__tests__/integration-spec/helper.tags.js

@@ -1,6 +1,8 @@
 'use strict';
 
-var utils = require('../integration-utils');
+jest.retryTimes(3, { logErrorsBeforeRetry: true });
+
+var utils = require('../../test/integration-utils');
 var setup = utils.setupSimple;
 var createIndexName = utils.createIndexName;
 

packages/algoliasearch-helper/test/spec/SearchResults/getFacet.js → packages/algoliasearch-helper/__tests__/spec/SearchResults/getFacet.js

@@ -3,7 +3,8 @@
 var SearchResults = require('../../../src/SearchResults');
 
 test('getFacetByName should return a given facet be it disjunctive or conjunctive', function () {
-  var data = require('../../datasets/SearchParameters/search.dataset')();
+  var data =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
 
   var result = new SearchResults(data.searchParams, data.response.results);
 

packages/algoliasearch-helper/test/spec/algoliasearch.helper/pendingSearch.js → packages/algoliasearch-helper/__tests__/spec/algoliasearch.helper/pendingSearch.js

@@ -5,7 +5,8 @@ var algoliaSearch = require('algoliasearch');
 var algoliasearchHelper = require('../../../index');
 
 test('When searchOnce with callback, hasPendingRequests is true', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
   var client = algoliaSearch('dsf', 'dsfdf');
 
   var triggerCb;
@@ -38,7 +39,8 @@ test('When searchOnce with callback, hasPendingRequests is true', function (done
 });
 
 test('When searchOnce with promises, hasPendingRequests is true', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
   var client = algoliaSearch('dsf', 'dsfdf');
 
   var triggerCb;
@@ -109,7 +111,8 @@ test('When searchForFacetValues, hasPendingRequests is true', function (done) {
 });
 
 test('When helper.search(), hasPendingRequests is true', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
   var client = algoliaSearch('dsf', 'dsfdf');
 
   var triggerCb;
@@ -144,7 +147,8 @@ test('When helper.search(), hasPendingRequests is true', function (done) {
 });
 
 test('When helper.search() and one request is discarded, hasPendingRequests is true unless all come back', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
   var client = algoliaSearch('dsf', 'dsfdf');
 
   var triggerCbs = [];

packages/algoliasearch-helper/test/spec/algoliasearch.helper/queryID.js → packages/algoliasearch-helper/__tests__/spec/algoliasearch.helper/queryID.js

@@ -22,7 +22,8 @@ test('the queryid should keep increasing when new requests arrives', function ()
 });
 
 test('the response handler should check that the query is not outdated', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
   var shouldTriggerResult = true;
   var callCount = 0;
 

packages/algoliasearch-helper/test/spec/algoliasearch.helper/searchOnce.js → packages/algoliasearch-helper/__tests__/spec/algoliasearch.helper/searchOnce.js

@@ -5,7 +5,8 @@ var SearchParameters = require('../../../src/SearchParameters');
 var algoliasearchHelper = require('../../../index');
 
 test('searchOnce should call the algolia client according to the number of refinements and call callback with no error and with results when no error', function (done) {
-  var testData = require('../../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../../test/datasets/SearchParameters/search.dataset')();
 
   var client = {
     search: jest.fn().mockImplementationOnce(function () {

packages/algoliasearch-helper/test/spec/requestBuilder.js → packages/algoliasearch-helper/__tests__/spec/requestBuilder.js

@@ -5,7 +5,8 @@ var SearchParameters = require('../../src/SearchParameters');
 var getQueries = requestBuilder._getQueries;
 
 test('The request builder should set analytics to subsequent queries', function () {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
   var searchParams = testData.searchParams;
 
   searchParams.analytics = true;
@@ -17,7 +18,8 @@ test('The request builder should set analytics to subsequent queries', function
 });
 
 test('The request builder should set clickAnalytics to subsequent queries', function () {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
   var searchParams = testData.searchParams;
 
   searchParams.clickAnalytics = true;
@@ -29,7 +31,8 @@ test('The request builder should set clickAnalytics to subsequent queries', func
 });
 
 test('The request builder should should force analytics to false on subsequent queries if not specified', function () {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
   var searchParams = testData.searchParams;
 
   var queries = getQueries(searchParams.index, searchParams);
@@ -39,7 +42,8 @@ test('The request builder should should force analytics to false on subsequent q
 });
 
 test('The request builder should should force clickAnalytics to false on subsequent queries if not specified', function () {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
   var searchParams = testData.searchParams;
 
   var queries = getQueries(searchParams.index, searchParams);

packages/algoliasearch-helper/test/spec/search.js → packages/algoliasearch-helper/__tests__/spec/search.js

@@ -3,7 +3,8 @@
 var algoliasearchHelper = require('../../index');
 
 test('Search should call the algolia client according to the number of refinements', function (done) {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
 
   var client = {
     search: jest.fn().mockImplementationOnce(function () {
@@ -90,7 +91,8 @@ test('Search should call the algolia client according to the number of refinemen
 });
 
 test('Search should not mutate the original client response', function (done) {
-  var testData = require('../datasets/SearchParameters/search.dataset')();
+  var testData =
+    require('../../test/datasets/SearchParameters/search.dataset')();
 
   var client = {
     search: jest.fn().mockImplementationOnce(function () {

packages/algoliasearch-helper/package.json

@@ -9,10 +9,6 @@
     "build": "./scripts/build.sh",
     "lint": "eslint .",
     "doc": "node documentation-src/metalsmith.js",
-    "test": "../../scripts/retry.sh 3 'scripts/test.sh'",
-    "test:unit": "jest",
-    "test:watch": "jest --watch",
-    "test:v3": "yarn run test",
     "version": "./scripts/update-version.js"
   },
   "author": {

packages/algoliasearch-helper/test/integration-utils.js

@@ -6,6 +6,13 @@ function setup(indexName, fn) {
   var appID = process.env.INTEGRATION_TEST_APPID;
   var key = process.env.INTEGRATION_TEST_API_KEY;
 
+  if (!appID) {
+    throw new Error('Missing environment variable INTEGRATION_TEST_APPID');
+  }
+  if (!key) {
+    throw new Error('Missing environment variable INTEGRATION_TEST_API_KEY');
+  }
+
   var client = algoliasearch(appID, key, {
     // all indexing requests must be done in https
     protocol: 'https:',