feat: persist promises more faithfully #6
Merged
Conversation
This file contains hidden or 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
Previously resolved promise values were being stored. Once they are server from cache, they were no longer promises, but instead values. So, they could be awaited, but if you were to use .then() on returned value, it would have failed because the resolved value is returned instead of an actual promise. This patch adds more thorough serialization/deserialization logic and ability to restore resolved or rejected promises from cache, the actual promises.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the caching mechanism by persisting promises so that restored promises accurately reflect their resolved or rejected states. Key changes include more robust serialization/deserialization logic using custom replacer and reviver, updated tests covering both resolved and rejected promise persistence, and documentation updates with a version bump.
Reviewed Changes
Copilot reviewed 8 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/utils.test.ts | Added tests for various object serialization including error cases |
| tests/cacheProxy.test.ts | Updated tests to verify proper caching and persistence of promises |
| src/utils.ts | Implemented custom replacer and reviver for serializing special types |
| src/mem-cache-store.ts | Adjusted promise handling in in-memory cache retrieval |
| src/file-cache-store.ts | Updated file-based cache to serialize/deserialize promises correctly |
| src/cache-store.ts | Expanded cache entry type to support promise state tracking |
| package.json | Bumped version from 3.0.0 to 3.1.0 |
| README.md | Updated documentation with clearer instructions and corrected typos |
| It can be used to save time and resources by caching the results of expensive function calls, paid or rate-limited API calls. | ||
|
|
||
| An in memory cache is also provided for non-persistent caching for environments where fs is not available. | ||
| It is designed to work with deeply nested objecst such as API SDKs, sync or async methods. |
There was a problem hiding this comment.
Correct the spelling of 'objecst' to 'objects' to improve clarity.
Suggested change
| It is designed to work with deeply nested objecst such as API SDKs, sync or async methods. | |
| It is designed to work with deeply nested objects such as API SDKs, sync or async methods. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously resolved promise values were being stored.
Once they are server from cache, they were no longer promises, but instead values.
So, they could be awaited, but if you were to use .then() on returned value, it would have failed because the resolved value is returned instead of an actual promise.
This patch adds more thorough serialization/deserialization logic and ability to restore resolved or rejected promises from cache, the actual promises.