-
Notifications
You must be signed in to change notification settings - Fork 146
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
fix: Make caching work correctly in async context #320
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import type { Stats } from "fs"; | ||
| import { resolve } from "path"; | ||
| import fs from "graceful-fs"; | ||
| import { Sema } from "async-sema"; | ||
|
|
||
| const fsReadFile = fs.promises.readFile; | ||
| const fsReadlink = fs.promises.readlink; | ||
| const fsStat = fs.promises.stat; | ||
|
|
||
| export class CachedFileSystem { | ||
| private fileCache: Map<string, Promise<string | null>>; | ||
| private statCache: Map<string, Promise<Stats | null>>; | ||
| private symlinkCache: Map<string, Promise<string | null>>; | ||
| private fileIOQueue: Sema; | ||
|
|
||
| constructor({ | ||
| cache, | ||
| fileIOConcurrency, | ||
| }: { | ||
| cache?: { fileCache?: Map<string, Promise<string | null>>, statCache?: Map<string, Promise<Stats | null>>, symlinkCache?: Map<string, Promise<string | null>> }; | ||
| fileIOConcurrency: number; | ||
| }) { | ||
| this.fileIOQueue = new Sema(fileIOConcurrency); | ||
| this.fileCache = cache?.fileCache ?? new Map(); | ||
| this.statCache = cache?.statCache ?? new Map(); | ||
| this.symlinkCache = cache?.symlinkCache ?? new Map(); | ||
|
|
||
| if (cache) { | ||
| cache.fileCache = this.fileCache; | ||
| cache.statCache = this.statCache; | ||
| cache.symlinkCache = this.symlinkCache; | ||
| } | ||
| } | ||
|
|
||
| async readlink(path: string): Promise<string | null> { | ||
| const cached = this.symlinkCache.get(path); | ||
| if (cached !== undefined) return cached; | ||
| // This is not awaiting the response, so that the cache is instantly populated and | ||
| // future calls serve the Promise from the cache | ||
| const readlinkPromise = this.executeFileIO(path, this._internalReadlink); | ||
| this.symlinkCache.set(path, readlinkPromise); | ||
|
|
||
| return readlinkPromise; | ||
| } | ||
|
|
||
| async readFile(path: string): Promise<string | null> { | ||
| const cached = this.fileCache.get(path); | ||
| if (cached !== undefined) return cached; | ||
| // This is not awaiting the response, so that the cache is instantly populated and | ||
| // future calls serve the Promise from the cache | ||
| const readFilePromise = this.executeFileIO(path, this._internalReadFile); | ||
| this.fileCache.set(path, readFilePromise); | ||
|
|
||
| return readFilePromise; | ||
| } | ||
|
|
||
| async stat(path: string): Promise<Stats | null> { | ||
| const cached = this.statCache.get(path); | ||
| if (cached !== undefined) return cached; | ||
| // This is not awaiting the response, so that the cache is instantly populated and | ||
| // future calls serve the Promise from the cache | ||
| const statPromise = this.executeFileIO(path, this._internalStat); | ||
| this.statCache.set(path, statPromise); | ||
|
|
||
| return statPromise; | ||
| } | ||
|
|
||
| private async _internalReadlink(path: string) { | ||
| try { | ||
| const link = await fsReadlink(path); | ||
| // also copy stat cache to symlink | ||
| const stats = this.statCache.get(path); | ||
| if (stats) this.statCache.set(resolve(path, link), stats); | ||
| return link; | ||
| } catch (e: any) { | ||
| if (e.code !== "EINVAL" && e.code !== "ENOENT" && e.code !== "UNKNOWN") | ||
| throw e; | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private async _internalReadFile(path: string): Promise<string | null> { | ||
| try { | ||
| return (await fsReadFile(path)).toString(); | ||
| } catch (e: any) { | ||
| if (e.code === "ENOENT" || e.code === "EISDIR") { | ||
| return null; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| private async _internalStat(path: string) { | ||
| try { | ||
| return await fsStat(path); | ||
| } catch (e: any) { | ||
| if (e.code === "ENOENT") { | ||
| return null; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| private async executeFileIO<Return>( | ||
| path: string, | ||
| fileIO: (path: string) => Promise<Return> | ||
| ): Promise<Return> { | ||
| await this.fileIOQueue.acquire(); | ||
|
|
||
| try { | ||
| return fileIO.call(this, path); | ||
| } finally { | ||
| this.fileIOQueue.release(); | ||
| } | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should analysisCache also go in the
CachedFileSystemclass?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not used there and right now it is only used in the job class.
If we move the cache we would need to move the analysis functionality there too, which I'm not sure fits into
CachedFileSystem