Merge pull request #4191 from coralproject/fix/CORL-2782-fix-gha-tests

[CORL-2782] Separate tests into different sections to improve GHA performance

.github/workflows/build-and-test.yml

@@ -69,8 +69,17 @@ jobs:
         name: Lint Versions
         run: npx @coralproject/package-version-lint
       -
-        name: Run Unit Tests
-        run: npm run test -- --ci --runInBand --reporters=default --reporters=jest-junit
+        name: Run Server Unit Tests
+        run: npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Stream Unit Tests
+        run: npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Admin Unit Tests
+        run: npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Other Unit Tests
+        run: npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Build
         run: npm run build

.github/workflows/build-test-deploy.yml

@@ -84,8 +84,17 @@ jobs:
         name: Lint Versions
         run: npx @coralproject/package-version-lint
       -
-        name: Run Unit Tests
-        run: npm run test -- --ci --runInBand --reporters=default --reporters=jest-junit
+        name: Run Server Unit Tests
+        run: npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Stream Unit Tests
+        run: npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Admin Unit Tests
+        run: npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
+      -
+        name: Run Client Other Unit Tests
+        run: npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Build
         run: npm run build

config/jest.client.admin.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  projects: [
+    "<rootDir>/jest/client.admin.config.js",
+  ],
+};

config/jest.client.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  projects: [
+    "<rootDir>/jest/client.config.js",
+  ],
+};

config/jest.client.other.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  projects: [
+    "<rootDir>/jest/client.other.config.js",
+  ],
+};

config/jest.client.stream.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  projects: [
+    "<rootDir>/jest/client.stream.config.js",
+  ],
+};

config/jest.server.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  projects: [
+    "<rootDir>/jest/server.config.js",
+  ],
+};

config/jest/client.admin.config.js

@@ -0,0 +1,9 @@
+const createConfig = require("./client.baseConfig");
+
+const baseConfig = createConfig();
+
+module.exports = {
+  ...baseConfig,
+  displayName: "client:admin",
+  roots: ["<rootDir>/src/core/client/admin"],
+}

config/jest/client.baseConfig.js

@@ -0,0 +1,87 @@
+const path = require("path");
+
+const createConfig = () => {
+  const d3Pkgs = [
+    "d3",
+    "d3-array",
+    "d3-axis",
+    "d3-brush",
+    "d3-chord",
+    "d3-color",
+    "d3-contour",
+    "d3-delaunay",
+    "d3-dispatch",
+    "d3-drag",
+    "d3-dsv",
+    "d3-ease",
+    "d3-fetch",
+    "d3-force",
+    "d3-format",
+    "d3-geo",
+    "d3-hierarchy",
+    "d3-interpolate",
+    "d3-path",
+    "d3-polygon",
+    "d3-quadtree",
+    "d3-random",
+    "d3-scale",
+    "d3-scale-chromatic",
+    "d3-selection",
+    "d3-shape",
+    "d3-time",
+    "d3-time-format",
+    "d3-timer",
+    "d3-transition",
+    "d3-zoom",
+  ];
+
+  return {
+    displayName: "jestBaseConfig",
+    rootDir: "../../",
+    roots: ["<rootDir>/src/core/"],
+    collectCoverageFrom: ["**/*.{js,jsx,mjs,ts,tsx}"],
+    coveragePathIgnorePatterns: ["/node_modules/"],
+    setupFiles: [
+      "<rootDir>/src/core/client/test/polyfills.ts",
+      "<rootDir>/src/core/client/test/setup.ts",
+    ],
+    setupFilesAfterEnv: ["<rootDir>/src/core/client/test/setupTestFramework.ts"],
+    testMatch: ["**/*.spec.{js,jsx,mjs,ts,tsx}"],
+    testEnvironment: "node",
+    testURL: "http://localhost",
+    transform: {
+      "^.+\\.jsx?$": "<rootDir>/node_modules/babel-jest",
+      "^.+\\.tsx?$": "<rootDir>/node_modules/ts-jest",
+      "^.+\\.css$": "<rootDir>/config/jest/cssTransform.js",
+      "^.+\\.ftl$": "<rootDir>/config/jest/contentTransform.js",
+      "^(?!.*\\.(js|jsx|mjs|ts|tsx|css|json|ftl)$)":
+        "<rootDir>/config/jest/fileTransform.js",
+    },
+    transformIgnorePatterns: [
+      `[/\\\\]node_modules[/\\\\](?!(fluent|react-relay-network-modern|@coralproject/rte/lib|internmap|${d3Pkgs.join(
+        "|"
+      )})[/\\\\]).+\\.(js|jsx|mjs|ts|tsx)$`,
+    ],
+    moduleNameMapper: {
+      "^coral-account/(.*)$": "<rootDir>/src/core/client/account/$1",
+      "^coral-admin/(.*)$": "<rootDir>/src/core/client/admin/$1",
+      "^coral-auth/(.*)$": "<rootDir>/src/core/client/auth/$1",
+      "^coral-count/(.*)$": "<rootDir>/src/core/client/count/$1",
+      "^coral-ui/(.*)$": "<rootDir>/src/core/client/ui/$1",
+      "^coral-stream/(.*)$": "<rootDir>/src/core/client/stream/$1",
+      "^coral-framework/(.*)$": "<rootDir>/src/core/client/framework/$1",
+      "^coral-common/(.*)$": "<rootDir>/src/core/common/$1",
+      "^coral-test/(.*)$": "<rootDir>/src/core/client/test/$1",
+    },
+    moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node", "ftl"],
+    globals: {
+      "ts-jest": {
+        babelConfig: true,
+        tsConfig: path.resolve(__dirname, "../../src/core/client/tsconfig.json"),
+      },
+    },
+    preset: "ts-jest/presets/js-with-babel",
+  };
+}
+
+module.exports = createConfig;

