feat: prevent accidentally opening binary file (#3772)

Author: bytemain

packages/ai-native/src/browser/widget/light-bulb/index.ts

@@ -1,6 +1,5 @@
 import { asClassNameArrayWrapper } from '@opensumi/ide-core-browser';
-import { Sumicon } from '@opensumi/ide-core-common/lib/codicons';
-import { Codicon } from '@opensumi/monaco-editor-core/esm/vs/base/common/codicons';
+import { Codicon, Sumicon } from '@opensumi/ide-core-common/lib/codicons';
 import { ThemeIcon } from '@opensumi/monaco-editor-core/esm/vs/base/common/themables';
 import {
   LightBulbState,

packages/debug/__tests__/browser/view/configuration/debug-configuration.service.test.ts

@@ -1,7 +1,6 @@
 import { PreferenceService } from '@opensumi/ide-core-browser';
 import { Disposable, EventBusImpl, IEventBus, StorageProvider, URI } from '@opensumi/ide-core-common';
-import { IDebugSessionManager } from '@opensumi/ide-debug';
-import { DEFAULT_CONFIGURATION_NAME_SEPARATOR } from '@opensumi/ide-debug';
+import { DEFAULT_CONFIGURATION_NAME_SEPARATOR, IDebugSessionManager } from '@opensumi/ide-debug';
 import { DebugConfigurationManager } from '@opensumi/ide-debug/lib/browser/debug-configuration-manager';
 import { DebugConfigurationService } from '@opensumi/ide-debug/lib/browser/view/configuration/debug-configuration.service';
 import { DebugConsoleService } from '@opensumi/ide-debug/lib/browser/view/console/debug-console.service';
@@ -64,6 +63,7 @@ describe('Debug Configuration Service', () => {
   const mockPreferenceService = {
     onPreferenceChanged: jest.fn(),
     get: jest.fn(() => true),
+    getValid: jest.fn(() => true),
   };
 
   const mockDebugConsoleService = {

packages/editor/src/browser/component.ts

@@ -108,7 +108,7 @@ export class EditorComponentRegistryImpl implements EditorComponentRegistry {
     let results: IEditorOpenType[] = [];
     const resolvers = this.getResolvers(resource.uri.scheme).slice(); // 防止异步操作时数组被改变
     let shouldBreak = false;
-    const resolve = (res) => {
+    const resolve = (res: IEditorOpenType[]) => {
       results = res;
       shouldBreak = true;
     };

packages/editor/src/browser/fs-resource/fs-editor-doc.ts

@@ -110,7 +110,10 @@ export class BaseFileSystemEditorDocumentProvider implements IEditorDocumentMode
         uri.toString(),
         getLanguageIdFromMonaco(uri)!,
       );
+
+    // TODO: 应该挪到后端去做
     const detected = await detectEncodingFromBuffer(buffer, guessEncoding);
+
     detected.encoding = await this.getReadEncoding(uri, options, detected.encoding);
 
     const content = buffer.toString(detected.encoding);
@@ -132,6 +135,7 @@ export class BaseFileSystemEditorDocumentProvider implements IEditorDocumentMode
     // TODO: 这部分要优化成buffer获取（长期来看是stream获取，encoding在哪一层做？）
     // 暂时还是使用 resolveContent 内提供的 decode 功能
     // 之后 encoding 做了分层之后和其他的需要 decode 的地方一起改
+
     return (await this.read(uri, { encoding })).content;
   }
 

packages/editor/src/browser/fs-resource/fs-resource.ts

@@ -129,7 +129,6 @@ export class FileSystemResourceProvider extends WithEventBus implements IResourc
   }
 
   async provideResource(uri: URI): Promise<IResource<any>> {
-    // 获取文件类型 getFileType: (path: string) => string
     await this.ready;
     this.involvedFiles.add(uri.codeUri.fsPath);
     return Promise.all([

packages/editor/src/browser/preference/schema.ts

@@ -1631,7 +1631,7 @@ const customEditorSchema: PreferenceSchemaProperties = {
   },
   'editor.largeFile': {
     type: 'number',
-    default: 4 * 1024 * 1024 * 1024,
+    default: 4 * 1024 * 1024 * 1024, // 4096 MB
     description: '%editor.configuration.largeFileSize%',
   },
   'editor.quickSuggestionsDelay': {

packages/editor/src/browser/types.ts

@@ -114,13 +114,10 @@ export class RegisterEditorComponentEvent extends BasicEvent<string> {}
 export abstract class EditorComponentRegistry {
   abstract registerEditorComponent<T>(component: IEditorComponent<T>, initialProps?: any): IDisposable;
 
-  // 等同于 handlesScheme => 10
-  abstract registerEditorComponentResolver<T>(scheme: string, resolver: IEditorComponentResolver<T>): IDisposable;
-
-  // handlesScheme 返回权重， 小于 0 表示不处理
   abstract registerEditorComponentResolver<T>(
-    // eslint-disable-next-line @typescript-eslint/unified-signatures
-    handlesScheme: (scheme: string) => number,
+    handlesScheme:
+      | string // 等同于 handlesScheme => 10
+      | ((scheme: string) => number), // handlesScheme 返回权重， 小于 0 表示不处理
     resolver: IEditorComponentResolver<T>,
   ): IDisposable;
 

packages/extension/src/browser/vscode/api/main.thread.doc.ts

@@ -116,7 +116,7 @@ export class MainThreadExtensionDocumentData extends WithEventBus implements IMa
         this.docSyncEnabled.set(
           uriString,
           docRef.instance.getMonacoModel().getValueLength() <
-            (this.preference.get<number>('editor.docExtHostSyncMaxSize') || 4 * 1024 * 1024 * 1024),
+            this.preference.getValid<number>('editor.docExtHostSyncMaxSize', 4 * 1024 * 1024 * 1024),
         );
         docRef.dispose();
       }

packages/file-scheme/__tests__/browser/contribution.test.ts

@@ -1,4 +1,6 @@
 import { PreferenceService, URI } from '@opensumi/ide-core-browser';
+import { createBrowserInjector } from '@opensumi/ide-dev-tool/src/injector-helper';
+import { MockInjector } from '@opensumi/ide-dev-tool/src/mock-injector';
 import {
   BrowserEditorContribution,
   EditorComponentRegistry,
@@ -12,9 +14,6 @@ import { IFileServiceClient } from '@opensumi/ide-file-service';
 import { ILanguageService } from '@opensumi/monaco-editor-core/esm/vs/editor/common/languages/language';
 import { StandaloneServices } from '@opensumi/monaco-editor-core/esm/vs/editor/standalone/browser/standaloneServices';
 
-import { createBrowserInjector } from '../../../../tools/dev-tool/src/injector-helper';
-import { MockInjector } from '../../../../tools/dev-tool/src/mock-injector';
-
 const createMockResource = (uriString: string) => ({ uri: new URI(uriString) } as any as IResource);
 
 const mockFileService = {
@@ -27,6 +26,7 @@ const mockFileService = {
 const mockPreferenceService = {
   onPreferenceChanged: jest.fn(),
   get: jest.fn(() => undefined),
+  getValid: jest.fn((_, defaultValue) => defaultValue),
   ready: Promise.resolve(),
 };
 

packages/file-scheme/src/browser/external.view.tsx

@@ -1,23 +1,47 @@
 import React from 'react';
 
 import { INJECTOR_TOKEN, Injector } from '@opensumi/di';
-import { AppConfig, localize, useInjectable } from '@opensumi/ide-core-browser';
+import { AppConfig, IEventBus, localize, useInjectable } from '@opensumi/ide-core-browser';
 import { IElectronMainUIService } from '@opensumi/ide-core-common/lib/electron';
-import { ReactEditorComponent } from '@opensumi/ide-editor/lib/browser';
+import {
+  ReactEditorComponent,
+  ResourceOpenTypeChangedEvent,
+  WorkbenchEditorService,
+} from '@opensumi/ide-editor/lib/browser';
 
-import styles from './style.module.less';
+import { PreventComponent } from './prevent.view';
 
 export const BinaryEditorComponent: ReactEditorComponent<null> = (props) => {
   const srcPath = props.resource.uri.codeUri.fsPath;
   const injector: Injector = useInjectable(INJECTOR_TOKEN);
   const appConfig: AppConfig = useInjectable(AppConfig);
+  const editorService = useInjectable<WorkbenchEditorService>(WorkbenchEditorService);
+  const eventBus = useInjectable<IEventBus>(IEventBus);
 
-  return (
-    <div className={styles.external}>
-      {localize('editor.cannotOpenBinary')}
-      {appConfig.isElectronRenderer ? (
-        <a onClick={() => injector.get(IElectronMainUIService).openPath(srcPath)}>{localize('editor.openExternal')}</a>
-      ) : null}
-    </div>
-  );
+  const handleClick = () => {
+    const current = editorService.currentResource;
+
+    if (!current) {
+      return;
+    }
+
+    current.metadata = { ...current.metadata, skipPreventBinary: true };
+    eventBus.fire(new ResourceOpenTypeChangedEvent(current.uri));
+  };
+
+  const actions = [
+    {
+      label: localize('editor.file.prevent.stillOpen'),
+      onClick: () => handleClick(),
+    },
+  ];
+
+  if (appConfig.isElectronRenderer) {
+    actions.push({
+      label: localize('editor.openExternal'),
+      onClick: () => injector.get(IElectronMainUIService).openPath(srcPath),
+    });
+  }
+
+  return <PreventComponent description={localize('editor.cannotOpenBinary')} actions={actions} />;
 };