test: Refactor test set up for readability (#810)

.gitignore

@@ -11,4 +11,5 @@ test/stub/test-stub-bundle.js
 test/integrations/requirejs/test-requirejs-bundle.js
 browserstack.err
 local.log
-test/cross-browser-testing/CBT-tests-es5.js
+test/cross-browser-testing/CBT-tests-es5.js
+test/cross-browser-testing/CBT-tests.js

package.json

@@ -22,7 +22,7 @@
     "repository": "https://github.com/mParticle/mparticle-web-sdk",
     "scripts": {
         "build": "cross-env ENVIRONMENT=prod BUILDALL=true rollup --config rollup.config.js",
-        "build:cbt": "rollup --config test/cross-browser-testing/rollup.CBT.config.js && rm test/cross-browser-testing/CBT-tests.js",
+        "build:cbt": "rollup --config test/cross-browser-testing/rollup.CBT.config.js",
         "build:dev": "cross-env ENVIRONMENT=dev BUILD=iife rollup --config rollup.config.js",
         "build:iife": "cross-env ENVIRONMENT=prod BUILD=iife rollup --config rollup.config.js",
         "build:npm": "cross-env ENVIRONMENT=prod BUILD=cjs rollup --config rollup.config.js",

rollup.test.config.js

@@ -10,7 +10,7 @@ const extensions = ['.js', '.ts'];
 
 const builds = {
     main: {
-        input: 'test/src/tests-main.js',
+        input: 'test/src/_test.index.ts',
         output: {
             file: 'test/test-bundle.js',
             format: 'iife',

src/sdkRuntimeModels.ts

@@ -152,6 +152,8 @@ export interface MParticleWebSDK {
     _NativeSdkHelpers: any; // TODO: Set up API
     _Persistence: IPersistence;
     _preInit: any; // TODO: Set up API
+    _instances?: Dictionary<MParticleWebSDK>;
+    _isTestEnv?: boolean;
     _resetForTests(
         MPConfig?: SDKInitConfig,
         keepPersistence?: boolean,
@@ -202,22 +204,25 @@ export interface SDKInitConfig
     dataPlanOptions?: KitBlockerOptions;
     flags?: Dictionary;
 
-    aliasMaxWindow: number;
+    aliasMaxWindow?: number;
     deviceId?: string;
     forceHttps?: boolean;
     aliasUrl?: string;
     configUrl?: string;
     identityUrl?: string;
-    integrationDelayTimeout: number;
+    integrationDelayTimeout?: number;
     isIOS?: boolean;
-    maxProducts: number;
+    maxProducts?: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
     useNativeSdk?: boolean;
     useCookieStorage?: boolean;
     v1SecureServiceUrl?: string;
     v2SecureServiceUrl?: string;
     v3SecureServiceUrl?: string;
+
+    workspaceToken?: string;
+    isDevelopmentMode?: boolean;
 }
 
 export interface DataPlanConfig {

test/cross-browser-testing/rollup.CBT.config.js

@@ -8,7 +8,7 @@ import json from '@rollup/plugin-json';
 
 export default [
     {
-        input: 'test/src/tests-main.js',
+        input: 'test/src/_test.index.ts',
         output: {
             file: 'test/cross-browser-testing/CBT-tests.js',
             format: 'umd',

test/jest/sideloadedKit.spec.ts

@@ -3,7 +3,7 @@ import { IMPSideloadedKitConstructor } from "../../src/sideloadedKit";
 import { EventTypeEnum, IdentityType } from "../../src/types.interfaces";
 import { UnregisteredKit } from '../../src/forwarders.interfaces';          
 import { IKitFilterSettings } from '../../src/configAPIClient';
-import { mParticle } from "../src/config";
+import { mParticle } from "../src/config/constants";
 
 const mockKitInstance: UnregisteredKit = {
     register: function() {}

test/src/_test.index.ts

@@ -0,0 +1,31 @@
+// Import set up logic
+import './config/setup';
+
+// Import each test module
+import './tests-core-sdk';
+import './tests-batchUploader';
+import './tests-beaconUpload';
+import './tests-kit-blocking';
+import './tests-persistence';
+import './tests-forwarders';
+import './tests-helpers';
+import './tests-identity';
+import './tests-event-logging';
+import './tests-eCommerce';
+import './tests-cookie-syncing';
+import './tests-identities-attributes';
+import './tests-native-sdk';
+import './tests-consent';
+import './tests-serverModel';
+import './tests-mockBatchCreator';
+import './tests-mParticleUser';
+import './tests-self-hosting-specific';
+import './tests-runtimeToBatchEventsDTO';
+import './tests-apiClient';
+import './tests-mparticle-instance-manager';
+import './tests-queue-public-methods';
+import './tests-validators';
+import './tests-utils';
+import './tests-session-manager';
+import './tests-store';
+import './tests-config-api-client';

test/src/config.ts → test/src/config/constants.ts

@@ -1,4 +1,4 @@
-import { SDKInitConfig } from "../../src/sdkRuntimeModels";
+import { SDKInitConfig } from "../../../src/sdkRuntimeModels";
 
 export const urls = {
     events: 'https://jssdks.mparticle.com/v3/JS/test_key/events',

test/src/config/setup.ts

@@ -0,0 +1,38 @@
+import { MPConfig, workspaceToken } from './constants';
+import { MParticleWebSDK } from '../../../src/sdkRuntimeModels';
+
+declare global {
+    interface Window {
+        mParticle: MParticleWebSDK;
+    }
+}
+
+let userApi = null;
+
+window.mParticle._isTestEnv = true;
+
+beforeEach(function() {
+    // mocha can't clean up after itself, so this lets
+    // tests mock the current user and restores in between runs.
+    if (!userApi) {
+        userApi = window.mParticle.getInstance().Identity.getCurrentUser;
+    } else {
+        window.mParticle.getInstance().Identity.getCurrentUser = userApi;
+    }
+
+    window.mParticle.config = {
+        workspaceToken: workspaceToken,
+        logLevel: 'none',
+        kitConfigs: [],
+        requestConfig: false,
+        isDevelopmentMode: false,
+        flags: {
+            eventBatchingIntervalMillis: 0,
+        }
+    };
+
+    // This is to tell the resetPersistence method that we are in a test environment
+    // It should probably be refactored to be included as an argument
+    window.mParticle._resetForTests(MPConfig);
+    delete window.mParticle._instances['default_instance'];
+});

test/src/utils.js → test/src/config/utils.js

@@ -1,4 +1,4 @@
-import * as Utils from '../../src/utils';
+import * as Utils from '../../../src/utils';
 import {
     apiKey,
     testMPID,
@@ -8,7 +8,7 @@ import {
     workspaceToken,
     workspaceCookieName,
     das,
-} from './config';
+} from './constants';
 
 var pluses = /\+/g,
     getLocalStorageProducts = function getLocalStorageProducts() {

test/src/tests-apiClient.ts

@@ -1,6 +1,6 @@
 import Types from '../../src/types';
 import Constants from '../../src/constants';
-import { apiKey, MPConfig } from './config';
+import { apiKey, MPConfig } from './config/constants';
 import { MParticleWebSDK } from '../../src/sdkRuntimeModels';
 import { expect } from 'chai';
 

test/src/tests-batchUploader.ts

@@ -1,14 +1,13 @@
 import sinon from 'sinon';
-import { urls } from './config';
-import { apiKey, MPConfig, testMPID } from './config';
+import { urls, apiKey, MPConfig, testMPID } from './config/constants';
 import {
     BaseEvent,
     MParticleWebSDK,
     SDKEvent,
     SDKProductActionType,
 } from '../../src/sdkRuntimeModels';
 import { Batch, CustomEventData } from '@mparticle/event-models';
-import Utils from './utils';
+import Utils from './config/utils';
 import { BatchUploader } from '../../src/batchUploader';
 import { expect } from 'chai';
 import _BatchValidator from '../../src/mockBatchCreator';

test/src/tests-beaconUpload.ts

@@ -1,8 +1,7 @@
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 import { expect } from 'chai';
-import { urls } from './config';
-import { apiKey, MPConfig, testMPID } from './config';
+import { urls, apiKey, MPConfig, testMPID } from './config/constants';
 import { MParticleWebSDK } from '../../src/sdkRuntimeModels';
 import { event0 } from '../fixtures/events';
 import { batch1, batch2, batch3 } from '../fixtures/batches';

test/src/tests-config-api-client.ts

@@ -1,6 +1,5 @@
 import sinon from 'sinon';
-import { urls } from './config';
-import { apiKey, MPConfig } from './config';
+import { urls, apiKey, MPConfig } from './config/constants';
 import { expect } from 'chai';
 import ConfigAPIClient, {
     IConfigAPIClient,

test/src/tests-consent.ts

@@ -1,8 +1,7 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
-import { urls } from './config';
-import { apiKey, MPConfig, testMPID } from './config';
+import { urls, apiKey, MPConfig, testMPID } from './config/constants';
 import { MParticleWebSDK } from '../../src/sdkRuntimeModels';
 import { expect } from 'chai';
 import { GDPRConsentState, PrivacyConsentState } from '@mparticle/web-sdk';

test/src/tests-cookie-syncing.js

@@ -1,7 +1,7 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
-import { urls, testMPID, MPConfig, v4LSKey, apiKey } from './config';
+import { urls, testMPID, MPConfig, v4LSKey, apiKey } from './config/constants';
 
 const { setLocalStorage, MockForwarder, getLocalStorage } = Utils;
 

test/src/tests-core-sdk.js

@@ -1,10 +1,9 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import Store from '../../src/store';
 import Constants from '../../src/constants';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
-import { urls } from './config';
-import { apiKey, das, MPConfig, testMPID, workspaceCookieName } from './config';
+import { urls, apiKey, das, MPConfig, testMPID, workspaceCookieName } from './config/constants';
 
 const DefaultConfig = Constants.DefaultConfig,
     setLocalStorage = Utils.setLocalStorage,

test/src/tests-eCommerce.js

@@ -1,7 +1,7 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
-import { urls, apiKey, workspaceToken, MPConfig, testMPID, ProductActionType, PromotionActionType } from './config';
+import { urls, apiKey, workspaceToken, MPConfig, testMPID, ProductActionType, PromotionActionType } from './config/constants';
 
 const getLocalStorageProducts = Utils.getLocalStorageProducts,
     forwarderDefaultConfiguration = Utils.forwarderDefaultConfiguration,

test/src/tests-event-logging.js

@@ -1,10 +1,10 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 import { urls, apiKey,
     testMPID,
     MPConfig,
-    MessageType } from './config';
+    MessageType } from './config/constants';
 
 const getIdentityEvent = Utils.getIdentityEvent,
     findEventFromRequest = Utils.findEventFromRequest,

test/src/tests-forwarders.js

@@ -1,9 +1,8 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 
-import { urls } from './config';
-import { apiKey, MPConfig, testMPID, MessageType } from './config';
+import { urls, apiKey, MPConfig, testMPID, MessageType } from './config/constants';
 import { expect } from 'chai';
 
 const findEventFromRequest = Utils.findEventFromRequest,

test/src/tests-helpers.js

@@ -1,4 +1,4 @@
-import { apiKey } from './config';
+import { apiKey } from './config/constants';
 import sinon from 'sinon';
 
 describe('helpers', function() {

test/src/tests-identities-attributes.js

@@ -1,9 +1,9 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 import { urls, apiKey,
     testMPID,
-    MPConfig } from './config';
+    MPConfig } from './config/constants';
 
 const findEventFromRequest = Utils.findEventFromRequest,
     findBatch = Utils.findBatch,

test/src/tests-identity.js

@@ -1,11 +1,11 @@
 import Constants from '../../src/constants';
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 import { urls, apiKey,
     testMPID,
     MPConfig,
-    workspaceCookieName } from './config';
+    workspaceCookieName } from './config/constants';
 
 const getLocalStorage = Utils.getLocalStorage,
     setLocalStorage = Utils.setLocalStorage,

test/src/tests-kit-blocking.ts

@@ -1,9 +1,8 @@
 import sinon from 'sinon';
-import { urls } from './config';
-import { apiKey, MPConfig, testMPID } from './config';
+import { urls, apiKey, MPConfig, testMPID } from './config/constants';
 import { MParticleWebSDK, SDKEvent, SDKProductActionType, DataPlanResult, KitBlockerDataPlan } from  '../../src/sdkRuntimeModels';
 import * as dataPlan from './dataPlan.json';
-import Utils from './utils';
+import Utils from './config/utils';
 import KitBlocker from '../../src/kitBlocking';
 import Types from '../../src/types';
 import { DataPlanVersion } from '@mparticle/data-planning-models';

test/src/tests-mParticleUser.js

@@ -1,6 +1,6 @@
-import Utils from './utils';
+import Utils from './config/utils';
 import sinon from 'sinon';
-import { urls, apiKey, MPConfig } from './config';
+import { urls, apiKey, MPConfig } from './config/constants';
 
 const forwarderDefaultConfiguration = Utils.forwarderDefaultConfiguration,
     MockForwarder = Utils.MockForwarder;