addressed comments and remove getExecutionId().

Author: liuyunnnn

README.md

@@ -190,7 +190,7 @@ ignored.
 | `--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`        | Enables execution IDs in logs, either `true` or `false`. When not specified, default to enable. 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:

docs/generated/api.json

@@ -779,29 +779,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@google-cloud/functions-framework!getExecutionId:var",
-          "docComment": "/**\n * Gets the request-specific execution id\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "getExecutionId: "
-            },
-            {
-              "kind": "Content",
-              "text": "() => string | undefined"
-            }
-          ],
-          "fileUrlPath": "src/function_registry.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "getExecutionId",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@google-cloud/functions-framework!HandlerFunction:type",

docs/generated/api.md

@@ -58,9 +58,6 @@ export interface EventFunctionWithCallback {
     (data: {}, context: Context, callback: Function): any;
 }
 
-// @public
-export const getExecutionId: () => string | undefined;
-
 // @public
 export type HandlerFunction<T = unknown, U = unknown> = HttpFunction | EventFunction | EventFunctionWithCallback | CloudEventFunction<T> | CloudEventFunctionWithCallback<T> | TypedFunction<T, U>;
 

src/async_local_storage.ts

@@ -23,8 +23,8 @@ export async function asyncLocalStorageMiddleware(
     next();
     return;
   }
-  const asyncHooks = await import('node:async_hooks');
   if (!asyncLocalStorage) {
+    const asyncHooks = await import('node:async_hooks');
     asyncLocalStorage = new asyncHooks.AsyncLocalStorage();
   }
 
@@ -46,7 +46,3 @@ export function getCurrentContext(): ExecutionContext | undefined {
   }
   return asyncLocalStorage.getStore();
 }
-
-export const getCurrentExecutionId = (): string | undefined => {
-  return getCurrentContext()?.executionId;
-};

src/function_registry.ts

@@ -20,7 +20,6 @@ import {
   JsonInvocationFormat,
 } from './functions';
 import {SignatureType} from './types';
