files - introduce generic stream interface and offer utility to convert to vsbuffer stream

src/vs/base/common/buffer.ts

@@ -141,18 +141,13 @@ export interface VSBufferReadable {
 	read(): VSBuffer | null;
 }
 
-/**
- * A buffer readable stream emits data to listeners. The stream
- * will only start emitting when the first data listener has
- * been added or the resume() method has been called.
- */
-export interface VSBufferReadableStream {
+export interface ReadableStream<T> {
 
 	/**
 	 * The 'data' event is emitted whenever the stream is
 	 * relinquishing ownership of a chunk of data to a consumer.
 	 */
-	on(event: 'data', callback: (chunk: VSBuffer) => void): void;
+	on(event: 'data', callback: (chunk: T) => void): void;
 
 	/**
 	 * Emitted when any error occurs.
@@ -182,6 +177,11 @@ export interface VSBufferReadableStream {
 	destroy(): void;
 }
 
+/**
+ * A readable stream that sends data via VSBuffer.
+ */
+export interface VSBufferReadableStream extends ReadableStream<VSBuffer> { }
+
 export function isVSBufferReadableStream(obj: any): obj is VSBufferReadableStream {
 	const candidate: VSBufferReadableStream = obj;
 
@@ -245,6 +245,19 @@ export function bufferToStream(buffer: VSBuffer): VSBufferReadableStream {
 	return stream;
 }
 
+/**
+ * Helper to create a VSBufferStream from a Uint8Array stream.
+ */
+export function toVSBufferReadableStream(stream: ReadableStream<Uint8Array>): VSBufferReadableStream {
+	const vsbufferStream = writeableBufferStream();
+
+	stream.on('data', data => vsbufferStream.write(VSBuffer.wrap(data)));
+	stream.on('end', () => vsbufferStream.end());
+	stream.on('error', error => vsbufferStream.error(error));
+
+	return vsbufferStream;
+}
+
 /**
  * Helper to create a VSBufferStream that can be pushed
  * buffers to. Will only start to emit data when a listener

src/vs/workbench/services/files/test/node/diskFileService.test.ts

@@ -14,13 +14,13 @@ import { join, basename, dirname, posix } from 'vs/base/common/path';
 import { getPathFromAmdModule } from 'vs/base/common/amd';
 import { copy, rimraf, symlink, RimRafMode, rimrafSync } from 'vs/base/node/pfs';
 import { URI } from 'vs/base/common/uri';
-import { existsSync, statSync, readdirSync, readFileSync, writeFileSync, renameSync, unlinkSync, mkdirSync, createReadStream, ReadStream } from 'fs';
+import { existsSync, statSync, readdirSync, readFileSync, writeFileSync, renameSync, unlinkSync, mkdirSync, createReadStream } from 'fs';
 import { FileOperation, FileOperationEvent, IFileStat, FileOperationResult, FileSystemProviderCapabilities, FileChangeType, IFileChange, FileChangesEvent, FileOperationError, etag, IStat, IFileStatWithMetadata } from 'vs/platform/files/common/files';
 import { NullLogService } from 'vs/platform/log/common/log';
 import { isLinux, isWindows } from 'vs/base/common/platform';
 import { DisposableStore } from 'vs/base/common/lifecycle';
 import { isEqual } from 'vs/base/common/resources';
-import { VSBuffer, VSBufferReadable, writeableBufferStream, VSBufferReadableStream, bufferToReadable, bufferToStream } from 'vs/base/common/buffer';
+import { VSBuffer, VSBufferReadable, toVSBufferReadableStream, VSBufferReadableStream, bufferToReadable, bufferToStream } from 'vs/base/common/buffer';
 
 function getByName(root: IFileStat, name: string): IFileStat | null {
 	if (root.children === undefined) {
@@ -58,16 +58,6 @@ function toLineByLineReadable(content: string): VSBufferReadable {
 	};
 }
 
-function nodeStreamToVSBufferStream(stream: ReadStream): VSBufferReadableStream {
-	const vsbufferStream = writeableBufferStream();
-
-	stream.on('data', data => vsbufferStream.write(VSBuffer.wrap(data)));
-	stream.on('end', () => vsbufferStream.end());
-	stream.on('error', error => vsbufferStream.error(error));
-
-	return vsbufferStream;
-}
-
 export class TestDiskFileSystemProvider extends DiskFileSystemProvider {
 
 	totalBytesRead: number = 0;
@@ -1573,7 +1563,7 @@ suite('Disk File Service', () => {
 		const source = URI.file(join(testDir, 'small.txt'));
 		const target = URI.file(join(testDir, 'small-copy.txt'));
 
-		const fileStat = await service.writeFile(target, nodeStreamToVSBufferStream(createReadStream(source.fsPath)));
+		const fileStat = await service.writeFile(target, toVSBufferReadableStream(createReadStream(source.fsPath)));
 		assert.equal(fileStat.name, 'small-copy.txt');
 
 		assert.equal(readFileSync(source.fsPath).toString(), readFileSync(target.fsPath).toString());
@@ -1585,7 +1575,7 @@ suite('Disk File Service', () => {
 		const source = URI.file(join(testDir, 'lorem.txt'));
 		const target = URI.file(join(testDir, 'lorem-copy.txt'));
 
-		const fileStat = await service.writeFile(target, nodeStreamToVSBufferStream(createReadStream(source.fsPath)));
+		const fileStat = await service.writeFile(target, toVSBufferReadableStream(createReadStream(source.fsPath)));
 		assert.equal(fileStat.name, 'lorem-copy.txt');
 
 		assert.equal(readFileSync(source.fsPath).toString(), readFileSync(target.fsPath).toString());
@@ -1597,7 +1587,7 @@ suite('Disk File Service', () => {
 		const source = URI.file(join(testDir, 'small.txt'));
 		const target = URI.file(join(testDir, 'small-copy.txt'));
 
-		const fileStat = await service.writeFile(target, nodeStreamToVSBufferStream(createReadStream(source.fsPath)));
+		const fileStat = await service.writeFile(target, toVSBufferReadableStream(createReadStream(source.fsPath)));
 		assert.equal(fileStat.name, 'small-copy.txt');
 
 		assert.equal(readFileSync(source.fsPath).toString(), readFileSync(target.fsPath).toString());
@@ -1609,7 +1599,7 @@ suite('Disk File Service', () => {
 		const source = URI.file(join(testDir, 'lorem.txt'));
 		const target = URI.file(join(testDir, 'lorem-copy.txt'));
 
-		const fileStat = await service.writeFile(target, nodeStreamToVSBufferStream(createReadStream(source.fsPath)));
+		const fileStat = await service.writeFile(target, toVSBufferReadableStream(createReadStream(source.fsPath)));
 		assert.equal(fileStat.name, 'lorem-copy.txt');
 
 		assert.equal(readFileSync(source.fsPath).toString(), readFileSync(target.fsPath).toString());