feat: added new host option

Author: Lucas Sales

README.md

@@ -187,10 +187,11 @@ ignored.
 | Command-line flag  | Environment variable      | Description                                                                                                                                                                                                      |
 | ------------------ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `--port`           | `PORT`                    | The port on which the Functions Framework listens for requests. Default: `8080`                                                                                                                                  |
+| `--host`           | `HOST`                    | The host on which the Functions Framework listens for requests. Default: `127.0.0.1`                                                                                                                             |
 | `--target`         | `FUNCTION_TARGET`         | The name of the exported function to be invoked in response to requests. Default: `function`                                                                                                                     |
 | `--signature-type` | `FUNCTION_SIGNATURE_TYPE` | The signature used when writing your function. Controls unmarshalling rules and determines which arguments are used to invoke your function. Default: `http`; accepted values: `http` or `event` or `cloudevent` |
 | `--source`         | `FUNCTION_SOURCE`         | The path to the directory of your function. Default: `cwd` (the current working directory)                                                                                                                       |
-| `--log-execution-id`| `LOG_EXECUTION_ID`        | Enables execution IDs in logs, either `true` or `false`. When not specified, default to disable. Requires Node.js 13.0.0 or later.                                                                                |
+| `--log-execution-id`| `LOG_EXECUTION_ID`        | Enables execution IDs in logs, either `true` or `false`. When not specified, default to disable. Requires Node.js 13.0.0 or later.                                                                              |
 
 You can set command-line flags in your `package.json` via the `start` script.
 For example:

src/main.ts

@@ -57,15 +57,21 @@ export const main = async () => {
     const server = getServer(userFunction!, options);
     const errorHandler = new ErrorHandler(server);
     server
-      .listen(options.port, () => {
-        errorHandler.register();
-        if (process.env.NODE_ENV !== 'production') {
-          console.log('Serving function...');
-          console.log(`Function: ${options.target}`);
-          console.log(`Signature type: ${signatureType}`);
-          console.log(`URL: http://localhost:${options.port}/`);
+      .listen(
+        {
+          port: options.port,
+          host: options.host,
+        },
+        () => {
+          errorHandler.register();
+          if (process.env.NODE_ENV !== 'production') {
+            console.log('Serving function...');
+            console.log(`Function: ${options.target}`);
+            console.log(`Signature type: ${signatureType}`);
+            console.log(`URL: http://localhost:${options.port}/`);
+          }
         }
-      })
+      )
       .setTimeout(0); // Disable automatic timeout on incoming connections.
   } catch (e) {
     if (e instanceof OptionsError) {

src/options.ts

@@ -31,6 +31,10 @@ export interface FrameworkOptions {
    * The port on which this server listens to all HTTP requests.
    */
   port: string;
+  /**
+   * The host on which this server listens for all HTTP requests.
+   */
+  host: string;
   /**
    * The name of the function within user's node module to execute. If such a
    * function is not defined, then falls back to 'function' name.
@@ -92,6 +96,7 @@ class ConfigurableOption<T> {
 }
 
 const PortOption = new ConfigurableOption('port', 'PORT', '8080');
+const HostOption = new ConfigurableOption('host', 'HOST', '127.0.0.1');
 const FunctionTargetOption = new ConfigurableOption(
   'target',
   'FUNCTION_TARGET',
@@ -185,6 +190,7 @@ export const parseOptions = (
   });
   return {
     port: PortOption.parse(argv, envVars),
+    host: HostOption.parse(argv, envVars),
     target: FunctionTargetOption.parse(argv, envVars),
     sourceLocation: SourceLocationOption.parse(argv, envVars),
     signatureType: SignatureOption.parse(argv, envVars),

src/testing.ts

@@ -53,6 +53,7 @@ export const getTestServer = (functionName: string): Server => {
     enableExecutionId: false,
     timeoutMilliseconds: 0,
     port: '0',
+    host: '127.0.0.1',
     target: '',
     sourceLocation: '',
     printHelp: false,

test/integration/legacy_event.ts

@@ -37,6 +37,7 @@ const testOptions = {
   enableExecutionId: false,
   timeoutMilliseconds: 0,
   port: '0',
+  host: '127.0.0.1',
   target: '',
   sourceLocation: '',
   printHelp: false,