Skip to content
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

[Runtime] Allow aborting fetchNDArray through AbortSignal #17208

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions web/src/artifact_cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,14 @@ export interface ArtifactCacheTemplate {
*
* @param url: The url to the data to be cached.
* @param storetype: Only applies to `ArtifactIndexedDBCache`. Since `indexedDB` stores the actual
* @param signal: An optional AbortSignal to abort data retrival
* data rather than a request, we specify `storagetype`. There are two options:
* 1. "json": IndexedDB stores `fetch(url).json()`
* 2. "arraybuffer": IndexedDB stores `fetch(url).arrayBuffer()`
*
* @note This is an async function.
*/
addToCache(url: string, storetype?: string): Promise<void>;
addToCache(url: string, storetype?: string, signal?: AbortSignal): Promise<void>;

/**
* check if cache has all keys in Cache
Expand Down Expand Up @@ -126,8 +127,8 @@ export class ArtifactCache implements ArtifactCacheTemplate {
}

// eslint-disable-next-line @typescript-eslint/no-unused-vars
async addToCache(url: string, storetype?: string) {
const request = new Request(url);
async addToCache(url: string, storetype?: string, signal?: AbortSignal) {
const request = new Request(url, signal ? { signal } : undefined);
if (this.cache === undefined) {
this.cache = await caches.open(this.scope);
}
Expand Down Expand Up @@ -282,15 +283,15 @@ export class ArtifactIndexedDBCache implements ArtifactCacheTemplate {
});
}

async addToCache(url: string, storetype?: string): Promise<void> {
async addToCache(url: string, storetype?: string, signal?: AbortSignal): Promise<void> {
await this.initDB(); // await the initDB process
// If already cached, nothing to do
const isInDB = await this.isUrlInDB(url);
if (isInDB) {
return;
}
try {
const response = await fetch(url);
const response = await fetch(url, signal ? { signal } : undefined);
if (!response.ok) {
throw new Error('Network response was not ok');
}
Expand Down
13 changes: 9 additions & 4 deletions web/src/runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1444,13 +1444,15 @@ export class Instance implements Disposable {
* @param device The device to be fetched to.
* @param cacheScope The scope identifier of the cache
* @param cacheType The type of the cache: "cache" or "indexedDB"
* @param signal An optional AbortSignal to abort the fetch
* @returns The meta data
*/
async fetchNDArrayCache(
ndarrayCacheUrl: string,
device: DLDevice,
cacheScope = "tvmjs",
cacheType = "cache"
cacheType = "cache",
signal?: AbortSignal,
): Promise<any> {
let artifactCache: ArtifactCacheTemplate;
if (cacheType === undefined || cacheType.toLowerCase() === "cache") {
Expand All @@ -1465,7 +1467,8 @@ export class Instance implements Disposable {
const list = await artifactCache.fetchWithCache(jsonUrl, "json");
await this.fetchNDArrayCacheInternal(
ndarrayCacheUrl,
list["records"] as Array<NDArrayShardEntry>, device, artifactCache);
list["records"] as Array<NDArrayShardEntry>, device, artifactCache,
signal);
this.cacheMetadata = { ...this.cacheMetadata, ...(list["metadata"] as Record<string, any>) };
}

Expand All @@ -1477,12 +1480,14 @@ export class Instance implements Disposable {
* @param list The list of array data.
* @param device The device to store the data to.
* @param artifactCache The artifact cache
* @param signal An optional AbortSignal to abort the fetch
*/
private async fetchNDArrayCacheInternal(
ndarrayCacheUrl: string,
list: Array<NDArrayShardEntry>,
device: DLDevice,
artifactCache: ArtifactCacheTemplate
artifactCache: ArtifactCacheTemplate,
signal?: AbortSignal,
) {
const perf = compact.getPerformance();
const tstart = perf.now();
Expand Down Expand Up @@ -1537,7 +1542,7 @@ export class Instance implements Disposable {
const shard = list[i];
const dataUrl = new URL(shard.dataPath, ndarrayCacheUrl).href;
try {
await artifactCache.addToCache(dataUrl, "arraybuffer");
await artifactCache.addToCache(dataUrl, "arraybuffer", signal);
} catch (err) {
this.env.logger("Error: Cannot fetch " + dataUrl + " err= " + err);
throw err;
Expand Down
Loading