node: change NodeFileSystem types for streams, add createReadStream

Author: perf2711

packages/node/src/storage/FsNodeFileSystem.ts

@@ -1,7 +1,8 @@
 import { BacktraceAttachment } from '@backtrace/sdk-core';
 import fs from 'fs';
+import { Readable, Writable } from 'stream';
 import { BacktraceFileAttachment } from '../attachment';
-import { NodeFileSystem, WritableStream } from './interfaces/NodeFileSystem';
+import { NodeFileSystem } from './interfaces/NodeFileSystem';
 
 export class FsNodeFileSystem implements NodeFileSystem {
     public readDir(dir: string): Promise<string[]> {
@@ -52,10 +53,12 @@ export class FsNodeFileSystem implements NodeFileSystem {
         fs.renameSync(oldPath, newPath);
     }
 
-    public createWriteStream(path: string): WritableStream {
-        const stream = fs.createWriteStream(path, 'utf-8');
-        (stream as Partial<WritableStream>).writeSync = (chunk) => stream.write(chunk);
-        return stream as unknown as WritableStream;
+    public createWriteStream(path: string): Writable {
+        return fs.createWriteStream(path, 'utf-8');
+    }
+
+    public createReadStream(path: string): Readable {
+        return fs.createReadStream(path, 'utf-8');
     }
 
     public async exists(path: string): Promise<boolean> {

packages/node/src/storage/interfaces/NodeFileSystem.ts

@@ -1,13 +1,9 @@
 import { FileSystem } from '@backtrace/sdk-core';
-
-export interface WritableStream {
-    write(chunk: string, callback?: (err?: Error | null) => void): void;
-    writeSync(chunk: string): void;
-    close(): void;
-}
+import { Readable, Writable } from 'stream';
 
 export interface NodeFileSystem extends FileSystem {
-    createWriteStream(path: string): WritableStream;
+    createReadStream(path: string): Readable;
+    createWriteStream(path: string): Writable;
     rename(oldPath: string, newPath: string): Promise<void>;
     renameSync(oldPath: string, newPath: string): void;
 }

packages/node/tests/_mocks/fileSystem.ts

@@ -1,7 +1,7 @@
 import { MockedFileSystem, mockFileSystem } from '@backtrace/sdk-core/tests/_mocks/fileSystem';
 import path from 'path';
-import { Writable } from 'stream';
-import { NodeFileSystem, WritableStream } from '../../src/storage/interfaces/NodeFileSystem';
+import { Readable, Writable } from 'stream';
+import { NodeFileSystem } from '../../src/storage/interfaces/NodeFileSystem';
 
 export function mockStreamFileSystem(files?: Record<string, string>): MockedFileSystem<NodeFileSystem> {
     const fs = mockFileSystem(files);
@@ -22,7 +22,7 @@ export function mockStreamFileSystem(files?: Record<string, string>): MockedFile
         }),
 
         createWriteStream: jest.fn().mockImplementation((p: string) => {
-            const writable = new Writable({
+            return new Writable({
                 write(chunk, encoding, callback) {
                     const str = Buffer.isBuffer(chunk)
                         ? chunk.toString('utf-8')
@@ -40,11 +40,27 @@ export function mockStreamFileSystem(files?: Record<string, string>): MockedFile
                     callback && callback();
                 },
             });
+        }),
 
-            (writable as Partial<WritableStream>).close = () => writable.end();
-            (writable as Partial<WritableStream>).writeSync = (chunk) => writable.write(chunk);
+        createReadStream: jest.fn().mockImplementation((p: string) => {
+            const fullPath = path.resolve(p);
+            const file = fs.files[fullPath];
+            if (!file) {
+                throw new Error(`File ${p} does not exist`);
+            }
 
-            return writable;
+            let position = 0;
+            return new Readable({
+                read(size) {
+                    const chunk = file.substring(position, position + size);
+                    if (!chunk) {
+                        this.push(null);
+                    } else {
+                        this.push(Buffer.from(chunk));
+                        position += size;
+                    }
+                },
+            });
         }),
     };
 }