fix(fs): correct typing so fsa.stream can be used with fsa.write

blacha · Feb 20, 2022 · 460a596 · 460a596
1 parent d5dc67b
commit 460a596
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/packages/fs/src/__test__/fs.abstraction.test.ts b/packages/fs/src/__test__/fs.abstraction.test.ts
@@ -1,5 +1,6 @@
 import { FsFile } from '@chunkd/source-file';
 import o from 'ospec';
+import Sinon from 'sinon';
 import { FileSystemAbstraction } from '../fs.abstraction.js';
 
 export class FakeSystem extends FsFile {
@@ -59,4 +60,21 @@ o.spec('FileSystemAbstraction', () => {
     o(fsa.systems.length).equals(1);
     o(fsa.systems[0].system).equals(fakeB);
   });
+
+  o('should stream files between systems', () => {
+    const fakeA = new FakeSystem('fake');
+    const fakeB = new FakeSystem('fakeSpecific');
+    const fsa = new FileSystemAbstraction();
+
+    const writeStub = (fakeB.write = Sinon.stub());
+    const streamStub = (fakeA.stream = Sinon.stub());
+
+    fsa.register('fake-a://', fakeA);
+    fsa.register('fake-b://', fakeB);
+
+    fsa.write('fake-b://bar.js', fsa.stream('fake-a://foo.js'));
+
+    o(streamStub.callCount).equals(1);
+    o(writeStub.callCount).equals(1);
+  });
 });
diff --git a/packages/fs/src/fs.abstraction.ts b/packages/fs/src/fs.abstraction.ts
@@ -1,4 +1,4 @@
-import { Readable } from 'stream';
+import type { Readable } from 'stream';
 import { ChunkSource, FileInfo, FileSystem, WriteOptions } from '@chunkd/core';
 
 export type FileWriteTypes = Buffer | Readable | string | Record<string, unknown> | Array<unknown>;
@@ -9,7 +9,8 @@ function isRecord(obj: unknown): obj is Record<string, unknown> {
   return obj.constructor === Object;
 }
 
-export class FileSystemAbstraction {
+export class FileSystemAbstraction implements FileSystem {
+  protocol = 'abstract';
   /**
    * Is the systems array currently ordered
    * @see FileSystemAbstraction.sortSystems
@@ -70,7 +71,7 @@ export class FileSystemAbstraction {
    * @param filePath file to read
    * @returns Stream of file contents
    */
-  stream(filePath: string): NodeJS.ReadableStream {
+  stream(filePath: string): Readable {
     return this.get(filePath).stream(filePath);
   }