Webpack v5 bump (#1096)

closes #1074

Author: loiswells97

.github/workflows/ci-cd.yml

@@ -92,9 +92,8 @@ jobs:
         with:
           install: false
           start: |
-            yarn start
             yarn start:wc
-          wait-on: "http://localhost:3010, http://localhost:3011"
+          wait-on: "http://localhost:3011"
           quiet: true
         env:
           REACT_APP_API_ENDPOINT: "https://test-editor-api.raspberrypi.org"

.github/workflows/deploy.yml

@@ -123,11 +123,9 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build site and WC bundle
+      - name: Build WC bundle
         run: |
-          if [[ "${{ inputs.environment }}" == "production" ]]; then
-            yarn build
-          else
+          if [[ "${{ inputs.environment }}" != "production" ]]; then
             yarn build:dev
           fi
           yarn build:wc

CHANGELOG.md

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Changed
 
+- Upgrade to `webpack 5` (#1096)
 - Bump `pyodide` to `v0.26.2` (#1098)
 
 ### Fixed

config/webpack.config.js

@@ -15,55 +15,22 @@ const sockPort = process.env.WDS_SOCKET_PORT;
 module.exports = function (proxy, _allowedHost) {
   return {
     allowedHosts: "all",
-    // Enable gzip compression of generated files.
     compress: true,
-    // Enable hot reloading server. It will provide WDS_SOCKET_PATH endpoint
-    // for the WebpackDevServer client so it can learn when the files were
-    // updated. The WebpackDevServer client is included as an entry point
-    // in the webpack development configuration. Note that only changes
-    // to CSS are currently hot reloaded. JS changes will refresh the browser.
     hot: true,
-    // Use 'ws' instead of 'sockjs-node' on server since we're using native
-    // websockets in `webpackHotDevClient`.
     webSocketServer: "ws",
-    // It is important to tell WebpackDevServer to use the same "publicPath" path as
-    // we specified in the webpack config. When homepage is '.', default to serving
-    // from the root.
-    // remove last slash so user can land on `/test` instead of `/test/`
     devMiddleware: {
       publicPath: paths.publicUrlOrPath.slice(0, -1),
     },
     static: {
-      // By default WebpackDevServer serves physical files from current directory
-      // in addition to all the virtual build products that it serves from memory.
-      // This is confusing because those files won’t automatically be available in
-      // production build folder unless we copy them. However, copying the whole
-      // project directory is dangerous because we may expose sensitive files.
-      // Instead, we establish a convention that only files in `public` directory
-      // get served. Our build script will copy `public` into the `build` folder.
-      // In `index.html`, you can get URL of `public` folder with %PUBLIC_URL%:
-      // <link rel="icon" href="%PUBLIC_URL%/favicon.ico">
-      // In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
-      // Note that we only recommend to use `public` folder as an escape hatch
-      // for files like `favicon.ico`, `manifest.json`, and libraries that are
-      // for some reason broken when imported through webpack. If you just want to
-      // use an image, put it in `src` and `import` it from JavaScript instead.
       directory: paths.appPublic,
       publicPath: paths.publicUrlOrPath,
-      // By default files from `directory` will not trigger a page reload.
-      // Reportedly, this avoids CPU overload on some systems.
-      // https://github.com/facebook/create-react-app/issues/293
-      // src/node_modules is not ignored to support absolute imports
-      // https://github.com/facebook/create-react-app/issues/1065
       watch: {
         ignored: ignoredFiles(paths.appSrc),
       },
     },
     https: getHttpsConfig(),
     host,
     historyApiFallback: {
-      // Paths with dots should still use the history fallback.
-      // See https://github.com/facebook/create-react-app/issues/387.
       disableDotRule: true,
       index: paths.publicUrlOrPath,
     },
@@ -76,44 +43,39 @@ module.exports = function (proxy, _allowedHost) {
       "Cross-Origin-Embedder-Policy": "require-corp",
     },
     client: {
-      // Silence WebpackDevServer's own logs since they're generally not useful.
-      // It will still show compile warnings and errors with this setting.
       logging: "none",
       overlay: false,
       webSocketURL: {
-        // Enable custom sockjs pathname for websocket connection to hot reloading server.
-        // Enable custom sockjs hostname, pathname and port for websocket connection
-        // to hot reloading server.
         hostname: sockHost,
         pathname: sockPath,
         port: sockPort,
       },
     },
-    // `proxy` is run between `before` and `after` `webpack-dev-server` hooks
     proxy,
-    onBeforeSetupMiddleware(devServer) {
+    setupMiddlewares: (middlewares, devServer) => {
       // Keep `evalSourceMapMiddleware` and `errorOverlayMiddleware`
       // middlewares before `redirectServedPath` otherwise will not have any effect
       // This lets us fetch source contents from webpack for the error overlay
-      devServer.app.use(evalSourceMapMiddleware(devServer));
+      middlewares.unshift(evalSourceMapMiddleware(devServer));
       // This lets us open files from the runtime error overlay.
-      devServer.app.use(errorOverlayMiddleware());
+      middlewares.unshift(errorOverlayMiddleware());
 
       if (fs.existsSync(paths.proxySetup)) {
         // This registers user provided middleware for proxy reasons
         require(paths.proxySetup)(devServer.app);
       }
-    },
-    onAfterSetupMiddleware(devServer) {
+
       // Redirect to `PUBLIC_URL` or `homepage` from `package.json` if url not match
-      devServer.app.use(redirectServedPath(paths.publicUrlOrPath));
+      middlewares.push(redirectServedPath(paths.publicUrlOrPath));
 
       // This service worker file is effectively a 'no-op' that will reset any
       // previous service worker registered for the same host:port combination.
       // We do this in development to avoid hitting the production cache if
       // it used the same host and port.
       // https://github.com/facebook/create-react-app/issues/2272#issuecomment-302832432
-      devServer.app.use(noopServiceWorkerMiddleware(paths.publicUrlOrPath));
+      middlewares.push(noopServiceWorkerMiddleware(paths.publicUrlOrPath));
+
+      return middlewares;
     },
   };
 };

config/webpackDevServer.config.js

@@ -1,4 +1,7 @@
 import { defineConfig } from "cypress";
+import dotenv from "dotenv";
+
+dotenv.config();
 
 export default defineConfig({
   e2e: {
@@ -20,4 +23,7 @@ export default defineConfig({
       openMode: 0,
     },
   },
+  env: {
+    REACT_APP_API_ENDPOINT: process.env.REACT_APP_API_ENDPOINT,
+  },
 });