feat: add propagate errors to client cli option

Author: gregorygaines

src/options.ts

@@ -15,7 +15,7 @@
 import * as minimist from 'minimist';
 import * as semver from 'semver';
 import {resolve} from 'path';
-import {SignatureType, isValidSignatureType} from './types';
+import {isValidSignatureType, SignatureType} from './types';
 
 /**
  * Error thrown when an invalid option is provided.
@@ -60,6 +60,10 @@ export interface FrameworkOptions {
    * Routes that should return a 404 without invoking the function.
    */
   ignoredRoutes: string | null;
+  /**
+   * Whether or not to propagate framework errors to the client.
+   */
+  propagateFrameworkErrors: boolean;
 }
 
 /**
@@ -167,6 +171,18 @@ const ExecutionIdOption = new ConfigurableOption(
   }
 );
 
+const PropagateFrameworkErrorsOption = new ConfigurableOption(
+  'propagate-framework-errors',
+  'PROPAGATE_FRAMEWORK_ERRORS',
+  false,
+  x => {
+    return (
+      (typeof x === 'boolean' && x) ||
+      (typeof x === 'string' && x.toLowerCase() === 'true')
+    );
+  }
+);
+
 export const helpText = `Example usage:
   functions-framework --target=helloWorld --port=8080
 Documentation:
@@ -191,6 +207,7 @@ export const parseOptions = (
       SourceLocationOption.cliOption,
       TimeoutOption.cliOption,
       IgnoredRoutesOption.cliOption,
+      PropagateFrameworkErrorsOption.cliOption,
     ],
   });
   return {
@@ -202,5 +219,9 @@ export const parseOptions = (
     printHelp: cliArgs[2] === '-h' || cliArgs[2] === '--help',
     enableExecutionId: ExecutionIdOption.parse(argv, envVars),
     ignoredRoutes: IgnoredRoutesOption.parse(argv, envVars),
+    propagateFrameworkErrors: PropagateFrameworkErrorsOption.parse(
+      argv,
+      envVars
+    ),
   };
 };

src/testing.ts

@@ -57,5 +57,6 @@ export const getTestServer = (functionName: string): Server => {
     sourceLocation: '',
     printHelp: false,
     ignoredRoutes: null,
+    propagateFrameworkErrors: false,
   });
 };

test/integration/legacy_event.ts

@@ -41,6 +41,7 @@ const testOptions = {
   sourceLocation: '',
   printHelp: false,
   ignoredRoutes: null,
+  propagateFrameworkErrors: false,
 };
 
 describe('Event Function', () => {

test/options.ts

@@ -61,6 +61,7 @@ describe('parseOptions', () => {
         enableExecutionId: false,
         timeoutMilliseconds: 0,
         ignoredRoutes: null,
+        propagateFrameworkErrors: false,
       },
     },
     {
@@ -77,6 +78,7 @@ describe('parseOptions', () => {
         '--timeout',
         '6',
         '--ignored-routes=banana',
+        '--propagate-framework-errors=true',
       ],
       envVars: {},
       expectedOptions: {
@@ -88,6 +90,7 @@ describe('parseOptions', () => {
         enableExecutionId: false,
         timeoutMilliseconds: 6000,
         ignoredRoutes: 'banana',
+        propagateFrameworkErrors: true,
       },
     },
     {
@@ -100,6 +103,7 @@ describe('parseOptions', () => {
         FUNCTION_SOURCE: '/source',
         CLOUD_RUN_TIMEOUT_SECONDS: '2',
         IGNORED_ROUTES: '',
+        PROPAGATE_FRAMEWORK_ERRORS: 'true',
       },
       expectedOptions: {
         port: '1234',
@@ -110,6 +114,7 @@ describe('parseOptions', () => {
         enableExecutionId: false,
         timeoutMilliseconds: 2000,
         ignoredRoutes: '',
+        propagateFrameworkErrors: true,
       },
     },
     {
@@ -125,6 +130,7 @@ describe('parseOptions', () => {
         '--source=/source',
         '--timeout=3',
         '--ignored-routes=avocado',
+        '--propagate-framework-errors',
       ],
       envVars: {
         PORT: '4567',
@@ -133,6 +139,7 @@ describe('parseOptions', () => {
         FUNCTION_SOURCE: '/somewhere/else',
         CLOUD_RUN_TIMEOUT_SECONDS: '5',
         IGNORED_ROUTES: 'banana',
+        PROPAGATE_FRAMEWORK_ERRORS: 'false',
       },
       expectedOptions: {
         port: '1234',
@@ -143,6 +150,7 @@ describe('parseOptions', () => {
         enableExecutionId: false,
         timeoutMilliseconds: 3000,
         ignoredRoutes: 'avocado',
+        propagateFrameworkErrors: false,
       },
     },
   ];
@@ -236,4 +244,33 @@ describe('parseOptions', () => {
       });
     });
   });
+
+  it('default disable propagate framework errors', () => {
+    const options = parseOptions(['bin/node', '/index.js'], {});
+    assert.strictEqual(options.propagateFrameworkErrors, false);
+  });
+
+  it('disable propagate framework errors by cli flag', () => {
+    const options = parseOptions(
+      ['bin/node', '/index.js', '--propagate-framework-errors=false'],
+      {}
+    );
+    assert.strictEqual(options.propagateFrameworkErrors, false);
+  });
+
+  it('enable propagate framework errors by cli flag', () => {
+    const options = parseOptions(
+      ['bin/node', '/index.js', '--propagate-framework-errors=true'],
+      {}
+    );
+    assert.strictEqual(options.propagateFrameworkErrors, true);
+  });
+
+  it('disable propagate framework errors by env var', () => {
+    const envVars = {
+      PROPAGATE_FRAMEWORK_ERRORS: 'False',
+    };
+    const options = parseOptions(cliOpts, envVars);
+    assert.strictEqual(options.propagateFrameworkErrors, false);
+  });
 });