-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Description - Eject the application from create react app - Remove references to craco in the scripts and package.json dependencies - Port craco changes to webpack configuration - Remove SASS and SCSS loaders - Add babel-plugin-lodash - Remove type checks and eslint from webpack Fixes #38903 ## Automation /ok-to-test tags="@tag.All" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/13323376575> > Commit: 8f206bd > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13323376575&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.All` > Spec: > <hr>Fri, 14 Feb 2025 07:06:14 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced enhanced HTTPS configuration with improved security validations. - Improved handling of environment variables for a more robust configuration experience. - **Chores** - Upgraded and streamlined the build and start processes for better reliability and faster launches. - Refined dependency management and optimized bundling to improve performance. - Modernized module resolution and asset type definitions for a more efficient development workflow. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
- Loading branch information
Showing
20 changed files
with
2,017 additions
and
1,512 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
{ | ||
"plugins": [ | ||
"babel-plugin-lodash", | ||
["module-resolver", { | ||
"root": ["./src"], | ||
"alias": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
'use strict'; | ||
const { createHash } = require('crypto'); | ||
|
||
module.exports = env => { | ||
const hash = createHash('md5'); | ||
hash.update(JSON.stringify(env)); | ||
|
||
return hash.digest('hex'); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
"use strict"; | ||
|
||
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")( | ||
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, <img src={process.env.PUBLIC_URL + '/img/logo.png'} />. | ||
// 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; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
'use strict'; | ||
|
||
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; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
"use strict"; | ||
|
||
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 null; | ||
} | ||
|
||
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`.", | ||
), | ||
); | ||
} | ||
|
||
/** | ||
* 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, | ||
}; | ||
} | ||
return {}; | ||
} | ||
|
||
/** | ||
* 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/(.*)$": "<rootDir>/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(); |
Oops, something went wrong.