feat: migrate from Promises to Streams

Author: ghiscoding

src/__tests__/cli.spec.ts

@@ -39,21 +39,31 @@ describe('copyfiles', () => {
       '**/*.ps.txt'
     ]);
 
+    // Mock process.exit so it doesn't kill the test runner
+    // @ts-ignore
+    const exitSpy = vi.spyOn(process, 'exit').mockImplementation((code?: string | number | null | undefined) => {
+      // Do nothing
+    });
+
     import('../cli')
-      .then((cli: any) => {
-        console.log(cli);
-      })
       .then(() => {
-        readdir('output2/input2', (err, files) => {
-          expect(files).toEqual(['a.txt', 'b.txt']);
-          done();
-        });
+        // Wait a tick to ensure file writes are complete
+        setTimeout(() => {
+          readdir('output2/input2', (err, files) => {
+            expect(files).toEqual(['a.txt', 'b.txt']);
+            exitSpy.mockRestore();
+            done();
+          });
+        }, 100); // 100ms delay to allow async file writes
       })
       .catch(e => {
-        readdir('output2/input2', (err, files) => {
-          expect(files).toEqual(['a.txt', 'b.txt']);
-          done();
-        });
+        setTimeout(() => {
+          readdir('output2/input2', (err, files) => {
+            expect(files).toEqual(['a.txt', 'b.txt']);
+            exitSpy.mockRestore();
+            done();
+          });
+        }, 100);
       });
-  }));
-});
+  }))
+})

src/__tests__/index.spec.ts

