.github/blunderbuss.yml

@@ -1,11 +1 @@
-assign_prs:
-  - HKwinterhalter
-  - jihuin
-  - chujchen
-  - liuyunnnn
 
-assign_issues:
-  - HKwinterhalter
-  - jihuin
-  - chujchen
-  - liuyunnnn

.github/workflows/buildpack-integration-test.yml

@@ -14,63 +14,36 @@ on:
 permissions: read-all
 
 jobs:
-  nodejs10:
-    uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
-    with:
-      http-builder-source: 'test/conformance'
-      http-builder-target: 'writeHttpDeclarative'
-      cloudevent-builder-source: 'test/conformance'
-      cloudevent-builder-target: 'writeCloudEventDeclarative'
-      prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs10'
-      builder-runtime-version: '10'
-  nodejs12:
-    uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
-    with:
-      http-builder-source: 'test/conformance'
-      http-builder-target: 'writeHttpDeclarative'
-      cloudevent-builder-source: 'test/conformance'
-      cloudevent-builder-target: 'writeCloudEventDeclarative'
-      prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs12'
-      builder-runtime-version: '12'
-  nodejs14:
-    uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
-    with:
-      http-builder-source: 'test/conformance'
-      http-builder-target: 'writeHttpDeclarative'
-      cloudevent-builder-source: 'test/conformance'
-      cloudevent-builder-target: 'writeCloudEventDeclarative'
-      prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs14'
-      builder-runtime-version: '14'
-  nodejs16:
+  nodejs18:
     uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
     with:
       http-builder-source: 'test/conformance'
       http-builder-target: 'writeHttpDeclarative'
       cloudevent-builder-source: 'test/conformance'
       cloudevent-builder-target: 'writeCloudEventDeclarative'
       prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs16'
-      builder-runtime-version: '16'
-  nodejs18:
+      builder-runtime: 'nodejs18'
+      builder-runtime-version: '18'
+      builder-url: 'us-docker.pkg.dev/serverless-runtimes/google-22-full/builder/nodejs:latest'
+  nodejs20:
     uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
     with:
       http-builder-source: 'test/conformance'
       http-builder-target: 'writeHttpDeclarative'
       cloudevent-builder-source: 'test/conformance'
       cloudevent-builder-target: 'writeCloudEventDeclarative'
       prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs18'
-      builder-runtime-version: '18'
-  nodejs20:
+      builder-runtime: 'nodejs20'
+      builder-runtime-version: '20'
+      builder-url: 'us-docker.pkg.dev/serverless-runtimes/google-22-full/builder/nodejs:latest'
+  nodejs22:
     uses: GoogleCloudPlatform/functions-framework-conformance/.github/workflows/buildpack-integration-test.yml@main
     with:
       http-builder-source: 'test/conformance'
       http-builder-target: 'writeHttpDeclarative'
       cloudevent-builder-source: 'test/conformance'
       cloudevent-builder-target: 'writeCloudEventDeclarative'
       prerun: 'test/conformance/prerun.sh'
-      builder-runtime: 'nodejs20'
-      builder-runtime-version: '20'
+      builder-runtime: 'nodejs22'
+      builder-runtime-version: '22'
+      builder-url: 'us-docker.pkg.dev/serverless-runtimes/google-22-full/builder/nodejs:latest'

.github/workflows/conformance.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10, 12, 14, 16, 18, 20]
+        node-version: [18, 20, 22]
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1

.github/workflows/docs.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
         with:
-          node-version: '14'
+          node-version: '20'
       - name: Install dependencies
         run: npm ci
       - name: Build docs

.github/workflows/publish.yml

@@ -25,12 +25,12 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
         with:
-          node-version: '16.x'
+          node-version: '20.x'
       - run: npm install
       - run: npm run build
       - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
         with:
-          node-version: '16.x'
+          node-version: '20.x'
           registry-url: 'https://wombat-dressing-room.appspot.com'
       - id: publish
         env:

.github/workflows/unit.yml

@@ -11,7 +11,7 @@ jobs:
   test:
     strategy:
       matrix:
-        node-version: [10, 12, 14, 16, 18, 20]
+        node-version: [18, 20, 22]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:

CHANGELOG.md

@@ -4,6 +4,18 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/functions-framework?activeTab=versions
 
