apollo-server-caching/src/InMemoryLRUCache.ts

[](https://badge.fury.io/js/apollo-server-caching) [](https://circleci.com/gh/apollographql/apoll

import LRUCache from 'lru-cache';
import type { KeyValueCache } from './KeyValueCache';

function defaultLengthCalculation(item: any) {
  if (Array.isArray(item) || typeof item === 'string') {
    return item.length;
  }

  // Go with the lru-cache default "naive" size, in lieu anything better:
  //   https://github.com/isaacs/node-lru-cache/blob/a71be6cd/index.js#L17
  return 1;
}

export class InMemoryLRUCache<V = string> implements KeyValueCache<V> {
  private store: LRUCache<string, V>;

  // TODO: Define reasonable default max size of the cache
  constructor({
    maxSize = Infinity,
    sizeCalculator = defaultLengthCalculation,
    onDispose,
  }: {
    maxSize?: number;
    sizeCalculator?: (value: V, key: string) => number;
    onDispose?: (key: string, value: V) => void;
  } = {}) {
    this.store = new LRUCache({
      max: maxSize,
      length: sizeCalculator,
      dispose: onDispose,
    });
  }

  async get(key: string) {
    return this.store.get(key);
  }
  async set(key: string, value: V, options?: { ttl?: number }) {
    const maxAge = options?.ttl && options.ttl * 1000;
    this.store.set(key, value, maxAge);
  }
  async delete(key: string) {
    this.store.del(key);
  }

  // Drops all data from the cache. This should only be used by test suites ---
  // production code should never drop all data from an end user cache.
  async flush(): Promise<void> {
    this.store.reset();
  }
  async getTotalSize() {
    return this.store.length;
  }

  // This is a size calculator based on the number of bytes in a JSON
  // encoding of the stored object. It happens to be what ApolloServer
  // uses for its default DocumentStore and may be helpful to others as well.
  static jsonBytesSizeCalculator<T>(obj: T): number {
    return Buffer.byteLength(JSON.stringify(obj), 'utf8');
  }
}