Skip to content

Use custom cache over FSCache if specified #1285

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 16, 2025
Merged

Use custom cache over FSCache if specified #1285

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de92dc7
Use custom cache over FSCache if specified
PrafulB Apr 15, 2025
022a1f9
Use custom cache over browser cache if specified
PrafulB Apr 15, 2025
7e6d191
Throw an error if fs is not available for FSCache
PrafulB Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions src/utils/hub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,22 @@ export async function getModelFile(path_or_repo_id, filename, fatal = true, opti
// First, check if the a caching backend is available
// If no caching mechanism available, will download the file every time
let cache;
if (!cache && env.useCustomCache) {
// Allow the user to specify a custom cache system.
if (!env.customCache) {
throw Error('`env.useCustomCache=true`, but `env.customCache` is not defined.')
}

// Check that the required methods are defined:
if (!env.customCache.match || !env.customCache.put) {
throw new Error(
"`env.customCache` must be an object which implements the `match` and `put` functions of the Web Cache API. " +
"For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Cache"
)
}
cache = env.customCache;
}

if (!cache && env.useBrowserCache) {
if (typeof caches === 'undefined') {
throw Error('Browser cache is not available in this environment.')
Expand All @@ -435,28 +451,14 @@ export async function getModelFile(path_or_repo_id, filename, fatal = true, opti
}

if (!cache && env.useFSCache) {
// TODO throw error if not available
if (!apis.IS_FS_AVAILABLE) {
throw Error('File System Cache is not available in this environment.');
}

// If `cache_dir` is not specified, use the default cache directory
cache = new FileCache(options.cache_dir ?? env.cacheDir);
}

if (!cache && env.useCustomCache) {
// Allow the user to specify a custom cache system.
if (!env.customCache) {
throw Error('`env.useCustomCache=true`, but `env.customCache` is not defined.')
}

// Check that the required methods are defined:
if (!env.customCache.match || !env.customCache.put) {
throw new Error(
"`env.customCache` must be an object which implements the `match` and `put` functions of the Web Cache API. " +
"For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Cache"
)
}
cache = env.customCache;
}

const revision = options.revision ?? 'main';
const requestURL = pathJoin(path_or_repo_id, filename);

Expand Down