Skip to content

Commit

Permalink
refactor: memory-cache
Browse files Browse the repository at this point in the history
  • Loading branch information
@rgwozdz
rgwozdz committed Feb 8, 2024
1 parent 0540a80 commit 236337e
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 98 deletions.
6 changes: 6 additions & 0 deletions .changeset/silver-trainers-promise.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@koopjs/cache-memory': major
---

- remove callbacks in favor of async/await
- remove normalization function; no longer needed now that the spec has been simplified
31 changes: 8 additions & 23 deletions packages/cache-memory/src/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ class Cache {
this.#cache = new LRUCache({ maxSize: options?.size || 500 });
}

insert(key, geojson, options, callback) {
this.#cache.set();
this.#cache.set(key, normalizeGeojson(geojson), {
async insert(key, data, options) {
this.#cache.set(key, data, {
maxAge: calculateMaxAge(options?.ttl),
});
callback(null);
return;
}

retrieve(key, options, callback) {
async retrieve(key, options) {
const cacheEntry = this.#cache.get(key);

if (!cacheEntry) {
return callback(null);
return null;
}

let data = cacheEntry;
Expand All @@ -35,27 +34,13 @@ class Cache {
data = _.omit(data, options.omit);
}

callback(null, data);
return data;
}

delete(key, callback) {
async delete(key) {
this.#cache.delete(key);
callback(null);
}
}

function normalizeGeojson(geojson) {
if (geojson === undefined || geojson === null || Array.isArray(geojson)) {
return {
type: 'FeatureCollection',
features: geojson || [],
metadata: {},
};
return;
}

geojson.type = geojson.type || 'FeatureCollection';
geojson.features = geojson.features || [];
return _.cloneDeep(geojson);
}

function calculateMaxAge(ttl) {
Expand Down
100 changes: 25 additions & 75 deletions packages/cache-memory/src/index.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@ const { promisify } = require('util');
const delay = promisify(setTimeout);
const Cache = require('../src');
const cache = new Cache();
const insert = promisify(cache.insert).bind(cache);
const retrieve = promisify(cache.retrieve).bind(cache);
const deleteMethod = promisify(cache.delete).bind(cache);

test('Inserting and retreiving from the cache', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, { ttl: 600 });
await cache.insert(key, geojson, { ttl: 600 });
try {
const cached = await retrieve(key, {});
const cached = await cache.retrieve(key, {});
t.equal(cached.features[0].properties.fooz, 'ball', 'retrieved features');
t.equal(cached.crs.type, 'name', 'retrieved coordinate reference system');
t.equal(cached.metadata.name, 'Test', 'retrieved metadata');
Expand All @@ -23,21 +20,21 @@ test('Inserting and retreiving from the cache', async (t) => {
t.end();
});

test('cache should expire entries, return undefined', async (t) => {
test('cache should expire entries, return null', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, { ttl: 1 });
await cache.insert(key, geojson, { ttl: 1 });
await delay(1500);
const cached = await retrieve(key, {});
t.equals(cached, undefined);
const cached = await cache.retrieve(key, {});
t.equals(cached, null);
t.end();
});

test('Inserting and retreiving from the cache', async (t) => {
test('Inserting and retreiving geojson from the cache', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, { ttl: 600 });
const cached = await retrieve(key, {});
await cache.insert(key, geojson, { ttl: 600 });
const cached = await cache.retrieve(key, {});
t.equal(cached.features[0].properties.fooz, 'ball', 'retrieved features');
t.equal(cached.crs.type, 'name', 'retrieved coordinate reference system');
t.equal(cached.metadata.name, 'Test', 'retrieved metadata');
Expand All @@ -47,17 +44,17 @@ test('Inserting and retreiving from the cache', async (t) => {
test('retrieve partial entry with pick option', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, { ttl: 600 });
const cached = await retrieve(key, { pick: ['features'] });
await cache.insert(key, geojson, { ttl: 600 });
const cached = await cache.retrieve(key, { pick: ['features'] });
t.deepEqual(Object.keys(cached), ['features'], 'retrieved only features');
t.end();
});

test('retrieve partial entry with omit option', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, { ttl: 600 });
const cached = await retrieve(key, { omit: ['features'] });
await cache.insert(key, geojson, { ttl: 600 });
const cached = await cache.retrieve(key, { omit: ['features'] });
t.deepEqual(
Object.keys(cached),
['type', 'crs', 'metadata'],
Expand All @@ -66,76 +63,29 @@ test('retrieve partial entry with omit option', async (t) => {
t.end();
});

test('Inserting and deleting from the cache', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, geojson, {});
await deleteMethod(key);
const cached = await retrieve(key, {});
t.equals(cached, undefined);
t.end();
});

test('Inserting object with additional properties', async (t) => {
test('Inserting and retreiving json from the cache', async (t) => {
const key = uuidv4();
const serverInfo = {
layers: [getFeatureCollection()],
crs: 'crs-info',
metadata: {
name: 'Test',
description: 'Test',
},
};
await insert(key, serverInfo, { ttl: 600 });
const cached = await retrieve(key, {});
t.ok(cached.layers, 'has layers');
t.ok(cached.layers[0].type === 'FeatureCollection', 'has layers property');
t.equal(cached.metadata.name, 'Test', 'retrieved metadata');
await cache.insert(key, { layers: [], tables: [], count: 0 }, { ttl: 600 });
const cached = await cache.retrieve(key, {});
t.deepEquals(cached, { layers: [], tables: [], count: 0 });
t.end();
});

test('Caching a feature array as feature collection', async (t) => {
const key = uuidv4();
const { features } = getFeatureCollection();
await insert(key, features, { ttl: 600 });
const cached = await retrieve(key, {});
t.deepEquals(cached.features, features,);
t.equal(cached.type, 'FeatureCollection');
t.deepEquals(cached.metadata, {});
t.end();
});

test('Caching an empty object as feature collection', async (t) => {
const key = uuidv4();
await insert(key, {}, { ttl: 600 });
const cached = await retrieve(key, {});
t.equal(cached.type, 'FeatureCollection');
t.deepEquals(cached.features, []);
t.end();
});

test('Caching a null object as feature collection', async (t) => {
const key = uuidv4();
await insert(key, null, { ttl: 600 });
const cached = await retrieve(key, {});
t.equal(cached.type, 'FeatureCollection');
t.end();
});

test('Caching a undefined as feature collection', async (t) => {
test('Inserting and deleting from the cache', async (t) => {
const geojson = getFeatureCollection();
const key = uuidv4();
await insert(key, undefined, { ttl: 600 });
const cached = await retrieve(key, {});
t.equal(cached.type, 'FeatureCollection');
t.deepEquals(cached.features, []);
await cache.insert(key, geojson, {});
await cache.delete(key);
const cached = await cache.retrieve(key, {});
t.equals(cached, null);
t.end();
});

test('Post-insert edits to geojson should not mutate cache', async (t) => {
const geojson = getFeatureCollection();
await insert('key', geojson, { ttl: 600 });
await cache.insert('key', geojson, { ttl: 600 });
geojson.features[0].properties.key = 'fooz';
const cached = await retrieve('key', {});
const cached = await cache.retrieve('key', {});
t.equal(cached.features[0].properties.fooz, 'ball', 'retrieved features');
t.equal(cached.crs.type, 'name', 'retrieved coordinate reference system');
t.equal(cached.metadata.name, 'Test', 'retrieved metadata');
Expand Down

0 comments on commit 236337e

Please sign in to comment.