@atlaspack/cache 3.1.1-canary.14 → 3.1.1-canary.141

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaspack/cache",
   "description": "Interface for defining caches and file-system, IDB and LMDB implementations.",
-  "version": "3.1.1-canary.14+267b0d591",
+  "version": "3.1.1-canary.141+2f29297bd",
   "license": "(MIT OR Apache-2.0)",
   "type": "commonjs",
   "publishConfig": {
@@ -11,24 +11,23 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/index.js",
-  "source": "src/index.js",
-  "types": "index.d.ts",
+  "main": "./lib/index.js",
+  "source": "./src/index.ts",
+  "types": "./lib/index.d.ts",
   "engines": {
     "node": ">= 16.0.0"
   },
   "scripts": {
     "test": "mocha",
-    "build-ts": "mkdir -p lib && flow-to-ts src/types.js > lib/types.d.ts",
-    "check-ts": "tsc --noEmit index.d.ts"
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src"
   },
   "dependencies": {
-    "@atlaspack/build-cache": "2.13.3-canary.82+267b0d591",
-    "@atlaspack/feature-flags": "2.14.1-canary.82+267b0d591",
-    "@atlaspack/fs": "2.14.5-canary.14+267b0d591",
-    "@atlaspack/logger": "2.14.5-canary.14+267b0d591",
-    "@atlaspack/rust": "3.2.1-canary.14+267b0d591",
-    "@atlaspack/utils": "2.14.5-canary.14+267b0d591",
+    "@atlaspack/build-cache": "2.13.3-canary.209+2f29297bd",
+    "@atlaspack/feature-flags": "2.14.1-canary.209+2f29297bd",
+    "@atlaspack/fs": "2.14.5-canary.141+2f29297bd",
+    "@atlaspack/logger": "2.14.5-canary.141+2f29297bd",
+    "@atlaspack/rust": "3.2.1-canary.141+2f29297bd",
+    "@atlaspack/utils": "2.14.5-canary.141+2f29297bd",
     "ncp": "^2.0.0"
   },
   "devDependencies": {
@@ -37,5 +36,5 @@
   "browser": {
     "./src/IDBCache.js": "./src/IDBCache.browser.js"
   },
-  "gitHead": "267b0d59131c00e4cd1526bbf87aa84b9c8fd411"
-}
+  "gitHead": "2f29297bd550840c9840871559349ef773bcbf6d"
+}

package/src/{FSCache.js → FSCache.ts}

@@ -1,5 +1,3 @@
-// @flow strict-local
-
 import type {Readable, Writable} from 'stream';
 import type {FilePath} from '@atlaspack/types';
 import type {FileSystem} from '@atlaspack/fs';
@@ -9,6 +7,8 @@ import stream from 'stream';
 import path from 'path';
 import {promisify} from 'util';
 
