fix(routerlicious-driver): Properly dispose caches when document service is disposed by anthony-murphy-agent · Pull Request #26196 · microsoft/FluidFramework

anthony-murphy-agent · 2026-01-13T17:28:28Z

Summary

Fixes memory leak where DocumentService.dispose() was empty and did nothing
Adds clear() method to ICache interface for cache cleanup
Implements proper disposal chain: DocumentService → DocumentStorageService → internal storage services
Clears blobsShaCache and prefetchCache on dispose
Adds expiration (5 days) to blobCache as a safety net against leaks

Background

Customer reported memory issues when using Fluid Framework with SharedTree and Routerlicious driver. Their heap snapshot showed a retention chain:

clearImmediate → timerListMap → onTimeout → readAndParseBlob (closure retaining ~140MB)

The readAndParseBlob closure captures the storage service, which holds the driver's blob cache:

Container Runtime                          Driver
─────────────────                          ──────
readAndParseBlob (closure)                 
    ↓ captures this.storage
readAndParse(storage, id)
    ↓
storage.readBlob(id)  ──────────────────→  ShreddedSummaryDocumentStorageService.readBlob()
                                               ↓
                                           blobCache.get() / blobCache.put()
                                               ↓
                                           Returns cached blob (~140MB)

The root cause: DocumentService.dispose() was completely empty, so even when containers were disposed, the driver caches retained all blob data indefinitely.

Fix

When dispose() is called:

DocumentService.dispose() → DocumentStorageService.dispose()
All caches are cleared (blobCache.clear(), snapshotTreeCache.clear(), etc.)
The ~140MB of cached blob data is released

Even if timer callbacks still hold the readAndParseBlob closure reference, the actual blob data in the cache is now freed on dispose.

Changes

File	Change
`cache.ts`	Add `clear()` to `ICache` interface and implementations
`documentService.ts`	Implement `dispose()` to call storage service dispose
`documentStorageService.ts`	Add `dispose()` to propagate to internal service
`shreddedSummaryDocumentStorageService.ts`	Add `dispose()` to clear caches
`wholeSummaryDocumentStorageService.ts`	Add `dispose()` to clear caches
`prefetchDocumentStorageService.ts`	Add `dispose()` to clear `prefetchCache`
`documentServiceFactory.ts`	Add expiration to `blobCache`
`cache.spec.ts`	Add test for `clear()`

Test plan

Existing unit tests pass (133 tests)
New test for clear() added
Manual memory profiling to verify improvement

🤖 Generated with Claude Code

…ice is disposed Previously, `DocumentService.dispose()` was empty, causing memory leaks: - Factory-level caches retained all blobs indefinitely - `blobsShaCache` grew unbounded with each blob read - `PrefetchDocumentStorageService` cache was never cleared This change: - Adds `removeByPrefix()` to ICache for document-specific cleanup - Implements `dispose()` in DocumentService to propagate to storage - Adds `dispose()` to storage services to clean document-specific entries - Adds expiration to blobCache as a safety net - Clears blobsShaCache and prefetchCache on dispose This ensures calling `dispose()` properly releases memory regardless of when it's called (immediately or after the "saved" event). Co-Authored-By: anthony-murphy <anthony.murphy@microsoft.com> Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

anthony-murphy · 2026-01-13T17:47:18Z

/azp run Build - api-markdown-documenter, Build - benchmark-tool, Build - build-common, Build - build-tools, Build - client packages, Build - common-utils, Build - eslint-config-fluid, Build - eslint-plugin-fluid, Build - protocol-definitions, Build - test-tools

anthony-murphy · 2026-01-13T17:47:24Z

/azp run repo-policy-check, server-gitrest, server-gitssh, server-historian, server-routerlicious

azure-pipelines · 2026-01-13T17:47:36Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-01-13T17:47:38Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR fixes a memory leak where DocumentService.dispose() was empty and did nothing, causing blob caches to retain data indefinitely even after containers were disposed. The fix implements a proper disposal chain and adds cache cleanup methods.

