From 1796435f0dfde13f0b779d37d882760f2f1be88a Mon Sep 17 00:00:00 2001 From: Kai Mansfield Date: Wed, 27 Sep 2023 08:34:33 +0100 Subject: [PATCH] created frontend dir and created a template to work from --- .devcontainer/devcontainer.json | 6 +- .devcontainer/docker-compose.yaml | 6 + .github/workflows/eslintrc.yml | 10 + .github/workflows/frontend-code.yml | 39 + frontend/.devcontainer/devcontainer.json | 29 + frontend/.gitignore | 6 + frontend/config/env.js | 104 + frontend/config/getHttpsConfig.js | 64 + frontend/config/jest/babelTransform.js | 27 + frontend/config/jest/cssTransform.js | 12 + frontend/config/jest/fileTransform.js | 38 + frontend/config/modules.js | 132 + frontend/config/paths.js | 77 + frontend/config/webpack.config.js | 616 ++ .../persistentCache/createEnvironmentHash.js | 8 + frontend/config/webpackDevServer.config.js | 125 + frontend/package.json | 139 + frontend/scripts/build.js | 215 + frontend/scripts/lint.js | 34 + frontend/scripts/start.js | 152 + frontend/scripts/test.js | 50 + frontend/src/index.ts | 0 frontend/src/setupTests.ts | 1 + frontend/tsconfig.json | 13 + frontend/yarn.lock | 9061 +++++++++++++++++ 25 files changed, 10961 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/eslintrc.yml create mode 100644 .github/workflows/frontend-code.yml create mode 100644 frontend/.devcontainer/devcontainer.json create mode 100644 frontend/.gitignore create mode 100644 frontend/config/env.js create mode 100644 frontend/config/getHttpsConfig.js create mode 100644 frontend/config/jest/babelTransform.js create mode 100644 frontend/config/jest/cssTransform.js create mode 100644 frontend/config/jest/fileTransform.js create mode 100644 frontend/config/modules.js create mode 100644 frontend/config/paths.js create mode 100644 frontend/config/webpack.config.js create mode 100644 frontend/config/webpack/persistentCache/createEnvironmentHash.js create mode 100644 frontend/config/webpackDevServer.config.js create mode 100644 frontend/package.json create mode 100644 frontend/scripts/build.js create mode 100644 frontend/scripts/lint.js create mode 100644 frontend/scripts/start.js create mode 100644 frontend/scripts/test.js create mode 100644 frontend/src/index.ts create mode 100644 frontend/src/setupTests.ts create mode 100644 frontend/tsconfig.json create mode 100644 frontend/yarn.lock diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 84f680d0..75fd30c9 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -6,14 +6,14 @@ "extensions": [ "redhat.vscode-yaml", "tsandall.opa", - "ms-kubernetes-tools.vscode-kubernetes-tools" + "ms-kubernetes-tools.vscode-kubernetes-tools" ] } }, "features": { "ghcr.io/devcontainers/features/common-utils:2": { - "username": "none", - "upgradePackages": false + "username": "none", + "upgradePackages": false }, "ghcr.io/devcontainers/features/git-lfs:1": {} }, diff --git a/.devcontainer/docker-compose.yaml b/.devcontainer/docker-compose.yaml index 95f6cf39..951c305b 100644 --- a/.devcontainer/docker-compose.yaml +++ b/.devcontainer/docker-compose.yaml @@ -13,6 +13,12 @@ services: DATABASE_URL: postgres://postgres:password@postgres RABBITMQ_URL: amqp://rabbitmq:password@rabbitmq + frontend: + image: docker.io/library/node:20.6.0-bookworm + volumes: + - ..:/workspace:z + command: sleep infinity + opa: image: docker.io/openpolicyagent/opa:0.53.1 volumes: diff --git a/.github/workflows/eslintrc.yml b/.github/workflows/eslintrc.yml new file mode 100644 index 00000000..2fec1aab --- /dev/null +++ b/.github/workflows/eslintrc.yml @@ -0,0 +1,10 @@ +env: +es2021: true +browser: true + +extends: + - eslint:recommended + +parserOptions: +ecmaVersion: 2021 +sourceType: module diff --git a/.github/workflows/frontend-code.yml b/.github/workflows/frontend-code.yml new file mode 100644 index 00000000..0a61ce1f --- /dev/null +++ b/.github/workflows/frontend-code.yml @@ -0,0 +1,39 @@ +name: Frontend Code + +on: + push: + pull_request: + +jobs: + test: + if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository + name: Frontend Test + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4.1.0 + + - name: Node Action + uses: actions/setup-node@v3.8.1 + with: + node-version: 18.x + cache: "npm" + cache-dependency-path: frontend/ + + - name: yarn install + uses: borales/actions-yarn@v4.2.0 + with: + cmd: install + dir: "frontend" + + - name: yarn test + uses: borales/actions-yarn@v4 + with: + cmd: test --passWithNoTests + dir: "frontend" + + - name: yarn eslint-lint + uses: borales/actions-yarn@v4 + with: + cmd: eslint-lint + dir: "frontend" diff --git a/frontend/.devcontainer/devcontainer.json b/frontend/.devcontainer/devcontainer.json new file mode 100644 index 00000000..c51a3b71 --- /dev/null +++ b/frontend/.devcontainer/devcontainer.json @@ -0,0 +1,29 @@ +{ + "name": "xchemlab frontend", + "dockerComposeFile": "../../.devcontainer/docker-compose.yaml", + "service": "frontend", + "customizations": { + "vscode": { + "extensions": [ + "ms-vscode.vscode-typescript-next", + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode" + ] + } + }, + "features": { + "ghcr.io/devcontainers/features/common-utils:2": { + "username": "none", + "upgradePackages": false + }, + "ghcr.io/devcontainers/features/git-lfs:1": {} + }, + // Make sure the files we are mapping into the container exist on the host + "initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'", + "mounts": [ + "source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind", + "source=${localEnv:HOME}/.inputrc,target=/root/.inputrc,type=bind" + ], + "workspaceFolder": "/workspace", + "postCreateCommand": "pre-commit install" +} diff --git a/frontend/.gitignore b/frontend/.gitignore new file mode 100644 index 00000000..5493f5d0 --- /dev/null +++ b/frontend/.gitignore @@ -0,0 +1,6 @@ +node_modules/ + +# Debug and Log Messages +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/frontend/config/env.js b/frontend/config/env.js new file mode 100644 index 00000000..997a3230 --- /dev/null +++ b/frontend/config/env.js @@ -0,0 +1,104 @@ + + +const fs = require('fs'); +const path = require('path'); +const paths = require('./paths'); + +// Make sure that including paths.js after env.js will read .env variables. +delete require.cache[require.resolve('./paths')]; + +const NODE_ENV = process.env.NODE_ENV; +if (!NODE_ENV) { + throw new Error( + 'The NODE_ENV environment variable is required but was not specified.' + ); +} + +// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use +const dotenvFiles = [ + `${paths.dotenv}.${NODE_ENV}.local`, + // Don't include `.env.local` for `test` environment + // since normally you expect tests to produce the same + // results for everyone + NODE_ENV !== 'test' && `${paths.dotenv}.local`, + `${paths.dotenv}.${NODE_ENV}`, + paths.dotenv, +].filter(Boolean); + +// Load environment variables from .env* files. Suppress warnings using silent +// if this file is missing. dotenv will never modify any environment variables +// that have already been set. Variable expansion is supported in .env files. +// https://github.com/motdotla/dotenv +// https://github.com/motdotla/dotenv-expand +dotenvFiles.forEach(dotenvFile => { + if (fs.existsSync(dotenvFile)) { + require('dotenv-expand').expand( + require('dotenv').config({ + path: dotenvFile, + }) + ); + } +}); + +// We support resolving modules according to `NODE_PATH`. +// This lets you use absolute paths in imports inside large monorepos: +// https://github.com/facebook/create-react-app/issues/253. +// It works similar to `NODE_PATH` in Node itself: +// https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders +// Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored. +// Otherwise, we risk importing Node.js core modules into an app instead of webpack shims. +// https://github.com/facebook/create-react-app/issues/1023#issuecomment-265344421 +// We also resolve them to make sure all tools using them work consistently. +const appDirectory = fs.realpathSync(process.cwd()); +process.env.NODE_PATH = (process.env.NODE_PATH || '') + .split(path.delimiter) + .filter(folder => folder && !path.isAbsolute(folder)) + .map(folder => path.resolve(appDirectory, folder)) + .join(path.delimiter); + +// Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be +// injected into the application via DefinePlugin in webpack configuration. +const REACT_APP = /^REACT_APP_/i; + +function getClientEnvironment(publicUrl) { + const raw = Object.keys(process.env) + .filter(key => REACT_APP.test(key)) + .reduce( + (env, key) => { + env[key] = process.env[key]; + return env; + }, + { + // Useful for determining whether we’re running in production mode. + // Most importantly, it switches React into the correct mode. + NODE_ENV: process.env.NODE_ENV || 'development', + // Useful for resolving the correct path to static assets in `public`. + // For example, . + // This should only be used as an escape hatch. Normally you would put + // images into the `src` and `import` them in code to get their paths. + PUBLIC_URL: publicUrl, + // We support configuring the sockjs pathname during development. + // These settings let a developer run multiple simultaneous projects. + // They are used as the connection `hostname`, `pathname` and `port` + // in webpackHotDevClient. They are used as the `sockHost`, `sockPath` + // and `sockPort` options in webpack-dev-server. + WDS_SOCKET_HOST: process.env.WDS_SOCKET_HOST, + WDS_SOCKET_PATH: process.env.WDS_SOCKET_PATH, + WDS_SOCKET_PORT: process.env.WDS_SOCKET_PORT, + // Whether or not react-refresh is enabled. + // It is defined here so it is available in the webpackHotDevClient. + FAST_REFRESH: process.env.FAST_REFRESH !== 'false', + } + ); + // Stringify all values so we can feed into webpack DefinePlugin + const stringified = { + 'process.env': Object.keys(raw).reduce((env, key) => { + env[key] = JSON.stringify(raw[key]); + return env; + }, {}), + }; + + return { raw, stringified }; +} + +module.exports = getClientEnvironment; diff --git a/frontend/config/getHttpsConfig.js b/frontend/config/getHttpsConfig.js new file mode 100644 index 00000000..d035cfe8 --- /dev/null +++ b/frontend/config/getHttpsConfig.js @@ -0,0 +1,64 @@ +const fs = require('fs'); +const path = require('path'); +const crypto = require('crypto'); +const chalk = require('react-dev-utils/chalk'); +const paths = require('./paths'); + +// Ensure the certificate and key provided are valid and if not +// throw an easy to debug error +function validateKeyAndCerts({ cert, key, keyFile, crtFile }) { + let encrypted; + try { + // publicEncrypt will throw an error with an invalid cert + encrypted = crypto.publicEncrypt(cert, Buffer.from('test')); + } catch (err) { + throw new Error( + `The certificate "${chalk.yellow(crtFile)}" is invalid.\n${err.message}` + ); + } + + try { + // privateDecrypt will throw an error with an invalid key + crypto.privateDecrypt(key, encrypted); + } catch (err) { + throw new Error( + `The certificate key "${chalk.yellow(keyFile)}" is invalid.\n${ + err.message + }` + ); + } +} + +// Read file and throw an error if it doesn't exist +function readEnvFile(file, type) { + if (!fs.existsSync(file)) { + throw new Error( + `You specified ${chalk.cyan( + type + )} in your env, but the file "${chalk.yellow(file)}" can't be found.` + ); + } + return fs.readFileSync(file); +} + +// Get the https config +// Return cert files if provided in env, otherwise just true or false +function getHttpsConfig() { + const { SSL_CRT_FILE, SSL_KEY_FILE, HTTPS } = process.env; + const isHttps = HTTPS === 'true'; + + if (isHttps && SSL_CRT_FILE && SSL_KEY_FILE) { + const crtFile = path.resolve(paths.appPath, SSL_CRT_FILE); + const keyFile = path.resolve(paths.appPath, SSL_KEY_FILE); + const config = { + cert: readEnvFile(crtFile, 'SSL_CRT_FILE'), + key: readEnvFile(keyFile, 'SSL_KEY_FILE'), + }; + + validateKeyAndCerts({ ...config, keyFile, crtFile }); + return config; + } + return isHttps; +} + +module.exports = getHttpsConfig; diff --git a/frontend/config/jest/babelTransform.js b/frontend/config/jest/babelTransform.js new file mode 100644 index 00000000..819473c8 --- /dev/null +++ b/frontend/config/jest/babelTransform.js @@ -0,0 +1,27 @@ +const babelJest = require('babel-jest').default; + +const hasJsxRuntime = (() => { + if (process.env.DISABLE_NEW_JSX_TRANSFORM === 'true') { + return false; + } + + try { + require.resolve('react/jsx-runtime'); + return true; + } catch (e) { + return false; + } +})(); + +module.exports = babelJest.createTransformer({ + presets: [ + [ + require.resolve('babel-preset-react-app'), + { + runtime: hasJsxRuntime ? 'automatic' : 'classic', + }, + ], + ], + babelrc: false, + configFile: false, +}); diff --git a/frontend/config/jest/cssTransform.js b/frontend/config/jest/cssTransform.js new file mode 100644 index 00000000..d3612352 --- /dev/null +++ b/frontend/config/jest/cssTransform.js @@ -0,0 +1,12 @@ +// This is a custom Jest transformer turning style imports into empty objects. +// http://facebook.github.io/jest/docs/en/webpack.html + +module.exports = { + process() { + return 'module.exports = {};'; + }, + getCacheKey() { + // The output is always the same. + return 'cssTransform'; + }, +}; diff --git a/frontend/config/jest/fileTransform.js b/frontend/config/jest/fileTransform.js new file mode 100644 index 00000000..b301c88f --- /dev/null +++ b/frontend/config/jest/fileTransform.js @@ -0,0 +1,38 @@ +const path = require('path'); +const camelcase = require('camelcase'); + +// This is a custom Jest transformer turning file imports into filenames. +// http://facebook.github.io/jest/docs/en/webpack.html + +module.exports = { + process(src, filename) { + const assetFilename = JSON.stringify(path.basename(filename)); + + if (filename.match(/\.svg$/)) { + // Based on how SVGR generates a component name: + // https://github.com/smooth-code/svgr/blob/01b194cf967347d43d4cbe6b434404731b87cf27/packages/core/src/state.js#L6 + const pascalCaseFilename = camelcase(path.parse(filename).name, { + pascalCase: true, + }); + const componentName = `Svg${pascalCaseFilename}`; + return `const React = require('react'); + module.exports = { + __esModule: true, + default: ${assetFilename}, + ReactComponent: React.forwardRef(function ${componentName}(props, ref) { + return { + $$typeof: Symbol.for('react.element'), + type: 'svg', + ref: ref, + key: null, + props: Object.assign({}, props, { + children: ${assetFilename} + }) + }; + }), + };`; + } + + return `module.exports = ${assetFilename};`; + }, +}; diff --git a/frontend/config/modules.js b/frontend/config/modules.js new file mode 100644 index 00000000..ddbcc893 --- /dev/null +++ b/frontend/config/modules.js @@ -0,0 +1,132 @@ +const fs = require('fs'); +const path = require('path'); +const paths = require('./paths'); +const chalk = require('react-dev-utils/chalk'); +const resolve = require('resolve'); + +/** + * Get additional module paths based on the baseUrl of a compilerOptions object. + * + * @param {Object} options + */ +function getAdditionalModulePaths(options = {}) { + const baseUrl = options.baseUrl; + + if (!baseUrl) { + return ''; + } + + const baseUrlResolved = path.resolve(paths.appPath, baseUrl); + + // We don't need to do anything if `baseUrl` is set to `node_modules`. This is + // the default behavior. + if (path.relative(paths.appNodeModules, baseUrlResolved) === '') { + return null; + } + + // Allow the user set the `baseUrl` to `appSrc`. + if (path.relative(paths.appSrc, baseUrlResolved) === '') { + return [paths.appSrc]; + } + + // If the path is equal to the root directory we ignore it here. + // We don't want to allow importing from the root directly as source files are + // not transpiled outside of `src`. We do allow importing them with the + // absolute path (e.g. `src/Components/Button.js`) but we set that up with + // an alias. + if (path.relative(paths.appPath, baseUrlResolved) === '') { + return null; + } + + // Otherwise, throw an error. + throw new Error( + chalk.red.bold( + "Your project's `baseUrl` can only be set to `src` or `node_modules`." + + ' Create React App does not support other values at this time.' + ) + ); +} + +/** + * Get webpack aliases based on the baseUrl of a compilerOptions object. + * + * @param {*} options + */ +function getWebpackAliases(options = {}) { + const baseUrl = options.baseUrl; + + if (!baseUrl) { + return {}; + } + + const baseUrlResolved = path.resolve(paths.appPath, baseUrl); + + if (path.relative(paths.appPath, baseUrlResolved) === '') { + return { + src: paths.appSrc, + }; + } +} + +/** + * Get jest aliases based on the baseUrl of a compilerOptions object. + * + * @param {*} options + */ +function getJestAliases(options = {}) { + const baseUrl = options.baseUrl; + + if (!baseUrl) { + return {}; + } + + const baseUrlResolved = path.resolve(paths.appPath, baseUrl); + + if (path.relative(paths.appPath, baseUrlResolved) === '') { + return { + '^src/(.*)$': '/src/$1', + }; + } +} + +function getModules() { + // Check if TypeScript is setup + const hasTsConfig = fs.existsSync(paths.appTsConfig); + const hasJsConfig = fs.existsSync(paths.appJsConfig); + + if (hasTsConfig && hasJsConfig) { + throw new Error( + 'You have both a tsconfig.json and a jsconfig.json. If you are using TypeScript please remove your jsconfig.json file.' + ); + } + + let config; + + // If there's a tsconfig.json we assume it's a + // TypeScript project and set up the config + // based on tsconfig.json + if (hasTsConfig) { + const ts = require(resolve.sync('typescript', { + basedir: paths.appNodeModules, + })); + config = ts.readConfigFile(paths.appTsConfig, ts.sys.readFile).config; + // Otherwise we'll check if there is jsconfig.json + // for non TS projects. + } else if (hasJsConfig) { + config = require(paths.appJsConfig); + } + + config = config || {}; + const options = config.compilerOptions || {}; + + const additionalModulePaths = getAdditionalModulePaths(options); + + return { + additionalModulePaths: additionalModulePaths, + webpackAliases: getWebpackAliases(options), + jestAliases: getJestAliases(options), + hasTsConfig, + }; +} + +module.exports = getModules(); diff --git a/frontend/config/paths.js b/frontend/config/paths.js new file mode 100644 index 00000000..d89f7ae9 --- /dev/null +++ b/frontend/config/paths.js @@ -0,0 +1,77 @@ + + +const path = require('path'); +const fs = require('fs'); +const getPublicUrlOrPath = require('react-dev-utils/getPublicUrlOrPath'); + +// Make sure any symlinks in the project folder are resolved: +// https://github.com/facebook/create-react-app/issues/637 +const appDirectory = fs.realpathSync(process.cwd()); +const resolveApp = relativePath => path.resolve(appDirectory, relativePath); + +// We use `PUBLIC_URL` environment variable or "homepage" field to infer +// "public path" at which the app is served. +// webpack needs to know it to put the right