[vscode] Stub for proposed API: EditSessionIdentityProvider (eclipse-…

…theia#12508) * [vscode] Stub for proposed API: EditSessionIdentityProvider EditSessionIdentityProvider is a new proposed API. As of 1.72.2 it's only used in built-in git (vscode.git). This commit adds a stub implementation, sufficient to use vscode.git 1.72.2 and hopefully later versions, if we need it to. The eventual goal is to implement this API with a working implementation. Fixes eclipse-theia#12437 Signed-off-by: Marc Dumais <[email protected]> * Update packages/plugin-ext/src/plugin/workspace.ts Co-authored-by: Vincent Fugnitto <[email protected]> --------- Signed-off-by: Marc Dumais <[email protected]> Co-authored-by: Vincent Fugnitto <[email protected]>
tsmaeder · May 23, 2023 · 10503eb · 10503eb
1 parent 603b28d
commit 10503eb
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 1 deletion.
diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts
@@ -702,6 +702,7 @@ export interface WorkspaceExt {
     $provideTextDocumentContent(uri: string): Promise<string | undefined | null>;
     $onTextSearchResult(searchRequestId: number, done: boolean, result?: SearchInWorkspaceResult): void;
     $onWorkspaceTrustChanged(trust: boolean | undefined): void;
+    $registerEditSessionIdentityProvider(scheme: string, provider: theia.EditSessionIdentityProvider): theia.Disposable
 }
 
 export interface TimelineExt {

diff --git a/packages/plugin-ext/src/plugin/plugin-context.ts b/packages/plugin-ext/src/plugin/plugin-context.ts
@@ -724,6 +724,9 @@ export function createAPIFactory(
             },
             get onDidGrantWorkspaceTrust(): theia.Event<void> {
                 return workspaceExt.onDidGrantWorkspaceTrust;
+            },
+            registerEditSessionIdentityProvider(scheme: string, provider: theia.EditSessionIdentityProvider) {
+                return workspaceExt.$registerEditSessionIdentityProvider(scheme, provider);
             }
         };
 

diff --git a/packages/plugin-ext/src/plugin/workspace.ts b/packages/plugin-ext/src/plugin/workspace.ts
@@ -34,7 +34,7 @@ import { Path } from '@theia/core/lib/common/path';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { WorkspaceRootsChangeEvent, SearchInWorkspaceResult, Range } from '../common/plugin-api-rpc-model';
 import { EditorsAndDocumentsExtImpl } from './editors-and-documents';
-import { URI } from './types-impl';
+import { Disposable, URI } from './types-impl';
 import { normalize } from '@theia/core/lib/common/paths';
 import { relative } from '../common/paths-util';
 import { Schemes } from '../common/uri-components';
@@ -449,4 +449,9 @@ export class WorkspaceExtImpl implements WorkspaceExt {
         }
     }
 
+    /** @stubbed */
+    $registerEditSessionIdentityProvider(scheme: string, provider: theia.EditSessionIdentityProvider): theia.Disposable {
+        return Disposable.NULL;
+    }
+
 }
diff --git a/packages/plugin/src/theia-proposed.d.ts b/packages/plugin/src/theia-proposed.d.ts
@@ -683,6 +683,29 @@ export module '@theia/plugin' {
         export function registerDocumentPasteEditProvider(selector: DocumentSelector, provider: DocumentPasteEditProvider, metadata: DocumentPasteProviderMetadata): Disposable;
     }
     // #endregion
+
+    // #region SessionIdentityProvider
+    export namespace workspace {
+        /**
+         *
+         * @param scheme The URI scheme that this provider can provide edit session identities for.
+         * @param provider A provider which can convert URIs for workspace folders of scheme @param scheme to
+         * an edit session identifier which is stable across machines. This enables edit sessions to be resolved.
+         */
+        export function registerEditSessionIdentityProvider(scheme: string, provider: EditSessionIdentityProvider): Disposable;
+    }
+
+    export interface EditSessionIdentityProvider {
+        /**
+         *
+         * @param workspaceFolder The workspace folder to provide an edit session identity for.
+         * @param token A cancellation token for the request.
+         * @returns An string representing the edit session identity for the requested workspace folder.
+         */
+        provideEditSessionIdentity(workspaceFolder: WorkspaceFolder, token: CancellationToken): ProviderResult<string>;
+    }
+
+    // #endregion
 }
 
 /**