Changes:

Added clear() method to ICache interface and its implementations
Implemented disposal chain: DocumentService → DocumentStorageService → internal storage services → cache cleanup
Added 5-day expiration to blobCache as a safety net against memory leaks

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`cache.ts`	Adds `clear()` method to `ICache` interface and implements it in `InMemoryCache` and `NullCache`
`documentService.ts`	Implements `dispose()` to call `documentStorageService?.dispose()`
`documentStorageService.ts`	Adds `dispose()` to propagate disposal to internal storage service
`prefetchDocumentStorageService.ts`	Implements `dispose()` to clear `prefetchCache` and propagate to internal service
`shreddedSummaryDocumentStorageService.ts`	Implements `dispose()` to clear `blobCache`, `snapshotTreeCache`, and `blobsShaCache`
`wholeSummaryDocumentStorageService.ts`	Implements `dispose()` to clear `blobCache` and `snapshotTreeCache`
`documentServiceFactory.ts`	Adds 5-day expiration to `blobCache` for additional protection
`cache.spec.ts`	Adds unit test for `clear()` functionality

anthony-murphy · 2026-02-03T17:25:18Z

/azp run Build - api-markdown-documenter, Build - benchmark-tool, Build - build-common, Build - build-tools, Build - client packages, Build - common-utils, Build - eslint-config-fluid, Build - eslint-plugin-fluid, Build - protocol-definitions, Build - test-tools

anthony-murphy · 2026-02-03T17:25:24Z

/azp run repo-policy-check, server-gitrest, server-gitssh, server-historian, server-routerlicious

azure-pipelines · 2026-02-03T17:25:39Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-02-03T17:25:39Z

Azure Pipelines successfully started running 1 pipeline(s).

…river-memory-disposal

packages/drivers/routerlicious-driver/src/shreddedSummaryDocumentStorageService.ts

packages/drivers/routerlicious-driver/src/wholeSummaryDocumentStorageService.ts

packages/drivers/routerlicious-driver/src/documentService.ts

packages/drivers/routerlicious-driver/src/cache.ts

The blobCache and snapshotTreeCache are shared across all documents via the factory, so clearing them in a per-document dispose() would wipe cached data for all active documents. Only clear the per-instance blobsShaCache. The MapWithExpiration-based expiration handles cleanup of the shared caches over time. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-Authored-By: anthony-murphy <anthony.murphy@microsoft.com>

This reverts commit 09ccaec.

anthony-murphy · 2026-02-07T01:27:12Z

/azp run Build - api-markdown-documenter, Build - benchmark-tool, Build - build-common, Build - build-tools, Build - client packages, Build - common-utils, Build - eslint-config-fluid, Build - eslint-plugin-fluid, Build - protocol-definitions, Build - test-tools

anthony-murphy · 2026-02-07T01:27:16Z

/azp run repo-policy-check, server-gitrest, server-gitssh, server-historian, server-routerlicious

azure-pipelines · 2026-02-07T01:27:27Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2026-02-07T01:27:29Z

Azure Pipelines successfully started running 1 pipeline(s).

The blobCache and snapshotTreeCache are factory-level shared caches. Using clear() in dispose() wiped cached data for ALL active documents, not just the one being disposed. This adds removeByPrefix() to the ICache interface and uses it in dispose() to only remove entries keyed with this document's ID prefix (`${this.id}:`), leaving other documents' cache entries intact. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-Authored-By: anthony-murphy <anthony.murphy@microsoft.com>

…:anthony-murphy-agent/FluidFramework into fix/routerlicious-driver-memory-disposal

anthony-murphy-agent · 2026-02-07T01:31:35Z

Azure Pipelines commands (copy and post separately, limit of 10 at a time):

/azp run Build - api-markdown-documenter, Build - benchmark-tool, Build - build-common, Build - build-tools, Build - client packages, Build - common-utils, Build - eslint-config-fluid, Build - eslint-plugin-fluid, Build - protocol-definitions, Build - test-tools

