-
Notifications
You must be signed in to change notification settings - Fork 430
fix(delete-user-data): resolve the RTDB client on first use #2955
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.
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
Draft
IzaakGough
wants to merge
1
commit into
kits-delete-user-data-tests
Choose a base branch
from
kits-delete-user-data-rtdb-lazy
base: kits-delete-user-data-tests
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,15 @@ | ||
| INSTANCE_ID=nortdb | ||
| FIRESTORE_PATHS= | ||
| FIRESTORE_DATABASE_ID=(default) | ||
| FIRESTORE_DELETE_MODE=recursive | ||
| SELECTED_DATABASE_INSTANCE= | ||
| SELECTED_DATABASE_LOCATION=us-central1 | ||
| RTDB_PATHS= | ||
| CLOUD_STORAGE_BUCKET=demo-test.appspot.com | ||
| STORAGE_PATHS= | ||
| ENABLE_AUTO_DISCOVERY=true | ||
| AUTO_DISCOVERY_SEARCH_DEPTH=3 | ||
| AUTO_DISCOVERY_SEARCH_FIELDS=id,uid,userId | ||
| SEARCH_FUNCTION= | ||
| DISCOVERY_TOPIC_NAME=kit-nortdb-discovery | ||
| DELETION_TOPIC_NAME=kit-nortdb-deletion |
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,22 @@ | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| // Exported under a distinct name so this codebase does not shadow the | ||
| // handleSearch registered by tests/emulator/app, and without clearData so | ||
| // only one auth onDelete handler exists. | ||
| const kit = require("../../../lib/index.js"); | ||
|
|
||
| exports.handleSearchNoRtdb = kit.handleSearch; |
6 changes: 6 additions & 0 deletions
6
kits/delete-user-data/tests/emulator/app-no-rtdb/package.json
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,6 @@ | ||
| { | ||
| "name": "delete-user-data-emulator-app-no-rtdb", | ||
| "private": true, | ||
| "main": "index.js", | ||
| "engines": { "node": "24" } | ||
| } |
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,57 @@ | ||
| /** | ||
| * 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 type { Firestore } from "firebase-admin/firestore"; | ||
| import { beforeAll, describe, expect, test } from "vitest"; | ||
|
|
||
| import { resolveDeleteUserDataConfig } from "../../src/export-config"; | ||
| import { publishSearch } from "../../src/runBatchPubSubDeletions"; | ||
| import { | ||
| collectionEmpty, | ||
| initialize, | ||
| publisherContext, | ||
| randomId, | ||
| waitFor, | ||
| } from "./helpers"; | ||
|
|
||
| // Matches tests/emulator/app-no-rtdb/.env: no Realtime Database instance, the | ||
| // default for anyone deleting only Firestore data. | ||
| const config = resolveDeleteUserDataConfig({ | ||
| instanceId: "nortdb", | ||
| projectId: "demo-test", | ||
| discoveryTopicName: "kit-nortdb-discovery", | ||
| deletionTopicName: "kit-nortdb-deletion", | ||
| }); | ||
|
|
||
| let db: Firestore; | ||
| let ctx: ReturnType<typeof publisherContext>; | ||
|
|
||
| beforeAll(() => { | ||
| ({ db } = initialize()); | ||
| ctx = publisherContext(config); | ||
| }); | ||
|
|
||
| describe("with no Realtime Database instance configured", () => { | ||
| test("still runs discovery instead of dying on startup", async () => { | ||
| const uid = randomId(); | ||
| const collection = db.collection(randomId()).doc("parent").collection(uid); | ||
| await collection.add({ foo: "bar" }); | ||
|
|
||
| await publishSearch(uid, 1, collection.path, ctx); | ||
|
|
||
| expect(await waitFor(collectionEmpty(db, collection.path))).toBe(true); | ||
| }); | ||
| }); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While resolving the database client on first use is a great way to prevent eager initialization errors, calling
admin.database()on every property access can be inefficient if accessed multiple times (e.g., in loops or multiple helper calls). Additionally, ifctxis ever destructured in the future (e.g.,const { database } = ctx), it will trigger this getter and throw if RTDB is not configured.We can optimize this and make it more robust by caching the resolved database instance in a local variable within
getContext().