format-results-cache.js

"use strict";

// Inspired by LintResultsCache from ESLint
// https://github.com/eslint/eslint/blob/c2d0a830754b6099a3325e6d3348c3ba983a677a/lib/cli-engine/lint-result-cache.js

const fileEntryCache = require("file-entry-cache");
const stringify = require("fast-json-stable-stringify");
// eslint-disable-next-line no-restricted-modules
const { version: prettierVersion } = require("../index.js");
const { createHash } = require("./utils.js");

const optionsHashCache = new WeakMap();
const nodeVersion = process && process.version;

/**
 * @param {*} options
 * @returns {string}
 */
function getHashOfOptions(options) {
  if (optionsHashCache.has(options)) {
    return optionsHashCache.get(options);
  }
  const hash = createHash(
    `${prettierVersion}_${nodeVersion}_${stringify(options)}`
  );
  optionsHashCache.set(options, hash);
  return hash;
}

/**
 * @typedef {{ hashOfOptions?: string }} OurMeta
 * @typedef {import("file-entry-cache").FileDescriptor} FileDescriptor
 *
 * @param {import("file-entry-cache").FileDescriptor} fileDescriptor
 * @returns {FileDescriptor["meta"] & OurMeta}
 */
function getMetadataFromFileDescriptor(fileDescriptor) {
  return fileDescriptor.meta;
}

class FormatResultsCache {
  /**
   * @param {string} cacheFileLocation The path of cache file location. (default: `node_modules/.cache/prettier/.prettier-cache`)
   * @param {string} cacheStrategy
   */
  constructor(cacheFileLocation, cacheStrategy) {
    const useChecksum = cacheStrategy === "content";

    this.cacheFileLocation = cacheFileLocation;
    this.fileEntryCache = fileEntryCache.create(
      /* cacheId */ cacheFileLocation,
      /* directory */ undefined,
      useChecksum
    );
  }

  /**
   * @param {string} filePath
   * @param {any} options
   */
  existsAvailableFormatResultsCache(filePath, options) {
    const fileDescriptor = this.fileEntryCache.getFileDescriptor(filePath);

    if (fileDescriptor.notFound) {
      return false;
    }

    const hashOfOptions = getHashOfOptions(options);
    const meta = getMetadataFromFileDescriptor(fileDescriptor);
    const changed =
      fileDescriptor.changed || meta.hashOfOptions !== hashOfOptions;

    return !changed;
  }

  /**
   * @param {string} filePath
   * @param {any} options
   */
  setFormatResultsCache(filePath, options) {
    const fileDescriptor = this.fileEntryCache.getFileDescriptor(filePath);
    const meta = getMetadataFromFileDescriptor(fileDescriptor);
    if (fileDescriptor && !fileDescriptor.notFound) {
      meta.hashOfOptions = getHashOfOptions(options);
    }
  }

  /**
   * @param {string} filePath
   */
  removeFormatResultsCache(filePath) {
    this.fileEntryCache.removeEntry(filePath);
  }

  reconcile() {
    this.fileEntryCache.reconcile();
  }
}

module.exports = FormatResultsCache;