/azp run repo-policy-check, server-gitrest, server-gitssh, server-historian, server-routerlicious

anthony-murphy-agent · 2026-02-07T01:43:49Z

Azure Pipelines need to be triggered for this fork PR. Please run the following:

/azp run Build - api-markdown-documenter, Build - benchmark-tool, Build - build-common, Build - build-tools, Build - client packages, Build - common-utils, Build - eslint-config-fluid, Build - eslint-plugin-fluid, Build - protocol-definitions, Build - test-tools

/azp run repo-policy-check, server-gitrest, server-gitssh, server-historian, server-routerlicious

anthony-murphy-agent force-pushed the fix/routerlicious-driver-memory-disposal branch 3 times, most recently from 7111f40 to 32833c7 Compare January 13, 2026 17:35

anthony-murphy-agent force-pushed the fix/routerlicious-driver-memory-disposal branch from 32833c7 to 7da42b1 Compare January 13, 2026 17:39

anthony-murphy-agent marked this pull request as ready for review January 13, 2026 17:46

anthony-murphy requested a review from Copilot January 13, 2026 18:07

Copilot started reviewing on behalf of anthony-murphy January 13, 2026 18:08 View session

Copilot AI reviewed Jan 13, 2026

View reviewed changes

Merge branch 'main' into fix/routerlicious-driver-memory-disposal

be4ad0f

Merge remote-tracking branch 'upstream/main' into fix/routerlicious-d…

a9e818c

…river-memory-disposal

anthony-murphy-agent commented Feb 7, 2026

View reviewed changes

packages/drivers/routerlicious-driver/src/shreddedSummaryDocumentStorageService.ts Outdated Show resolved Hide resolved

anthony-murphy-agent commented Feb 7, 2026

View reviewed changes

packages/drivers/routerlicious-driver/src/wholeSummaryDocumentStorageService.ts Outdated Show resolved Hide resolved

anthony-murphy-agent commented Feb 7, 2026

View reviewed changes

packages/drivers/routerlicious-driver/src/documentService.ts Show resolved Hide resolved

anthony-murphy-agent commented Feb 7, 2026

View reviewed changes

packages/drivers/routerlicious-driver/src/cache.ts Show resolved Hide resolved

anthony-murphy-agent commented Feb 7, 2026

View reviewed changes

packages/drivers/routerlicious-driver/src/cache.ts Show resolved Hide resolved

anthony-murphy-agent and others added 2 commits February 6, 2026 17:16

Revert "fix: don't clear shared factory-level caches in dispose()"

cdb025a

This reverts commit 09ccaec.

anthony-murphy-agent and others added 2 commits February 6, 2026 17:29

Merge branch 'fix/routerlicious-driver-memory-disposal' of github.com…

34b5b07

…:anthony-murphy-agent/FluidFramework into fix/routerlicious-driver-memory-disposal

Conversation

anthony-murphy-agent commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Background

Fix

Changes

Test plan

Uh oh!

anthony-murphy commented Jan 13, 2026

Uh oh!

anthony-murphy commented Jan 13, 2026

Uh oh!

azure-pipelines bot commented Jan 13, 2026

Uh oh!

azure-pipelines bot commented Jan 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

anthony-murphy commented Feb 3, 2026

Uh oh!

anthony-murphy commented Feb 3, 2026

Uh oh!

azure-pipelines bot commented Feb 3, 2026

Uh oh!

azure-pipelines bot commented Feb 3, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anthony-murphy commented Feb 7, 2026

Uh oh!

anthony-murphy commented Feb 7, 2026

Uh oh!

azure-pipelines bot commented Feb 7, 2026

Uh oh!

azure-pipelines bot commented Feb 7, 2026

Uh oh!

anthony-murphy-agent commented Feb 7, 2026

Uh oh!

anthony-murphy-agent commented Feb 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

anthony-murphy-agent commented Jan 13, 2026 •

edited

Loading