@@ -1,22 +1,44 @@
-import { mkdirSync, readdir, rmdirSync, symlinkSync, writeFileSync } from 'node:fs';
+import { existsSync, mkdirSync, readdir, rmSync, symlinkSync, writeFileSync } from 'node:fs';
 import { globSync } from 'tinyglobby';
 import { afterAll, afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
 
 import { copyfiles, createDir } from '../index';
 
+let shouldMockReadError = false;
+const error = new Error('Mock read error');
+
+vi.mock('node:fs', async () => {
+  const actual = await vi.importActual<typeof import('node:fs')>('node:fs');
+  return {
+    ...actual,
+    createReadStream: (...args: any[]) => {
+      if (shouldMockReadError) {
+        const { Readable } = require('node:stream');
+        const stream = new Readable({ read() { } });
+        setImmediate(() => stream.emit('error', error));
+        return stream;
+      }
+      // fallback to real implementation
+      return (actual.createReadStream as any)(...args);
+    }
+  };
+});
+
 async function cleanupFolders() {
   try {
-    rmdirSync('input', { recursive: true });
-    rmdirSync('output', { recursive: true });
+    rmSync('input', { recursive: true, force: true });
+    rmSync('output', { recursive: true, force: true });
   } catch (e) { }
 }
 
 describe('copyfiles', () => {
   afterEach(async () => {
-    cleanupFolders();
+    await cleanupFolders();
   });
 
-  afterAll(() => cleanupFolders());
+  afterAll(async () => {
+    await cleanupFolders();
+  });
 
   beforeEach(() => {
     createDir('input/other');
@@ -43,8 +65,6 @@ describe('copyfiles', () => {
     copyfiles(['input/*.txt', 'output'], {}, (err) => {
       console.error(err, 'copyfiles');
       readdir('output/input', async (err, files) => {
-        // console.error(err, 'readdir');
-        // 'correct number of things'
         expect(files).toEqual(['a.txt', 'b.txt']);
         done();
       });
@@ -184,7 +204,9 @@ describe('copyfiles', () => {
     copyfiles(['input/**/*.txt', 'output'], { flat: true, verbose: true }, (err) => {
       readdir('output', (err, files) => {
         expect(files).toEqual(['a.txt', 'b.txt']);
-        expect(logSpy).toHaveBeenCalledWith('glob found', ['input/b.txt', 'input/other/a.txt']);
+        const globCall = logSpy.mock.calls.find(call => call[0] === 'glob found');
+        expect(globCall).toBeTruthy();
+        expect(new Set(globCall![1])).toEqual(new Set(['input/b.txt', 'input/other/a.txt']));
         expect(logSpy).toHaveBeenCalledWith('copy:', { from: 'input/other/a.txt', to: 'output/a.txt' });
         expect(logSpy).toHaveBeenCalledWith('copy:', { from: 'input/b.txt', to: 'output/b.txt' });
         expect(logSpy).toHaveBeenCalledWith('Files copied:   2');
@@ -193,6 +215,88 @@ describe('copyfiles', () => {
     });
   }));
 
+  test('createDir does not throw if dir exists', () => {
+    createDir('input');
+    expect(() => createDir('input')).not.toThrow();
+  });
+
+  test('throws when inFile or outDir are missing (no callback)', () => {
+    expect(() => copyfiles(['input/**/*.txt'], {})).toThrow(
+      'Please make sure to provide both <inFile> and <outDirectory>, i.e.: "copyfiles <inFile> <outDirectory>"'
+    );
+  });
+
+  test('callback called when no files to copy', () => new Promise((done: any) => {
+    copyfiles(['input/doesnotexist/*.txt', 'output'], {}, (err) => {
+      expect(err).toBeUndefined();
+      done();
+    });
+  }));
+
+  test('copyFileStream handles read error', () => new Promise((done: any) => {
+    writeFileSync('input/bad.txt', 'bad'); // <-- Ensure the file exists!
+    shouldMockReadError = true;
+    copyfiles(['input/bad.txt', 'output'], {}, (err) => {
+      expect(err).toBeInstanceOf(Error);
+      expect(err?.message).toBe('Mock read error');
+      shouldMockReadError = false;
+      done();
+    });
+  }));
+
+  test('throws when flat & up used together', () => {
+    expect(() => copyfiles(['input/**/*.txt', 'output'], { flat: true, up: 1 })).toThrow(
+      'Cannot use --flat in conjunction with --up option.'
+    );
+  });
+
+  test('calls callback with error when nothing copied and options.error is set', () => new Promise((done: any) => {
+    copyfiles(['input/doesnotexist/*.txt', 'output'], { error: true }, (err) => {
+      expect(err).toBeInstanceOf(Error);
+      expect(err?.message).toBe('nothing copied');
+      done();
+    });
+  }));
+
+  test('logs and calls callback when nothing copied and verbose/stat is set', () => new Promise((done: any) => {
+    const logSpy = vi.spyOn(global.console, 'log').mockReturnValue();
+    const timeSpy = vi.spyOn(global.console, 'timeEnd').mockReturnValue();
+    copyfiles(['input/doesnotexist/*.txt', 'output'], { verbose: true }, (err) => {
+      expect(logSpy).toHaveBeenCalledWith('Files copied:   0');
+      expect(timeSpy).toHaveBeenCalled();
+      expect(err).toBeUndefined();
+      logSpy.mockRestore();
+      timeSpy.mockRestore();
+      done();
+    });
+  }));
+
+  test('throws when flat & up used together (with callback)', () => new Promise((done: any) => {
+    copyfiles(['input/**/*.txt', 'output'], { flat: true, up: 1 }, (err) => {
+      expect(err).toBeInstanceOf(Error);
+      expect(err?.message).toBe('Cannot use --flat in conjunction with --up option.');
+      done();
+    });
+  }));
+
+  test('throws when nothing copied and options.error is set (no callback)', () => {
+    expect(() => {
+      copyfiles(['input/doesnotexist/*.txt', 'output'], { error: true });
+    }).toThrow('nothing copied');
+  });
+
+  test('sets followSymbolicLinks when options.follow is true', () => new Promise((done: any) => {
+    if (process.platform === 'win32') return done(); // skip on Windows (symlink perms)
+    mkdirSync('input/real', { recursive: true });
+    writeFileSync('input/real/a.txt', 'test');
+    symlinkSync('real', 'input/link');
+    copyfiles(['input/link/*.txt', 'output'], { follow: true }, (err) => {
+      expect(err).toBeUndefined();
+      expect(existsSync('output/link/a.txt')).toBe(true);
+      done();
+    });
+  }));
+
   test('verbose up', () => new Promise((done: any) => {
     const logSpy = vi.spyOn(global.console, 'log').mockReturnValue();
     writeFileSync('input/other/a.txt', 'a');