Skip to content

fix(firestore-bigquery-export): republish the legacy firestore-counter event types #3111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CorieW merged 1 commit into from
Sep 11, 2026
+43 −25
Merged

fix(firestore-bigquery-export): republish the legacy firestore-counter event types #3111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions kits/firestore-bigquery-export/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,19 +170,27 @@ the instances cannot collide.

## Events

When `EVENTARC_CHANNEL` is configured, the functions publish lifecycle events
under `firebase.extensions.firestore-bigquery-export.v1.*`: `onStart` and
`onError` from the write path, and `onSuccess` from the `syncBigQuery` task
when a buffered write lands (matching the extension, which only emitted
`onSuccess` from its queue handler).
When `EVENTARC_CHANNEL` is configured, the functions publish lifecycle events:
`onStart` and `onError` from the write path, and `onSuccess` from the
`syncBigQuery` task when a buffered write lands (matching the extension, which
only emitted `onSuccess` from its queue handler).

Each event is published twice, exactly as the extension published it: once
under `firebase.extensions.firestore-bigquery-export.v1.*` and once under
`firebase.extensions.firestore-counter.v1.*`. The `firestore-counter` type is a
historical naming mistake the extension kept for backwards compatibility, and
the kit keeps it for the same reason: triggers listening on it survive the
migration. The two copies carry the same `data` and `subject`, and only differ
by `type`. Write new triggers against the `firestore-bigquery-export` types.

Publishing is filtered by `EXT_SELECTED_EVENTS`: the value is split on commas
and only exactly matching event types are published, silently. An empty value
suppresses every event, and a value carrying only another product's types
(the extension offered more than one namespace to tick) publishes nothing. A
config exported from the extension brings its `EXT_SELECTED_EVENTS` along, so
check it lists the `firebase.extensions.firestore-bigquery-export.v1.*` types
you expect, `onSuccess` included.
check it lists the types you expect, `onSuccess` included. It gates the legacy
`firestore-counter` copies too, so a trigger on a legacy type only fires when
that legacy type is listed.

## Provisioning

Expand Down Expand Up @@ -367,14 +375,6 @@ inside that window. That property is gone by design - a row that exhausts the
queue without a configured `BACKUP_COLLECTION` is dropped, exactly as in the
extension. Set `BACKUP_COLLECTION`.

### Events

Events are published under `firebase.extensions.firestore-bigquery-export.v1.*`
only. The extension also published a duplicate copy of every event under
`firebase.extensions.firestore-counter.v1.*`, a historical naming mistake kept
for backwards compatibility. If you have Eventarc triggers listening on those
`firestore-counter` types, point them at the `firestore-bigquery-export` types.

### Wildcard columns include the document ID

With `WILDCARD_IDS=true`, the wildcard column now contains a `documentId` key
Expand Down
10 changes: 7 additions & 3 deletions kits/firestore-bigquery-export/src/events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,17 @@ import * as eventArc from "firebase-admin/eventarc";
const { getEventarc } = eventArc;

/**
* Builds the Eventarc event type for this extension.
* Generates both the OLD and NEW event types to maintain backward compatibility.
*
* Old Event Type: firebase.extensions.firestore-counter.v1.{eventName}
* New Event Type: firebase.extensions.firestore-bigquery-export.v1.{eventName}
*
* @param eventName The name of the event (e.g., "onStart", "onError", etc.)
* @returns The event type string.
* @returns An array containing both the old and new event types
*/
const getEventTypes = (eventName: string) => [
`firebase.extensions.firestore-bigquery-export.v1.${eventName}`,
`firebase.extensions.firestore-counter.v1.${eventName}`, // OLD Event Type for backward compatibility

@IzaakGough IzaakGough Sep 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Non-blocking, and I don't think the code should change here since this is exactly the parity the PR is restoring.

Worth noting though: this type is byte-identical to the type the firestore-counter kit publishes today (kits/firestore-counter/src/events.ts builds firebase.extensions.firestore-counter.v1.<name>). In a project running both kits against the same EVENTARC_CHANNEL, the counter kit's onStart trigger will now fire for every document write this kit exports, with a payload of {documentId, changeType, before, after, context} rather than the counter's {data, params}, so a handler reading event.data.params gets undefined. Eventarc triggers filter on type, so it can't be filtered downstream; the only escape is setting EXT_SELECTED_EVENTS on this kit to the new types only.

In the extension this was accepted history, but in the kits world both are first-class packages someone may deploy side by side, so it might be worth a line in the differences entry with that mitigation named.

@CorieW CorieW Sep 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hmm, this is something worth considering.

@cabljac cabljac Sep 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it's a valid point but like you say, for parity this is a follow-up

`firebase.extensions.firestore-bigquery-export.v1.${eventName}`, // NEW Event Type following the updated convention
];
Comment thread
CorieW marked this conversation as resolved.

let eventChannel: eventArc.Channel | undefined;
Expand Down
28 changes: 21 additions & 7 deletions kits/firestore-bigquery-export/tests/events.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,13 @@ describe("channel configured", () => {
setupEventChannel();
});

test("publishes the firestore-bigquery-export event type only", async () => {
test("publishes both the legacy and the current event type", async () => {
await recordStartEvent({ a: 1 });
expect(publish).toHaveBeenCalledTimes(1);
expect(publish).toHaveBeenCalledWith(
expect.objectContaining({
type: "firebase.extensions.firestore-bigquery-export.v1.onStart",
})
);
expect(publish).toHaveBeenCalledTimes(2);
expect(publish.mock.calls.map((c) => c[0].type)).toEqual([
"firebase.extensions.firestore-counter.v1.onStart",
"firebase.extensions.firestore-bigquery-export.v1.onStart",
]);
});

test("error / success / completion map to their event types", async () => {
Expand All @@ -76,9 +75,24 @@ describe("channel configured", () => {

const types = publish.mock.calls.map((c) => c[0].type);
expect(types).toEqual([
"firebase.extensions.firestore-counter.v1.onError",
"firebase.extensions.firestore-bigquery-export.v1.onError",
"firebase.extensions.firestore-counter.v1.onSuccess",
"firebase.extensions.firestore-bigquery-export.v1.onSuccess",
"firebase.extensions.firestore-counter.v1.onCompletion",
"firebase.extensions.firestore-bigquery-export.v1.onCompletion",
]);
});

test("the legacy copy carries the same payload as the current one", async () => {
await recordErrorEvent(new Error("boom"), "doc1");

const [legacy, current] = publish.mock.calls.map((c) => c[0]);
expect(legacy.data).toEqual({ message: "boom" });
expect(legacy.subject).toBe("doc1");
expect({ ...legacy, type: undefined }).toEqual({
...current,
type: undefined,
});
});
});
Loading