Debt - Add execution id to edit session request headers (microsoft#154575)

Add execution id to edit session request headers

Author: joyceerhl

src/vs/platform/userDataSync/common/userDataSync.ts

@@ -184,7 +184,7 @@ export interface IUserDataSyncStoreClient {
 	delete(resource: ServerResource, ref: string | null): Promise<void>;
 
 	getAllRefs(resource: ServerResource): Promise<IResourceRefHandle[]>;
-	resolveContent(resource: ServerResource, ref: string): Promise<string | null>;
+	resolveContent(resource: ServerResource, ref: string, headers?: IHeaders): Promise<string | null>;
 }
 
 export const IUserDataSyncStoreService = createDecorator<IUserDataSyncStoreService>('IUserDataSyncStoreService');

src/vs/platform/userDataSync/common/userDataSyncStoreService.ts

@@ -244,13 +244,13 @@ export class UserDataSyncStoreClient extends Disposable implements IUserDataSync
 		return result.map(({ url, created }) => ({ ref: relativePath(uri, uri.with({ path: url }))!, created: created * 1000 /* Server returns in seconds */ }));
 	}
 
-	async resolveContent(resource: ServerResource, ref: string): Promise<string | null> {
+	async resolveContent(resource: ServerResource, ref: string, headers: IHeaders = {}): Promise<string | null> {
 		if (!this.userDataSyncStoreUrl) {
 			throw new Error('No settings sync store url configured.');
 		}
 
 		const url = joinPath(this.userDataSyncStoreUrl, 'resource', resource, ref).toString();
-		const headers: IHeaders = {};
+		headers = { ...headers };
 		headers['Cache-Control'] = 'no-cache';
 
 		const context = await this.request(url, { type: 'GET', headers }, [], CancellationToken.None);

src/vs/workbench/contrib/editSessions/browser/editSessions.contribution.ts

@@ -85,7 +85,7 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 		super();
 
 		if (this.environmentService.editSessionId !== undefined) {
-			void this.applyEditSession(this.environmentService.editSessionId).finally(() => this.environmentService.editSessionId = undefined);
+			void this.resumeEditSession(this.environmentService.editSessionId).finally(() => this.environmentService.editSessionId = undefined);
 		}
 
 		this.configurationService.onDidChangeConfiguration((e) => {
@@ -132,7 +132,7 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 
 		this.registerContinueEditSessionAction();
 
-		this.registerApplyLatestEditSessionAction();
+		this.registerResumeLatestEditSessionAction();
 		this.registerStoreLatestEditSessionAction();
 
 		this.registerContinueInLocalFolderAction();
@@ -171,9 +171,9 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 		}));
 	}
 
