Combine file-manager and file-description

Author: lo1tuma

source/artifacts/artifacts-builder.ts

@@ -2,9 +2,9 @@ import path from 'node:path';
 import ssri from 'ssri';
 import type { BundleContent, BundleDescription } from '../bundler/bundle-description.js';
 import type { TarballBuilder } from '../tar/tarball-builder.js';
-import type { FileDescription } from '../file-description/file-description.js';
-import { isExecutableFileMode } from '../file-description/permissions.js';
-import type { FileManager } from './file-manager.js';
+import type { FileDescription } from '../file-manager/file-description.js';
+import { isExecutableFileMode } from '../file-manager/permissions.js';
+import type { FileManager } from '../file-manager/file-manager.js';
 
 export type ArtifactsBuilderDependencies = {
     readonly fileManager: FileManager;

source/dependency-scanner/source-map-file-locator.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import { Maybe } from 'true-myth';
-import type { FileManager } from '../artifacts/file-manager.js';
+import type { FileManager } from '../file-manager/file-manager.js';
 
 export type SourceMapFileLocatorDependencies = {
     readonly fileManager: FileManager;

source/file-description/file-description.ts

@@ -0,0 +1,13 @@
+type BaseDescription = {
+    readonly content: string;
+    readonly isExecutable: boolean;
+};
+
+export type FileDescription = BaseDescription & {
+    readonly filePath: string;
+};
+
+export type TransferableFileDescription = BaseDescription & {
+    readonly sourceFilePath: string;
+    readonly targetFilePath: string;
+};

source/file-description/compare.test.ts renamed to source/file-manager/compare.test.ts

@@ -101,3 +101,37 @@ test('getFileMode() returns the file mode of the given file path', async (t) =>
     t.deepEqual(stat.firstCall.args, ['/foo/bar.txt']);
     t.is(result, 42);
 });
+
+test('getTransferableFileDescriptionFromPath() returns the file description of the given file paths', async (t) => {
+    const stat = fake.resolves({ mode: 42 });
+    const readFile = fake.resolves('the-content');
+    const fileManager = fileManagerFactory({ stat, readFile });
+
+    const result = await fileManager.getTransferableFileDescriptionFromPath('/foo/bar.txt', '/target/path.txt');
+
+    t.is(stat.callCount, 1);
+    t.deepEqual(stat.firstCall.args, ['/foo/bar.txt']);
+    t.is(readFile.callCount, 1);
+    t.deepEqual(readFile.firstCall.args, ['/foo/bar.txt']);
+    t.deepEqual(result, {
+        sourceFilePath: '/foo/bar.txt',
+        targetFilePath: '/target/path.txt',
+        content: 'the-content',
+        isExecutable: false
+    });
+});
+
+test('getTransferableFileDescriptionFromPath() returns the file description with isExecutable set to true when the file mode indicates this', async (t) => {
+    const stat = fake.resolves({ mode: 493 });
+    const readFile = fake.resolves('the-content');
+    const fileManager = fileManagerFactory({ stat, readFile });
+
+    const result = await fileManager.getTransferableFileDescriptionFromPath('/foo/bar.txt', '/target/path.txt');
+
+    t.deepEqual(result, {
+        sourceFilePath: '/foo/bar.txt',
+        targetFilePath: '/target/path.txt',
+        content: 'the-content',
+        isExecutable: true
+    });
+});

source/file-description/compare.ts renamed to source/file-manager/compare.ts

@@ -1,5 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import type { TransferableFileDescription } from './file-description.js';
+import { isExecutableFileMode } from './permissions.js';
 
 export type FileManagerDependencies = {
     readonly hostFileSystem: typeof fs.promises;
@@ -15,6 +17,10 @@ export type FileManager = {
     writeFile(filePath: string, content: string): Promise<void>;
     copyFile(from: string, to: string): Promise<void>;
     getFileMode(filePath: string): Promise<number>;
+    getTransferableFileDescriptionFromPath(
+        sourceFilePath: string,
+        targetFilePath: string
+    ): Promise<TransferableFileDescription>;
 };
 
 export function createFileManager(dependencies: FileManagerDependencies): FileManager {
@@ -44,21 +50,34 @@ export function createFileManager(dependencies: FileManagerDependencies): FileMa
         return hostFileSystem.readFile(filePath, { encoding: 'utf8' });
     }
 
+    async function getFileMode(filePath: string): Promise<number> {
+        const stats = await hostFileSystem.stat(filePath);
+        return stats.mode;
+    }
+
     return {
         checkReadability,
 
         writeFile,
 
         readFile,
 
+        getFileMode,
+
+        async getTransferableFileDescriptionFromPath(sourceFilePath, targetFilePath) {
+            const mode = await getFileMode(sourceFilePath);
+
+            return {
+                sourceFilePath,
+                targetFilePath,
+                content: await readFile(targetFilePath),
+                isExecutable: isExecutableFileMode(mode)
+            };
+        },
+
         async copyFile(from, to) {
             const content = await readFile(from);
             await writeFile(to, content);
-        },
-
-        async getFileMode(filePath) {
-            const stats = await hostFileSystem.stat(filePath);
-            return stats.mode;
         }
     };
 }