Skip to content

Debt - do not expose an unregister method from service #158641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joyceerhl merged 2 commits into from
Aug 30, 2022
Merged

Debt - do not expose an unregister method from service #158641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23b58fb
Debt - do not expose an unregister method from service
joyceerhl Aug 29, 2022
c9b3fdd
Add registration disposable to disposable store
joyceerhl Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/vs/platform/workspace/common/editSessions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
import { IDisposable } from 'vs/base/common/lifecycle';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';

Expand All @@ -17,7 +18,6 @@ export const IEditSessionIdentityService = createDecorator<IEditSessionIdentityS
export interface IEditSessionIdentityService {
readonly _serviceBrand: undefined;

registerEditSessionIdentityProvider(provider: IEditSessionIdentityProvider): void;
unregisterEditSessionIdentityProvider(scheme: string): void;
registerEditSessionIdentityProvider(provider: IEditSessionIdentityProvider): IDisposable;
getEditSessionIdentifier(workspaceFolder: IWorkspaceFolder, cancellationTokenSource: CancellationTokenSource): Promise<string | undefined>;
}
17 changes: 12 additions & 5 deletions src/vs/workbench/api/browser/mainThreadWorkspace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
import { isCancellationError } from 'vs/base/common/errors';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { DisposableStore, IDisposable } from 'vs/base/common/lifecycle';
import { isNative } from 'vs/base/common/platform';
import { withNullAsUndefined } from 'vs/base/common/types';
import { URI, UriComponents } from 'vs/base/common/uri';
Expand Down Expand Up @@ -224,16 +224,23 @@ export class MainThreadWorkspace implements MainThreadWorkspaceShape {
}

// --- edit sessions ---
$registerEditSessionIdentityProvider(scheme: string) {
this._editSessionIdentityService.registerEditSessionIdentityProvider({
private registeredEditSessionProviders = new Map<number, IDisposable>();

$registerEditSessionIdentityProvider(handle: number, scheme: string) {
const disposable = this._editSessionIdentityService.registerEditSessionIdentityProvider({
scheme: scheme,
getEditSessionIdentifier: async (workspaceFolder: WorkspaceFolder, token: CancellationToken) => {
return this._proxy.$getEditSessionIdentifier(workspaceFolder.uri, token);
}
});

this.registeredEditSessionProviders.set(handle, disposable);
this._toDispose.add(disposable);
}

$unregisterEditSessionIdentityProvider(scheme: string) {
this._editSessionIdentityService.unregisterEditSessionIdentityProvider(scheme);
$unregisterEditSessionIdentityProvider(handle: number) {
const disposable = this.registeredEditSessionProviders.get(handle);
disposable?.dispose();
this.registeredEditSessionProviders.delete(handle);
}
}
4 changes: 2 additions & 2 deletions src/vs/workbench/api/common/extHost.protocol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1085,8 +1085,8 @@ export interface MainThreadWorkspaceShape extends IDisposable {
$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents; name?: string }[]): Promise<void>;
$resolveProxy(url: string): Promise<string | undefined>;
$requestWorkspaceTrust(options?: WorkspaceTrustRequestOptions): Promise<boolean | undefined>;
$registerEditSessionIdentityProvider(scheme: string): void;
$unregisterEditSessionIdentityProvider(scheme: string): void;
$registerEditSessionIdentityProvider(handle: number, scheme: string): void;
$unregisterEditSessionIdentityProvider(handle: number): void;
}

export interface IFileChangeDto {
Expand Down
7 changes: 5 additions & 2 deletions src/vs/workbench/api/common/extHostWorkspace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,8 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspac

// --- edit sessions ---

private _providerHandlePool = 0;

// called by ext host
registerEditSessionIdentityProvider(scheme: string, provider: vscode.EditSessionIdentityProvider) {
if (this._editSessionIdentityProviders.has(scheme)) {
Expand All @@ -591,11 +593,12 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspac

this._editSessionIdentityProviders.set(scheme, provider);
const outgoingScheme = this._uriTransformerService.transformOutgoingScheme(scheme);
this._proxy.$registerEditSessionIdentityProvider(outgoingScheme);
const handle = this._providerHandlePool++;
this._proxy.$registerEditSessionIdentityProvider(handle, outgoingScheme);

return toDisposable(() => {
this._editSessionIdentityProviders.delete(scheme);
this._proxy.$unregisterEditSessionIdentityProvider(outgoingScheme);
this._proxy.$unregisterEditSessionIdentityProvider(handle);
});
}

Expand Down
10 changes: 5 additions & 5 deletions src/vs/workbench/services/workspaces/common/editSessionIdentityService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import { CancellationTokenSource } from 'vs/base/common/cancellation';
import { IDisposable, toDisposable } from 'vs/base/common/lifecycle';
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { ILogService } from 'vs/platform/log/common/log';
import { IEditSessionIdentityProvider, IEditSessionIdentityService } from 'vs/platform/workspace/common/editSessions';
Expand All @@ -20,16 +21,15 @@ export class EditSessionIdentityService implements IEditSessionIdentityService {
@ILogService private readonly _logService: ILogService,
) { }

registerEditSessionIdentityProvider(provider: IEditSessionIdentityProvider): void {
registerEditSessionIdentityProvider(provider: IEditSessionIdentityProvider): IDisposable {
if (this._editSessionIdentifierProviders.get(provider.scheme)) {
throw new Error(`A provider has already been registered for scheme ${provider.scheme}`);
}

this._editSessionIdentifierProviders.set(provider.scheme, provider);
}

unregisterEditSessionIdentityProvider(scheme: string): void {
this._editSessionIdentifierProviders.delete(scheme);
return toDisposable(() => {
this._editSessionIdentifierProviders.delete(provider.scheme);
});
}

async getEditSessionIdentifier(workspaceFolder: IWorkspaceFolder, cancellationTokenSource: CancellationTokenSource): Promise<string | undefined> {
Expand Down