Migrate build tooling to Vite

Switch the project to build using Vite, per the considerations outlined in #1212. Notable changes are: * `react-scripts` would provide some built-in Jest transforms and mocks under the hood, which need to be defined explicitly now. * Build-time injected constants no longer utilize `process.env`. Signed-off-by: Máté Szabó <[email protected]>
jaegertracing · Mar 3, 2023 · 426f021 · 426f021
1 parent f5d276d
commit 426f021
Show file tree

Hide file tree

Showing 25 changed files with 1,783 additions and 6,106 deletions.
diff --git a/BUILD.md b/BUILD.md
@@ -20,14 +20,6 @@ In the project root, `typescript` is used to bolster the linting of TypeScript f
 
 In `./packages/plexus`, `typescript` is used to generate type declarations for the ES module build. See [`./packages/plexus/BUILD.md`](packages/plexus/BUILD.md#typescript---emitdeclarationonly) for details.
 
-### Workspaces
-
-[Create React App](https://facebook.github.io/create-react-app/) (CRA) is used as the build-tooling for the Jaeger UI website. In 2.1.2+ CRA introduced a guard for the `start`, `build` and `test` scripts which checks the version of NPM packages available to make sure they're consistent with CRA's expectations ([reference](https://github.com/facebook/create-react-app/blob/dea19fdb30c2e896ed8ac75b68a612b0b92b2406/packages/react-scripts/scripts/utils/verifyPackageTree.js#L23-L29)). This process checks `node_modules` in parent directories and errors if an unexpected package version is encountered.
-
-To avoid a world of pain, the [`nohoist`](https://yarnpkg.com/blog/2018/02/15/nohoist/#scope-private) feature of `yarn` workspaces is leveraged. CRA and it's dependencies are local to `./packages/jaeger-ui/node_modules` instead of `./node_modules`, i.e. they're not hoisted. This ensures CRA is using the packages it expects to use.
-
-Unfortunately, the CRA check is not savvy to `yarn` workspaces and errors even though the _`yarn` workspace-magic_ ensures the right packages are actually used by the CRA scripts. So, the escape hatch provided by CRA is used to skip the check: the envvar `SKIP_PREFLIGHT_CHECK=true`, set in `./packages/jaeger-ui/.env`.
-
 ### Scripts
 
 #### `build`

diff --git a/package.json b/package.json
@@ -37,12 +37,7 @@
       "packages/*"
     ],
     "nohoist": [
-      "**/customize-cra",
-      "**/customize-cra/**",
-      "**/react-scripts",
-      "**/react-scripts/**",
-      "**/react-app-rewired",
-      "**/react-app-rewired/**"
+      "**/parse5"
     ]
   },
   "scripts": {

diff --git a/packages/jaeger-ui/.env b/packages/jaeger-ui/.env
diff --git a/packages/jaeger-ui/.eslintrc.js b/packages/jaeger-ui/.eslintrc.js
@@ -0,0 +1,11 @@
+module.exports = {
+  // Let ESLint know about constants injected by the build system.
+  // These aren't technically globals (in that they are replaced by literals at build time),
+  // but from a linter perspective, they are globals and so need to be explicitly listed.
+  // https://vitejs.dev/config/shared-options.html#define
+  globals: {
+    __REACT_APP_GA_DEBUG__: false,
+    __REACT_APP_VSN_STATE__: false,
+    __APP_ENVIRONMENT__: false,
+  },
+};
diff --git a/packages/jaeger-ui/.gitignore b/packages/jaeger-ui/.gitignore
@@ -1 +1,4 @@
 tsconfig.lint.tsbuildinfo
+
+# Bundle size breakdown generated by rollup-plugin-visualizer
+stats.html
diff --git a/packages/jaeger-ui/config-overrides-antd-vars.less b/packages/jaeger-ui/config-overrides-antd-vars.less
diff --git a/packages/jaeger-ui/config-overrides.js b/packages/jaeger-ui/config-overrides.js
diff --git a/packages/jaeger-ui/public/favicon.ico → packages/jaeger-ui/favicon.ico b/packages/jaeger-ui/public/favicon.ico → packages/jaeger-ui/favicon.ico
diff --git a/packages/jaeger-ui/public/index.html → packages/jaeger-ui/index.html b/packages/jaeger-ui/public/index.html → packages/jaeger-ui/index.html
@@ -12,7 +12,7 @@
 
     <!-- NOTE: The document MUST have a <base> element. package.json#homepage is set to "." as part of resolving https://github.com/jaegertracing/jaeger-ui/issues/42 and therefore static assets are linked via relative URLs. This will break on many document URLs, e.g. /trace/abc, unless a valid base URL is provided. The base href defaults to "/" but the query-service can inject an override. -->
     <base href="/" data-inject-target="BASE_URL" />
-    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
+    <link rel="shortcut icon" href="/favicon.ico">
     <title>Jaeger UI</title>
     <script>
       // Jaeger UI config data is embedded by the query-service via search-replace.
@@ -34,19 +34,20 @@
         const JAEGER_VERSION = DEFAULT_VERSION;
         return JAEGER_VERSION;
       }
+
+      // Workaround some legacy NPM dependencies that assume this is always defined.
+      window.global = {};
+      // Avoid noise from redux-form until https://github.com/redux-form/redux-form/pull/4723 is released.
+      window.module = {};
     </script>
   </head>
   <body>
     <div id="jaeger-ui-root"></div>
     <!--
-      This HTML file is a template.
-      If you open it directly in the browser, you will see an empty page.
-
-      You can add webfonts, meta tags, or analytics to this file.
-      The build step will place the bundled scripts into the <body> tag.
-
-      To begin the development, run `npm start` in this folder.
-      To create a production bundle, use `npm run build`.
+      This file is the main entry point for the Jaeger UI application.
+      See https://vitejs.dev/guide/#index-html-and-project-root for more information
+      on how asset references are managed by the build system.
     -->
+    <script type="module" src="/src/index.tsx"></script>
   </body>
 </html>
diff --git a/packages/jaeger-ui/jest.global-setup.js b/packages/jaeger-ui/jest.global-setup.js
diff --git a/packages/jaeger-ui/package.json b/packages/jaeger-ui/package.json
@@ -2,44 +2,45 @@
   "private": true,
   "name": "jaeger-ui",
   "version": "1.27.3",
-  "main": "src/index.js",
+  "main": "src/index.tsx",
   "license": "Apache-2.0",
   "homepage": ".",
-  "workspaces": {
-    "nohoist": [
-      "customize-cra",
-      "customize-cra/**",
-      "react-scripts",
-      "react-scripts/**",
-      "react-app-rewired",
-      "react-app-rewired/**"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/jaegertracing/jaeger-ui.git",
     "directory": "packages/jaeger-ui"
   },
   "devDependencies": {
+    "@babel/core": "^7.21.0",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.21.0",
+    "@svgr/babel-plugin-transform-svg-component": "^6.5.1",
+    "@svgr/babel-preset": "^6.5.1",
     "@types/match-sorter": "^2.3.0",
+    "@types/react-router-redux": "^5.0.21",
     "@types/react-window": "^1.8.0",
     "@types/redux-form": "^8.3.5",
+    "@types/rollup-plugin-visualizer": "^4.2.1",
+    "@vitejs/plugin-legacy": "^4.0.1",
+    "@vitejs/plugin-react": "^3.1.0",
     "@wojtekmaj/enzyme-adapter-react-17": "^0.8.0",
-    "babel-plugin-import": "1.13.5",
+    "babel-jest": "^28.1.3",
+    "babel-plugin-inline-react-svg": "^2.0.2",
     "bluebird": "^3.5.0",
-    "customize-cra": "0.2.9",
     "enzyme": "^3.8.0",
     "enzyme-to-json": "^3.6.2",
-    "http-proxy-middleware": "^2.0.6",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "^28.1.3",
     "jest-junit": "^15.0.0",
     "less": "3.13.1",
-    "less-loader": "4.1.0",
-    "less-vars-to-js": "^1.2.1",
-    "react-app-rewired": "2.2.1",
-    "react-scripts": "2.1.3",
     "react-test-renderer": "^18.2.0",
+    "rollup-plugin-visualizer": "^5.9.0",
     "sinon": "7.3.2",
-    "source-map-explorer": "^2.5.3"
+    "source-map-explorer": "^2.5.3",
+    "terser": "^5.16.5",
+    "vite": "^4.1.4",
+    "vite-plugin-imp": "^2.3.1"
   },
   "dependencies": {
     "@jaegertracing/plexus": "0.2.0",
@@ -104,7 +105,7 @@
     "redux": "^3.7.2",
     "redux-actions": "^2.2.1",
     "redux-async-middleware": "^0.0.0",
-    "redux-form": "^8.3.8",
+    "redux-form": "^8.3.9",
     "redux-promise-middleware": "^5.1.1",
     "reselect": "^4.1.6",
     "store": "^2.0.12",
@@ -115,17 +116,21 @@
     "u-basscss": "2.0.1"
   },
   "scripts": {
-    "analyze": "source-map-explorer build/static/js/main.*",
-    "build": "REACT_APP_VSN_STATE=$(../../scripts/get-tracking-version.js) react-app-rewired build",
-    "coverage": "yarn run test --coverage",
-    "start:ga-debug": "REACT_APP_GA_DEBUG=1 REACT_APP_VSN_STATE=$(../../scripts/get-tracking-version.js) react-app-rewired start",
-    "start": "react-app-rewired start",
-    "test-dev": "react-app-rewired test --env=jsdom",
-    "test": "CI=1 react-app-rewired test --env=jsdom --color"
+    "build": "NODE_ENV=production REACT_APP_VSN_STATE=$(../../scripts/get-tracking-version.js) vite build",
+    "coverage": "yarn run test-ci --coverage",
+    "start:ga-debug": "REACT_APP_GA_DEBUG=1 REACT_APP_VSN_STATE=$(../../scripts/get-tracking-version.js) vite",
+    "start": "vite",
+    "test": "jest",
+    "test-ci": "CI=1 jest --color"
   },
   "jest": {
-    "globalSetup": "./jest.global-setup.js",
+    "globalSetup": "./test/jest.global-setup.js",
+    "setupFilesAfterEnv": [
+      "./test/jest-per-test-setup.js"
+    ],
     "collectCoverageFrom": [
+      "src/**/*.{js,jsx,ts,tsx}",
+      "!src/**/*.d.ts",
       "!src/setup*.js",
       "!src/utils/DraggableManager/demo/*.tsx",
       "!src/utils/test/**/*.js",
@@ -135,12 +140,18 @@
     "reporters": [
       "default",
       "jest-junit"
-    ]
-  },
-  "browserslist": [
-    ">0.5%",
-    "not dead",
-    "not ie <= 11",
-    "not op_mini all"
-  ]
+    ],
+    "transform": {
+      "\\.(css|png)$": "./test/generic-file-transform.js",
+      "\\.([jt]sx?|svg)$": "./test/babel-transform.js"
+    },
+    "transformIgnorePatterns": [
+      "[/\\\\\\\\]node_modules[/\\\\\\\\].+\\\\.(js|jsx|mjs|cjs|ts|tsx)$"
+    ],
+    "testEnvironment": "jsdom",
+    "snapshotFormat": {
+      "escapeString": true,
+      "printBasicPrototype": true
+    }
+  }
 }
diff --git a/packages/jaeger-ui/src/components/common/FilteredList/index.test.js b/packages/jaeger-ui/src/components/common/FilteredList/index.test.js
@@ -80,7 +80,7 @@ describe('<FilteredList>', () => {
   describe('up / down arrow keys', () => {
     let indices;
 
-    beforeAll(jest.useFakeTimers);
+    beforeAll(() => jest.useFakeTimers('modern'));
 
     beforeEach(() => {
       indices = {
@@ -266,7 +266,7 @@ describe('<FilteredList>', () => {
   });
 
   it('scrolling unsets the focus index', () => {
-    jest.useFakeTimers();
+    jest.useFakeTimers('modern');
     wrapper.setState({ focusedIndex: 0 });
     wrapper.instance().onListScrolled({ scrollUpdateWasRequested: false });
     jest.runAllTimers();