+import {hashString} from '@atlaspack/rust';
+import {getFeatureFlag} from '@atlaspack/feature-flags';
 import logger from '@atlaspack/logger';
 import {
   deserialize,
@@ -21,7 +21,7 @@ import packageJson from '../package.json';
 
 import {WRITE_LIMIT_CHUNK} from './constants';
 
-const pipeline: (Readable, Writable) => Promise<void> = promisify(
+const pipeline: (arg1: Readable, arg2: Writable) => Promise<void> = promisify(
   stream.pipeline,
 );
 
@@ -40,9 +40,10 @@ export class FSCache implements Cache {
 
     // In parallel, create sub-directories for every possible hex value
     // This speeds up large caches on many file systems since there are fewer files in a single directory.
-    let dirPromises = [];
+    let dirPromises: Array<Promise<undefined>> = [];
     for (let i = 0; i < 256; i++) {
       dirPromises.push(
+        // @ts-expect-error TS2345
         this.fs.mkdirp(path.join(this.dir, ('00' + i.toString(16)).slice(-2))),
       );
     }
@@ -51,6 +52,10 @@ export class FSCache implements Cache {
   }
 
   _getCachePath(cacheId: string): FilePath {
+    if (getFeatureFlag('cachePerformanceImprovements')) {
+      const cleanId = hashString(cacheId);
+      return path.join(this.dir, cleanId.slice(0, 2), cleanId.slice(2));
+    }
     return path.join(this.dir, cacheId.slice(0, 2), cacheId.slice(2));
   }
 
@@ -77,10 +82,10 @@ export class FSCache implements Cache {
     await this.fs.writeFile(this._getCachePath(key), contents);
   }
 
-  async getBuffer(key: string): Promise<?Buffer> {
+  async getBuffer(key: string): Promise<Buffer | null | undefined> {
     try {
       return await this.fs.readFile(this._getCachePath(key));
-    } catch (err) {
+    } catch (err: any) {
       if (err.code === 'ENOENT') {
         return null;
       } else {
@@ -90,14 +95,17 @@ export class FSCache implements Cache {
   }
 
   #getFilePath(key: string, index: number): string {
+    if (getFeatureFlag('cachePerformanceImprovements')) {
+      return path.join(this.dir, `${hashString(key)}-${index}`);
+    }
     return path.join(this.dir, `${key}-${index}`);
   }
 
-  async #unlinkChunks(key: string, index: number): Promise<void> {
+  async #unlinkChunks(key: string, index: number): Promise<undefined> {
     try {
       await this.fs.unlink(this.#getFilePath(key, index));
       await this.#unlinkChunks(key, index + 1);
-    } catch (err) {
+    } catch (err: any) {
       // If there's an error, no more chunks are left to delete
     }
   }
@@ -120,21 +128,26 @@ export class FSCache implements Cache {
   async setLargeBlob(
     key: string,
     contents: Buffer | string,
-    options?: {|signal?: AbortSignal|},
+    options?: {
+      signal?: AbortSignal;
+    },
   ): Promise<void> {
     const chunks = Math.ceil(contents.length / WRITE_LIMIT_CHUNK);
 
-    const writePromises: Promise<void>[] = [];
+    const writePromises: Promise<undefined>[] = [];
     if (chunks === 1) {
       // If there's one chunk, don't slice the content
       writePromises.push(
+        // @ts-expect-error TS2345
         this.fs.writeFile(this.#getFilePath(key, 0), contents, {
+          // @ts-expect-error TS2353
           signal: options?.signal,
         }),
       );
     } else {
       for (let i = 0; i < chunks; i += 1) {
         writePromises.push(
+          // @ts-expect-error TS2345
           this.fs.writeFile(
             this.#getFilePath(key, i),
             typeof contents === 'string'
@@ -146,6 +159,7 @@ export class FSCache implements Cache {
                   i * WRITE_LIMIT_CHUNK,
                   (i + 1) * WRITE_LIMIT_CHUNK,
                 ),
+            // @ts-expect-error TS2353
             {signal: options?.signal},
           ),
         );
@@ -159,12 +173,13 @@ export class FSCache implements Cache {
   }
 
   async deleteLargeBlob(key: string): Promise<void> {
-    const deletePromises: Promise<void>[] = [];
+    const deletePromises: Promise<undefined>[] = [];
 
     let i = 0;
     let filePath = this.#getFilePath(key, i);
 
     while (await this.fs.exists(filePath)) {
+      // @ts-expect-error TS2345
       deletePromises.push(this.fs.rimraf(filePath));
       i += 1;
       filePath = this.#getFilePath(key, i);
@@ -173,11 +188,11 @@ export class FSCache implements Cache {
     await Promise.all(deletePromises);
   }
 
-  async get<T>(key: string): Promise<?T> {
+  async get<T>(key: string): Promise<T | null | undefined> {
     try {
       let data = await this.fs.readFile(this._getCachePath(key));
       return deserialize(data);
-    } catch (err) {
+    } catch (err: any) {
       if (err.code === 'ENOENT') {
         return null;
       } else {
@@ -186,13 +201,13 @@ export class FSCache implements Cache {
     }
   }
 
-  async set(key: string, value: mixed): Promise<void> {
+  async set(key: string, value: unknown): Promise<void> {
     try {
       let blobPath = this._getCachePath(key);
       let data = serialize(value);
 
       await this.fs.writeFile(blobPath, data);
-    } catch (err) {
+    } catch (err: any) {
       logger.error(err, '@atlaspack/cache');
     }
   }

package/src/{IDBCache.browser.js → IDBCache.browser.ts}

@@ -1,4 +1,3 @@
-// @flow strict-local
 import type {Cache} from './types';
 
 import {Readable} from 'stream';
@@ -9,21 +8,18 @@ import {
   serialize,
 } from '@atlaspack/build-cache';
 import {bufferStream} from '@atlaspack/utils';
-// $FlowFixMe[untyped-import]
 import {openDB} from 'idb';
 
-// $FlowFixMe[untyped-import]
 import packageJson from '../package.json';
 
 const STORE_NAME = 'cache';
 
 export class IDBCache implements Cache {
-  // $FlowFixMe
   store: any;
 
   constructor() {
     this.store = openDB('REPL-parcel-cache', 1, {
-      upgrade(db) {
+      upgrade(db: any) {
         db.createObjectStore(STORE_NAME);
       },
       blocked() {},
@@ -36,7 +32,7 @@ export class IDBCache implements Cache {
     return Promise.resolve();
   }
 
-  serialize(): {||} {
+  serialize(): Record<any, any> {
     return {
       /*::...null*/
     };
@@ -50,7 +46,7 @@ export class IDBCache implements Cache {
     return Promise.resolve(this.store.get(key) != null);
   }
 
-  async get<T>(key: string): Promise<?T> {
+  async get<T>(key: string): Promise<T | null | undefined> {
     let data = await (await this.store).get(STORE_NAME, key);
     if (data == null) {
       return null;
@@ -59,17 +55,19 @@ export class IDBCache implements Cache {
     return Promise.resolve(deserialize(data));
   }
 
-  async set(key: string, value: mixed): Promise<void> {
+  async set(key: string, value: unknown): Promise<void> {
     await (await this.store).put(STORE_NAME, serialize(value), key);
   }
 
   getStream(key: string): Readable {
     let dataPromise = this.store
+      // @ts-expect-error TS7006
       .then((s) => s.get(STORE_NAME, key))
+      // @ts-expect-error TS7006
       .then((d) => Buffer.from(d))
+      // @ts-expect-error TS7006
       .catch((e) => e);
     const stream = new Readable({
-      // $FlowFixMe(incompatible-call)
       async read() {
         let data = await dataPromise;
         if (data instanceof Error) {
@@ -118,7 +116,7 @@ export class IDBCache implements Cache {
   //   ]);
   // }
 
-  async getBuffer(key: string): Promise<?Buffer> {
+  async getBuffer(key: string): Promise<Buffer | null | undefined> {
     let data = await (await this.store).get(STORE_NAME, key);
     if (data == null) {
       return null;

package/src/{IDBCache.js → IDBCache.ts}

@@ -1,7 +1,6 @@
-// @flow strict-local
 import type {Cache} from './types';
 
-// $FlowFixMe
+// @ts-expect-error TS2420
 export class IDBCache implements Cache {
   constructor() {
     throw new Error('IDBCache is only supported in the browser');

package/src/{LMDBLiteCache.js → LMDBLiteCache.ts}

@@ -1,5 +1,3 @@
-// @flow strict-local
-
 import {
   deserialize,
   registerSerializableClass,
@@ -10,15 +8,15 @@ import {Lmdb} from '@atlaspack/rust';
 import type {FilePath} from '@atlaspack/types';
 import type {Cache} from './types';
 import type {Readable, Writable} from 'stream';
-import fs from 'fs';
+// @ts-expect-error TS7016
 import ncp from 'ncp';
 import {promisify} from 'util';
 import stream from 'stream';
 import path from 'path';
 import {NodeFS} from '@atlaspack/fs';
-// $FlowFixMe
 import packageJson from '../package.json';
 import {FSCache} from './FSCache';
+import {instrumentAsync} from '@atlaspack/logger';
 
 const ncpAsync = promisify(ncp);
 
@@ -35,11 +33,6 @@ export class LmdbWrapper {
 
   constructor(lmdb: Lmdb) {
     this.lmdb = lmdb;
-
-    // $FlowFixMe
-    this[Symbol.dispose] = () => {
-      this.lmdb.close();
-    };
   }
 
   has(key: string): boolean {
@@ -94,23 +87,28 @@ export function open(
   );
 }
 
-const pipeline: (Readable, Writable) => Promise<void> = promisify(
+const pipeline: (arg1: Readable, arg2: Writable) => Promise<void> = promisify(
   stream.pipeline,
 );
 
-export type SerLMDBLiteCache = {|
-  dir: FilePath,
-|};
+export type SerLMDBLiteCache = {
+  dir: FilePath;
+};
 
 export class LMDBLiteCache implements Cache {
   fs: NodeFS;
   dir: FilePath;
   store: LmdbWrapper;
   fsCache: FSCache;
+  /**
+   * Directory where we store raw files.
+   */
+  cacheFilesDirectory: FilePath;
 
   constructor(cacheDir: FilePath) {
     this.fs = new NodeFS();
     this.dir = cacheDir;
+    this.cacheFilesDirectory = path.join(cacheDir, 'files');
     this.fsCache = new FSCache(this.fs, cacheDir);
 
     this.store = open(cacheDir, {
@@ -131,6 +129,7 @@ export class LMDBLiteCache implements Cache {
     if (!getFeatureFlag('cachePerformanceImprovements')) {
       await this.fsCache.ensure();
     }
+    await this.fs.mkdirp(this.cacheFilesDirectory);
     return Promise.resolve();
   }
 
@@ -148,7 +147,7 @@ export class LMDBLiteCache implements Cache {
     return Promise.resolve(this.store.has(key));
   }
 
-  get<T>(key: string): Promise<?T> {
+  get<T>(key: string): Promise<T | null | undefined> {
     let data = this.store.get(key);
     if (data == null) {
       return Promise.resolve(null);
@@ -157,19 +156,29 @@ export class LMDBLiteCache implements Cache {
     return Promise.resolve(deserialize(data));
   }
 
-  async set(key: string, value: mixed): Promise<void> {
+  async set(key: string, value: unknown): Promise<void> {
     await this.setBlob(key, serialize(value));
   }
 
   getStream(key: string): Readable {
-    return this.fs.createReadStream(path.join(this.dir, key));
+    if (!getFeatureFlag('cachePerformanceImprovements')) {
+      return this.fs.createReadStream(path.join(this.dir, key));
+    }
+
+    return this.fs.createReadStream(this.getFileKey(key));
   }
 
-  setStream(key: string, stream: Readable): Promise<void> {
-    return pipeline(
-      stream,
-      this.fs.createWriteStream(path.join(this.dir, key)),
-    );
+  async setStream(key: string, stream: Readable): Promise<void> {
+    if (!getFeatureFlag('cachePerformanceImprovements')) {
+      return pipeline(
+        stream,
+        this.fs.createWriteStream(path.join(this.dir, key)),
+      );
+    }
+
+    const filePath = this.getFileKey(key);
+    await this.fs.mkdirp(path.dirname(filePath));
+    return pipeline(stream, this.fs.createWriteStream(filePath));
   }
 
   // eslint-disable-next-line require-await
@@ -189,43 +198,39 @@ export class LMDBLiteCache implements Cache {
     await this.store.put(key, contents);
   }
 
-  getBuffer(key: string): Promise<?Buffer> {
+  getBuffer(key: string): Promise<Buffer | null | undefined> {
     return Promise.resolve(this.store.get(key));
   }
 
-  #getFilePath(key: string, index: number): string {
-    return path.join(this.dir, `${key}-${index}`);
-  }
-
   hasLargeBlob(key: string): Promise<boolean> {
     if (!getFeatureFlag('cachePerformanceImprovements')) {
       return this.fsCache.hasLargeBlob(key);
     }
-    return this.has(key);
+
+    return this.fs.exists(this.getFileKey(key));
   }
 
-  /**
-   * @deprecated Use getBlob instead.
-   */
   getLargeBlob(key: string): Promise<Buffer> {
     if (!getFeatureFlag('cachePerformanceImprovements')) {
       return this.fsCache.getLargeBlob(key);
     }
-    return Promise.resolve(this.getBlobSync(key));
+    return this.fs.readFile(this.getFileKey(key));
   }
 
-  /**
-   * @deprecated Use setBlob instead.
-   */
-  setLargeBlob(
+  async setLargeBlob(
     key: string,
     contents: Buffer | string,
-    options?: {|signal?: AbortSignal|},
+    options?: {
+      signal?: AbortSignal;
+    },
   ): Promise<void> {
     if (!getFeatureFlag('cachePerformanceImprovements')) {
       return this.fsCache.setLargeBlob(key, contents, options);
     }
-    return this.setBlob(key, contents);
+
+    const targetPath = this.getFileKey(key);
+    await this.fs.mkdirp(path.dirname(targetPath));
+    return this.fs.writeFile(targetPath, contents);
   }
 
   /**
@@ -244,9 +249,9 @@ export class LMDBLiteCache implements Cache {
   }
 
   async compact(targetPath: string): Promise<void> {
-    await fs.promises.mkdir(targetPath, {recursive: true});
+    await this.fs.mkdirp(targetPath);
 
-    const files = await fs.promises.readdir(this.dir);
+    const files = await this.fs.readdir(this.dir);
     // copy all files except data.mdb and lock.mdb to the target path (recursive)
     for (const file of files) {
       const filePath = path.join(this.dir, file);
@@ -262,6 +267,42 @@ export class LMDBLiteCache implements Cache {
   }
 
   refresh(): void {}
+
+  /**
+   * Streams, packages are stored in files instead of LMDB.
+   *
+   * On this case, if a cache key happens to have a parent traversal, ../..
+   * it is treated specially
+   *
+   * That is, something/../something and something are meant to be different
+   * keys.
+   *
+   * Plus we do not want to store values outside of the cache directory.
+   */
+  getFileKey(key: string): string {
+    const cleanKey = key
+      .split('/')
+      .map((part) => {
+        if (part === '..') {
+          return '$$__parent_dir$$';
+        }
+        return part;
+      })
+      .join('/');
+    return path.join(this.cacheFilesDirectory, cleanKey);
+  }
+
+  async clear(): Promise<void> {
+    await instrumentAsync('LMDBLiteCache::clear', async () => {
+      const keys = await this.keys();
+      for (const key of keys) {
+        await this.store.delete(key);
+      }
+
+      await this.fs.rimraf(this.cacheFilesDirectory);
+      await this.fs.mkdirp(this.cacheFilesDirectory);
+    });
+  }
 }
 
 registerSerializableClass(

package/src/{constants.js → constants.ts}

@@ -1,4 +1,2 @@
-// @flow strict-local
-
 // Node has a file size limit of 2 GB
 export const WRITE_LIMIT_CHUNK = 2 * 1024 ** 3;

package/src/{index.js → index.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 export * from './FSCache';
 export * from './IDBCache';
 export * from './LMDBLiteCache';

package/src/{types.js → types.ts}

@@ -1,4 +1,3 @@
-// @flow
 import type {Cache} from '@atlaspack/types';
 
 export type {Cache};