Merge pull request microsoft#201157 from microsoft/tyriar/180257

Use safer pasted input chunking algorithm

Author: Tyriar

src/vs/platform/terminal/common/terminalProcess.ts

@@ -67,3 +67,41 @@ export interface ReplayEntry {
 	rows: number;
 	data: string;
 }
+
+const enum Constants {
+	/**
+	 * Writing large amounts of data can be corrupted for some reason, after looking into this is
+	 * appears to be a race condition around writing to the FD which may be based on how powerful
+	 * the hardware is. The workaround for this is to space out when large amounts of data is being
+	 * written to the terminal. See https://github.com/microsoft/vscode/issues/38137
+	 */
+	WriteMaxChunkSize = 50,
+}
+
+/**
+ * Splits incoming pty data into chunks to try prevent data corruption that could occur when pasting
+ * large amounts of data.
+ */
+export function chunkInput(data: string): string[] {
+	const chunks: string[] = [];
+	let nextChunkStartIndex = 0;
+	for (let i = 0; i < data.length - 1; i++) {
+		if (
+			// If the max chunk size is reached
+			i - nextChunkStartIndex + 1 >= Constants.WriteMaxChunkSize ||
+			// If the next character is ESC, send the pending data to avoid splitting the escape
+			// sequence.
+			data[i + 1] === '\x1b'
+		) {
+			chunks.push(data.substring(nextChunkStartIndex, i + 1));
+			nextChunkStartIndex = i + 1;
+			// Skip the next character as the chunk would be a single character
+			i++;
+		}
+	}
+	// Push final chunk
+	if (nextChunkStartIndex !== data.length) {
+		chunks.push(data.substring(nextChunkStartIndex));
+	}
+	return chunks;
+}

src/vs/platform/terminal/node/terminalProcess.ts

@@ -19,6 +19,7 @@ import { ChildProcessMonitor } from 'vs/platform/terminal/node/childProcessMonit
 import { findExecutable, getShellIntegrationInjection, getWindowsBuildNumber, IShellIntegrationConfigInjection } from 'vs/platform/terminal/node/terminalEnvironment';
 import { WindowsShellHelper } from 'vs/platform/terminal/node/windowsShellHelper';
 import { IPty, IPtyForkOptions, IWindowsPtyForkOptions, spawn } from 'node-pty';
+import { chunkInput } from 'vs/platform/terminal/common/terminalProcess';
 
 const enum ShutdownConstants {
 	/**
@@ -54,14 +55,6 @@ const enum Constants {
 	 * interval.
 	 */
 	KillSpawnSpacingDuration = 50,
-
-	/**
-	 * Writing large amounts of data can be corrupted for some reason, after looking into this is
-	 * appears to be a race condition around writing to the FD which may be based on how powerful
-	 * the hardware is. The workaround for this is to space out when large amounts of data is being
-	 * written to the terminal. See https://github.com/microsoft/vscode/issues/38137
-	 */
-	WriteMaxChunkSize = 50,
 	/**
 	 * How long to wait between chunk writes.
 	 */
@@ -437,17 +430,13 @@ export class TerminalProcess extends Disposable implements ITerminalChildProcess
 		}
 	}
 
-	input(data: string, isBinary?: boolean): void {
+	input(data: string, isBinary: boolean = false): void {
 		if (this._store.isDisposed || !this._ptyProcess) {
 			return;
 		}
-		for (let i = 0; i <= Math.floor(data.length / Constants.WriteMaxChunkSize); i++) {
-			const obj = {
-				isBinary: isBinary || false,
-				data: data.substr(i * Constants.WriteMaxChunkSize, Constants.WriteMaxChunkSize)
-			};
-			this._writeQueue.push(obj);
-		}
+		this._writeQueue.push(...chunkInput(data).map(e => {
+			return { isBinary, data: e };
+		}));
 		this._startWrite();
 	}
 

src/vs/platform/terminal/test/common/terminalProcess.test.ts

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { deepStrictEqual } from 'assert';
+import { ensureNoDisposablesAreLeakedInTestSuite } from 'vs/base/test/common/utils';
+import { chunkInput } from 'vs/platform/terminal/common/terminalProcess';
+
+suite('platform - terminalProcess', () => {
+	ensureNoDisposablesAreLeakedInTestSuite();
+	suite('chunkInput', () => {
+		test('single chunk', () => {
+			deepStrictEqual(chunkInput('foo bar'), ['foo bar']);
+		});
+		test('multi chunk', () => {
+			deepStrictEqual(chunkInput('foo'.repeat(50)), [
+				'foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoofo',
+				'ofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoof',
+				'oofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo'
+			]);
+		});
+		test('small data with escapes', () => {
+			deepStrictEqual(chunkInput('foo \x1b[30mbar'), [
+				'foo ',
+				'\x1b[30mbar'
+			]);
+		});
+		test('large data with escapes', () => {
+			deepStrictEqual(chunkInput('foofoofoofoo\x1b[30mbarbarbarbarbar\x1b[0m'.repeat(3)), [
+				'foofoofoofoo',
+				'\x1B[30mbarbarbarbarbar',
+				'\x1B[0mfoofoofoofoo',
+				'\x1B[30mbarbarbarbarbar',
+				'\x1B[0mfoofoofoofoo',
+				'\x1B[30mbarbarbarbarbar',
+				'\x1B[0m'
+			]);
+		});
+	});
+});