Skip to content

fix: throttle the collection write requests #249903

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

Closed
wants to merge 3 commits into from
Closed

fix: throttle the collection write requests #249903

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25e812f
fix: throttle the collection write requests
rzhao271 Jun 20, 2025
2712169
Throttle within the write functions
rzhao271 Jun 20, 2025
705a6e2
polish comment
rzhao271 Jun 20, 2025
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
16 changes: 14 additions & 2 deletions src/vs/platform/userDataSync/common/userDataSyncStoreService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import { CancelablePromise, createCancelablePromise, timeout } from '../../../base/common/async.js';
import { VSBufferReadableStream } from '../../../base/common/buffer.js';
import { CancellationToken } from '../../../base/common/cancellation.js';
import { getErrorMessage, isCancellationError } from '../../../base/common/errors.js';
import { Emitter, Event } from '../../../base/common/event.js';
Expand All @@ -18,13 +19,12 @@ import { generateUuid } from '../../../base/common/uuid.js';
import { IHeaders, IRequestContext, IRequestOptions } from '../../../base/parts/request/common/request.js';
import { IConfigurationService } from '../../configuration/common/configuration.js';
import { IEnvironmentService } from '../../environment/common/environment.js';
import { getServiceMachineId } from '../../externalServices/common/serviceMachineId.js';
import { IFileService } from '../../files/common/files.js';
import { IProductService } from '../../product/common/productService.js';
import { asJson, asText, asTextOrError, hasNoContent, IRequestService, isSuccess, isSuccess as isSuccessContext } from '../../request/common/request.js';
import { getServiceMachineId } from '../../externalServices/common/serviceMachineId.js';
import { IStorageService, StorageScope, StorageTarget } from '../../storage/common/storage.js';
import { HEADER_EXECUTION_ID, HEADER_OPERATION_ID, IAuthenticationProvider, IResourceRefHandle, IUserData, IUserDataManifest, IUserDataSyncLogService, IUserDataSyncStore, IUserDataSyncStoreManagementService, IUserDataSyncStoreService, ServerResource, SYNC_SERVICE_URL_TYPE, UserDataSyncErrorCode, UserDataSyncStoreError, UserDataSyncStoreType } from './userDataSync.js';
import { VSBufferReadableStream } from '../../../base/common/buffer.js';

const CONFIGURATION_SYNC_STORE_KEY = 'configurationSync.store';
const SYNC_PREVIOUS_STORE = 'sync.previous.store';
Expand Down Expand Up @@ -263,6 +263,7 @@ export class UserDataSyncStoreClient extends Disposable {
if (!collectionId) {
throw new UserDataSyncStoreError('Server did not return the collection id', url, UserDataSyncErrorCode.NoCollection, context.res.statusCode, context.res.headers[HEADER_OPERATION_ID]);
}
await this.throttleUpdate();
return collectionId;
}

Expand All @@ -275,6 +276,17 @@ export class UserDataSyncStoreClient extends Disposable {
headers = { ...headers };

await this.request(url, { type: 'DELETE', headers }, [], CancellationToken.None);
await this.throttleUpdate();
}

/**
* This is a helper function to avoid write conflicts in Cosmos DB.
* Session tokens in Cosmos DB seem to include a timestamp in seconds.
* Writing multiple collections under the same timestamp results in a case where only the last collection seems to be written successfully.
* This function acts as a throttle by forcing the client to wait for around a second before continuing.
*/
private async throttleUpdate(): Promise<void> {
await timeout(1000);
}

// #endregion
Expand Down
Loading