DEPRECATE: move checksum code to @dr-js/core

Author: dr-js

source/node/cache/checksum.js

@@ -1,73 +1,12 @@
-import { resolve, relative, dirname } from 'path'
-import { createReadStream, promises as fsAsync } from 'fs'
-import { createHash } from 'crypto'
-
-import { compareString } from '@dr-js/core/module/common/compare.js'
-import { createAsyncLane, extendAutoSelectLane } from '@dr-js/core/module/common/module/AsyncLane.js'
+import { dirname } from 'path'
+import { promises as fsAsync } from 'fs'
 
 import { calcHash } from '@dr-js/core/module/node/data/Buffer.js'
-import { setupStreamPipe, readableStreamToBufferAsync } from '@dr-js/core/module/node/data/Stream.js'
-import { PATH_TYPE, getPathStat, getPathTypeFromStat } from '@dr-js/core/module/node/fs/Path.js'
-import { getDirInfoTree, walkDirInfoTreeAsync, createDirectory } from '@dr-js/core/module/node/fs/Directory.js'
+import { createDirectory } from '@dr-js/core/module/node/fs/Directory.js'
+import { describeChecksumOfPathList } from '@dr-js/core/module/node/fs/Checksum.js'
 
 import { packTime, parseTime, loadStat, saveStat } from './function.js'
 
-const getChecksumInfoOfFile = async (
-  absolutePath, // absolute path of file
-  fromPath // path will relative to this in output file
-) => [ // [ 'relative/path', 'hash-bash64' ]
-  relative(fromPath, absolutePath),
-  (await readableStreamToBufferAsync(setupStreamPipe(
-    createReadStream(absolutePath),
-    createHash('sha1')
-  ))).toString('base64')
-]
-
-const getChecksumInfoListOfPath = async (
-  path = '.', // relative or absolute path
-  fromPath = process.cwd(), // path will relative to this in output file
-  checksumInfoList = []
-) => {
-  path = resolve(fromPath, path) // to absolute path
-  const collector = async (filePath) => { checksumInfoList.push(await getChecksumInfoOfFile(filePath, fromPath)) }
-  const pathType = getPathTypeFromStat(await getPathStat(path))
-  switch (pathType) {
-    case PATH_TYPE.File:
-      await collector(path)
-      break
-    case PATH_TYPE.Directory: {
-      const { getTailPromise, pushAuto } = extendAutoSelectLane(createAsyncLane({ laneSize: 4 })) // NOTE: too much or too lane will actually be slower
-      await walkDirInfoTreeAsync(await getDirInfoTree(path), async (dirInfo) => {
-        dirInfo.type === PATH_TYPE.File && pushAuto(() => collector(dirInfo.path))
-      })
-      await getTailPromise()
-      break
-    }
-    default:
-      throw new Error(`invalid pathType: ${pathType} for ${path}`)
-  }
-  return checksumInfoList
-}
-
-const getChecksumInfoListOfPathList = async (
-  pathList = [], // relative or absolute path
-  fromPath = process.cwd(), // path will relative to this in output file
-  checksumInfoList = []
-) => {
-  for (const path of pathList) await getChecksumInfoListOfPath(path, fromPath, checksumInfoList)
-  return checksumInfoList
-}
-
-const describeChecksumInfoList = (checksumInfoList) => checksumInfoList
-  .sort(([ a ], [ b ]) => compareString(a, b))// sort by relativePath so the order is stable
-  .map(([ relativePath, hashBase64 ]) => `${hashBase64} ${relativePath}`) // hash first seems better
-  .join('\n')
-
-const describeChecksumOfPathList = async ({
-  pathList = [], // relative or absolute path
-  fromPath = process.cwd() // path will relative to this in output file
-}) => describeChecksumInfoList(await getChecksumInfoListOfPathList(pathList, fromPath))
-
 __DEV__ && console.log({
   SAMPLE_CHECKSUM_CONFIG: {
     pathStatFile: '/absolute/path/to/stat-file', // path of stat file, used to help detect checksum change
@@ -130,13 +69,14 @@ const checksumDetectChange = async (config, isSkipSave = false) => { // set isSk
 }
 
 export {
-  getChecksumInfoOfFile,
-  getChecksumInfoListOfPath,
-  getChecksumInfoListOfPathList,
-
-  describeChecksumInfoList,
-  describeChecksumOfPathList,
-
   loadStatFile, saveStatFile,
   checksumUpdate, checksumDetectChange
 }
+
+export {
+  getChecksumInfoOfFile, // TODO: DEPRECATE
+  getChecksumInfoListOfPath, // TODO: DEPRECATE
+  getChecksumInfoListOfPathList, // TODO: DEPRECATE
+  describeChecksumInfoList, // TODO: DEPRECATE
+  describeChecksumOfPathList // TODO: DEPRECATE
+} from '@dr-js/core/module/node/fs/Checksum.js'

source/node/cache/checksum.test.js

@@ -1,13 +1,12 @@
 import { promises as fsAsync } from 'fs'
 import { resolve } from 'path'
-import { strictEqual, doThrowAsync } from '@dr-js/core/module/common/verify.js'
+import { strictEqual } from '@dr-js/core/module/common/verify.js'
 import { getSampleRange } from '@dr-js/core/module/common/math/sample.js'
 import { createDirectory, resetDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 import { modifyDelete } from '@dr-js/core/module/node/fs/Modify.js'
+import { describeChecksumOfPathList } from '@dr-js/core/module/node/fs/Checksum.js'
 
 import {
-  describeChecksumOfPathList,
-
   loadStatFile, saveStatFile,
   checksumUpdate, checksumDetectChange
 } from './checksum.js'
@@ -45,32 +44,6 @@ after(async () => {
 })
 
 describe('Node.Cache.Checksum', () => {
-  it('getChecksumFileOfPathList', async () => strictEqual(
-    await describeChecksumOfPathList({
-      pathList: [
-        fromRoot('sample-cache-file-0'),
-        fromRoot('sample-cache-file-1'),
-        fromRoot('sample-cache-dir-0/'),
-        fromRoot('sample-cache-dir-1/')
-      ]
-    }),
-    await describeChecksumOfPathList({
-      pathList: [
-        fromRoot('sample-cache-dir-0/'),
-        fromRoot('sample-cache-dir-1/'),
-        fromRoot('sample-cache-file-0'),
-        fromRoot('sample-cache-file-1')
-      ]
-    }),
-    'path order should not matter'
-  ))
-
-  it('getChecksumFileOfPathList path must exist', async () => doThrowAsync(() => describeChecksumOfPathList({
-    pathList: [
-      fromRoot('sample-cache-file-not-exist')
-    ]
-  })))
-
   it('checksumUpdate', async () => {
     __DEV__ && info(await describeChecksumOfPathList({ pathList: TEST_CONFIG.pathChecksumList }))