DND from OS no longer works (fix microsoft#230536) (microsoft#230567)

bpasero · web-flow · commit 23433ab61b9e · 2024-10-05T00:03:33.000-07:00
diff --git a/src/vs/editor/browser/dnd.ts b/src/vs/editor/browser/dnd.ts
@@ -7,7 +7,7 @@ import { DataTransfers } from '../../base/browser/dnd.js';
 import { createFileDataTransferItem, createStringDataTransferItem, IDataTransferItem, UriList, VSDataTransfer } from '../../base/common/dataTransfer.js';
 import { Mimes } from '../../base/common/mime.js';
 import { URI } from '../../base/common/uri.js';
-import { CodeDataTransfers, FileAdditionalNativeProperties } from '../../platform/dnd/browser/dnd.js';
+import { CodeDataTransfers, getPathForFile } from '../../platform/dnd/browser/dnd.js';
 
 
 export function toVSDataTransfer(dataTransfer: DataTransfer) {
@@ -28,7 +28,8 @@ export function toVSDataTransfer(dataTransfer: DataTransfer) {
 }
 
 function createFileDataTransferItemFromFile(file: File): IDataTransferItem {
-	const uri = (file as FileAdditionalNativeProperties).path ? URI.parse((file as FileAdditionalNativeProperties).path!) : undefined;
+	const path = getPathForFile(file);
+	const uri = path ? URI.parse(path!) : undefined;
 	return createFileDataTransferItem(file.name, uri, async () => {
 		return new Uint8Array(await file.arrayBuffer());
 	});
@@ -55,7 +56,7 @@ export function toExternalVSDataTransfer(sourceDataTransfer: DataTransfer, overw
 			for (const item of sourceDataTransfer.items) {
 				const file = item.getAsFile();
 				if (file) {
-					const path = (file as FileAdditionalNativeProperties).path;
+					const path = getPathForFile(file);
 					try {
 						if (path) {
 							editorData.push(URI.file(path).toString());
diff --git a/src/vs/platform/dnd/browser/dnd.ts b/src/vs/platform/dnd/browser/dnd.ts
@@ -12,7 +12,7 @@ import { VSBuffer } from '../../../base/common/buffer.js';
 import { ResourceMap } from '../../../base/common/map.js';
 import { parse } from '../../../base/common/marshalling.js';
 import { Schemas } from '../../../base/common/network.js';
-import { isWeb } from '../../../base/common/platform.js';
+import { isNative, isWeb } from '../../../base/common/platform.js';
 import { URI } from '../../../base/common/uri.js';
 import { localize } from '../../../nls.js';
 import { IDialogService } from '../../dialogs/common/dialogs.js';
@@ -24,13 +24,6 @@ import { IInstantiationService, ServicesAccessor } from '../../instantiation/com
 import { extractSelection } from '../../opener/common/opener.js';
 import { Registry } from '../../registry/common/platform.js';
 
-export interface FileAdditionalNativeProperties {
-	/**
-	 * The real path to the file on the users filesystem. Only available on electron.
-	 */
-	readonly path?: string;
-}
-
 
 //#region Editor / Resources DND
 
@@ -84,9 +77,9 @@ export function extractEditorsDropData(e: DragEvent): Array<IDraggedResourceEdit
 		if (e.dataTransfer?.files) {
 			for (let i = 0; i < e.dataTransfer.files.length; i++) {
 				const file = e.dataTransfer.files[i];
-				if (file && (file as FileAdditionalNativeProperties).path /* Electron only */) {
+				if (file && getPathForFile(file)) {
 					try {
-						editors.push({ resource: URI.file((file as FileAdditionalNativeProperties).path!), isExternal: true, allowWorkspaceOpen: true });
+						editors.push({ resource: URI.file(getPathForFile(file)!), isExternal: true, allowWorkspaceOpen: true });
 					} catch (error) {
 						// Invalid URI
 					}
@@ -407,4 +400,16 @@ export class LocalSelectionTransfer<T> {
 	}
 }
 
+/**
+ * A helper to get access to Electrons `webUtils.getPathForFile` function
+ * in a safe way without crashing the application when running in the web.
+ */
+export function getPathForFile(file: File): string | undefined {
+	if (isNative && typeof (globalThis as any).vscode?.webUtils?.getPathForFile === 'function') {
+		return (globalThis as any).vscode.webUtils.getPathForFile(file);
+	}
+
+	return undefined;
+}
+
 //#endregion
diff --git a/src/vs/workbench/contrib/files/browser/fileActions.ts b/src/vs/workbench/contrib/files/browser/fileActions.ts
@@ -60,6 +60,7 @@ import { KeyChord, KeyCode, KeyMod } from '../../../../base/common/keyCodes.js';
 import { Categories } from '../../../../platform/action/common/actionCommonCategories.js';
 import { ILocalizedString } from '../../../../platform/action/common/action.js';
 import { VSBuffer } from '../../../../base/common/buffer.js';
+import { getPathForFile } from '../../../../platform/dnd/browser/dnd.js';
 
 export const NEW_FILE_COMMAND_ID = 'explorer.newFile';
 export const NEW_FILE_LABEL = nls.localize2('newFile', "New File...");
@@ -1128,7 +1129,7 @@ export const pasteFileHandler = async (accessor: ServicesAccessor, fileList?: Fi
 			}
 
 			if (toPaste.type === 'paths') {
-				const path = hostService.getPathForFile(item);
+				const path = getPathForFile(item);
 				if (path) {
 					return path;
 				}
@@ -1287,13 +1288,13 @@ type FilesToPaste =
 async function getFilesToPaste(fileList: FileList | undefined, clipboardService: IClipboardService, hostService: IHostService): Promise<FilesToPaste> {
 	if (fileList && fileList.length > 0) {
 		// with a `fileList` we support natively pasting file from disk from clipboard
-		const resources = [...fileList].map(file => hostService.getPathForFile(file)).filter(filePath => !!filePath && isAbsolute(filePath)).map((filePath) => URI.file(filePath!));
+		const resources = [...fileList].map(file => getPathForFile(file)).filter(filePath => !!filePath && isAbsolute(filePath)).map((filePath) => URI.file(filePath!));
 		if (resources.length) {
 			return { type: 'paths', files: resources, };
 		}
 
 		// Support pasting files that we can't read from disk
-		return { type: 'data', files: [...fileList].filter(file => !hostService.getPathForFile(file)) };
+		return { type: 'data', files: [...fileList].filter(file => !getPathForFile(file)) };
 	} else {
 		// otherwise we fallback to reading resources from our clipboard service
 		return { type: 'paths', files: resources.distinctParents(await clipboardService.readResources(), resource => resource) };
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts b/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts
@@ -30,7 +30,7 @@ import { AccessibilitySignal, IAccessibilitySignalService } from '../../../../pl
 import { ICommandService } from '../../../../platform/commands/common/commands.js';
 import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
 import { IContextKey, IContextKeyService } from '../../../../platform/contextkey/common/contextkey.js';
-import { CodeDataTransfers, containsDragType } from '../../../../platform/dnd/browser/dnd.js';
+import { CodeDataTransfers, containsDragType, getPathForFile } from '../../../../platform/dnd/browser/dnd.js';
 import { FileSystemProviderCapabilities, IFileService } from '../../../../platform/files/common/files.js';
 import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
 import { ServiceCollection } from '../../../../platform/instantiation/common/serviceCollection.js';
@@ -84,7 +84,6 @@ import type { IMarker, Terminal as XTermTerminal } from '@xterm/xterm';
 import { AccessibilityCommandId } from '../../accessibility/common/accessibilityCommands.js';
 import { terminalStrings } from '../common/terminalStrings.js';
 import { TerminalIconPicker } from './terminalIconPicker.js';
-import { IHostService } from '../../../services/host/browser/host.js';
 import { TerminalResizeDebouncer } from './terminalResizeDebouncer.js';
 import { openContextMenu } from './terminalContextMenu.js';
 import type { IMenu } from '../../../../platform/actions/common/actions.js';
@@ -2312,7 +2311,6 @@ class TerminalInstanceDragAndDropController extends Disposable implements dom.ID
 		private readonly _container: HTMLElement,
 		@IWorkbenchLayoutService private readonly _layoutService: IWorkbenchLayoutService,
 		@IViewDescriptorService private readonly _viewDescriptorService: IViewDescriptorService,
-		@IHostService private readonly _hostService: IHostService,
 	) {
 		super();
 		this._register(toDisposable(() => this._clearDropOverlay()));
@@ -2395,9 +2393,9 @@ class TerminalInstanceDragAndDropController extends Disposable implements dom.ID
 			path = URI.file(JSON.parse(rawCodeFiles)[0]);
 		}
 
-		if (!path && e.dataTransfer.files.length > 0 && this._hostService.getPathForFile(e.dataTransfer.files[0])) {
+		if (!path && e.dataTransfer.files.length > 0 && getPathForFile(e.dataTransfer.files[0])) {
 			// Check if the file was dragged from the filesystem
-			path = URI.file(this._hostService.getPathForFile(e.dataTransfer.files[0])!);
+			path = URI.file(getPathForFile(e.dataTransfer.files[0])!);
 		}
 
 		if (!path) {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalTabsList.ts b/src/vs/workbench/contrib/terminal/browser/terminalTabsList.ts
@@ -38,7 +38,7 @@ import { InputBox, MessageType } from '../../../../base/browser/ui/inputbox/inpu
 import { createSingleCallFunction } from '../../../../base/common/functional.js';
 import { IKeyboardEvent } from '../../../../base/browser/keyboardEvent.js';
 import { KeyCode } from '../../../../base/common/keyCodes.js';
-import { CodeDataTransfers, containsDragType } from '../../../../platform/dnd/browser/dnd.js';
+import { CodeDataTransfers, containsDragType, getPathForFile } from '../../../../platform/dnd/browser/dnd.js';
 import { terminalStrings } from '../common/terminalStrings.js';
 import { ILifecycleService } from '../../../services/lifecycle/common/lifecycle.js';
 import { IProcessDetails } from '../../../../platform/terminal/common/terminalProcess.js';
@@ -51,7 +51,6 @@ import { Schemas } from '../../../../base/common/network.js';
 import { getColorForSeverity } from './terminalStatusList.js';
 import { TerminalContextActionRunner } from './terminalContextMenu.js';
 import type { IHoverAction } from '../../../../base/browser/ui/hover/hover.js';
-import { IHostService } from '../../../services/host/browser/host.js';
 import { HoverPosition } from '../../../../base/browser/ui/hover/hoverWidget.js';
 
 const $ = DOM.$;
@@ -587,7 +586,6 @@ class TerminalTabsDragAndDrop extends Disposable implements IListDragAndDrop<ITe
 	constructor(
 		@ITerminalService private readonly _terminalService: ITerminalService,
 		@ITerminalGroupService private readonly _terminalGroupService: ITerminalGroupService,
-		@IHostService private readonly _hostService: IHostService,
 		@IListService private readonly _listService: IListService,
 	) {
 		super();
@@ -753,9 +751,9 @@ class TerminalTabsDragAndDrop extends Disposable implements IListDragAndDrop<ITe
 			resource = URI.file(JSON.parse(rawCodeFiles)[0]);
 		}
 
-		if (!resource && e.dataTransfer.files.length > 0 && this._hostService.getPathForFile(e.dataTransfer.files[0])) {
+		if (!resource && e.dataTransfer.files.length > 0 && getPathForFile(e.dataTransfer.files[0])) {
 			// Check if the file was dragged from the filesystem
-			resource = URI.file(this._hostService.getPathForFile(e.dataTransfer.files[0])!);
+			resource = URI.file(getPathForFile(e.dataTransfer.files[0])!);
 		}
 
 		if (!resource) {
diff --git a/src/vs/workbench/services/host/browser/browserHostService.ts b/src/vs/workbench/services/host/browser/browserHostService.ts
@@ -574,13 +574,6 @@ export class BrowserHostService extends Disposable implements IHostService {
 
 	//#endregion
 
-	//#region File
-
-	getPathForFile(): undefined {
-		return undefined; // unsupported in browser environments
-	}
-
-	//#endregion
 }
 
 registerSingleton(IHostService, BrowserHostService, InstantiationType.Delayed);
diff --git a/src/vs/workbench/services/host/browser/host.ts b/src/vs/workbench/services/host/browser/host.ts
@@ -122,9 +122,4 @@ export interface IHostService {
 
 	//#endregion
 
-	//#region File
-
-	getPathForFile(file: File): string | undefined;
-
-	//#endregion
 }
diff --git a/src/vs/workbench/services/host/electron-sandbox/nativeHostService.ts b/src/vs/workbench/services/host/electron-sandbox/nativeHostService.ts
@@ -17,7 +17,6 @@ import { IMainProcessService } from '../../../../platform/ipc/common/mainProcess
 import { disposableWindowInterval, getActiveDocument, getWindowId, getWindowsCount, hasWindow, onDidRegisterWindow } from '../../../../base/browser/dom.js';
 import { memoize } from '../../../../base/common/decorators.js';
 import { isAuxiliaryWindow } from '../../../../base/browser/window.js';
-import { webUtils } from '../../../../base/parts/sandbox/electron-sandbox/globals.js';
 
 class WorkbenchNativeHostService extends NativeHostService {
 
@@ -187,14 +186,6 @@ class WorkbenchHostService extends Disposable implements IHostService {
 
 	//#endregion
 
-	//#region File
-
-	getPathForFile(file: File): string {
-		return webUtils.getPathForFile(file);
-	}
-
-	//#endregion
-
 }
 
 registerSingleton(IHostService, WorkbenchHostService, InstantiationType.Delayed);
diff --git a/src/vs/workbench/test/browser/workbenchTestServices.ts b/src/vs/workbench/test/browser/workbenchTestServices.ts
@@ -1563,10 +1563,6 @@ export class TestHostService implements IHostService {
 
 	readonly colorScheme = ColorScheme.DARK;
 	onDidChangeColorScheme = Event.None;
-
-	getPathForFile(file: File): string | undefined {
-		return undefined;
-	}
 }
 
 export class TestFilesConfigurationService extends FilesConfigurationService {

Original file line number	Diff line number	Diff line change
`@@ -122,9 +122,4 @@ export interface IHostService {`
`122`	`122`
`123`	`123`	`//#endregion`
`124`	`124`
`125`		`- //#region File`
`126`		`-`
`127`		`- getPathForFile(file: File): string \| undefined;`
`128`		`-`
`129`		`- //#endregion`
`130`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1563,10 +1563,6 @@ export class TestHostService implements IHostService {`
`1563`	`1563`
`1564`	`1564`	`readonly colorScheme = ColorScheme.DARK;`
`1565`	`1565`	`onDidChangeColorScheme = Event.None;`
`1566`		`-`
`1567`		`- getPathForFile(file: File): string \| undefined {`
`1568`		`- return undefined;`
`1569`		`- }`
`1570`	`1566`	`}`
`1571`	`1567`
`1572`	`1568`	`export class TestFilesConfigurationService extends FilesConfigurationService {`