@netlify/cache-utils 2.0.3 → 4.0.0

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@netlify/cache-utils",
-  "version": "2.0.3",
+  "version": "4.0.0",
   "description": "Utility for caching files in Netlify Build",
-  "main": "src/main.js",
+  "type": "module",
+  "exports": "./src/main.js",
+  "main": "./src/main.js",
   "files": [
     "src/**/*.js"
   ],
@@ -43,11 +45,10 @@
   },
   "license": "MIT",
   "dependencies": {
-    "array-flat-polyfill": "^1.0.1",
     "cpy": "^8.1.0",
     "del": "^5.1.0",
     "get-stream": "^6.0.0",
-    "globby": "^10.0.2",
+    "globby": "^11.0.0",
     "junk": "^3.1.0",
     "locate-path": "^6.0.0",
     "make-dir": "^3.1.0",
@@ -60,6 +61,6 @@
     "tmp-promise": "^3.0.0"
   },
   "engines": {
-    "node": ">=10.18.0"
+    "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
   }
 }

package/src/dir.js

@@ -1,12 +1,8 @@
-'use strict'
-
-const { resolve } = require('path')
+import { resolve } from 'path'
 
 // Retrieve the cache directory location
-const getCacheDir = function ({ cacheDir = DEFAULT_CACHE_DIR, cwd = '.' } = {}) {
+export const getCacheDir = function ({ cacheDir = DEFAULT_CACHE_DIR, cwd = '.' } = {}) {
   return resolve(cwd, cacheDir)
 }
 
 const DEFAULT_CACHE_DIR = '.netlify/cache/'
-
-module.exports = { getCacheDir }

package/src/expire.js

@@ -1,7 +1,5 @@
-'use strict'
-
 // Retrieve the expiration date when caching a file
-const getExpires = function (ttl) {
+export const getExpires = function (ttl) {
   if (!Number.isInteger(ttl) || ttl < 1) {
     return
   }
@@ -12,8 +10,6 @@ const getExpires = function (ttl) {
 const SECS_TO_MSECS = 1e3
 
 // Check if a file about to be restored is expired
-const checkExpires = function (expires) {
+export const checkExpires = function (expires) {
   return expires !== undefined && Date.now() > expires
 }
-
-module.exports = { getExpires, checkExpires }

package/src/fs.js

@@ -1,18 +1,16 @@
-'use strict'
+import { stat } from 'fs'
+import { basename, dirname } from 'path'
+import { promisify } from 'util'
 
-const { stat } = require('fs')
-const { basename, dirname } = require('path')
-const { promisify } = require('util')
-
-const cpy = require('cpy')
-const globby = require('globby')
-const junk = require('junk')
-const moveFile = require('move-file')
+import cpy from 'cpy'
+import globby from 'globby'
+import junk from 'junk'
+import moveFile from 'move-file'
 
 const pStat = promisify(stat)
 
 // Move or copy a cached file/directory from/to a local one
-const moveCacheFile = async function (src, dest, move) {
+export const moveCacheFile = async function (src, dest, move) {
   // Moving is faster but removes the source files locally
   if (move) {
     return moveFile(src, dest, { overwrite: false })
@@ -23,7 +21,7 @@ const moveCacheFile = async function (src, dest, move) {
 }
 
 // Non-existing files and empty directories are always skipped
-const hasFiles = async function (src) {
+export const hasFiles = async function (src) {
   const { srcGlob, cwd, isDir } = await getSrcGlob(src)
   return srcGlob !== undefined && !(await isEmptyDir({ srcGlob, cwd, isDir }))
 }
@@ -63,5 +61,3 @@ const getStat = async function (src) {
     return await pStat(src)
   } catch (error) {}
 }
-
-module.exports = { moveCacheFile, hasFiles }

package/src/hash.js

@@ -1,15 +1,13 @@
-'use strict'
+import { createHash } from 'crypto'
+import { createReadStream } from 'fs'
 
-const { createHash } = require('crypto')
-const { createReadStream } = require('fs')
-
-const getStream = require('get-stream')
-const locatePath = require('locate-path')
+import getStream from 'get-stream'
+import locatePath from 'locate-path'
 
 // Caching a big directory like `node_modules` is slow. However those can
 // sometime be represented by a digest file such as `package-lock.json`. If this
 // has not changed, we don't need to save cache again.
-const getHash = async function (digests, move) {
+export const getHash = async function (digests, move) {
   // Moving files is faster than computing hashes
   if (move || digests.length === 0) {
     return
@@ -36,5 +34,3 @@ const hashFile = async function (path) {
 // We need a hashing algoritm that's as fast as possible.
 // Userland CRC32 implementations are actually slower than Node.js SHA1.
 const HASH_ALGO = 'sha1'
-
-module.exports = { getHash }

package/src/list.js

@@ -1,15 +1,13 @@
-'use strict'
+import { join } from 'path'
 
-const { join } = require('path')
+import readdirp from 'readdirp'
 
-const readdirp = require('readdirp')
-
-const { getCacheDir } = require('./dir')
-const { isManifest } = require('./manifest')
-const { getBases } = require('./path')
+import { getCacheDir } from './dir.js'
+import { isManifest } from './manifest.js'
+import { getBases } from './path.js'
 
 // List all cached files/directories, at the top-level
-const list = async function ({ cacheDir, cwd: cwdOpt, depth = DEFAULT_DEPTH } = {}) {
+export const list = async function ({ cacheDir, cwd: cwdOpt, depth = DEFAULT_DEPTH } = {}) {
   const bases = await getBases(cwdOpt)
   const cacheDirA = getCacheDir({ cacheDir, cwd: cwdOpt })
   const files = await Promise.all(bases.map(({ name, base }) => listBase({ name, base, cacheDir: cacheDirA, depth })))
@@ -29,5 +27,3 @@ const listBase = async function ({ name, base, cacheDir, depth }) {
 const fileFilter = function ({ basename }) {
   return !isManifest(basename)
 }
-
-module.exports = { list }

package/src/main.js

@@ -1,14 +1,13 @@
-'use strict'
+import del from 'del'
 
-require('./utils/polyfills')
+import { getCacheDir } from './dir.js'
+import { moveCacheFile, hasFiles } from './fs.js'
+import { list } from './list.js'
+import { getManifestInfo, writeManifest, removeManifest, isExpired } from './manifest.js'
+import { parsePath } from './path.js'
 
-const del = require('del')
-
-const { getCacheDir } = require('./dir')
-const { moveCacheFile, hasFiles } = require('./fs')
-const { list } = require('./list')
-const { getManifestInfo, writeManifest, removeManifest, isExpired } = require('./manifest')
-const { parsePath } = require('./path')
+export { getCacheDir } from './dir.js'
+export { list } from './list.js'
 
 // Cache a file
 const saveOne = async function (
@@ -86,13 +85,13 @@ const allowMany = async function (func, paths, ...args) {
   return results.some(Boolean)
 }
 
-const save = allowMany.bind(null, saveOne)
-const restore = allowMany.bind(null, restoreOne)
-const remove = allowMany.bind(null, removeOne)
-const has = allowMany.bind(null, hasOne)
+export const save = allowMany.bind(null, saveOne)
+export const restore = allowMany.bind(null, restoreOne)
+export const remove = allowMany.bind(null, removeOne)
+export const has = allowMany.bind(null, hasOne)
 
 // Change `opts` default values
-const bindOpts = function (opts) {
+export const bindOpts = function (opts) {
   return {
     save: (paths, optsA) => save(paths, { ...opts, ...optsA }),
     restore: (paths, optsA) => restore(paths, { ...opts, ...optsA }),
@@ -102,5 +101,3 @@ const bindOpts = function (opts) {
     getCacheDir: (optsA) => getCacheDir({ ...opts, ...optsA }),
   }
 }
-
-module.exports = { save, restore, remove, has, list, getCacheDir, bindOpts }

package/src/manifest.js

@@ -1,22 +1,20 @@
-'use strict'
+import { writeFile, readFile } from 'fs'
+import { dirname } from 'path'
+import { promisify } from 'util'
 
-const { writeFile, readFile } = require('fs')
-const { dirname } = require('path')
-const { promisify } = require('util')
+import del from 'del'
+import makeDir from 'make-dir'
+import pathExists from 'path-exists'
 
-const del = require('del')
-const makeDir = require('make-dir')
-const pathExists = require('path-exists')
-
-const { getExpires, checkExpires } = require('./expire')
-const { getHash } = require('./hash')
+import { getExpires, checkExpires } from './expire.js'
+import { getHash } from './hash.js'
 
 const pWriteFile = promisify(writeFile)
 const pReadFile = promisify(readFile)
 
 // Retrieve cache manifest of a file to cache, which contains the file/directory
 // contents hash and the `expires` date.
-const getManifestInfo = async function ({ cachePath, move, ttl, digests }) {
+export const getManifestInfo = async function ({ cachePath, move, ttl, digests }) {
   const manifestPath = getManifestPath(cachePath)
   const expires = getExpires(ttl)
   const hash = await getHash(digests, move)
@@ -37,13 +35,13 @@ const isIdentical = async function ({ hash, manifestPath, manifestString }) {
 }
 
 // Persist the cache manifest to filesystem
-const writeManifest = async function ({ manifestPath, manifestString }) {
+export const writeManifest = async function ({ manifestPath, manifestString }) {
   await makeDir(dirname(manifestPath))
   await pWriteFile(manifestPath, manifestString)
 }
 
 // Remove the cache manifest from filesystem
-const removeManifest = async function (cachePath) {
+export const removeManifest = async function (cachePath) {
   const manifestPath = getManifestPath(cachePath)
   await del(manifestPath, { force: true })
 }
@@ -53,14 +51,14 @@ const getManifestPath = function (cachePath) {
   return `${cachePath}${CACHE_EXTENSION}`
 }
 
-const isManifest = function (filePath) {
+export const isManifest = function (filePath) {
   return filePath.endsWith(CACHE_EXTENSION)
 }
 
 const CACHE_EXTENSION = '.netlify.cache.json'
 
 // Check whether a file/directory is expired by checking its cache manifest
-const isExpired = async function (cachePath) {
+export const isExpired = async function (cachePath) {
   const manifestPath = getManifestPath(cachePath)
   if (!(await pathExists(manifestPath))) {
     return false
@@ -76,5 +74,3 @@ const readManifest = async function (cachePath) {
   const manifest = JSON.parse(manifestString)
   return manifest
 }
-
-module.exports = { getManifestInfo, writeManifest, removeManifest, isManifest, isExpired }

package/src/path.js

@@ -1,13 +1,11 @@
-'use strict'
+import { homedir } from 'os'
+import { resolve, isAbsolute, join, sep } from 'path'
 
-const { homedir } = require('os')
-const { resolve, isAbsolute, join, sep } = require('path')
-
-const { getCacheDir } = require('./dir')
-const { safeGetCwd } = require('./utils/cwd')
+import { getCacheDir } from './dir.js'
+import { safeGetCwd } from './utils/cwd.js'
 
 // Find the paths of the file before/after caching
-const parsePath = async function ({ path, cacheDir, cwdOpt }) {
+export const parsePath = async function ({ path, cacheDir, cwdOpt }) {
   const srcPath = await getSrcPath(path, cwdOpt)
   const cachePath = await getCachePath({ srcPath, cacheDir, cwdOpt })
   return { srcPath, cachePath }
@@ -94,7 +92,7 @@ const parseBase = function (name, base, srcPath) {
   return { name, relPath }
 }
 
-const getBases = async function (cwdOpt) {
+export const getBases = async function (cwdOpt) {
   const cwdBase = await getCwdBase(cwdOpt)
   return [...cwdBase, { name: 'home', base: homedir() }, { name: 'root', base: sep }]
 }
@@ -107,5 +105,3 @@ const getCwdBase = async function (cwdOpt) {
 
   return [{ name: 'cwd', base: cwd }]
 }
-
-module.exports = { parsePath, getBases }

package/src/utils/cwd.js

@@ -1,12 +1,10 @@
-'use strict'
+import { normalize } from 'path'
+import process from 'process'
 
-const { normalize } = require('path')
-const process = require('process')
-
-const pathExists = require('path-exists')
+import pathExists from 'path-exists'
 
 // Like `process.cwd()` but safer when current directory is wrong
-const safeGetCwd = async function (cwdOpt) {
+export const safeGetCwd = async function (cwdOpt) {
   try {
     const cwd = getCwdValue(cwdOpt)
 
@@ -23,5 +21,3 @@ const safeGetCwd = async function (cwdOpt) {
 const getCwdValue = function (cwdOpt = process.cwd()) {
   return normalize(cwdOpt)
 }
-
-module.exports = { safeGetCwd }

package/src/utils/polyfills.js

@@ -1,5 +0,0 @@
-'use strict'
-
-// Patches `Array.flat()` and `Array.flatMap()`
-// TODO: remove after dropping Node <12 support
-require('array-flat-polyfill')