Skip to content

Conversation

@lisajian
Copy link
Contributor

@lisajian lisajian commented Aug 28, 2025

Description

Adds basic FDC function trigger for onMutationExecuted

Includes unit tests. Also fixes a typo on an existing file

npm test passes locally

Internal tracking bug: b/436623435

Code sample

Examples of how to use this

import { onMutationExecuted } from "firebase-functions/v2/dataconnect";

exports.myfunction = onMutationExecuted(
  {
    service: "service-id",
    connector: "connector-id",
    operation: "mutation-name",
  },
  (event) => { 
    // event.params.service == "service-id" 
    // event.params.connector == "connector-id"
    // event.params.operation == "mutation-name"

    // event.data contains [MutationEventData](https://docs.google.com/document/d/1sCYuBzjhirVTy9Xo2gflGVcKcZyhau9MhkVlbOvC4MI/edit?tab=t.0#bookmark=id.1k7sz3vu87vx)  
  }
);

// Use capture group on operation
exports.myfunctionwithcaptures = onMutationExecuted(
  {
    service: "service-id",
    connector: "connector-id",
    operation: "{operation}",
  },
  (event) => { /** do something */ }
);

// Use wildcard on connector
exports.myfunctionwithwildcards = onMutationExecuted(
  {
    service: "service-id",
    connector: "*",
    operation: "mutation-name",
  },
  (event) => { /** do something */ }
);

See go/fdc-eventarc-functions-sdk for more information

@lisajian lisajian requested a review from taeold August 28, 2025 18:42
@lisajian lisajian marked this pull request as ready for review August 28, 2025 18:42
@lisajian lisajian force-pushed the lj/fdc-support-pt1 branch from 13cbf42 to 52a95a3 Compare October 5, 2025 22:54
@taeold
Copy link
Contributor

taeold commented Oct 7, 2025

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces support for Firebase Data Connect v2 with the onMutationExecuted trigger. The changes are well-structured, including the new provider, unit tests, and necessary package configuration updates. I've identified a few type safety issues in the new provider implementation concerning the handling of optional parameters, which could lead to runtime errors. I've provided suggestions to address these. Additionally, I've included a recommendation for a minor refactoring to enhance code clarity.

@lisajian lisajian changed the base branch from lj/fdc-support to next October 21, 2025 17:21
Operation extends string = string
> extends EventHandlerOptions {
/** Firebase Data Connect service ID */
service?: Service;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm a bit surprised that all these options are optional 🤔 should the all be required? what does not providing one mean? is it interpreted as wildcard or something else

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question - leaving it empty is equivalent wildcard, effectively no filter for those fields. This matches what's possible on GCP Console.

Side bar: Interestingly, you can also add a filter for an empty string, which is different than no filter. Empty string is possible for the Connector filter

@lisajian lisajian merged commit ec05deb into next Oct 31, 2025
18 of 19 checks passed
@github-project-automation github-project-automation bot moved this from Approved [PR] to Done in [Cloud] Extensions + Functions Oct 31, 2025
@lisajian lisajian deleted the lj/fdc-support-pt1 branch October 31, 2025 19:10
github-merge-queue bot pushed a commit that referenced this pull request Nov 4, 2025
* BREAKING: Upgrade TypeScript to v5.9.3 (#1746)

Upgrades from TypeScript v4.3.5 to v5.9.3. All tests pass successfully.

* BREAKING: Drop Node.js 14/16 support, require Node.js >=18 (#1747)

* BREAKING: Drop Node.js 14/16 support, require Node.js >=18

- Update package.json engines to require Node.js >=18.0.0
- Upgrade @types/node from v14 to v18
- Update TypeScript target from ES2019 to ES2022
- Add useDefineForClassFields: false for backward compatibility
- Update CI/CD workflows to test Node.js 18, 20, 22, and 24
- Set default CI/CD Node.js version to 24
- Update integration test documentation

* BREAKING: remove functions.config() implementation (#1748)

Replace functions.config() implementation with an error that provides
clear migration guidance to the params module. This removes the deprecated
API as planned for the next major release while helping developers migrate.

The error message directs users to:
https://firebase.google.com/docs/functions/config-env#migrate-config

* chore: migrate to ESLint v9 and Flat Config (#1753)

Upgraded eslint to v9 and replaced the legacy .eslintrc.js with the new eslint.config.js format.

Applied minor fixes to 4 files (renaming unused catch variables to _e and one small refactor) to satisfy slightly stricter baseline rules from updated plugins.

Mostly doing this due to our upgrade in TS to latest v5 version which the old versions of eslint ts plugins no longer support.

* chore: enable esModuleInterop (#1751)

* feat: add async error handling to onRequest (#1755)

BREAKING CHANGE: Unhandled errors in async onRequest handlers now immediately return a 500 Internal Server Error instead of hanging until timeout. This may affect clients relying on 504 Gateway Timeout for retry logic.

* BREAKING: Break TS build that uses functions.config() (#1757)

Type out `functions.config()` API. Use of `functions.config()` API should now cause a BUILD error at compile time.

```ts
import * as functions from "firebase-functions";
import {onRequest} from "firebase-functions/https";
import * as logger from "firebase-functions/logger";

const cfg = functions.config()

export const helloWorld = onRequest((request, response) => {
  logger.info("Hello logs!", cfg);
  response.send("Hello from Firebase!");
});
```
```bash
$ npm run build

> build
> tsc

src/index.ts:5:23 - error TS2349: This expression is not callable.
  Type 'never' has no call signatures.

5 const cfg = functions.config()
                        ~~~~~~


Found 1 error in src/index.ts:5
```

* Add Firebase Data Connect v2 support (#1727)

* Add Firebase Data Connect v2 support

* Export dataconnect

* Fix export

* Rename Extract to VarName, since Extract is a built in type

* Include auth context in event payload

* Stronger typing for data connect params

* Fix formatting and address comments

* Apply another suggestion

* Add region and fix bug in which event.service, event.connector, event.operation gets populated

* Remove locations/... segment

* Address comments

* Fix linter

* feat: enable ESM support via dual-publishing (#1750)

- Configure tsdown to build both CJS and ESM outputs.
- Update package.json exports to support both 'require' and 'import'.
- Fix type hygiene issues by using explicit 'export type'.
- Update protos/update.sh to generate ESM version of compiledFirestore and fix its imports for Node.js compatibility.
- Configure build aliases to handle relative paths to protos correctly in both CJS and ESM builds.
- Add packaging integration test to CI.

~Note: I enabled `esModuleInterop` in tsconfig.release.json to support default imports from CommonJS modules (like cors), which is required for proper ESM interop. This caused some chain-effect that required updating several unit tests and source files to use default imports for other CJS dependencies (e.g., fs, nock, jsonwebtoken) to align with the new compiler configuration.~ Fixed in #1751.

* lock down permission per GitHub alert.

* update lint rule to enforce prettier rules.

* chore: update CHANGELOG for v7.0.0

* format.

---------

Co-authored-by: Lisa Jian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants