refactor: extract cache logic into dedicated class #171
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
|
There was a problem hiding this comment. @mktcode It appears that there are no merge conflicts in the current branch. The working tree is clean, and no conflict markers were found. If you need to synchronize this branch with the latest changes from the If you need further assistance or specific updates, please let me know! Analysis chainScripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Fetch the conflicting files and the nature of conflicts
git fetch origin
git merge-base HEAD origin/main
git diff --name-only --diff-filter=U
Length of output: 134 Script: #!/bin/bash
# List all remote branches to identify the correct main branch name
git branch -r
Length of output: 62 Script: #!/bin/bash
# Fetch the conflicting files and the nature of conflicts using the master branch
git fetch origin
git merge-base HEAD origin/master
git diff --name-only --diff-filter=U
Length of output: 93 Script: #!/bin/bash
# Check the status of the repository
git status
# Search for conflict markers in the files
git grep -n '<<<<<<< HEAD'
Length of output: 104
Contributor
There was a problem hiding this comment. @coderabbitai I'm afraid you're mistaken. GitHub is displaying conflicts rather than a merge button. Your conclusion is incorrect. There was a problem hiding this comment. @mktcode The rebase attempt with the
To resolve these conflicts, please follow these steps:
Please let me know if you need any further assistance! Analysis chainScripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Fetch the conflicting files and the nature of conflicts using the master branch
git fetch origin
git merge-base HEAD origin/master
git diff --name-only --diff-filter=U
# Check the status of the repository
git status
# Search for conflict markers in the files
git grep -n '<<<<<<< HEAD'
Length of output: 198 Script: #!/bin/bash
# Attempt to rebase the current branch with master to identify any conflicts
git fetch origin
git rebase origin/master
Length of output: 894 |
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
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 |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| import { createHash } from 'crypto'; | ||
| import { Readable } from 'stream'; | ||
| import { set as setCache, get as getCache, clear as clearCache, isConfigured } from '../aws'; | ||
| import constants from '../constants.json'; | ||
| import { imageResolversCacheHitCount } from '../helpers/metrics'; | ||
| import { capture } from '@snapshot-labs/snapshot-sentry'; | ||
|
|
||
| export function sha256(str: string) { | ||
| return createHash('sha256') | ||
| .update(str) | ||
| .digest('hex'); | ||
| } | ||
|
|
||
| type ParamsType = { | ||
| type: string; | ||
| network: string; | ||
| address: string; | ||
| w: number; | ||
| h: number; | ||
| fallback?: string; | ||
| cb?: string; | ||
| }; | ||
|
|
||
| export default class Cache { | ||
| baseImageCacheKey: string; | ||
| resizedImageCacheKey: string; | ||
| isConfigured: boolean; | ||
|
|
||
| constructor({ type, network, address, w, h, fallback, cb }: ParamsType) { | ||
| const data = { type, network, address, w, h }; | ||
| if (fallback !== 'blockie') data['fallback'] = fallback; | ||
| if (cb) data['cb'] = cb; | ||
|
|
||
| const baseImageKey = this._buildKey({ ...data, w: constants.max, h: constants.max }); | ||
| const resizedImageKey = this._buildKey(data); | ||
|
|
||
| this.baseImageCacheKey = `${baseImageKey}/${baseImageKey}`; | ||
| this.resizedImageCacheKey = `${baseImageKey}/${resizedImageKey}`; | ||
| this.isConfigured = isConfigured; | ||
|
|
||
| if (!this.isConfigured) { | ||
| console.log('[cache:resolver] Cache is not configured'); | ||
| } | ||
| } | ||
|
|
||
| async getBaseImage(): Promise<Readable | boolean> { | ||
| return await this._getCache(this.baseImageCacheKey); | ||
| } | ||
|
|
||
| async getResizedImage(): Promise<Readable | boolean> { | ||
| return await this._getCache(this.resizedImageCacheKey); | ||
| } | ||
|
|
||
| async setBaseImage(value: Buffer) { | ||
| return await this._setCache(this.baseImageCacheKey, value); | ||
| } | ||
|
|
||
| async setResizedImage(value: Buffer) { | ||
| return await this._setCache(this.resizedImageCacheKey, value); | ||
| } | ||
|
|
||
| async clear(): Promise<boolean> { | ||
| if (!this.isConfigured) return false; | ||
|
|
||
| try { | ||
| const result = await clearCache(this.baseImageCacheKey); | ||
|
|
||
| console.log(`[cache:resolver] Cached cleared ${this.baseImageCacheKey}`); | ||
|
|
||
| return result; | ||
| } catch (e) { | ||
| console.log(`[cache:resolver] Failed to clear cache ${this.baseImageCacheKey}`); | ||
| capture(e); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| private async _getCache(key: string) { | ||
| if (!this.isConfigured) return false; | ||
|
|
||
| try { | ||
| console.log(`[cache:resolver] Getting cache ${key}`); | ||
| const cache = await getCache(key); | ||
|
|
||
| imageResolversCacheHitCount.inc({ status: cache ? 'HIT' : 'MISS' }, 1); | ||
|
|
||
| return cache; | ||
| } catch (e) { | ||
| capture(e); | ||
| console.log(`[cache:resolver] Failed to get cache ${key}`); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| private async _setCache(key: string, value: Buffer) { | ||
| if (!this.isConfigured) return false; | ||
|
|
||
| try { | ||
| console.log(`[cache:resolver] Setting cache ${key}`); | ||
| return await setCache(key, value); | ||
| } catch (e) { | ||
| capture(e); | ||
| console.log(`[cache:resolver] Failed to set cache ${key}`); | ||
| } | ||
| } | ||
|
|
||
| private _buildKey(params: ParamsType): string { | ||
| return sha256(JSON.stringify(params)); | ||
| } | ||
| } |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Did that just sneak into the commit, or is it meant to stay changed?