config/jest/client.config.js

@@ -1,83 +1,9 @@
-const path = require("path");
+const createConfig = require("./client.baseConfig");
 
-const d3Pkgs = [
-  "d3",
-  "d3-array",
-  "d3-axis",
-  "d3-brush",
-  "d3-chord",
-  "d3-color",
-  "d3-contour",
-  "d3-delaunay",
-  "d3-dispatch",
-  "d3-drag",
-  "d3-dsv",
-  "d3-ease",
-  "d3-fetch",
-  "d3-force",
-  "d3-format",
-  "d3-geo",
-  "d3-hierarchy",
-  "d3-interpolate",
-  "d3-path",
-  "d3-polygon",
-  "d3-quadtree",
-  "d3-random",
-  "d3-scale",
-  "d3-scale-chromatic",
-  "d3-selection",
-  "d3-shape",
-  "d3-time",
-  "d3-time-format",
-  "d3-timer",
-  "d3-transition",
-  "d3-zoom",
-];
+const baseConfig = createConfig();
 
 module.exports = {
+  ...baseConfig,
   displayName: "client",
-  rootDir: "../../",
   roots: ["<rootDir>/src/core/client"],
-  collectCoverageFrom: ["**/*.{js,jsx,mjs,ts,tsx}"],
-  coveragePathIgnorePatterns: ["/node_modules/"],
-  setupFiles: [
-    "<rootDir>/src/core/client/test/polyfills.ts",
-    "<rootDir>/src/core/client/test/setup.ts",
-  ],
-  setupFilesAfterEnv: ["<rootDir>/src/core/client/test/setupTestFramework.ts"],
-  testMatch: ["**/*.spec.{js,jsx,mjs,ts,tsx}"],
-  testEnvironment: "node",
-  testURL: "http://localhost",
-  transform: {
-    "^.+\\.jsx?$": "<rootDir>/node_modules/babel-jest",
-    "^.+\\.tsx?$": "<rootDir>/node_modules/ts-jest",
-    "^.+\\.css$": "<rootDir>/config/jest/cssTransform.js",
-    "^.+\\.ftl$": "<rootDir>/config/jest/contentTransform.js",
-    "^(?!.*\\.(js|jsx|mjs|ts|tsx|css|json|ftl)$)":
-      "<rootDir>/config/jest/fileTransform.js",
-  },
-  transformIgnorePatterns: [
-    `[/\\\\]node_modules[/\\\\](?!(fluent|react-relay-network-modern|@coralproject/rte/lib|internmap|${d3Pkgs.join(
-      "|"
-    )})[/\\\\]).+\\.(js|jsx|mjs|ts|tsx)$`,
-  ],
-  moduleNameMapper: {
-    "^coral-account/(.*)$": "<rootDir>/src/core/client/account/$1",
-    "^coral-admin/(.*)$": "<rootDir>/src/core/client/admin/$1",
-    "^coral-auth/(.*)$": "<rootDir>/src/core/client/auth/$1",
-    "^coral-count/(.*)$": "<rootDir>/src/core/client/count/$1",
-    "^coral-ui/(.*)$": "<rootDir>/src/core/client/ui/$1",
-    "^coral-stream/(.*)$": "<rootDir>/src/core/client/stream/$1",
-    "^coral-framework/(.*)$": "<rootDir>/src/core/client/framework/$1",
-    "^coral-common/(.*)$": "<rootDir>/src/core/common/$1",
-    "^coral-test/(.*)$": "<rootDir>/src/core/client/test/$1",
-  },
-  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node", "ftl"],
-  globals: {
-    "ts-jest": {
-      babelConfig: true,
-      tsConfig: path.resolve(__dirname, "../../src/core/client/tsconfig.json"),
-    },
-  },
-  preset: "ts-jest/presets/js-with-babel",
-};
+}

