Automations: migrate to provider supplied automations client side #329655
+1,173
−35
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { Sequencer } from '../../../../base/common/async.js'; | ||
| import { Disposable } from '../../../../base/common/lifecycle.js'; | ||
| import { derived, IObservable, observableSignalFromEvent } from '../../../../base/common/observable.js'; | ||
| import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js'; | ||
| import { ILogService } from '../../../../platform/log/common/log.js'; | ||
| import { IAutomation, IAutomationRun, AutomationRunTrigger } from '../../../../workbench/contrib/chat/common/automations/automation.js'; | ||
| import { AutomationMutationGuard, IAutomationRunClaim, IAutomationService, ICreateAutomationOptions, IGuardedAutomationUpdateResult, IUpdateAutomationOptions, IUpdateAutomationRunOptions } from '../../../../workbench/contrib/chat/common/automations/automationService.js'; | ||
| import { ISessionsProvidersService } from '../../../services/sessions/browser/sessionsProvidersService.js'; | ||
| import { ISessionsProviderAutomations } from '../../../services/sessions/common/sessionsProvider.js'; | ||
| import { AutomationService } from './automationService.js'; | ||
|
|
||
| interface IAutomationStoreEntry { | ||
| readonly providerId: string | undefined; | ||
| readonly store: ISessionsProviderAutomations; | ||
| } | ||
|
|
||
| export class ProviderAutomationService extends Disposable implements IAutomationService { | ||
|
|
||
| declare readonly _serviceBrand: undefined; | ||
|
|
||
| private readonly legacyStore: AutomationService; | ||
| private readonly providersChanged; | ||
| private readonly migrationSequencer = new Sequencer(); | ||
| private migrationPromise: Promise<void> = Promise.resolve(); | ||
| private readonly runsForCache = new Map<string, IObservable<readonly IAutomationRun[]>>(); | ||
|
|
||
| readonly automations: IObservable<readonly IAutomation[]>; | ||
| readonly runs: IObservable<readonly IAutomationRun[]>; | ||
|
|
||
| constructor( | ||
| @ISessionsProvidersService private readonly sessionsProvidersService: ISessionsProvidersService, | ||
| @IInstantiationService instantiationService: IInstantiationService, | ||
| @ILogService private readonly logService: ILogService, | ||
| ) { | ||
| super(); | ||
| this.legacyStore = this._register(instantiationService.createInstance(AutomationService)); | ||
| this.providersChanged = observableSignalFromEvent(this, sessionsProvidersService.onDidChangeProviders); | ||
| this.automations = derived(this, reader => { | ||
| this.providersChanged.read(reader); | ||
| return distinctById( | ||
| this.getStores().flatMap(entry => [...entry.store.automations.read(reader)]) | ||
| ).sort((a, b) => b.createdAt.localeCompare(a.createdAt)); | ||
| }); | ||
| this.runs = derived(this, reader => { | ||
| this.providersChanged.read(reader); | ||
| return distinctById( | ||
| this.getStores().flatMap(entry => [...entry.store.runs.read(reader)]) | ||
| ).sort((a, b) => b.startedAt.localeCompare(a.startedAt)); | ||
| }); | ||
| this._register(sessionsProvidersService.onDidChangeProviders(event => { | ||
| if (event.added.some(provider => provider.automations)) { | ||
|
Contributor
There was a problem hiding this comment. AI Review: Providers registered after construction only queue legacy migration. Stale-run recovery is a separate one-shot operation, so a late provider can expose persisted |
||
| this.queueMigration(); | ||
| } | ||
|
benvillalobos marked this conversation as resolved.
|
||
| })); | ||
| this.queueMigration(); | ||
| } | ||
|
|
||
| getAutomation(id: string): IAutomation | undefined { | ||
| return this.findAutomationStore(id)?.store.getAutomation(id); | ||
| } | ||
|
|
||
| runsFor(automationId: string): IObservable<readonly IAutomationRun[]> { | ||
| let result = this.runsForCache.get(automationId); | ||
| if (!result) { | ||
| result = derived(this, reader => this.runs.read(reader).filter(run => run.automationId === automationId)); | ||
| this.runsForCache.set(automationId, result); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| createAutomation(options: ICreateAutomationOptions, mutationGuard?: AutomationMutationGuard): Promise<IAutomation> { | ||
| return this.getCreationStore(options).createAutomation(options, mutationGuard); | ||
| } | ||
|
|
||
| updateAutomation(id: string, patch: IUpdateAutomationOptions): Promise<IAutomation> { | ||
| return this.requireAutomationStore(id).updateAutomation(id, patch); | ||
|
benvillalobos marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| updateAutomationIfUnchanged(id: string, patch: IUpdateAutomationOptions, expected: IAutomation, mutationGuard?: AutomationMutationGuard): Promise<IGuardedAutomationUpdateResult> { | ||
| return this.requireAutomationStore(id).updateAutomationIfUnchanged(id, patch, expected, mutationGuard); | ||
| } | ||
|
|
||
| async deleteAutomation(id: string, mutationGuard?: AutomationMutationGuard): Promise<void> { | ||
| await this.requireAutomationStore(id).deleteAutomation(id, mutationGuard); | ||
| this.runsForCache.delete(id); | ||
| } | ||
|
|
||
| recordRunStart(automationId: string, trigger: AutomationRunTrigger, leaderWindowId: number): Promise<IAutomationRunClaim> { | ||
| return this.requireAutomationStore(automationId).recordRunStart(automationId, trigger, leaderWindowId); | ||
| } | ||
|
|
||
| updateRun(runId: string, patch: IUpdateAutomationRunOptions): Promise<IAutomationRun | undefined> { | ||
| const store = this.findRunStore(runId); | ||
| return store ? store.updateRun(runId, patch) : Promise.resolve(undefined); | ||
| } | ||
|
|
||
| deleteRun(runId: string): Promise<void> { | ||
| const store = this.findRunStore(runId); | ||
| return store ? store.deleteRun(runId) : Promise.resolve(); | ||
| } | ||
|
|
||
| getActiveRunFor(automationId: string): IAutomationRun | undefined { | ||
| return this.findAutomationStore(automationId)?.store.getActiveRunFor(automationId); | ||
| } | ||
|
|
||
| async markStaleRunsFailed(reason: string): Promise<void> { | ||
| await this.migrationPromise; | ||
| const stores = this.getStores(); | ||
| const results = await Promise.allSettled(stores.map(entry => entry.store.markStaleRunsFailed(reason))); | ||
| for (let index = 0; index < results.length; index++) { | ||
| const result = results[index]; | ||
| if (result.status === 'rejected') { | ||
| const providerId = stores[index].providerId ?? 'legacy'; | ||
| this.logService.error(`[ProviderAutomationService] Failed to recover stale Automation runs for '${providerId}'.`, result.reason); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| waitForMigrationForTesting(): Promise<void> { | ||
| return this.migrationPromise; | ||
| } | ||
|
|
||
| private getStores(): IAutomationStoreEntry[] { | ||
| const providerStores = this.sessionsProvidersService.getProviders() | ||
| .filter(provider => provider.automations) | ||
| .map(provider => ({ providerId: provider.id, store: provider.automations! })); | ||
| return [...providerStores, { providerId: undefined, store: this.legacyStore }]; | ||
| } | ||
|
|
||
| private getCreationStore(options: ICreateAutomationOptions): ISessionsProviderAutomations { | ||
| const providerId = options.target.providerId; | ||
| if (providerId) { | ||
| const providerStore = this.sessionsProvidersService.getProvider(providerId)?.automations; | ||
| if (providerStore) { | ||
| return providerStore; | ||
| } | ||
| } | ||
|
|
||
| return this.legacyStore; | ||
| } | ||
|
|
||
| private findAutomationStore(id: string): IAutomationStoreEntry | undefined { | ||
| return this.getStores().find(entry => !!entry.store.getAutomation(id)); | ||
| } | ||
|
|
||
| private requireAutomationStore(id: string): ISessionsProviderAutomations { | ||
| const entry = this.findAutomationStore(id); | ||
| if (!entry) { | ||
| throw new Error(`Automation '${id}' does not exist.`); | ||
| } | ||
| return entry.store; | ||
| } | ||
|
|
||
| private findRunStore(runId: string): ISessionsProviderAutomations | undefined { | ||
| return this.getStores().find(entry => entry.store.runs.get().some(run => run.id === runId))?.store; | ||
| } | ||
|
|
||
| private queueMigration(): void { | ||
| this.migrationPromise = this.migrationSequencer.queue(() => this.migrateLegacyAutomations()).catch(error => { | ||
| this.logService.error('[ProviderAutomationService] Failed to migrate legacy Automations.', error); | ||
| }); | ||
| } | ||
|
|
||
| private async migrateLegacyAutomations(): Promise<void> { | ||
| for (const automation of [...this.legacyStore.automations.get()]) { | ||
| const providerId = automation.target.providerId; | ||
| if (!providerId) { | ||
| continue; | ||
| } | ||
| const providerStore = this.sessionsProvidersService.getProvider(providerId)?.automations; | ||
| if (!providerStore) { | ||
| continue; | ||
| } | ||
| try { | ||
| await providerStore.importAutomation(automation, this.legacyStore.runsFor(automation.id).get()); | ||
| await this.legacyStore.removeAutomationForMigration(automation.id); | ||
|
benvillalobos marked this conversation as resolved.
Outdated
|
||
| } catch (error) { | ||
| this.logService.error(`[ProviderAutomationService] Failed to migrate Automation '${automation.id}' to provider '${providerId}'.`, error); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| function distinctById<T extends { readonly id: string }>(items: readonly T[]): T[] { | ||
| const result: T[] = []; | ||
| const seen = new Set<string>(); | ||
| for (const item of items) { | ||
| if (!seen.has(item.id)) { | ||
| seen.add(item.id); | ||
| result.push(item); | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI Review: An existing automation ID is treated as equivalent without comparing the stored payload, and same-ID runs are also skipped without comparing their payloads. Migration then removes the unchanged legacy snapshot, so divergent provider state silently wins and legacy automation/run data is lost. Please report a conflict for divergent snapshots and remove the source only after destination equivalence is established.