Fix paste actions breaking paste on new line (microsoft#152809)

Fixes microsoft#151326

Author: mjbvz

src/vs/editor/contrib/copyPaste/browser/copyPasteController.ts

@@ -6,7 +6,6 @@
 import { DataTransfers } from 'vs/base/browser/dnd';
 import { addDisposableListener } from 'vs/base/browser/dom';
 import { CancelablePromise, createCancelablePromise } from 'vs/base/common/async';
-import { CancellationToken } from 'vs/base/common/cancellation';
 import { createStringDataTransferItem, VSDataTransfer } from 'vs/base/common/dataTransfer';
 import { Disposable } from 'vs/base/common/lifecycle';
 import { Mimes } from 'vs/base/common/mime';
@@ -16,8 +15,7 @@ import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
 import { IBulkEditService, ResourceEdit } from 'vs/editor/browser/services/bulkEditService';
 import { EditorOption } from 'vs/editor/common/config/editorOptions';
 import { IRange, Range } from 'vs/editor/common/core/range';
-import { IEditorContribution } from 'vs/editor/common/editorCommon';
-import { DocumentPasteEdit, DocumentPasteEditProvider } from 'vs/editor/common/languages';
+import { Handler, IEditorContribution, PastePayload } from 'vs/editor/common/editorCommon';
 import { ITextModel } from 'vs/editor/common/model';
 import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures';
 import { CodeEditorStateFlag, EditorStateCancellationTokenSource } from 'vs/editor/contrib/editorState/browser/editorState';
@@ -26,21 +24,12 @@ import { SnippetParser } from 'vs/editor/contrib/snippet/browser/snippetParser';
 import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 
-const vscodeClipboardMime = 'application/vnd.code.copyId';
+const vscodeClipboardMime = 'application/vnd.code.copyMetadata';
 
-const defaultPasteEditProvider = new class implements DocumentPasteEditProvider {
-	pasteMimeTypes = [Mimes.text, 'text'];
-
-	async provideDocumentPasteEdits(_model: ITextModel, _ranges: readonly IRange[], dataTransfer: VSDataTransfer, _token: CancellationToken): Promise<DocumentPasteEdit | undefined> {
-		const textDataTransfer = dataTransfer.get(Mimes.text) ?? dataTransfer.get('text');
-		if (textDataTransfer) {
-			const text = await textDataTransfer.asString();
-			return { insertText: text };
-		}
-
-		return undefined;
-	}
-};
+interface CopyMetadata {
+	readonly id?: string;
+	readonly wasFromEmptySelection: boolean;
+}
 
 export class CopyPasteController extends Disposable implements IEditorContribution {
 
@@ -97,7 +86,8 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 
 		const ranges: IRange[] = [...selections];
 		const primarySelection = selections[0];
-		if (primarySelection.isEmpty()) {
+		const wasFromEmptySelection = primarySelection.isEmpty();
+		if (wasFromEmptySelection) {
 			if (!this._editor.getOption(EditorOption.emptySelectionClipboard)) {
 				return;
 			}
@@ -106,14 +96,18 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 
 		const providers = this._languageFeaturesService.documentPasteEditProvider.ordered(model).filter(x => !!x.prepareDocumentPaste);
 		if (!providers.length) {
+			this.setCopyMetadata(e.clipboardData, { wasFromEmptySelection });
 			return;
 		}
 
 		const dataTransfer = toVSDataTransfer(e.clipboardData);
 
 		// Save off a handle pointing to data that VS Code maintains.
 		const handle = generateUuid();
-		e.clipboardData.setData(vscodeClipboardMime, handle);
+		this.setCopyMetadata(e.clipboardData, {
+			id: handle,
+			wasFromEmptySelection,
+		});
 
 		const promise = createCancelablePromise(async token => {
 			const results = await Promise.all(providers.map(provider => {
@@ -133,6 +127,10 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 		this._currentClipboardItem = { handle: handle, dataTransferPromise: promise };
 	}
 
+	private setCopyMetadata(dataTransfer: DataTransfer, metadata: CopyMetadata) {
+		dataTransfer.setData(vscodeClipboardMime, JSON.stringify(metadata));
+	}
+
 	private async handlePaste(e: ClipboardEvent) {
 		if (!e.clipboardData || !this._editor.hasTextFocus()) {
 			return;
@@ -148,9 +146,10 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 			return;
 		}
 
-		const handle = e.clipboardData?.getData(vscodeClipboardMime);
-		if (typeof handle !== 'string') {
-			return;
+		let metadata: CopyMetadata | undefined;
+		const rawMetadata = e.clipboardData?.getData(vscodeClipboardMime);
+		if (rawMetadata && typeof rawMetadata === 'string') {
+			metadata = JSON.parse(rawMetadata);
 		}
 
 		const providers = this._languageFeaturesService.documentPasteEditProvider.ordered(model);
@@ -167,7 +166,7 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 		try {
 			const dataTransfer = toVSDataTransfer(e.clipboardData);
 
-			if (handle && this._currentClipboardItem?.handle === handle) {
+			if (metadata?.id && this._currentClipboardItem?.handle === metadata.id) {
 				const toMergeDataTransfer = await this._currentClipboardItem.dataTransferPromise;
 				toMergeDataTransfer.forEach((value, key) => {
 					dataTransfer.replace(key, value);
@@ -184,7 +183,7 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 
 			dataTransfer.delete(vscodeClipboardMime);
 
-			for (const provider of [...providers, defaultPasteEditProvider]) {
+			for (const provider of providers) {
 				if (!provider.pasteMimeTypes.some(type => {
 					if (type.toLowerCase() === DataTransfers.FILES.toLowerCase()) {
 						return [...dataTransfer.values()].some(item => item.asFile());
@@ -208,6 +207,23 @@ export class CopyPasteController extends Disposable implements IEditorContributi
 					return;
 				}
 			}
+
+			// Default handler
+			const textDataTransfer = dataTransfer.get(Mimes.text) ?? dataTransfer.get('text');
+			if (!textDataTransfer) {
+				return;
+			}
+
+			const text = await textDataTransfer.asString();
+			if (originalDocVersion !== model.getVersionId()) {
+				return;
+			}
+
+			this._editor.trigger('keyboard', Handler.Paste, <PastePayload>{
+				text: text,
+				pasteOnNewLine: metadata?.wasFromEmptySelection,
+				multicursorText: null
+			});
 		} finally {
 			tokenSource.dispose();
 		}