config/jest/client.other.config.js

@@ -0,0 +1,27 @@
+const fs = require("fs");
+const path = require("path");
+const createConfig = require("./client.baseConfig");
+
+const dir = "./src/core/client";
+const dirItems = fs.readdirSync(dir);
+let roots = [];
+
+const excludedRoots = ["src/core/client/stream", "src/core/client/admin"];
+
+for (const item of dirItems) {
+  const fullPath = path.join(dir, item);
+  const stats = fs.statSync(fullPath);
+  if (stats.isDirectory() && !excludedRoots.includes(fullPath)) {
+    roots.push(fullPath);
+  }
+}
+
+roots = roots.map((r) => `<rootDir>/${r}`);
+
+const baseConfig = createConfig();
+
+module.exports = {
+  ...baseConfig,
+  displayName: "client:other",
+  roots
+}

config/jest/client.stream.config.js

@@ -0,0 +1,9 @@
+const createConfig = require("./client.baseConfig");
+
+const baseConfig = createConfig();
+
+module.exports = {
+  ...baseConfig,
+  displayName: "client:stream",
+  roots: ["<rootDir>/src/core/client/stream"],
+}

config/paths.client.admin.ts

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import appPaths from "../src/core/build/paths";
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebookincubator/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath: string) =>
+  path.resolve(appDirectory, relativePath);
+
+// config after eject: we're in ./config/
+export default {
+  ...appPaths,
+  appJestConfig: resolveApp("config/jest.client.admin.config.js"),
+};

config/paths.client.other.ts

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import appPaths from "../src/core/build/paths";
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebookincubator/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath: string) =>
+  path.resolve(appDirectory, relativePath);
+
+// config after eject: we're in ./config/
+export default {
+  ...appPaths,
+  appJestConfig: resolveApp("config/jest.client.other.config.js"),
+};

config/paths.client.stream.ts

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import appPaths from "../src/core/build/paths";
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebookincubator/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath: string) =>
+  path.resolve(appDirectory, relativePath);
+
+// config after eject: we're in ./config/
+export default {
+  ...appPaths,
+  appJestConfig: resolveApp("config/jest.client.stream.config.js"),
+};

config/paths.client.ts

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import appPaths from "../src/core/build/paths";
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebookincubator/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath: string) =>
+  path.resolve(appDirectory, relativePath);
+
+// config after eject: we're in ./config/
+export default {
+  ...appPaths,
+  appJestConfig: resolveApp("config/jest.client.config.js"),
+};

config/paths.server.ts

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import appPaths from "../src/core/build/paths";
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebookincubator/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath: string) =>
+  path.resolve(appDirectory, relativePath);
+
+// config after eject: we're in ./config/
+export default {
+  ...appPaths,
+  appJestConfig: resolveApp("config/jest.server.config.js"),
+};

package.json

@@ -57,7 +57,11 @@
     "start:development:withJobs": "NODE_ENV=development TS_NODE_PROJECT=./src/tsconfig.json ts-node-dev --inspect --transpile-only --no-notify -r tsconfig-paths/register --ignore-watch ./docs/ ./src/index.ts",
     "start:webpackDevServer": "ts-node --transpile-only ./scripts/start.ts",
     "start": "NODE_ENV=production node dist/index.js",
-    "test": "node --trace-warnings scripts/test.js --env=jsdom",
+    "test": "node --trace-warnings scripts/test.js --watch",
+    "test:server": "node --trace-warnings scripts/testServer.js",
+    "test:client:stream": "node --trace-warnings scripts/testClient.stream.js",
+    "test:client:admin": "node --trace-warnings scripts/testClient.admin.js",
+    "test:client:other": "node --trace-warnings scripts/testClient.other.js",
     "test:cache": "node --trace-warnings scripts/test.cache.js --env=jsdom",
     "tscheck:client": "tsc --project ./src/core/client/tsconfig.json --noEmit",
     "tscheck:scripts": "tsc --project ./tsconfig.json --noEmit",