-import {getCurrentExecutionId} from './async_local_storage';
 
 interface RegisteredFunction<T, U> {
   signatureType: SignatureType;
@@ -66,14 +65,6 @@ export const isValidFunctionName = (functionName: string): boolean => {
   return regex.test(functionName);
 };
 
-/**
- * Gets the request-specific execution id
- * @public
- */
-export const getExecutionId = (): string | undefined => {
-  return getCurrentExecutionId();
-};
-
 /**
  * Get a declaratively registered function
  * @param functionName the name with which the function was registered

src/index.ts

@@ -20,4 +20,4 @@ export * from './functions';
 /**
  * @public
  */
-export {http, cloudEvent, typed, getExecutionId} from './function_registry';
+export {http, cloudEvent, typed} from './function_registry';

src/options.ts

@@ -114,29 +114,27 @@ const SignatureOption = new ConfigurableOption(
 );
 
 export const requiredNodeJsVersionForLogExecutionID = '13.0.0';
-const logExecutionIDEnvVar = 'LOG_EXECUTION_ID';
-function enableExecutionId(envVars: NodeJS.ProcessEnv): boolean {
-  const logExecutionID = envVars[logExecutionIDEnvVar];
-  const nodeVersion = process.versions.node;
-  const isVersionSatisfied = semver.gte(
-    nodeVersion,
-    requiredNodeJsVersionForLogExecutionID
-  );
-  // If not specified, default to false.
-  if (typeof logExecutionID === 'undefined') {
-    return false;
-  }
-  const isTrue =
-    (typeof logExecutionID === 'boolean' && logExecutionID) ||
-    (typeof logExecutionID === 'string' &&
-      logExecutionID.toLowerCase() === 'true');
-  if (isTrue && !isVersionSatisfied) {
-    throw new OptionsError(
-      `Execution id is only supported with Node.js versions ${requiredNodeJsVersionForLogExecutionID} and above. Your current version is ${nodeVersion}. Please upgrade.`
+const ExecutionIdOption = new ConfigurableOption(
+  'log-execution-id',
+  'LOG_EXECUTION_ID',
+  false,
+  x => {
+    const nodeVersion = process.versions.node;
+    const isVersionSatisfied = semver.gte(
+      nodeVersion,
+      requiredNodeJsVersionForLogExecutionID
     );
+    const isTrue =
+      (typeof x === 'boolean' && x) ||
+      (typeof x === 'string' && x.toLowerCase() === 'true');
+    if (isTrue && !isVersionSatisfied) {
+      throw new OptionsError(
+        `Execution id is only supported with Node.js versions ${requiredNodeJsVersionForLogExecutionID} and above. Your current version is ${nodeVersion}. Please upgrade.`
+      );
+    }
+    return isTrue;
   }
-  return isTrue;
-}
+);
 
 export const helpText = `Example usage:
   functions-framework --target=helloWorld --port=8080
@@ -168,6 +166,6 @@ export const parseOptions = (
     sourceLocation: SourceLocationOption.parse(argv, envVars),
     signatureType: SignatureOption.parse(argv, envVars),
     printHelp: cliArgs[2] === '-h' || cliArgs[2] === '--help',
-    enableExecutionId: enableExecutionId(envVars),
+    enableExecutionId: ExecutionIdOption.parse(argv, envVars),
   };
 };

test/options.ts

@@ -26,7 +26,7 @@ describe('parseOptions', () => {
     name: string;
     cliOpts: string[];
     envVars: {[key: string]: string};
-    expectedOptions: Partial<FrameworkOptions>;
+    expectedOptions?: Partial<FrameworkOptions>;
   }
 
   const testData: TestData[] = [
@@ -134,6 +134,7 @@ describe('parseOptions', () => {
     it(testCase.name, () => {
       const options = parseOptions(testCase.cliOpts, testCase.envVars);
       const {expectedOptions} = testCase;
+      assert(expectedOptions);
       let opt: keyof FrameworkOptions;
       for (opt in expectedOptions) {
         assert.deepStrictEqual(expectedOptions[opt], options[opt]);
@@ -142,33 +143,58 @@ describe('parseOptions', () => {
   });
 
   const cliOpts = ['bin/node', '/index.js'];
-  it('default execution id support', () => {
+  it('default disable execution id support', () => {
     const options = parseOptions(cliOpts, {});
     assert.strictEqual(options.enableExecutionId, false);
   });
 
-  it('disable execution id support', () => {
+  it('disable execution id support by cli flag', () => {
+    const options = parseOptions(
+      ['bin/node', '/index.js', '--log-execution-id=false'],
+      {}
+    );
+    assert.strictEqual(options.enableExecutionId, false);
+  });
+
+  it('disable execution id support by env var', () => {
     const envVars = {
       LOG_EXECUTION_ID: 'False',
     };
     const options = parseOptions(cliOpts, envVars);
     assert.strictEqual(options.enableExecutionId, false);
   });
 
-  it('enable execution id support', () => {
-    const envVars = {
-      LOG_EXECUTION_ID: 'TRUE',
-    };
-    if (
-      semver.lt(process.versions.node, requiredNodeJsVersionForLogExecutionID)
-    ) {
-      assert.throws(() => {
-        parseOptions(cliOpts, envVars);
-      });
-    } else {
-      const options = parseOptions(cliOpts, envVars);
-      assert.strictEqual(options.enableExecutionId, true);
-    }
+  const executionIdTestData: TestData[] = [
+    {
+      name: 'enable execution id support by cli flag',
+      cliOpts: ['bin/node', '/index.js', '--log-execution-id'],
+      envVars: {},
+    },
+    {
+      name: 'enable execution id support by env var',
+      cliOpts: ['bin/node', '/index.js'],
+      envVars: {LOG_EXECUTION_ID: 'True'},
+    },
+    {
+      name: 'execution id prioritizes cli flag over env var',
+      cliOpts: ['bin/node', '/index.js', '--log-execution-id=true'],
+      envVars: {LOG_EXECUTION_ID: 'False'},
+    },
+  ];
+
+  executionIdTestData.forEach(testCase => {
+    it(testCase.name, () => {
+      if (
+        semver.lt(process.versions.node, requiredNodeJsVersionForLogExecutionID)
+      ) {
+        assert.throws(() => {
+          parseOptions(testCase.cliOpts, testCase.envVars);
+        });
+      } else {
+        const options = parseOptions(testCase.cliOpts, testCase.envVars);
+        assert.strictEqual(options.enableExecutionId, true);
+      }
+    });
   });
 
   it('throws an exception for invalid signature types', () => {