mirror of
https://github.com/arthurfiorette/axios-cache-interceptor.git
synced 2025-12-08 17:36:16 +00:00
48e33c5d5a
* feat(WIP): etag and if-modified-since support * test: fixed test name * fix: merge response headers * test: add etag / last-modified tests * test: add must-revalidate tests * fix: handle expirationTime 0 as true. * tests: refactored some tests * test: added keepIfStale tests * fix: remove axios error for 304 requests * fix: possible infinite loop on validateStatus function * tests: ignore code that is hard test from coverage * fix: use Last-Modified header for modifiedSince If-Modified-Since is never sent by a server, it's a client only header. However Last-Modified is sent by the server to indicate the last time the returned version was modified (it might not be the last version depending on cache configuration on intermediate servers) * test: use validateStatus in mock This more closely match default axios adapter. * fix: validateStatus handling all cases * refactor: use cache.createdAt if the last-modified header isn't present * test: etag with predefined value * test: added more test cases * fix: fixed logic in some tests * docs: initial documentation * fix: manual values work out of the box This removes header requirement from server. * docs: add details to etag and modifiedSince features * fix: delete custom headers from response * feat: accept all configurations from global axios Merging global into local configuration enable user to use global configuration for all options and remove the need to check local and global values every time. * fix: preserve original types from AxiosInstance The only value axios needs is a URL, and in the second definition of the method, there is already a URL parameter, so it can be undefined. * Fix: defaults modifiedSince back to false. Avoids breaking changes. * docs: fix etag examples * docs: document internal headers * refactor: ternary operator :) * style: prettified code * test: remove modifiedSince: false in tests since this is the default * docs: fix headers examples * docs: fixed example formatting * tests: split tests into multiple files to test them faster * docs: correct jsdoc empty object Co-authored-by: Charly Koza <cka@f4-group.com>
102 lines
2.8 KiB
TypeScript
102 lines
2.8 KiB
TypeScript
import { Header } from '../../src/util/headers';
|
|
import { mockAxios } from '../mocks/axios';
|
|
import { sleep } from '../utils';
|
|
|
|
describe('Last-Modified handling', () => {
|
|
it('tests last modified header handling', async () => {
|
|
const axios = mockAxios(
|
|
{},
|
|
{
|
|
'last-modified': 'Wed, 21 Oct 2015 07:28:00 GMT',
|
|
'cache-control': 'max-age=1'
|
|
}
|
|
);
|
|
|
|
const config = { cache: { interpretHeader: true, modifiedSince: true } };
|
|
|
|
await axios.get('', config);
|
|
|
|
const response = await axios.get('', config);
|
|
expect(response.cached).toBe(true);
|
|
expect(response.data).toBe(true);
|
|
|
|
// Sleep entire max age time.
|
|
await sleep(1000);
|
|
|
|
const response2 = await axios.get('', config);
|
|
// from revalidation
|
|
expect(response2.cached).toBe(true);
|
|
expect(response2.status).toBe(200);
|
|
});
|
|
|
|
it('tests last modified header handling in global config', async () => {
|
|
const axios = mockAxios(
|
|
{ interpretHeader: true, modifiedSince: true },
|
|
{
|
|
'last-modified': 'Wed, 21 Oct 2015 07:28:00 GMT',
|
|
'cache-control': 'max-age=1'
|
|
}
|
|
);
|
|
|
|
await axios.get('');
|
|
|
|
const response = await axios.get('');
|
|
expect(response.cached).toBe(true);
|
|
expect(response.data).toBe(true);
|
|
|
|
// Sleep entire max age time.
|
|
await sleep(1000);
|
|
|
|
const response2 = await axios.get('');
|
|
// from revalidation
|
|
expect(response2.cached).toBe(true);
|
|
expect(response2.status).toBe(200);
|
|
});
|
|
|
|
it('tests modifiedSince as date', async () => {
|
|
const axios = mockAxios({ ttl: 0 });
|
|
|
|
const config = {
|
|
cache: { modifiedSince: new Date(2014, 1, 1) }
|
|
};
|
|
|
|
const response = await axios.get('', config);
|
|
expect(response.cached).toBe(false);
|
|
expect(response.data).toBe(true);
|
|
expect(response.config.headers?.[Header.IfModifiedSince]).toBeUndefined();
|
|
expect(response.headers?.[Header.XAxiosCacheLastModified]).toBeDefined();
|
|
|
|
const response2 = await axios.get('', config);
|
|
expect(response2.cached).toBe(true);
|
|
expect(response2.data).toBe(true);
|
|
expect(response2.config.headers?.[Header.IfModifiedSince]).toBeDefined();
|
|
expect(response2.headers?.[Header.XAxiosCacheLastModified]).toBeDefined();
|
|
});
|
|
|
|
it('tests modifiedSince using cache timestamp', async () => {
|
|
const axios = mockAxios(
|
|
{},
|
|
{
|
|
'cache-control': 'must-revalidate'
|
|
}
|
|
);
|
|
|
|
const config = {
|
|
cache: { interpretHeader: true, modifiedSince: true }
|
|
};
|
|
|
|
await axios.get('', config);
|
|
const response = await axios.get('', config);
|
|
|
|
const modifiedSince = response.config.headers?.[Header.IfModifiedSince];
|
|
|
|
if (!modifiedSince) {
|
|
throw new Error('modifiedSince is not defined');
|
|
}
|
|
const milliseconds = Date.parse(modifiedSince);
|
|
|
|
expect(typeof milliseconds).toBe('number');
|
|
expect(milliseconds).toBeLessThan(Date.now());
|
|
});
|
|
});
|