+## [3.5.0](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.4.6...v3.5.0) (2025-03-27)
+
+
+### Features
+
+* adds a new ignored-routes config option ([70f68e9](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/70f68e9d0b4fa1db6345ab012ddfec0fd983f762))
+
+
+### Bug Fixes
+
+* **deps:** downgrade @types/express to v4 ([d40a514](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/commit/d40a5149bd4302ecb293101a18f0eaa552ddfc7c))
+
 ## [3.4.6](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/compare/v3.4.5...v3.4.6) (2025-03-04)
 
 

README.md

@@ -182,6 +182,7 @@ ignored.
 | `--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.                                                                                |
+| `--ignored-routes`| `IGNORED_ROUTES`        | A route expression for requests that should not be routed the function. An empty 404 response will be returned. This is set to `/favicon.ico|/robots.txt` by default for `http` functions.                                                     |
 
 You can set command-line flags in your `package.json` via the `start` script.
 For example:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/functions-framework",
-  "version": "3.4.6",
+  "version": "3.5.0",
   "description": "FaaS (Function as a service) framework for writing portable Node.js functions",
   "engines": {
     "node": ">=10.0.0"
@@ -19,7 +19,7 @@
     }
   },
   "dependencies": {
-    "@types/express": "^5.0.0",
+    "@types/express": "^4.17.21",
     "body-parser": "^1.18.3",
     "cloudevents": "^8.0.2",
     "express": "^4.21.2",

src/options.ts

@@ -56,6 +56,10 @@ export interface FrameworkOptions {
    * The request timeout.
    */
   timeoutMilliseconds: number;
+  /**
+   * Routes that should return a 404 without invoking the function.
+   */
+  ignoredRoutes: string | null;
 }
 
 /**
@@ -86,7 +90,7 @@ class ConfigurableOption<T> {
 
   parse(cliArgs: minimist.ParsedArgs, envVars: NodeJS.ProcessEnv): T {
     return this.validator(
-      cliArgs[this.cliOption] || envVars[this.envVar] || this.defaultValue
+      cliArgs[this.cliOption] ?? envVars[this.envVar] ?? this.defaultValue
     );
   }
 }
@@ -130,6 +134,11 @@ const TimeoutOption = new ConfigurableOption(
     return x * 1000;
   }
 );
+const IgnoredRoutesOption = new ConfigurableOption<string | null>(
+  'ignored-routes',
+  'IGNORED_ROUTES',
+  null // null by default so we can detect if it is explicitly set to ""
+);
 
 export const requiredNodeJsVersionForLogExecutionID = '13.0.0';
 const ExecutionIdOption = new ConfigurableOption(
@@ -181,6 +190,7 @@ export const parseOptions = (
       SignatureOption.cliOption,
       SourceLocationOption.cliOption,
       TimeoutOption.cliOption,
+      IgnoredRoutesOption.cliOption,
     ],
   });
   return {
@@ -191,5 +201,6 @@ export const parseOptions = (
     timeoutMilliseconds: TimeoutOption.parse(argv, envVars),
     printHelp: cliArgs[2] === '-h' || cliArgs[2] === '--help',
     enableExecutionId: ExecutionIdOption.parse(argv, envVars),
+    ignoredRoutes: IgnoredRoutesOption.parse(argv, envVars),
   };
 };

src/server.ts

@@ -134,14 +134,23 @@ export function getServer(
   if (options.signatureType === 'cloudevent') {
     app.use(backgroundEventToCloudEventMiddleware);
   }
-
-  if (options.signatureType === 'http') {
+  if (options.ignoredRoutes !== null) {
+    // Ignored routes is a configuration option that allows requests to specific paths to be prevented
+    // from invoking the user's function.
+    app.use(options.ignoredRoutes, (req, res) => {
+      res.status(404).send(null);
+    });
+  } else if (options.signatureType === 'http') {
+    // We configure some default ignored routes, only for HTTP functions.
     app.use('/favicon.ico|/robots.txt', (req, res) => {
       // Neither crawlers nor browsers attempting to pull the icon find the body
-      // contents particularly useful, so we send nothing in the response body.
+      // contents particularly useful, so we filter these requests out from invoking
+      // the user's function by default.
       res.status(404).send(null);
     });
+  }
 
+  if (options.signatureType === 'http') {
     app.use('/*', (req, res, next) => {
       onFinished(res, (err, res) => {
         res.locals.functionExecutionFinished = true;

src/testing.ts

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

test/integration/legacy_event.ts

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