jest.config.ts 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. /* eslint-env node */
  2. import type {Config} from '@jest/types';
  3. import path from 'node:path';
  4. import process from 'node:process';
  5. import babelConfig from './babel.config';
  6. const {
  7. CI,
  8. JEST_TESTS,
  9. JEST_TEST_BALANCER,
  10. CI_NODE_TOTAL,
  11. CI_NODE_INDEX,
  12. GITHUB_PR_SHA,
  13. GITHUB_PR_REF,
  14. GITHUB_RUN_ID,
  15. GITHUB_RUN_ATTEMPT,
  16. } = process.env;
  17. const IS_MASTER_BRANCH = GITHUB_PR_REF === 'refs/heads/master';
  18. const BALANCE_RESULTS_PATH = path.resolve(
  19. __dirname,
  20. 'tests',
  21. 'js',
  22. 'test-balancer',
  23. 'jest-balance.json'
  24. );
  25. const optionalTags: {
  26. balancer?: boolean;
  27. balancer_strategy?: string;
  28. } = {
  29. balancer: false,
  30. };
  31. if (!!JEST_TEST_BALANCER && !CI) {
  32. throw new Error(
  33. '[Operation only allowed in CI]: Jest test balancer should never be ran manually as you risk skewing the numbers - please trigger the automated github workflow at https://github.com/getsentry/sentry/actions/workflows/jest-balance.yml'
  34. );
  35. }
  36. /**
  37. * In CI we may need to shard our jest tests so that we can parellize the test runs
  38. *
  39. * `JEST_TESTS` is a list of all tests that will run, captured by `jest --listTests`
  40. * Then we split up the tests based on the total number of CI instances that will
  41. * be running the tests.
  42. */
  43. let testMatch: string[] | undefined;
  44. function getTestsForGroup(
  45. nodeIndex: number,
  46. nodeTotal: number,
  47. allTests: ReadonlyArray<string>,
  48. testStats: Record<string, number>
  49. ): string[] {
  50. const speculatedSuiteDuration = Object.values(testStats).reduce((a, b) => a + b, 0);
  51. const targetDuration = speculatedSuiteDuration / nodeTotal;
  52. if (speculatedSuiteDuration <= 0) {
  53. throw new Error('Speculated suite duration is <= 0');
  54. }
  55. // We are going to take all of our tests and split them into groups.
  56. // If we have a test without a known duration, we will default it to 2 second
  57. // This is to ensure that we still assign some weight to the tests and still attempt to somewhat balance them.
  58. // The 1.5s default is selected as a p50 value of all of our JS tests in CI (as of 2022-10-26) taken from our sentry performance monitoring.
  59. const tests = new Map<string, number>();
  60. const SUITE_P50_DURATION_MS = 1500;
  61. // First, iterate over all of the tests we have stats for.
  62. for (const test in testStats) {
  63. if (testStats[test] <= 0) {
  64. throw new Error(`Test duration is <= 0 for ${test}`);
  65. }
  66. tests.set(test, testStats[test]);
  67. }
  68. // Then, iterate over all of the remaining tests and assign them a default duration.
  69. for (const test of allTests) {
  70. if (tests.has(test)) {
  71. continue;
  72. }
  73. tests.set(test, SUITE_P50_DURATION_MS);
  74. }
  75. // Sanity check to ensure that we have all of our tests accounted for, we need to fail
  76. // if this is not the case as we risk not executing some tests and passing the build.
  77. if (tests.size < allTests.length) {
  78. throw new Error(
  79. `All tests should be accounted for, missing ${allTests.length - tests.size}`
  80. );
  81. }
  82. const groups: string[][] = [];
  83. // We sort files by path so that we try and improve the transformer cache hit rate.
  84. // Colocated domain specific files are likely to require other domain specific files.
  85. const testsSortedByPath = Array.from(tests.entries()).sort((a, b) => {
  86. // WidgetBuilder tests are a special case as they can sometimes take a long time to run (3-5 minutes)
  87. // As such, we want to ensure that they are ran in the same group as other widget builder tests.
  88. // We do this by sorting them by the path of the widget builder test which ensures they are started by the first job
  89. // in the CI group and that all of the tests actually run in the same group.
  90. if (a[0].includes('widgetBuilder')) {
  91. return -1;
  92. }
  93. if (b[0].includes('widgetBuilder')) {
  94. return 1;
  95. }
  96. return a[0].localeCompare(b[0]);
  97. });
  98. for (let group = 0; group < nodeTotal; group++) {
  99. groups[group] = [];
  100. let duration = 0;
  101. // While we are under our target duration and there are tests in the group
  102. while (duration < targetDuration && testsSortedByPath.length > 0) {
  103. // We peek the next item to check that it is not some super long running
  104. // test that may exceed our target duration. For example, if target runtime for each group is
  105. // 10 seconds, we have currently accounted for 9 seconds, and the next test is 5 seconds, we
  106. // want to move that test to the next group so as to avoid a 40% imbalance.
  107. const peek = testsSortedByPath[testsSortedByPath.length - 1];
  108. if (duration + peek[1] > targetDuration && peek[1] > 30_000) {
  109. break;
  110. }
  111. const nextTest = testsSortedByPath.pop();
  112. if (!nextTest) {
  113. throw new TypeError('Received falsy test' + JSON.stringify(nextTest));
  114. }
  115. groups[group].push(nextTest[0]);
  116. duration += nextTest[1];
  117. }
  118. }
  119. // Whatever may be left over will get round robin'd into the groups.
  120. let i = 0;
  121. while (testsSortedByPath.length) {
  122. const nextTest = testsSortedByPath.pop();
  123. if (!nextTest) {
  124. throw new TypeError('Received falsy test' + JSON.stringify(nextTest));
  125. }
  126. groups[i % 4].push(nextTest[0]);
  127. i++;
  128. }
  129. // Make sure we exhausted all tests before proceeding.
  130. if (testsSortedByPath.length > 0) {
  131. throw new Error('All tests should be accounted for');
  132. }
  133. // We need to ensure that everything from jest --listTests is accounted for.
  134. for (const test of allTests) {
  135. if (!tests.has(test)) {
  136. throw new Error(`Test ${test} is not accounted for`);
  137. }
  138. }
  139. if (!groups[nodeIndex]) {
  140. throw new Error(`No tests found for node ${nodeIndex}`);
  141. }
  142. return groups[nodeIndex].map(test => `<rootDir>/${test}`);
  143. }
  144. if (
  145. JEST_TESTS &&
  146. typeof CI_NODE_TOTAL !== 'undefined' &&
  147. typeof CI_NODE_INDEX !== 'undefined'
  148. ) {
  149. let balance: null | Record<string, number> = null;
  150. try {
  151. balance = require(BALANCE_RESULTS_PATH);
  152. } catch (err) {
  153. // Just ignore if balance results doesn't exist
  154. }
  155. // Taken from https://github.com/facebook/jest/issues/6270#issue-326653779
  156. const envTestList: string[] = JSON.parse(JEST_TESTS).map(file =>
  157. file.replace(__dirname, '')
  158. );
  159. const nodeTotal = Number(CI_NODE_TOTAL);
  160. const nodeIndex = Number(CI_NODE_INDEX);
  161. if (balance) {
  162. optionalTags.balancer = true;
  163. optionalTags.balancer_strategy = 'by_path';
  164. testMatch = getTestsForGroup(nodeIndex, nodeTotal, envTestList, balance);
  165. } else {
  166. const tests = envTestList.sort((a, b) => b.localeCompare(a));
  167. const length = tests.length;
  168. const size = Math.floor(length / nodeTotal);
  169. const remainder = length % nodeTotal;
  170. const offset = Math.min(nodeIndex, remainder) + nodeIndex * size;
  171. const chunk = size + (nodeIndex < remainder ? 1 : 0);
  172. testMatch = tests.slice(offset, offset + chunk).map(test => '<rootDir>' + test);
  173. }
  174. }
  175. /**
  176. * For performance we don't want to try and compile everything in the
  177. * node_modules, but some packages which use ES6 syntax only NEED to be
  178. * transformed.
  179. */
  180. const ESM_NODE_MODULES = [];
  181. const config: Config.InitialOptions = {
  182. verbose: false,
  183. collectCoverageFrom: [
  184. 'static/app/**/*.{js,jsx,ts,tsx}',
  185. '!static/app/**/*.spec.{js,jsx,ts,tsx}',
  186. ],
  187. coverageReporters: ['html', 'cobertura'],
  188. coverageDirectory: '.artifacts/coverage',
  189. moduleNameMapper: {
  190. '^sentry/(.*)': '<rootDir>/static/app/$1',
  191. '^sentry-fixture/(.*)': '<rootDir>/fixtures/js-stubs/$1',
  192. '^sentry-test/(.*)': '<rootDir>/tests/js/sentry-test/$1',
  193. '^sentry-locale/(.*)': '<rootDir>/src/sentry/locale/$1',
  194. '\\.(css|less|png|jpg|mp4)$': '<rootDir>/tests/js/sentry-test/importStyleMock.js',
  195. '\\.(svg)$': '<rootDir>/tests/js/sentry-test/svgMock.js',
  196. // Disable echarts in test, since they're very slow and take time to
  197. // transform
  198. '^echarts/(.*)': '<rootDir>/tests/js/sentry-test/echartsMock.js',
  199. '^zrender/(.*)': '<rootDir>/tests/js/sentry-test/echartsMock.js',
  200. },
  201. setupFiles: [
  202. '<rootDir>/static/app/utils/silence-react-unsafe-warnings.ts',
  203. 'jest-canvas-mock',
  204. ],
  205. setupFilesAfterEnv: [
  206. '<rootDir>/tests/js/setup.ts',
  207. '<rootDir>/tests/js/setupFramework.ts',
  208. '@testing-library/jest-dom/extend-expect',
  209. ],
  210. testMatch: testMatch || ['<rootDir>/static/**/?(*.)+(spec|test).[jt]s?(x)'],
  211. testPathIgnorePatterns: ['<rootDir>/tests/sentry/lang/javascript/'],
  212. unmockedModulePathPatterns: [
  213. '<rootDir>/node_modules/react',
  214. '<rootDir>/node_modules/reflux',
  215. ],
  216. transform: {
  217. '^.+\\.jsx?$': ['babel-jest', babelConfig as any],
  218. '^.+\\.tsx?$': ['babel-jest', babelConfig as any],
  219. '^.+\\.pegjs?$': '<rootDir>/tests/js/jest-pegjs-transform.js',
  220. },
  221. transformIgnorePatterns: [
  222. ESM_NODE_MODULES.length
  223. ? `/node_modules/(?!${ESM_NODE_MODULES.join('|')})`
  224. : '/node_modules/',
  225. ],
  226. moduleFileExtensions: ['js', 'ts', 'jsx', 'tsx'],
  227. globals: {},
  228. testResultsProcessor: JEST_TEST_BALANCER
  229. ? '<rootDir>/tests/js/test-balancer/index.js'
  230. : undefined,
  231. reporters: [
  232. 'default',
  233. [
  234. 'jest-junit',
  235. {
  236. outputDirectory: '.artifacts',
  237. outputName: 'jest.junit.xml',
  238. },
  239. ],
  240. ],
  241. /**
  242. * jest.clearAllMocks() automatically called before each test
  243. * @link - https://jestjs.io/docs/configuration#clearmocks-boolean
  244. */
  245. clearMocks: true,
  246. testEnvironment: 'jsdom',
  247. testEnvironmentOptions: {
  248. sentryConfig: {
  249. init: {
  250. // jest project under Sentry organization (dev productivity team)
  251. dsn: 'https://3fe1dce93e3a4267979ebad67f3de327@sentry.io/4857230',
  252. // Use production env to reduce sampling of commits on master
  253. environment: CI ? (IS_MASTER_BRANCH ? 'ci:master' : 'ci:pull_request') : 'local',
  254. tracesSampleRate: CI ? 1 : 0.5,
  255. profilesSampleRate: 0.1,
  256. transportOptions: {keepAlive: true},
  257. },
  258. transactionOptions: {
  259. tags: {
  260. ...optionalTags,
  261. branch: GITHUB_PR_REF,
  262. commit: GITHUB_PR_SHA,
  263. github_run_attempt: GITHUB_RUN_ATTEMPT,
  264. github_actions_run: `https://github.com/getsentry/sentry/actions/runs/${GITHUB_RUN_ID}`,
  265. },
  266. },
  267. },
  268. },
  269. };
  270. export default config;