fix(env): add ONE_ prefix to env var

americanexpress · Oct 22, 2021 · 8c0acbc · 8c0acbc
1 parent bbbdf19
commit 8c0acbc
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/__tests__/server/utils/onModuleLoad.spec.jsx b/__tests__/server/utils/onModuleLoad.spec.jsx
@@ -253,8 +253,8 @@ describe('onModuleLoad', () => {
     expect(() => onModuleLoad({ module: { [CONFIGURATION_KEY]: configuration, [META_DATA_KEY]: { version: '1.0.11' } }, moduleName: 'my-awesome-module' })).toThrowErrorMatchingSnapshot();
   });
 
-  it('logs a warning if the root module provides an incompatible version of a required external and DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS is set to true', () => {
-    process.env.DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS = true;
+  it('logs a warning if the root module provides an incompatible version of a required external and ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS is set to true', () => {
+    process.env.ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS = true;
     RootModule[CONFIGURATION_KEY].providedExternals = {
       'dep-a': { version: '2.1.0', module: () => 0 },
     };

diff --git a/docs/api/server/Environment-Variables.md b/docs/api/server/Environment-Variables.md
@@ -33,7 +33,7 @@ One App can be configured via Environment Variables:
   * [`NODE_ENV`](#node_env) ⚠️
   * [`ONE_CLIENT_ROOT_MODULE_NAME`](#one_client_root_module_name) ⚠️
   * [`ONE_CONFIG_ENV`](#one_config_env) ⚠️
-  * [`DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS`](#dangerously_accept_breaking_externals)
+  * [`ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS`](#ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS)
 * Server Settings
   * [`HOLOCRON_SERVER_MAX_MODULES_RETRY`](#holocron_server_max_modules_retry)
   * [`HOLOCRON_SERVER_MAX_SIM_MODULES_FETCH`](#holocron_server_max_sim_modules_fetch)
@@ -511,7 +511,7 @@ ONE_CONFIG_ENV=staging
 ONE_CONFIG_ENV=undefined
 ```
 
-## `DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS`
+## `ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS`
 
 **Runs In**
 * ✅ Production
@@ -522,17 +522,17 @@ This flag is meant to ease the transition to newer versions of externals. It sho
 
 **Shape**
 ```bash
-DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=true
+ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=true
 ```
 
 **Example**
 ```bash
-DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=true
+ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=true
 ```
 
 **Default Value**
 ```bash
-DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=undefined
+ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS=undefined
 ```
 
 

diff --git a/src/server/utils/onModuleLoad.js b/src/server/utils/onModuleLoad.js
@@ -148,7 +148,7 @@ export default function onModuleLoad({
         messages.push(`External '${externalName}' is required by ${moduleName}, but is not provided by the root module`);
       } else if (!semver.satisfies(providedExternal.version, requestedExternalVersion)) {
         const failedExternalMessage = `${externalName}@${requestedExternalVersion} is required by ${moduleName}, but the root module provides ${providedExternal.version}`;
-        if (process.env.DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS) {
+        if (process.env.ONE_DANGEROUSLY_ACCEPT_BREAKING_EXTERNALS) {
           console.warn(failedExternalMessage);
         } else {
           messages.push(failedExternalMessage);