Skip to content

Latest commit

 

History

History
 
 

driver-web-cache

README.md

@fluidframework/driver-web-cache

This package provides an implementation of the IPersistedCache interface in the odsp-driver package. This cache enables storing of user content on the user's machine in order to provide faster boot experiences when opening the same Fluid containers more than once. This implementation has a dependency on indexeddb, so it is intended to only be used in a browser context.

Using Fluid Framework libraries

When taking a dependency on a Fluid Framework library's public APIs, we recommend using a ^ (caret) version range, such as ^1.3.4. While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries, library consumers should always prefer ^.

If using any of Fluid Framework's unstable APIs (for example, its beta APIs), we recommend using a more constrained version range, such as ~.

Installation

To get started, install the package by running the following command:

npm i @fluidframework/driver-web-cache

Importing from this package

This package leverages package.json exports to separate its APIs by support level. For more information on the related support guarantees, see API Support Levels.

To access the public (SemVer) APIs, import via @fluidframework/driver-web-cache like normal.

To access the legacy APIs, import via @fluidframework/driver-web-cache/legacy.

API Documentation

API documentation for @fluidframework/driver-web-cache is available at https://fluidframework.com/docs/apis/driver-web-cache.

Usage

import { FluidCache } from "@fluidframework/driver-web-cache";

new FluidCache({
	partitionKey: userId,
	logger,
	maxCacheItemAge,
});

Parameters

  • partitionKey - Used to determine what partition of the cache is being used, and can prevent multiple users on the same machine from sharing a snapshot cache. If you absolutely know that users will not share the cache, can also be set to null. Currently optional, but is proposed to be required in the next major bump. The recommendation is to use this key to differentiate users for the cache data.
  • logger - An optional implementation of the logger contract where diagnostic data can be logged.
  • maxCacheItemAge - The cache tracks a timestamp with each entry. This flag specifies the maximum age (in milliseconds) for a cache entry to be used. This flag does not control when cached content is deleted since different scenarios and applications may have different staleness thresholds for the same data.

Clearing cache entries

Whenever any Fluid content is loaded with the web cache enabled, a task is scheduled to clear out all "stale" cache entries. This task is scheduled with the setIdleCallback browser API. We define stale cache entries as any cache entries that have not been used (read or written to) within the last 4 weeks. The cache is cleared of all stale cache entries corresponding to all documents, not just the ones corresponding to the Fluid document being loaded.

The deleteFluidCacheIndexDbInstance API that an application can use to clear out the entire contents of the snapshot cache at any time. We recommend calling this API when the user explicitly signs out. Hosting applications are on point for ensuring responsible usage of the snapshot caching capability to still meet any relevant customer promises, such as clearing out storage when appropriate or disabling snapshot caching under certain circumstances, such as when it is known the user is logged in to a public computer.

import { deleteFluidCacheIndexDbInstance } from "@fluidframework/driver-web-cache";

// We put a catch here because Firefox Incognito will throw an error here. This is why we claim this method is a "best effort", since sometimes the browser won't let us access storage
deleteFluidCacheIndexDbInstance().catch(() => {});

Minimum Client Requirements

These are the platform requirements for the current version of Fluid Framework Client Packages. These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter. For Long Term Support (LTS) versions this can require supporting these platforms for several years.

It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug. If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request. When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.

Supported Runtimes

  • NodeJs ^20.10.0 except that we will drop support for it when NodeJs 20 loses its upstream support on 2026-04-30, and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
  • Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).

Supported Tools

  • TypeScript 5.4:
    • All strict options are supported.
    • strictNullChecks is required.
    • Configuration options deprecated in 5.0 are not supported.
    • exactOptionalPropertyTypes is currently not fully supported. If used, narrowing members of Fluid Framework types types using in, Reflect.has, Object.hasOwn or Object.prototype.hasOwnProperty should be avoided as they may incorrectly exclude undefined from the possible values in some cases.
  • webpack 5
    • We are not intending to be prescriptive about what bundler to use. Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.

Module Resolution

Node16, NodeNext, or Bundler resolution should be used with TypeScript compilerOptions to follow the Node.js v12+ ESM Resolution and Loading algorithm. Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.

Module Formats

  • ES Modules: ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.

  • CommonJs: Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below. This is done to accommodate some workflows without good ES Module support. If you have a workflow you would like included in this list, file an issue. Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.

Contribution Guidelines

There are many ways to contribute to Fluid.

Detailed instructions for working in the repo can be found in the Wiki.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Help

Not finding what you're looking for in this README? Check out fluidframework.com.

Still not finding what you're looking for? Please file an issue.

Thank you!

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.