Updates telemetry/context and adds warning for workdir/index changes

Author: axosoft-ramint

docs/telemetry-events.md

@@ -82,6 +82,7 @@ export type GlobalStorage = {
 	'confirm:draft:storage': boolean;
 	// Value based on `currentOnboardingVersion` in composer's protocol
 	'composer:onboarding:dismissed': string;
+	'composer:onboarding:stepReached': number;
 	'home:sections:collapsed': string[];
 	'home:walkthrough:dismissed': boolean;
 	'launchpad:groups:collapsed': StoredLaunchpadGroup[];

src/constants.storage.ts

@@ -134,25 +134,33 @@ export interface TelemetryEvents extends WebviewShowAbortedEvents, WebviewShownE
 	/** Sent when the Commit Composer is reloaded */
 	'composer/reloaded': ComposerEvent;
 	/** Sent when the user adds unstaged changes to draft commits in the Commit Composer */
-	'composer/includedUnstagedChanges': ComposerEvent;
+	'composer/action/includedUnstagedChanges': ComposerEvent;
 	/** Sent when the user uses auto-compose in the Commit Composer */
-	'composer/generateCommits': ComposerEvent;
-	/** Sent when the user cancels an auto-compose operation in the Commit Composer */
-	'composer/generateCommits/cancelled': ComposerEvent;
+	'composer/action/compose': ComposerEvent;
+	/** Sent when the user fails an auto-compose operation in the Commit Composer */
+	'composer/action/compose/failed': ComposerEvent;
+	/** Sent when the user uses recompose in the Commit Composer */
+	'composer/action/recompose': ComposerEvent;
+	/** Sent when the user fails a recompose operation in the Commit Composer */
+	'composer/action/recompose/failed': ComposerEvent;
 	/** Sent when the user uses generate commit message in the Commit Composer */
-	'composer/generateCommitMessage': ComposerEvent;
-	/** Sent when the user cancels a generate commit message operation in the Commit Composer */
-	'composer/generateCommitMessage/cancelled': ComposerEvent;
-	/** Sent when the user updates custom instructions in the Commit Composer */
-	'composer/customInstructions/updated': ComposerEvent;
+	'composer/action/generateCommitMessage': ComposerEvent;
+	/** Sent when the user fails a generate commit message operation in the Commit Composer */
+	'composer/action/generateCommitMessage/failed': ComposerEvent;
 	/** Sent when the user changes the AI model in the Commit Composer */
-	'composer/aiModel/changed': ComposerEvent;
+	'composer/action/changeAiModel': ComposerEvent;
 	/** Sent when the user finishes and commits in the Commit Composer */
-	'composer/finishAndCommit': ComposerEvent;
+	'composer/action/finishAndCommit': ComposerEvent;
+	/** Sent when the user fails to finish and commit in the Commit Composer */
+	'composer/action/finishAndCommit/failed': ComposerEvent;
 	/** Sent when the user uses the undo button in the Commit Composer */
-	'composer/undo': ComposerEvent;
+	'composer/action/undo': ComposerEvent;
 	/** Sent when the user uses the reset button in the Commit Composer */
-	'composer/reset': ComposerEvent;
+	'composer/action/reset': ComposerEvent;
+	/** Sent when the user is warned that the working directory has changed in the Commit Composer */
+	'composer/warning/workingDirectoryChanged': ComposerEvent;
+	/** Sent when the user is warned that the index has changed in the Commit Composer */
+	'composer/warning/indexChanged': ComposerEvent;
 
 	/** Sent when the Commit Graph is shown */
 	'graph/shown': GraphShownEvent;
@@ -703,53 +711,73 @@ export type InspectShownTelemetryContext = InspectShownEventData;
 
 export type ComposerTelemetryContext = ComposerContextEventData;
 type ComposerContextEventData = WebviewTelemetryContext & ComposerSessionContextEventData;
-type ComposerContextModelData = {
-	'context.model.id': string | undefined;
-	'context.model.name': string | undefined;
-	'context.model.provider.id': AIProviders | undefined;
-	'context.model.temperature': number | undefined;
-	'context.model.maxTokens.input': number | undefined;
-	'context.model.maxTokens.output': number | undefined;
-	'context.model.default': boolean | undefined;
-	'context.model.hidden': boolean | undefined;
+type ComposerContextSessionData = {
+	'context.session.start': string;
+	'context.session.duration': number | undefined;
 };
-type ComposerContextAIOperationData = {
+type ComposerContextDiffData = {
+	'context.diff.files.count': number;
+	'context.diff.hunks.count': number;
+	'context.diff.lines.count': number;
+	'context.diff.staged.exists': boolean;
+	'context.diff.unstaged.exists': boolean;
+	'context.diff.unstaged.included': boolean;
+};
+type ComposerContextCommitsData = {
+	'context.commits.initialCount': number;
+	'context.commits.autoComposedCount': number | undefined;
+	'context.commits.composedCount': number | undefined;
+	'context.commits.finalCount': number | undefined;
+};
+type ComposerContextOnboardingData = {
+	'context.onboarding.dismissed': boolean;
+	'context.onboarding.stepReached': number | undefined;
+};
+type ComposerContextAIData = {
 	'context.ai.enabled.org': boolean;
 	'context.ai.enabled.config': boolean;
-	'context.ai.operations.generateCommits.count': number;
-	'context.ai.operations.generateCommits.cancelled.count': number;
-	'context.ai.operations.generateCommits.error.count': number;
-	'context.ai.operations.generateCommits.customInstructions.used': boolean;
-	'context.ai.operations.generateCommits.customInstructions.length': number;
-	'context.ai.operations.generateCommits.customInstructions.hash': string;
-	'context.ai.operations.generateCommits.customInstructions.setting.used': boolean;
-	'context.ai.operations.generateCommits.customInstructions.setting.length': number;
-	'context.ai.operations.generateCommits.feedback.upvote.count': number;
-	'context.ai.operations.generateCommits.feedback.downvote.count': number;
-	'context.ai.operations.generateCommitMessage.count': number;
-	'context.ai.operations.generateCommitMessage.cancelled.count': number;
-	'context.ai.operations.generateCommitMessage.error.count': number;
-	'context.ai.operations.generateCommitMessage.customInstructions.setting.used': boolean;
-	'context.ai.operations.generateCommitMessage.customInstructions.setting.length': number;
+	'context.ai.model.id': string | undefined;
+	'context.ai.model.name': string | undefined;
+	'context.ai.model.provider.id': AIProviders | undefined;
+	'context.ai.model.temperature': number | undefined;
+	'context.ai.model.maxTokens.input': number | undefined;
+	'context.ai.model.maxTokens.output': number | undefined;
+	'context.ai.model.default': boolean | undefined;
+	'context.ai.model.hidden': boolean | undefined;
+};
+type ComposerContextOperationData = {
+	'context.operations.generateCommits.count': number;
+	'context.operations.generateCommits.cancelled.count': number;
+	'context.operations.generateCommits.error.count': number;
+	'context.operations.generateCommits.feedback.upvote.count': number;
+	'context.operations.generateCommits.feedback.downvote.count': number;
+	'context.operations.generateCommitMessage.count': number;
+	'context.operations.generateCommitMessage.cancelled.count': number;
+	'context.operations.generateCommitMessage.error.count': number;
+	'context.operations.finishAndCommit.error.count': number;
+	'context.operations.undo.count': number;
+	'context.operations.redo.count': number;
+	'context.operations.reset.count': number;
+};
+type ComposerContextWarningsData = {
+	'context.warnings.workingDirectoryChanged': boolean;
+	'context.warnings.indexChanged': boolean;
+};
+type ComposerContextErrorsData = {
+	'context.errors.safety.count': number;
+	'context.errors.operation.count': number;
 };
 
-type ComposerSessionContextEventData = ComposerContextModelData &
-	ComposerContextAIOperationData & {
+type ComposerSessionContextEventData = ComposerContextSessionData &
+	ComposerContextDiffData &
+	ComposerContextCommitsData &
+	ComposerContextOnboardingData &
+	ComposerContextAIData &
+	ComposerContextOperationData &
+	ComposerContextWarningsData &
+	ComposerContextErrorsData & {
 		'context.source': Sources | undefined;
 		'context.mode': 'experimental' | 'preview';
-		'context.sessionId': string;
-		'context.files.count': number;
-		'context.hunks.count': number;
-		'context.lines.count': number;
-		'context.draftCommits.initialCount': number;
-		'context.draftCommits.finalCount': number | undefined;
-		'context.diffSources.staged': boolean;
-		'context.diffSources.unstaged': boolean;
-		'context.diffSources.unstaged.included': boolean;
-		'context.onboarding.dismissed': boolean;
-		'context.history.undo.count': number;
-		'context.history.redo.count': number;
-		'context.history.reset.count': number;
 	};
 
 type ComposerEvent = ComposerContextEventData;

src/constants.telemetry.ts

@@ -6,6 +6,7 @@ import { when } from 'lit/directives/when.js';
 import Sortable from 'sortablejs';
 import type { ComposerCommit, ComposerHunk, State } from '../../../../plus/composer/protocol';
 import {
+	AdvanceOnboardingCommand,
 	AIFeedbackHelpfulCommand,
 	AIFeedbackUnhelpfulCommand,
 	CancelGenerateCommitMessageCommand,
@@ -21,7 +22,7 @@ import {
 	OnResetCommand,
 	OnSelectAIModelCommand,
 	OnUndoCommand,
-	OnUpdateCustomInstructionsCommand,
+	OpenOnboardingCommand,
 	ReloadComposerCommand,
 } from '../../../../plus/composer/protocol';
 import { createCombinedDiffForCommit, updateHunkAssignments } from '../../../../plus/composer/utils';
@@ -132,6 +133,31 @@ export class ComposerApp extends LitElement {
 				justify-content: flex-end;
 			}
 
+			.working-directory-warning {
+				display: flex;
+				align-items: center;
+				gap: 0.8rem;
+				padding: 0.8rem 1.2rem;
+				background-color: var(--vscode-inputValidation-warningBackground);
+				border: 1px solid var(--vscode-inputValidation-warningBorder);
+				border-radius: 0.3rem;
+				margin-inline-start: 1.6rem;
+			}
+
+			.working-directory-warning--error {
+				background-color: var(--vscode-inputValidation-errorBackground);
+				border-color: var(--vscode-inputValidation-errorBorder);
+			}
+
+			.working-directory-warning__text {
+				color: var(--vscode-inputValidation-warningForeground);
+				font-size: 1.3rem;
+			}
+
+			.working-directory-warning--error .working-directory-warning__text {
+				color: var(--vscode-inputValidation-errorForeground);
+			}
+
 			.main-content {
 				display: flex;
 				flex: 1;
@@ -361,6 +387,9 @@ export class ComposerApp extends LitElement {
 	@state()
 	private showCommitsGeneratedModal: boolean = false;
 
+	@state()
+	private onboardingStepNumber: number = 0;
+
 	private commitsSortable?: Sortable;
 	private hunksSortable?: Sortable;
 	private isDragging = false;
@@ -1364,12 +1393,6 @@ export class ComposerApp extends LitElement {
 		this.customInstructions = e.detail?.customInstructions ?? '';
 	}
 
-	private handleCustomInstructionsUpdate(e: CustomEvent) {
-		this._ipc.sendCommand(OnUpdateCustomInstructionsCommand, {
-			customInstructions: e.detail?.customInstructions ?? '',
-		});
-	}
-
 	@query('gl-details-panel')
 	private detailsPanel!: DetailsPanel;
 
@@ -1434,6 +1457,7 @@ export class ComposerApp extends LitElement {
 		this._ipc.sendCommand(GenerateCommitMessageCommand, {
 			commitId: commitId,
 			diff: patch,
+			overwriteExistingMessage: commit.message.trim() !== '',
 		});
 	}
 
@@ -1521,7 +1545,7 @@ export class ComposerApp extends LitElement {
 						><code-icon icon="feedback"></code-icon
 					></gl-button>
 				</h1>
-				${this.renderActions()}
+				${this.renderWorkingDirectoryWarning()} ${this.renderActions()}
 			</header>
 
 			<main class="main-content">
@@ -1556,7 +1580,6 @@ export class ComposerApp extends LitElement {
 					@finish-and-commit=${this.finishAndCommit}
 					@generate-commits-with-ai=${this.handleGenerateCommitsWithAI}
 					@custom-instructions-change=${this.handleCustomInstructionsChange}
-					@custom-instructions-update=${this.handleCustomInstructionsUpdate}
 					@focus-commit-message=${this.handleFocusCommitMessage}
 					@commit-reorder=${(e: CustomEvent) => this.reorderCommits(e.detail.oldIndex, e.detail.newIndex)}
 					@create-new-commit=${(e: CustomEvent) => this.createNewCommitWithHunks(e.detail.hunkIds)}
@@ -1670,6 +1693,41 @@ export class ComposerApp extends LitElement {
 		`;
 	}
 
+	private renderWorkingDirectoryWarning() {
+		const { indexHasChanged, workingDirectoryHasChanged } = this.state || {};
+
+		// No warnings if neither flag is set
+		if (!indexHasChanged && !workingDirectoryHasChanged) return nothing;
+
+		// Check if there are any assigned unstaged hunks
+		const hasAssignedUnstagedHunks = this.hunksWithAssignments.some(
+			hunk => hunk.source === 'unstaged' && hunk.assigned,
+		);
+
+		let warningText: string;
+		let isError: boolean;
+
+		if (indexHasChanged) {
+			warningText = 'Index has changed. You must reload to commit.';
+			isError = true;
+		} else if (workingDirectoryHasChanged && hasAssignedUnstagedHunks) {
+			warningText = 'Working directory has changed. You must reload to commit.';
+			isError = true;
+		} else if (workingDirectoryHasChanged) {
+			warningText = 'Working directory has changed';
+			isError = false;
+		} else {
+			return nothing;
+		}
+
+		return html`
+			<div class="working-directory-warning ${isError ? 'working-directory-warning--error' : ''}">
+				<span class="working-directory-warning__text">${warningText}</span>
+				<gl-button appearance="primary" @click=${this.handleReloadComposer}>Reload</gl-button>
+			</div>
+		`;
+	}
+
 	private renderActions() {
 		if (!this.showHistoryButtons) return nothing;
 
@@ -1746,11 +1804,18 @@ export class ComposerApp extends LitElement {
 			onDestroyStarted: (_el, _step) => {
 				this.dismissOnboarding();
 			},
+			onNextClick: (_el, _step) => {
+				this.advanceOnboardingStep();
+			},
 		});
 
+		this.onboardingStepNumber = 1;
+
 		setTimeout(() => {
 			this.onboarding?.drive();
 		}, 1500);
+
+		this._ipc.sendCommand(OpenOnboardingCommand);
 	}
 
 	dismissOnboarding() {
@@ -1762,6 +1827,11 @@ export class ComposerApp extends LitElement {
 		this.state.onboardingDismissed = true;
 		this.requestUpdate();
 	}
+
+	advanceOnboardingStep() {
+		this.onboardingStepNumber++;
+		this._ipc.sendCommand(AdvanceOnboardingCommand, { stepNumber: this.onboardingStepNumber });
+	}
 }
 
 function replaceLineBreaks(text?: string | null, replaceWith: string = '<br>'): string | undefined {

src/webviews/apps/plus/composer/components/app.ts

@@ -356,9 +356,6 @@ export class CommitsPanel extends LitElement {
 	@property({ type: String })
 	customInstructions: string = '';
 
-	// Track the original value for telemetry purposes
-	private _originalCustomInstructions = '';
-
 	@property({ type: Boolean })
 	hasUsedAutoCompose: boolean = false;
 
@@ -860,27 +857,6 @@ export class CommitsPanel extends LitElement {
 		);
 	}
 
-	private handleCustomInstructionsFocus(e: Event) {
-		const input = e.target as HTMLInputElement;
-		// Store the original value when focus is gained
-		this._originalCustomInstructions = input.value;
-	}
-
-	private handleCustomInstructionsBlur(e: Event) {
-		const input = e.target as HTMLInputElement;
-		const currentValue = input.value;
-
-		// Only dispatch telemetry event if the value actually changed
-		if (currentValue !== this._originalCustomInstructions) {
-			this.dispatchEvent(
-				new CustomEvent('custom-instructions-update', {
-					detail: { customInstructions: currentValue },
-					bubbles: true,
-				}),
-			);
-		}
-	}
-
 	private getIncludeButtonText(sectionKey: string): string {
 		switch (sectionKey) {
 			case 'unstaged':
@@ -1058,8 +1034,6 @@ export class CommitsPanel extends LitElement {
 						placeholder="Include additional instructions"
 						.value=${this.customInstructions}
 						@input=${this.handleCustomInstructionsChange}
-						@focus=${this.handleCustomInstructionsFocus}
-						@blur=${this.handleCustomInstructionsBlur}
 					/>
 					<gl-button appearance="toolbar" class="auto-compose__instructions-info">
 						<code-icon icon="info"></code-icon>