remove throwErrorIfNotFound from getConfig

Author: clairep94

client/utils/getConfig.test.ts

@@ -40,18 +40,10 @@ 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 throwErrorIfNotFound is false (default)', () => {
+    it('warns but does not throw', () => {
       expect(() => getConfig('CONFIG_TEST_KEY_NAME')).not.toThrow();
     });
 
-    it('throws an error if throwErrorIfNotFound is true', () => {
-      expect(() =>
-        getConfig('CONFIG_TEST_KEY_NAME', {
-          throwErrorIfNotFound: true
-        })
-      ).toThrow();
-    });
-
     it('returns undefined by default', () => {
       const result = getConfig('CONFIG_TEST_KEY_NAME');
       expect(result).toBe(undefined);
@@ -70,18 +62,10 @@ describe('utils/getConfig()', () => {
       global.process.env.CONFIG_TEST_KEY_NAME = '';
     });
 
-    it('warns but does not throw if throwErrorIfNotFound is false (default)', () => {
+    it('warns but does not throw', () => {
       expect(() => getConfig('CONFIG_TEST_KEY_NAME')).not.toThrow();
     });
 
-    it('throws an error if throwErrorIfNotFound is true', () => {
-      expect(() =>
-        getConfig('CONFIG_TEST_KEY_NAME', {
-          throwErrorIfNotFound: true
-        })
-      ).toThrow();
-    });
-
     it('returns undefined by default', () => {
       const result = getConfig('CONFIG_TEST_KEY_NAME');
       expect(result).toBe(undefined);

client/utils/getConfig.ts

@@ -14,22 +14,19 @@ export function getEnvVar(key: string): string | undefined {
 interface GetConfigOptions {
   warn?: boolean;
   nullishString?: boolean;
-  throwErrorIfNotFound?: boolean;
 }
 
 const DEFAULT_GET_CONFIG_OPTIONS: GetConfigOptions = {
   warn: !isTestEnvironment,
-  nullishString: false,
-  throwErrorIfNotFound: false
+  nullishString: false
 };
 
 /**
  * Returns a string config value from environment variables.
- * Logs a warning or throws an error if the value is missing, if `warn` and `throwErrorIfNotFound` are true in options
+ * Logs a warning if the value is missing, if `warn` is true in options
  *
  * @param key - The environment variable key to fetch.
  * @param options - Optional settings:
- *   - `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.
  * @returns String value of the env var, or `''` or `undefined` if missing.
@@ -43,7 +40,7 @@ export function getConfig(
   }
 
   // override default options with param options
-  const { warn, nullishString, throwErrorIfNotFound } = {
+  const { warn, nullishString } = {
     ...DEFAULT_GET_CONFIG_OPTIONS,
     ...options
   };
@@ -55,10 +52,7 @@ export function getConfig(
   if (value == null || value === '') {
     const notFoundMessage = `getConfig("${key}") returned null or undefined`;
 
-    // error, warn or continue if no value found:
-    if (throwErrorIfNotFound && !isTestEnvironment) {
-      throw new Error(notFoundMessage);
-    }
+    // warn or continue if no value found:
     if (warn) {
       console.warn(notFoundMessage);
     }