Add api to remove a single entry from FluidCache#26065
Merged
Merged
Conversation
shubhi1092
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new optional method removeEntry to the IPersistedCache interface, allowing removal of a single cache entry instead of all entries for a document. The change is backward compatible since the method is optional, but breaks forward compatibility as documented in the type validation changes.
Key Changes
- Added
removeEntryoptional method toIPersistedCacheinterface for granular cache entry removal - Implemented
removeEntryinFluidCacheclass with appropriate error handling and telemetry - Added comprehensive test coverage for the new functionality
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/common/driver-definitions/src/cacheDefinitions.ts | Added optional removeEntry method to IPersistedCache interface with documentation |
| packages/drivers/driver-web-cache/src/FluidCache.ts | Implemented removeEntry method with error handling pattern consistent with removeEntries |
| packages/drivers/driver-web-cache/src/fluidCacheTelemetry.ts | Added new error event FluidCacheDeleteSingleEntryError for telemetry tracking |
| packages/drivers/driver-web-cache/src/test/FluidCache.test.ts | Added test case verifying selective entry removal without affecting other entries |
| packages/drivers/driver-web-cache/package.json | Updated type validation configuration to document forward compatibility break |
| packages/drivers/driver-web-cache/src/test/types/validateDriverWebCachePrevious.generated.ts | Added ts-expect-error directive for expected compatibility break |
Comment on lines
+187
to
+216
| it("removes a specific entry without affecting other entries for the same document", async () => { | ||
| const fluidCache = getFluidCache(); | ||
|
|
||
| const docId1Entry1 = getMockCacheEntry("docId1Entry1", { | ||
| docId: "docId1", | ||
| }); | ||
| const docId1Entry2 = getMockCacheEntry("docId1Entry2", { | ||
| docId: "docId1", | ||
| }); | ||
| const docId2Entry1 = getMockCacheEntry("docId2Entry1", { | ||
| docId: "docId2", | ||
| }); | ||
|
|
||
| await fluidCache.put(docId1Entry1, { data: "entry1" }); | ||
| await fluidCache.put(docId1Entry2, { data: "entry2" }); | ||
| await fluidCache.put(docId2Entry1, { data: "entry3" }); | ||
|
|
||
| // Verify all entries exist | ||
| expect(await fluidCache.get(docId1Entry1)).toEqual({ data: "entry1" }); | ||
| expect(await fluidCache.get(docId1Entry2)).toEqual({ data: "entry2" }); | ||
| expect(await fluidCache.get(docId2Entry1)).toEqual({ data: "entry3" }); | ||
|
|
||
| // Remove only one specific entry from docId1 | ||
| await fluidCache.removeEntry(docId1Entry1); | ||
|
|
||
| // Verify only the specified entry was removed | ||
| expect(await fluidCache.get(docId1Entry1)).toBeUndefined(); | ||
| expect(await fluidCache.get(docId1Entry2)).toEqual({ data: "entry2" }); // Still exists | ||
| expect(await fluidCache.get(docId2Entry1)).toEqual({ data: "entry3" }); // Still exists | ||
| }); |
There was a problem hiding this comment.
The test coverage for the new removeEntry method is incomplete. Consider adding test cases for:
- Attempting to remove a non-existent entry (should not throw)
- Behavior when the database has been upgraded by another client (similar to line 250)
- Behavior when an older client is blocking the database (similar to line 264)
These scenarios are tested for other cache operations and would ensure consistent behavior across all API methods.
Contributor
Author
There was a problem hiding this comment.
@copilot update this pull request by applying changes based on this feedback
Contributor
|
@shubhi1092 I've opened a new pull request, #26066, to work on those changes. Once the pull request is ready, I'll request review from you. |
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
anthony-murphy
approved these changes
Dec 18, 2025
anthony-murphy-agent
pushed a commit
to anthony-murphy-agent/FluidFramework
that referenced
this pull request
Jan 14, 2026
## Description Added api to remove a single entry from fluidCache ## Breaking Changes Added an optional method for deleting a single entry from fluid cache - removeEntry. It is not forward compatible, but it is still backwards compatible because it is optional. --------- Co-authored-by: Shubhangi Agarwal <shuagarwal@microsoft.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Added api to remove a single entry from fluidCache
Breaking Changes
Added an optional method for deleting a single entry from fluid cache - removeEntry.
It is not forward compatible, but it is still backwards compatible because it is optional.