-	private registerApplyLatestEditSessionAction(): void {
+	private registerResumeLatestEditSessionAction(): void {
 		const that = this;
-		this._register(registerAction2(class ApplyLatestEditSessionAction extends Action2 {
+		this._register(registerAction2(class ResumeLatestEditSessionAction extends Action2 {
 			constructor() {
 				super({
 					id: 'workbench.experimental.editSessions.actions.resumeLatest',
@@ -186,8 +186,8 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 			async run(accessor: ServicesAccessor): Promise<void> {
 				await that.progressService.withProgress({
 					location: ProgressLocation.Notification,
-					title: localize('applying edit session', 'Applying edit session...')
-				}, async () => await that.applyEditSession());
+					title: localize('resuming edit session', 'Resuming edit session...')
+				}, async () => await that.resumeEditSession());
 			}
 		}));
 	}
@@ -213,26 +213,24 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 		}));
 	}
 
-	async applyEditSession(ref?: string): Promise<void> {
-		if (ref !== undefined) {
-			this.logService.info(`Applying edit session with ref ${ref}.`);
-		}
+	async resumeEditSession(ref?: string): Promise<void> {
+		this.logService.info(ref !== undefined ? `Resuming edit session with ref ${ref}...` : 'Resuming edit session...');
 
 		const data = await this.editSessionsWorkbenchService.read(ref);
 		if (!data) {
 			if (ref === undefined) {
-				this.notificationService.info(localize('no edit session', 'There are no edit sessions to apply.'));
+				this.notificationService.info(localize('no edit session', 'There are no edit sessions to resume.'));
 			} else {
-				this.notificationService.warn(localize('no edit session content for ref', 'Could not apply edit session contents for ID {0}.', ref));
+				this.notificationService.warn(localize('no edit session content for ref', 'Could not resume edit session contents for ID {0}.', ref));
 			}
-			this.logService.info(`Aborting applying edit session as no edit session content is available to be applied from ref ${ref}.`);
+			this.logService.info(`Aborting resuming edit session as no edit session content is available to be applied from ref ${ref}.`);
 			return;
 		}
 		const editSession = data.editSession;
 		ref = data.ref;
 
 		if (editSession.version > EditSessionSchemaVersion) {
-			this.notificationService.error(localize('client too old', "Please upgrade to a newer version of {0} to apply this edit session.", this.productService.nameLong));
+			this.notificationService.error(localize('client too old', "Please upgrade to a newer version of {0} to resume this edit session.", this.productService.nameLong));
 			return;
 		}
 
@@ -266,7 +264,7 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 			if (hasLocalUncommittedChanges) {
 				// TODO@joyceerhl Provide the option to diff files which would be overwritten by edit session contents
 				const result = await this.dialogService.confirm({
-					message: localize('apply edit session warning', 'Applying your edit session may overwrite your existing uncommitted changes. Do you want to proceed?'),
+					message: localize('resume edit session warning', 'Resuming your edit session may overwrite your existing uncommitted changes. Do you want to proceed?'),
 					type: 'warning',
 					title: EDIT_SESSION_SYNC_CATEGORY.value
 				});
@@ -287,8 +285,8 @@ export class EditSessionsContribution extends Disposable implements IWorkbenchCo
 			await this.editSessionsWorkbenchService.delete(ref);
 			this.logService.info(`Deleted edit session with ref ${ref}.`);
 		} catch (ex) {
-			this.logService.error('Failed to apply edit session, reason: ', (ex as Error).toString());
-			this.notificationService.error(localize('apply failed', "Failed to apply your edit session."));
+			this.logService.error('Failed to resume edit session, reason: ', (ex as Error).toString());
+			this.notificationService.error(localize('resume failed', "Failed to resume your edit session."));
 		}
 	}
 

src/vs/workbench/contrib/editSessions/browser/editSessionsWorkbenchService.ts

@@ -14,11 +14,12 @@ import { IProductService } from 'vs/platform/product/common/productService';
 import { IQuickInputService, IQuickPickItem, IQuickPickSeparator } from 'vs/platform/quickinput/common/quickInput';
 import { IRequestService } from 'vs/platform/request/common/request';
 import { IStorageService, IStorageValueChangeEvent, StorageScope, StorageTarget } from 'vs/platform/storage/common/storage';
-import { IAuthenticationProvider } from 'vs/platform/userDataSync/common/userDataSync';
+import { createSyncHeaders, IAuthenticationProvider } from 'vs/platform/userDataSync/common/userDataSync';
 import { UserDataSyncStoreClient } from 'vs/platform/userDataSync/common/userDataSyncStoreService';
 import { AuthenticationSession, AuthenticationSessionsChangeEvent, IAuthenticationService } from 'vs/workbench/services/authentication/common/authentication';
 import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
 import { EDIT_SESSIONS_SIGNED_IN, EditSession, EDIT_SESSION_SYNC_CATEGORY, IEditSessionsWorkbenchService, EDIT_SESSIONS_SIGNED_IN_KEY, IEditSessionsLogService } from 'vs/workbench/contrib/editSessions/common/editSessions';
+import { generateUuid } from 'vs/base/common/uuid';
 
 type ExistingSession = IQuickPickItem & { session: AuthenticationSession & { providerId: string } };
 type AuthenticationProviderOption = IQuickPickItem & { provider: IAuthenticationProvider };
@@ -73,7 +74,7 @@ export class EditSessionsWorkbenchService extends Disposable implements IEditSes
 			throw new Error('Please sign in to store your edit session.');
 		}
 
-		return this.storeClient!.write('editSessions', JSON.stringify(editSession), null);
+		return this.storeClient!.write('editSessions', JSON.stringify(editSession), null, createSyncHeaders(generateUuid()));
 	}
 
 	/**
@@ -89,11 +90,12 @@ export class EditSessionsWorkbenchService extends Disposable implements IEditSes
 		}
 
 		let content: string | undefined | null;
+		const headers = createSyncHeaders(generateUuid());
 		try {
 			if (ref !== undefined) {
-				content = await this.storeClient?.resolveContent('editSessions', ref);
+				content = await this.storeClient?.resolveContent('editSessions', ref, headers);
 			} else {
-				const result = await this.storeClient?.read('editSessions', null);
+				const result = await this.storeClient?.read('editSessions', null, headers);
 				content = result?.content;
 				ref = result?.ref;
 			}

src/vs/workbench/contrib/editSessions/test/browser/editSessions.test.ts

@@ -112,8 +112,8 @@ suite('Edit session sync', () => {
 		// Create root folder
 		await fileService.createFolder(folderUri);
 
-		// Apply edit session
-		await editSessionsContribution.applyEditSession();
+		// Resume edit session
+		await editSessionsContribution.resumeEditSession();
 
 		// Verify edit session was correctly applied
 		assert.equal((await fileService.readFile(fileUri)).value.toString(), fileContents);