Merge branch 'main' into renovate/npm-express-vulnerability

GoogleCloudPlatform · Sep 23, 2024 · 8d13435 · 8d13435
2 parents 8429b52 + 45d803b
commit 8d13435
Show file tree

Hide file tree

Showing 29 changed files with 748 additions and 393 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,3 +1,6 @@
 {
-    "extends": "./node_modules/gts"
+    "extends": "./node_modules/gts",
+    "rules": {
+        "no-control-regex": 0
+    }
 }
diff --git a/.github/blunderbuss.yml b/.github/blunderbuss.yml
@@ -1,5 +1,11 @@
 assign_prs:
-  - HKWinterhalter
+  - HKwinterhalter
+  - jihuin
+  - chujchen
+  - liuyunnnn
 
 assign_issues:
-  - HKWinterhalter
+  - HKwinterhalter
+  - jihuin
+  - chujchen
+  - liuyunnnn
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -24,4 +24,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@c74b580d73376b7750d3d2a50bfb8adc2c937507 # v3.1.5
+        uses: actions/dependency-review-action@5bbc3ba658137598168acb2ab73b21c432dd411b # v4.2.5
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,35 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/functions-framework?activeTab=versions
 
+## [3.4.2](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.4.1...v3.4.2) (2024-07-22)
+
+
+### Bug Fixes
+
+* Don't set severity level for text log. ([#625](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/625)) ([5bd82de](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/5bd82de7fff4e41967974587dbe389a1d637f78b))
+
+## [3.4.1](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.4.0...v3.4.1) (2024-07-09)
+
+
+### Bug Fixes
+
+* if execution id support requested for node 12, fail open and drop execution id support instead of crashing out ([#618](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/618)) ([47003fd](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/47003fdc7c7b1315fb219233928222593d606b93))
+* parse structured logs, and handle ANSI escape codes in logs ([#620](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/620)) ([33a7266](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/33a7266900a8030f4f1f7fd6b11e4293e75b4a9e))
+
+## [3.4.0](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.3.0...v3.4.0) (2024-04-29)
+
+
+### Features
+
+* AbortController to signal request timeouts ([#600](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/600)) ([7a538e0](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/7a538e09f07cfffde1e2ee1592f53386062639c2))
+* add execution id support ([#592](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/592)) ([1c48074](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/1c48074b749343904f07abd53328a2233eccd47b))
+
+
+### Bug Fixes
+
+* etag should not be set on any response ([#571](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/571)) ([89a3abb](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/89a3abb10a815eeb37bc779ae7015e751765cf62))
+* framework fails to shutdown gracefully when exit code is a string ([#545](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/545)) ([5355069](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/53550694b56c80cf326d21198cd65d641cfbbc17))
+
 ## [3.3.0](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.2.1...v3.3.0) (2023-06-28)
 
 

diff --git a/docs/generated/api.json b/docs/generated/api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.4",
+    "toolVersion": "7.43.1",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -173,17 +173,29 @@
       "preserveMemberOrder": false,
       "members": [
         {
-          "kind": "Variable",
-          "canonicalReference": "@google-cloud/functions-framework!cloudEvent:var",
-          "docComment": "/**\n * Register a function that handles CloudEvents.\n *\n * @param functionName - the name of the function\n *\n * @param handler - the function to trigger when handling CloudEvents\n *\n * @public\n */\n",
+          "kind": "Function",
+          "canonicalReference": "@google-cloud/functions-framework!cloudEvent:function(1)",
+          "docComment": "/**\n * Register a function that handles CloudEvents.\n *\n * @param functionName - The name of the function\n *\n * @param handler - The function to trigger when handling CloudEvents\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "cloudEvent: "
+              "text": "cloudEvent: <T = "
             },
             {
               "kind": "Content",
-              "text": "<T = unknown>(functionName: string, handler: "
+              "text": "unknown"
+            },
+            {
+              "kind": "Content",
+              "text": ">(functionName: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", handler: "
             },
             {
               "kind": "Reference",
@@ -192,17 +204,56 @@
             },
             {
               "kind": "Content",
-              "text": "<T>) => void"
+              "text": "<T>"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
             }
           ],
           "fileUrlPath": "src/function_registry.ts",
-          "isReadonly": true,
+          "returnTypeTokenRange": {
+            "startIndex": 8,
+            "endIndex": 9
+          },
           "releaseTag": "Public",
-          "name": "cloudEvent",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 4
-          }
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "functionName",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "handler",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "name": "cloudEvent"
         },
         {
           "kind": "Interface",
@@ -896,17 +947,21 @@
           }
         },
         {
-          "kind": "Variable",
-          "canonicalReference": "@google-cloud/functions-framework!http:var",
-          "docComment": "/**\n * Register a function that responds to HTTP requests.\n *\n * @param functionName - the name of the function\n *\n * @param handler - the function to invoke when handling HTTP requests\n *\n * @public\n */\n",
+          "kind": "Function",
+          "canonicalReference": "@google-cloud/functions-framework!http:function(1)",
+          "docComment": "/**\n * Register a function that responds to HTTP requests.\n *\n * @param functionName - The name of the function\n *\n * @param handler - The function to invoke when handling HTTP requests\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "http: "
+              "text": "http: (functionName: "
             },
             {
               "kind": "Content",
-              "text": "(functionName: string, handler: "
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", handler: "
             },
             {
               "kind": "Reference",
@@ -915,17 +970,39 @@
             },
             {
               "kind": "Content",
-              "text": ") => void"
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
             }
           ],
           "fileUrlPath": "src/function_registry.ts",
-          "isReadonly": true,
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
           "releaseTag": "Public",
-          "name": "http",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 4
-          }
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "functionName",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "handler",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "http"
         },
         {
           "kind": "Interface",
@@ -1048,7 +1125,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@google-cloud/functions-framework!InvocationFormat#deserializeRequest:member(1)",
-              "docComment": "/**\n * Creates an instance of the request type from an invocation request.\n *\n * @param request - the request body as raw bytes\n */\n",
+              "docComment": "/**\n * Creates an instance of the request type from an invocation request.\n *\n * @param request - The request body as raw bytes\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1103,7 +1180,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@google-cloud/functions-framework!InvocationFormat#serializeResponse:member(1)",
-              "docComment": "/**\n * Writes the response type to the invocation result.\n *\n * @param responseWriter - interface for writing to the invocation result\n *\n * @param response - the response object\n */\n",
+              "docComment": "/**\n * Writes the response type to the invocation result.\n *\n * @param responseWriter - Interface for writing to the invocation result\n *\n * @param response - The response object\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1757,6 +1834,34 @@
           "name": "Request_2",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@google-cloud/functions-framework!Request_2#abortController:member",
+              "docComment": "/**\n * An AbortController used to signal cancellation of a function invocation (e.g. in case of time out).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "abortController?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AbortController",
+                  "canonicalReference": "!AbortController:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "abortController",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@google-cloud/functions-framework!Request_2#executionId:member",
@@ -1874,47 +1979,6 @@
             }
           ]
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@google-cloud/functions-framework!typed:var",
-          "docComment": "/**\n * Register a function that handles strongly typed invocations.\n *\n * @param functionName - the name of the function\n *\n * @param handler - the function to trigger\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "typed: "
-            },
-            {
-              "kind": "Content",
-              "text": "<T, U>(functionName: string, handler: "
-            },
-            {
-              "kind": "Reference",
-              "text": "TypedFunction",
-              "canonicalReference": "@google-cloud/functions-framework!TypedFunction:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "<T, U> | ((req: T) => U | "
-            },
-            {
-              "kind": "Reference",
-              "text": "Promise",
-              "canonicalReference": "!Promise:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "<U>)) => void"
-            }
-          ],
-          "fileUrlPath": "src/function_registry.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "typed",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 6
-          }
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@google-cloud/functions-framework!TypedFunction:interface",

diff --git a/docs/generated/api.md b/docs/generated/api.md
@@ -112,6 +112,7 @@ export interface LegacyEvent {
 
 // @public (undocumented)
 interface Request_2 extends Request_3 {
+    abortController?: AbortController;
     executionId?: string;
     rawBody?: Buffer;
     spanId?: string;
@@ -121,7 +122,9 @@ export { Request_2 as Request }
 
 export { Response_2 as Response }
 
-// @public
+// Warning: (ae-internal-missing-underscore) The name "typed" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
 export const typed: <T, U>(functionName: string, handler: TypedFunction<T, U> | ((req: T) => U | Promise<U>)) => void;
 
 // @public