getConfig: cleanup new optional property names

Author: clairep94

client/modules/IDE/actions/project.js

@@ -15,11 +15,11 @@ import {
 } from './ide';
 import { clearState, saveState } from '../../../persistState';
 
-const ROOT_URL = getConfig('API_URL', { failOnNotFound: true });
+const ROOT_URL = getConfig('API_URL', { throwErrorIfNotFound: true });
 const S3_BUCKET_URL_BASE = getConfig('S3_BUCKET_URL_BASE', {
-  failOnNotFound: true
+  throwErrorIfNotFound: true
 });
-const S3_BUCKET = getConfig('S3_BUCKET', { failOnNotFound: true });
+const S3_BUCKET = getConfig('S3_BUCKET', { throwErrorIfNotFound: true });
 
 export function setProject(project) {
   return {

client/modules/IDE/components/PreviewFrame.jsx

@@ -13,7 +13,7 @@ const Frame = styled.iframe`
 
 function PreviewFrame({ fullView, isOverlayVisible }) {
   const iframe = useRef();
-  const previewUrl = getConfig('PREVIEW_URL', { failOnNotFound: true });
+  const previewUrl = getConfig('PREVIEW_URL', { throwErrorIfNotFound: true });
   useEffect(() => {
     const unsubscribe = registerFrame(iframe.current.contentWindow, previewUrl);
     return () => {

client/modules/IDE/components/SketchListRowBase.jsx

@@ -11,7 +11,7 @@ import MenuItem from '../../../components/Dropdown/MenuItem';
 import { formatDateToString } from '../../../utils/formatDate';
 import { getConfig } from '../../../utils/getConfig';
 
-const ROOT_URL = getConfig('API_URL', { failOnNotFound: true });
+const ROOT_URL = getConfig('API_URL', { throwErrorIfNotFound: true });
 
 const formatDateCell = (date, mobile = false) =>
   formatDateToString(date, { showTime: !mobile });

client/modules/Preview/EmbedFrame.jsx

@@ -246,7 +246,7 @@ p5.prototype.registerMethod('afterSetup', p5.prototype.ensureAccessibleCanvas);`
     window.objectUrls = ${JSON.stringify(objectUrls)};
     window.objectPaths = ${JSON.stringify(objectPaths)};
     window.editorOrigin = '${getConfig('EDITOR_URL', {
-      failOnNotFound: true
+      throwErrorIfNotFound: true
     })}';
   `;
   addLoopProtect(sketchDoc);

client/modules/Preview/previewIndex.jsx

@@ -26,7 +26,7 @@ const App = () => {
   const [gridOutput, setGridOutput] = useState(false);
   registerFrame(
     window.parent,
-    getConfig('EDITOR_URL', { failOnNotFound: true })
+    getConfig('EDITOR_URL', { throwErrorIfNotFound: true })
   );
 
   function handleMessageEvent(message) {

client/utils/apiClient.ts

@@ -1,7 +1,7 @@
 import axios, { AxiosInstance } from 'axios';
 import { getConfig } from './getConfig';
 
-const ROOT_URL = getConfig('API_URL', { failOnNotFound: true });
+const ROOT_URL = getConfig('API_URL', { throwErrorIfNotFound: true });
 
 /**
  * Configures an Axios instance with the correct API URL

client/utils/getConfig.test.ts

@@ -28,16 +28,16 @@ describe('utils/getConfig()', () => {
 
   // check returns unhappy path
   describe('and when the key does not exist in the env file', () => {
-    it('warns but does not throw if failOnNotFound is false (default)', () => {
+    it('warns but does not throw if throwErrorIfNotFound is false (default)', () => {
       expect(() => getConfig('CONFIG_TEST_KEY_NAME')).not.toThrow();
     });
 
-    it('throws an error if failOnNotFound is true', () => {
+    it('throws an error if throwErrorIfNotFound is true', () => {
       process.env.NODE_ENV = 'not_test';
       expect(() =>
         getConfig('CONFIG_TEST_KEY_NAME', {
-          failOnNotFound: true,
-          failInTestEnv: true
+          throwErrorIfNotFound: true,
+          throwErrorInTestEnv: true
         })
       ).toThrow();
     });
@@ -60,15 +60,15 @@ describe('utils/getConfig()', () => {
       global.process.env.CONFIG_TEST_KEY_NAME = '';
     });
 
-    it('warns but does not throw if failOnNotFound is false (default)', () => {
+    it('warns but does not throw if throwErrorIfNotFound is false (default)', () => {
       expect(() => getConfig('CONFIG_TEST_KEY_NAME')).not.toThrow();
     });
 
-    it('throws an error if failOnNotFound is true', () => {
+    it('throws an error if throwErrorIfNotFound is true', () => {
       expect(() =>
         getConfig('CONFIG_TEST_KEY_NAME', {
-          failOnNotFound: true,
-          failInTestEnv: true
+          throwErrorIfNotFound: true,
+          throwErrorInTestEnv: true
         })
       ).toThrow();
     });

client/utils/getConfig.ts

@@ -12,28 +12,29 @@ function getEnvVar(key: string): string | undefined {
 interface GetConfigOptions {
   warn?: boolean;
   nullishString?: boolean;
-  failOnNotFound?: boolean;
-  failInTestEnv?: boolean; // this is only to test getConfig and should never be set to override defaults
+  throwErrorIfNotFound?: boolean;
+  throwErrorInTestEnv?: boolean; // this is only to test getConfig and should never be set to override defaults
 }
 
 export const isTestEnvironment = getEnvVar('NODE_ENV') === 'test';
 
 const defaultGetConfigOptions: GetConfigOptions = {
   warn: !isTestEnvironment,
   nullishString: false,
-  failOnNotFound: false,
-  failInTestEnv: false
+  throwErrorIfNotFound: false,
+  throwErrorInTestEnv: false
 };
 
 /**
  * Returns a string config value from environment variables.
- * Logs a warning or throws an error if the value is missing, if `warn` and `failOnNotFound` are true in options
+ * Logs a warning or throws an error if the value is missing, if `warn` and `throwErrorIfNotFound` are true in options
  *
  * @param key - The environment variable key to fetch.
  * @param options - Optional settings:
- *   - `failOnNotFound`: whether to throw an error if the value is missing (default to `false`).
+ *   - `throwErrorIfNotFound`: whether to throw an error if the value is missing (default to `false`).
  *   - `warn`: whether to warn if the value is missing (default `true` unless in test env).
  *   - `nullishString`: if true, returns `''` instead of `undefined` when missing.
+ *   - `throwErrorInTestEnv`: this is to test getConfig and should not be overridden (default to `false`).
  * @returns String value of the env var, or `''` or `undefined` if missing.
  */
 export function getConfig(
@@ -45,7 +46,7 @@ export function getConfig(
   }
 
   // override default options with param options
-  const { warn, nullishString, failOnNotFound, failInTestEnv } = {
+  const { warn, nullishString, throwErrorIfNotFound, throwErrorInTestEnv } = {
     ...defaultGetConfigOptions,
     ...options
   };
@@ -59,8 +60,8 @@ export function getConfig(
 
     // error, warn or continue if no value found:
     if (
-      (failOnNotFound && !isTestEnvironment) ||
-      (failOnNotFound && isTestEnvironment && failInTestEnv) // this is just to enable us to test getConfig's error throwing
+      (throwErrorIfNotFound && !isTestEnvironment) ||
+      (throwErrorIfNotFound && isTestEnvironment && throwErrorInTestEnv) // this is just to enable us to test getConfig's error throwing
     ) {
       throw new Error(notFoundMessage);
     }