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

refactor(backend): update rate caching #2891

Merged
merged 1 commit into from
Aug 26, 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
29 changes: 17 additions & 12 deletions packages/backend/src/rates/service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { initIocContainer } from '../'
import { AppServices } from '../app'
import { CacheDataStore } from '../middleware/cache/data-stores'
import { mockRatesApi } from '../tests/rates'
import { AxiosInstance } from 'axios'

const nock = (global as unknown as { nock: typeof import('nock') }).nock

Expand Down Expand Up @@ -214,23 +215,27 @@ describe('Rates service', function () {
expect(apiRequestCount).toBe(2)
})

it('prefetches when the cached request is old', async () => {
it('returns new rates after cache expires', async () => {
await expect(service.rates('USD')).resolves.toEqual(usdRates)
jest.advanceTimersByTime(exchangeRatesLifetime * 0.5 + 1)
// ... cache isn't expired yet, but it will be soon
await expect(service.rates('USD')).resolves.toEqual(usdRates)
expect(apiRequestCount).toBe(1)

// Invalidate the cache.
jest.advanceTimersByTime(exchangeRatesLifetime * 0.5 + 1)
jest.advanceTimersByTime(exchangeRatesLifetime + 1)
await expect(service.rates('USD')).resolves.toEqual(usdRates)
// The prefetch response is promoted to the cache.
expect(apiRequestCount).toBe(2)
})

it('cannot use an expired cache', async () => {
await expect(service.rates('USD')).resolves.toEqual(usdRates)
jest.advanceTimersByTime(exchangeRatesLifetime + 1)
it('returns rates on second request (first one was error)', async () => {
jest
.spyOn(
(service as RatesService & { axios: AxiosInstance }).axios,
'get'
)
.mockImplementationOnce(() => {
apiRequestCount++
throw new Error()
})

await expect(service.rates('USD')).rejects.toThrow(
'Could not fetch rates'
)
await expect(service.rates('USD')).resolves.toEqual(usdRates)
expect(apiRequestCount).toBe(2)
})
Expand Down
61 changes: 31 additions & 30 deletions packages/backend/src/rates/service.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BaseService } from '../shared/baseService'
import Axios, { AxiosInstance } from 'axios'
import Axios, { AxiosInstance, isAxiosError } from 'axios'
import { convert, ConvertOptions } from './util'
import { createInMemoryDataStore } from '../middleware/cache/data-stores/in-memory'
import { CacheDataStore } from '../middleware/cache/data-stores'
Expand Down Expand Up @@ -74,29 +74,13 @@ class RatesServiceImpl implements RatesService {
}

private async getRates(baseAssetCode: string): Promise<Rates> {
const [cachedRate, cachedExpiry] = await Promise.all([
this.cachedRates.get(baseAssetCode),
this.cachedRates.getKeyExpiry(baseAssetCode)
])

if (cachedRate && cachedExpiry) {
const isCloseToExpiry =
cachedExpiry.getTime() <
Date.now() + 0.5 * this.deps.exchangeRatesLifetime

if (isCloseToExpiry) {
this.fetchNewRatesAndCache(baseAssetCode) // don't await, just get new rates for later
}
Comment on lines -83 to -89
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This didn't make sense, using this.fetchNewRatesAndCache(baseAssetCode) without await just turns it into a sync method, which was still making the request and not "prefetching it".

Now in the the new changes its a simple flow: if the rate is cached, return it, if not, get new rates. No need to check for "isCloseToExpiry"

const cachedRate = await this.cachedRates.get(baseAssetCode)

if (cachedRate) {
return JSON.parse(cachedRate)
}

try {
return await this.fetchNewRatesAndCache(baseAssetCode)
} catch (err) {
this.cachedRates.delete(baseAssetCode)
throw err
}
return await this.fetchNewRatesAndCache(baseAssetCode)
}

private async fetchNewRatesAndCache(baseAssetCode: string): Promise<Rates> {
Expand All @@ -106,12 +90,32 @@ class RatesServiceImpl implements RatesService {
this.inProgressRequests[baseAssetCode] = this.fetchNewRates(baseAssetCode)
}

const rates = await this.inProgressRequests[baseAssetCode]
try {
const rates = await this.inProgressRequests[baseAssetCode]

delete this.inProgressRequests[baseAssetCode]
await this.cachedRates.set(baseAssetCode, JSON.stringify(rates))
return rates
} catch (err) {
const errorMessage = 'Could not fetch rates'

this.deps.logger.error(
{
...(isAxiosError(err)
? {
errorMessage: err.message,
errorCode: err.code,
errorStatus: err.status
}
: { err }),
url: this.deps.exchangeRatesUrl
},
errorMessage
)

await this.cachedRates.set(baseAssetCode, JSON.stringify(rates))
return rates
throw new Error(errorMessage)
} finally {
delete this.inProgressRequests[baseAssetCode]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BlairCurrey this is the line that fixes the error

}
}

private async fetchNewRates(baseAssetCode: string): Promise<Rates> {
Expand All @@ -120,12 +124,9 @@ class RatesServiceImpl implements RatesService {
return { base: baseAssetCode, rates: {} }
}

const res = await this.axios
.get<Rates>(url, { params: { base: baseAssetCode } })
.catch((err) => {
this.deps.logger.warn({ err: err.message }, 'price request error')
throw err
})
const res = await this.axios.get<Rates>(url, {
params: { base: baseAssetCode }
})

const { base, rates } = res.data
this.checkBaseAsset(base)
Expand Down
Loading