(ref): extracted common functions from backup lib (#48)

Author: SystemFiles

package.json

@@ -9,7 +9,7 @@
     "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   },
   "scripts": {
-    "start": "NODE_ENV=dev tsc && node dist/app.js restore --ref 1bc41083-afd2-4b5e-8270-5e475844ba50 --dest ./dev/restore",
+    "start": "NODE_ENV=dev tsc && node dist/app.js restore --ref 7203e58c-2e31-40f1-b6db-fd48cf98ca05 --dest ./dev/restore2",
     "build": "NODE_ENV=production tsc",
     "lint": "NODE_ENV=test eslint \"{src,libs,test}/**/*.ts\" --fix",
     "test": "echo \"WARN: no test specified\" && exit 0"

src/common/functions.ts

@@ -1,5 +1,10 @@
 import figlet from 'figlet'
+import { MakeDirectoryOptions } from 'fs'
+import { pathExists } from 'fs-extra'
+import { chown, readdir, mkdir } from 'fs/promises'
 import { userInfo } from 'os'
+import { join } from 'path/posix'
+import { log } from '../lib/logger.js'
 import { PACKAGE_NAME } from './constants.js'
 import { BackupRecord, Directory } from './types.js'
 
@@ -45,3 +50,37 @@ export function compareByDepth(dirA: Directory, dirB: Directory): number {
 	if (dirA.depth > dirB.depth) return 1
 	return 0
 }
+
+// Create a directory with optional permissions modes
+export async function createDirectory(
+	rootPath: string,
+	directoryName: string,
+	options: MakeDirectoryOptions = { mode: '0755' },
+	ownership?: { uid: number; gid: number }
+): Promise<[string, Error]> {
+	try {
+		const fullPath = join(rootPath, directoryName)
+		if (!await pathExists(fullPath)) {
+			await mkdir(fullPath, { recursive: false, ...options })
+
+			// Append ownership information to directory
+			if (ownership) await chown(fullPath, ownership.uid, ownership.gid)
+			return [ fullPath, null ]
+		} else {
+			log(`Directory already exists ... skipping create.`)
+			return [ fullPath, null ]
+		}
+	} catch (err) {
+		if (!err.message.includes('EPERM')) {
+			log(`ERROR creating directory: ${err}`)
+			return [ null, err ]
+		}
+	}
+}
+
+// Check whether a given directory is empty or not
+export async function isDirEmpty(path: string): Promise<boolean> {
+	return readdir(path).then((files) => {
+		return files.length === 0
+	})
+}

src/lib/backup.ts

@@ -1,6 +1,6 @@
-import { mkdir, lstat, readdir, chown } from 'fs/promises'
+import { lstat, readdir } from 'fs/promises'
 import { join, sep } from 'path/posix'
-import { copy, pathExists } from 'fs-extra'
+import { copy } from 'fs-extra'
 import { BackupRecord, BackupType, Directory, FileData, RecordTable } from '../common/types.js'
 import { v4 as uuid } from 'uuid'
 import {
@@ -10,10 +10,9 @@ import {
 	IOException
 } from '../common/exceptions.js'
 import { DatabaseManager } from './database.js'
-import { log } from './logger.js'
 import { createHash } from 'crypto'
-import { createReadStream, MakeDirectoryOptions, ReadStream } from 'fs'
-import { compareByDepth } from '../common/functions.js'
+import { createReadStream, ReadStream } from 'fs'
+import { compareByDepth, createDirectory } from '../common/functions.js'
 
 export class BackupManager {
 	private static instance: BackupManager
@@ -32,32 +31,6 @@ export class BackupManager {
 		return BackupManager.instance
 	}
 
-	private async _createDirectory(
-		rootPath: string,
-		directoryName: string,
-		options: MakeDirectoryOptions = { mode: '0755' },
-		ownership?: { uid: number; gid: number }
-	): Promise<[string, Error]> {
-		try {
-			const fullPath = join(rootPath, directoryName)
-			if (!await pathExists(fullPath)) {
-				await mkdir(fullPath, { recursive: false, ...options })
-
-				// Append ownership information to directory
-				if (ownership) await chown(fullPath, ownership.uid, ownership.gid)
-				return [ fullPath, null ]
-			} else {
-				log(`Directory already exists ... skipping create.`)
-				return [ fullPath, null ]
-			}
-		} catch (err) {
-			if (!err.message.includes('EPERM')) {
-				log(`ERROR creating directory: ${err}`)
-				return [ null, err ]
-			}
-		}
-	}
-
 	public clearBuffers(): void {
 		this.filesBuffer = []
 		this.directoriesBuffer = []
@@ -296,7 +269,7 @@ export class BackupManager {
 
 					// Append the operation to the queue
 					processQueue.push(
-						this._createDirectory(
+						createDirectory(
 							destRoot,
 							d.path.split(sourceRoot)[1],
 							{ mode: d.mode || '0755' },
@@ -351,7 +324,7 @@ export class BackupManager {
 			}
 
 			// Make the backup directory && Copy all changed files (maintaining path and timestamps)
-			const [ _, createErr ] = await this._createDirectory(destination, generatedBackupName)
+			const [ _, createErr ] = await createDirectory(destination, generatedBackupName)
 			if (createErr) {
 				throw new IOException(`Could not create the backup directory. Aborting... (${createErr.message})`)
 			}
@@ -418,7 +391,7 @@ export class BackupManager {
 			}
 
 			// Create the FULL backup
-			const [ _, createErr ] = await this._createDirectory(destination, generatedBackupName)
+			const [ _, createErr ] = await createDirectory(destination, generatedBackupName)
 			if (createErr) {
 				throw new IOException(`Could not create the backup directory. Aborting... (${createErr.message})`)
 			}