fix(firestore-send-email): map DATABASE_REGION to a Cloud Run region for function placement #3102
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| - fix: map `DATABASE_REGION` to a valid Cloud Run region before using it as the function region. Firestore multi-region locations (`nam5`, `nam7`) now deploy the function to `us-central1` and `eur3` to `europe-west1` instead of failing the deploy; regional locations pass through unchanged. The value is matched case-insensitively. With the parameter unset or empty the function declares no region and the Firebase CLI resolves one at deploy time. | ||
| - Initial release of kit, see README for differences between the legacy extension and this kit | ||
| - SendGrid sends now work with `AUTH_TYPE=OAuth2`: the `SMTP_PASSWORD` secret is no longer dropped from the config under OAuth2, so the SendGrid transport receives its API key | ||
| - SendGrid delivery no longer fails with `sgMail.setApiKey is not a function`: the transport imports `@sendgrid/mail` in a form that survives the compiled output |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,40 @@ | ||||||||||||||||||||||||||||||||||||||||||
| /* | ||||||||||||||||||||||||||||||||||||||||||
| * Copyright 2019 Google LLC | ||||||||||||||||||||||||||||||||||||||||||
| * | ||||||||||||||||||||||||||||||||||||||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||||||||||||||||||||||||||||||||||||||
| * you may not use this file except in compliance with the License. | ||||||||||||||||||||||||||||||||||||||||||
| * You may obtain a copy of the License at | ||||||||||||||||||||||||||||||||||||||||||
| * | ||||||||||||||||||||||||||||||||||||||||||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||||||||||||||||||||||||||||||||||||||||||
| * | ||||||||||||||||||||||||||||||||||||||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||||||||||||||||||||||||||||||||||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||||||||||||||||||||||||||||||||||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||||||||||||||||||||||||||||||||||||||
| * See the License for the specific language governing permissions and | ||||||||||||||||||||||||||||||||||||||||||
| * limitations under the License. | ||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Firestore multi-region locations are not Cloud Run regions; deploying a | ||||||||||||||||||||||||||||||||||||||||||
| // function to one hard-fails, so they map to a region inside the multi-region. | ||||||||||||||||||||||||||||||||||||||||||
| const MULTI_REGION_TO_FUNCTION_REGION: Record<string, string> = { | ||||||||||||||||||||||||||||||||||||||||||
| nam5: "us-central1", | ||||||||||||||||||||||||||||||||||||||||||
| nam7: "us-central1", | ||||||||||||||||||||||||||||||||||||||||||
| eur3: "europe-west1", | ||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||||||||||||
| * Maps a Firestore database location to the Cloud Run region the functions | ||||||||||||||||||||||||||||||||||||||||||
| * should deploy to. The lookup is case-insensitive and ignores surrounding | ||||||||||||||||||||||||||||||||||||||||||
| * whitespace, as the CLI's own region handling is. Regional locations pass | ||||||||||||||||||||||||||||||||||||||||||
| * through lowercased; an unset or blank location returns `undefined`, meaning | ||||||||||||||||||||||||||||||||||||||||||
| * the functions declare no region. | ||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||
| export function firestoreLocationToFunctionRegion( | ||||||||||||||||||||||||||||||||||||||||||
| location: string | undefined | ||||||||||||||||||||||||||||||||||||||||||
| ): string | undefined { | ||||||||||||||||||||||||||||||||||||||||||
| const normalized = location?.trim().toLowerCase(); | ||||||||||||||||||||||||||||||||||||||||||
| if (!normalized) { | ||||||||||||||||||||||||||||||||||||||||||
| return undefined; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
| return MULTI_REGION_TO_FUNCTION_REGION[normalized] ?? normalized; | ||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+32
to
+40
Contributor
There was a problem hiding this comment. To make the region mapping more robust against accidental leading/trailing whitespace or casing differences in the
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /** | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { afterEach, describe, expect, test, vi } from "vitest"; | ||
|
|
||
| vi.mock("firebase-functions/firestore", () => ({ | ||
| onDocumentWritten: vi.fn(() => ({})), | ||
| })); | ||
| vi.mock("firebase-functions/v2", () => ({ | ||
| requiresAPI: vi.fn(), | ||
| requiresRole: vi.fn(), | ||
| })); | ||
|
|
||
| type FunctionOptions = Record<string, unknown>; | ||
|
|
||
| const originalDatabaseRegion = process.env.DATABASE_REGION; | ||
|
|
||
| afterEach(() => { | ||
| if (originalDatabaseRegion === undefined) { | ||
| delete process.env.DATABASE_REGION; | ||
| } else { | ||
| process.env.DATABASE_REGION = originalDatabaseRegion; | ||
| } | ||
| }); | ||
|
|
||
| async function loadTriggerOptions( | ||
| databaseRegion?: string | ||
| ): Promise<FunctionOptions> { | ||
| vi.resetModules(); | ||
| if (databaseRegion === undefined) { | ||
| delete process.env.DATABASE_REGION; | ||
| } else { | ||
| process.env.DATABASE_REGION = databaseRegion; | ||
| } | ||
|
|
||
| await import("../src/index"); | ||
| const { onDocumentWritten } = await import("firebase-functions/firestore"); | ||
|
|
||
| const calls = vi.mocked(onDocumentWritten).mock.calls; | ||
| expect(calls.length).toBeGreaterThan(0); | ||
| return calls[calls.length - 1][0] as FunctionOptions; | ||
| } | ||
|
|
||
| describe("processQueue options", () => { | ||
| test.each([ | ||
| ["nam5", "us-central1"], | ||
| ["nam7", "us-central1"], | ||
| ["eur3", "europe-west1"], | ||
| ["NAM5", "us-central1"], | ||
| ])( | ||
| "multi-region DATABASE_REGION %s deploys the function to %s", | ||
| async (databaseRegion, expectedRegion) => { | ||
| const options = await loadTriggerOptions(databaseRegion); | ||
| expect(options.region).toBe(expectedRegion); | ||
| } | ||
| ); | ||
|
|
||
| test("regional DATABASE_REGION passes through as the function region", async () => { | ||
| const options = await loadTriggerOptions("europe-west1"); | ||
| expect(options.region).toBe("europe-west1"); | ||
| }); | ||
|
|
||
| test("unset DATABASE_REGION leaves the function without a region", async () => { | ||
| const options = await loadTriggerOptions(); | ||
| expect(options).not.toHaveProperty("region"); | ||
| }); | ||
|
|
||
| test("empty DATABASE_REGION leaves the function without a region", async () => { | ||
| const options = await loadTriggerOptions(""); | ||
| expect(options).not.toHaveProperty("region"); | ||
| }); | ||
|
|
||
| test("the trigger binds to the configured database and collection", async () => { | ||
| const options = await loadTriggerOptions(); | ||
| expect(String(options.database)).toBe("params.DATABASE"); | ||
| const document = options.document as { toCEL(): string }; | ||
| expect(document.toCEL()).toContain("params.MAIL_COLLECTION"); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.