-
Notifications
You must be signed in to change notification settings - Fork 228
fix(js): fixed caching performance issues #1604
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
Open
eric-zaharia
wants to merge
6
commits into
v4
Choose a base branch
from
fix/localstorage-cache-perf
base: v4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
be9df5a
fix(js): fixed caching performance issues
eric-zaharia 50e39da
fix(js): fixed build issue
eric-zaharia 02b1b4a
fix(js): removed async/await usage
eric-zaharia 9c1aa79
Merge branch 'v4' into fix/localstorage-cache-perf
eric-zaharia 7432326
fix(js): small refactor
eric-zaharia c7b04fb
fix(js): modified bundle size limit
eric-zaharia 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 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,22 @@ import { Cache, CacheEvents } from '@algolia/cache-common'; | |
|
|
||
| import { BrowserLocalStorageCacheItem, BrowserLocalStorageOptions } from '.'; | ||
|
|
||
| function yieldToMain(): Promise<void> { | ||
| // eslint-disable-next-line no-undef | ||
| const g: any = typeof globalThis !== 'undefined' ? globalThis : undefined; | ||
|
|
||
| if (g && g.scheduler && g.scheduler.yield) { | ||
eric-zaharia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return g.scheduler.yield().catch((error: any) => { | ||
| // eslint-disable-next-line no-console | ||
| console.error('Failed to yield to main: ', error); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what error can happen? |
||
|
|
||
| return new Promise(resolve => setTimeout(resolve, 0)); | ||
| }); | ||
| } | ||
|
|
||
| return new Promise(resolve => setTimeout(resolve, 0)); | ||
| } | ||
|
|
||
| export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptions): Cache { | ||
| const namespaceKey = `algoliasearch-client-js-${options.key}`; | ||
|
|
||
|
|
@@ -23,30 +39,24 @@ export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptio | |
| getStorage().setItem(namespaceKey, JSON.stringify(namespace)); | ||
| }; | ||
|
|
||
| const removeOutdatedCacheItems = () => { | ||
| const getFilteredNamespace = (): Record<string, BrowserLocalStorageCacheItem> => { | ||
| const timeToLive = options.timeToLive ? options.timeToLive * 1000 : null; | ||
| const namespace = getNamespace<BrowserLocalStorageCacheItem>(); | ||
| const currentTime = new Date().getTime(); | ||
|
|
||
| const filteredNamespaceWithoutOldFormattedCacheItems = Object.fromEntries( | ||
| return Object.fromEntries( | ||
| Object.entries(namespace).filter(([, cacheItem]) => { | ||
| return cacheItem.timestamp !== undefined; | ||
| }) | ||
| ); | ||
|
|
||
| setNamespace(filteredNamespaceWithoutOldFormattedCacheItems); | ||
| if (!cacheItem || cacheItem.timestamp === undefined) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!timeToLive) return; | ||
| if (!timeToLive) { | ||
| return true; | ||
| } | ||
|
|
||
| const filteredNamespaceWithoutExpiredItems = Object.fromEntries( | ||
| Object.entries(filteredNamespaceWithoutOldFormattedCacheItems).filter(([, cacheItem]) => { | ||
| const currentTimestamp = new Date().getTime(); | ||
| const isExpired = cacheItem.timestamp + timeToLive < currentTimestamp; | ||
|
|
||
| return !isExpired; | ||
| return cacheItem.timestamp + timeToLive >= currentTime; | ||
| }) | ||
| ); | ||
|
|
||
| setNamespace(filteredNamespaceWithoutExpiredItems); | ||
| }; | ||
|
|
||
| return { | ||
|
|
@@ -57,25 +67,24 @@ export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptio | |
| miss: () => Promise.resolve(), | ||
| } | ||
| ): Readonly<Promise<TValue>> { | ||
| return Promise.resolve() | ||
| .then(() => { | ||
| removeOutdatedCacheItems(); | ||
|
|
||
| const keyAsString = JSON.stringify(key); | ||
|
|
||
| return getNamespace<Promise<BrowserLocalStorageCacheItem>>()[keyAsString]; | ||
| }) | ||
| .then(value => { | ||
| return Promise.all([value ? value.value : defaultValue(), value !== undefined]); | ||
| }) | ||
| .then(([value, exists]) => { | ||
| return Promise.all([value, exists || events.miss(value)]); | ||
| }) | ||
| .then(([value]) => value); | ||
| return yieldToMain().then(() => { | ||
| const namespace = getFilteredNamespace(); | ||
| const keyAsString = JSON.stringify(key); | ||
| const cachedItem = namespace[keyAsString]; | ||
|
|
||
| setNamespace(namespace); | ||
|
|
||
| if (cachedItem) { | ||
| return cachedItem.value as TValue; | ||
| } | ||
|
|
||
| // eslint-disable-next-line promise/no-nesting | ||
| return defaultValue().then((value: TValue) => events.miss(value).then(() => value)); | ||
| }); | ||
| }, | ||
|
|
||
| set<TValue>(key: object | string, value: TValue): Readonly<Promise<TValue>> { | ||
| return Promise.resolve().then(() => { | ||
| return yieldToMain().then(() => { | ||
| const namespace = getNamespace(); | ||
|
|
||
| // eslint-disable-next-line functional/immutable-data | ||
|
|
@@ -91,7 +100,7 @@ export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptio | |
| }, | ||
|
|
||
| delete(key: object | string): Readonly<Promise<void>> { | ||
| return Promise.resolve().then(() => { | ||
| return yieldToMain().then(() => { | ||
| const namespace = getNamespace(); | ||
|
|
||
| // eslint-disable-next-line functional/immutable-data | ||
|
|
||
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.
why do you cast this as any and not
Windowor something? seems a bit odd to lie to typescript