|
| 1 | +import type { TextEditor, Uri } from 'vscode'; |
| 2 | +import { window } from 'vscode'; |
| 3 | +import { Schemes } from '../constants'; |
| 4 | +import type { AIFeedbackEvent, Source } from '../constants.telemetry'; |
| 5 | +import type { Container } from '../container'; |
| 6 | +import type { MarkdownContentMetadata } from '../documents/markdown'; |
| 7 | +import { decodeGitLensRevisionUriAuthority } from '../git/gitUri.authority'; |
| 8 | +import { command } from '../system/-webview/command'; |
| 9 | +import { Logger } from '../system/logger'; |
| 10 | +import { ActiveEditorCommand } from './commandBase'; |
| 11 | +import { getCommandUri } from './commandBase.utils'; |
| 12 | + |
| 13 | +export interface AIFeedbackContext { |
| 14 | + feature: AIFeedbackEvent['feature']; |
| 15 | + model: { |
| 16 | + id: string; |
| 17 | + providerId: string; |
| 18 | + providerName: string; |
| 19 | + }; |
| 20 | + usage?: { |
| 21 | + promptTokens?: number; |
| 22 | + completionTokens?: number; |
| 23 | + totalTokens?: number; |
| 24 | + limits?: { |
| 25 | + used: number; |
| 26 | + limit: number; |
| 27 | + resetsOn: Date; |
| 28 | + }; |
| 29 | + }; |
| 30 | + outputLength: number; |
| 31 | +} |
| 32 | + |
| 33 | +@command() |
| 34 | +export class AIFeedbackPositiveCommand extends ActiveEditorCommand { |
| 35 | + constructor(private readonly container: Container) { |
| 36 | + super('gitlens.ai.feedback.positive'); |
| 37 | + } |
| 38 | + |
| 39 | + execute(editor?: TextEditor, uri?: Uri): void { |
| 40 | + const context = this.extractFeedbackContext(editor, uri); |
| 41 | + if (!context) return; |
| 42 | + |
| 43 | + try { |
| 44 | + // For positive feedback, just send the event immediately without showing any form |
| 45 | + sendFeedbackEvent( |
| 46 | + this.container, |
| 47 | + context, |
| 48 | + 'positive', |
| 49 | + { |
| 50 | + presetReasons: [], |
| 51 | + writeInFeedback: '', |
| 52 | + }, |
| 53 | + { source: 'markdown-preview' }, |
| 54 | + ); |
| 55 | + |
| 56 | + void window.showInformationMessage('Thank you for your feedback!'); |
| 57 | + } catch (ex) { |
| 58 | + Logger.error(ex, 'AIFeedbackPositiveCommand', 'execute'); |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + private extractFeedbackContext(editor?: TextEditor, uri?: Uri): AIFeedbackContext | undefined { |
| 63 | + uri = getCommandUri(uri, editor); |
| 64 | + if (uri?.scheme !== Schemes.GitLensMarkdown) return undefined; |
| 65 | + |
| 66 | + const authority = uri.authority; |
| 67 | + if (!authority) return undefined; |
| 68 | + |
| 69 | + try { |
| 70 | + const metadata = decodeGitLensRevisionUriAuthority<MarkdownContentMetadata>(authority); |
| 71 | + |
| 72 | + // Extract feedback context from metadata |
| 73 | + if (metadata.feedbackContext) { |
| 74 | + return metadata.feedbackContext as unknown as AIFeedbackContext; |
| 75 | + } |
| 76 | + |
| 77 | + return undefined; |
| 78 | + } catch (ex) { |
| 79 | + Logger.error(ex, 'AIFeedbackPositiveCommand', 'extractFeedbackContext'); |
| 80 | + return undefined; |
| 81 | + } |
| 82 | + } |
| 83 | +} |
| 84 | + |
| 85 | +@command() |
| 86 | +export class AIFeedbackNegativeCommand extends ActiveEditorCommand { |
| 87 | + constructor(private readonly container: Container) { |
| 88 | + super('gitlens.ai.feedback.negative'); |
| 89 | + } |
| 90 | + |
| 91 | + async execute(editor?: TextEditor, uri?: Uri): Promise<void> { |
| 92 | + const context = this.extractFeedbackContext(editor, uri); |
| 93 | + if (!context) return; |
| 94 | + |
| 95 | + try { |
| 96 | + // For negative feedback, always show the detailed form directly |
| 97 | + await showDetailedFeedbackForm(this.container, context); |
| 98 | + } catch (ex) { |
| 99 | + Logger.error(ex, 'AIFeedbackNegativeCommand', 'execute'); |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + private extractFeedbackContext(editor?: TextEditor, uri?: Uri): AIFeedbackContext | undefined { |
| 104 | + uri = getCommandUri(uri, editor); |
| 105 | + if (uri?.scheme !== Schemes.GitLensMarkdown) return undefined; |
| 106 | + |
| 107 | + const authority = uri.authority; |
| 108 | + if (!authority) return undefined; |
| 109 | + |
| 110 | + try { |
| 111 | + const metadata = decodeGitLensRevisionUriAuthority<MarkdownContentMetadata>(authority); |
| 112 | + |
| 113 | + // Extract feedback context from metadata |
| 114 | + if (metadata.feedbackContext) { |
| 115 | + return metadata.feedbackContext as unknown as AIFeedbackContext; |
| 116 | + } |
| 117 | + |
| 118 | + return undefined; |
| 119 | + } catch (ex) { |
| 120 | + Logger.error(ex, 'AIFeedbackNegativeCommand', 'extractFeedbackContext'); |
| 121 | + return undefined; |
| 122 | + } |
| 123 | + } |
| 124 | +} |
| 125 | + |
| 126 | +async function showDetailedFeedbackForm(container: Container, context: AIFeedbackContext): Promise<void> { |
| 127 | + const negativeReasons = [ |
| 128 | + 'Inaccurate or incorrect response', |
| 129 | + 'Too generic or not specific enough', |
| 130 | + 'Poor code quality', |
| 131 | + 'Missing important details', |
| 132 | + 'Difficult to understand', |
| 133 | + 'Not relevant to my needs', |
| 134 | + ]; |
| 135 | + |
| 136 | + // Show quick pick for preset reasons |
| 137 | + const selectedReasons = await window.showQuickPick( |
| 138 | + negativeReasons.map(reason => ({ label: reason, picked: false })), |
| 139 | + { |
| 140 | + title: 'What specifically could be improved?', |
| 141 | + canPickMany: true, |
| 142 | + placeHolder: 'Select all that apply (optional)', |
| 143 | + }, |
| 144 | + ); |
| 145 | + |
| 146 | + // Show input box for additional feedback |
| 147 | + const writeInFeedback = await window.showInputBox({ |
| 148 | + title: 'Additional feedback (optional)', |
| 149 | + placeHolder: 'Tell us more about your experience...', |
| 150 | + prompt: 'Your feedback helps us improve our AI features', |
| 151 | + }); |
| 152 | + |
| 153 | + // Always send feedback submission telemetry for negative feedback |
| 154 | + sendFeedbackEvent( |
| 155 | + container, |
| 156 | + context, |
| 157 | + 'negative', |
| 158 | + { |
| 159 | + presetReasons: selectedReasons?.map(r => r.label), |
| 160 | + writeInFeedback: writeInFeedback, |
| 161 | + }, |
| 162 | + { source: 'markdown-preview' }, |
| 163 | + ); |
| 164 | + |
| 165 | + void window.showInformationMessage('Thank you for your feedback!'); |
| 166 | +} |
| 167 | + |
| 168 | +function sendFeedbackEvent( |
| 169 | + container: Container, |
| 170 | + context: AIFeedbackContext, |
| 171 | + rating: 'positive' | 'negative', |
| 172 | + feedback: { |
| 173 | + presetReasons?: string[]; |
| 174 | + writeInFeedback?: string; |
| 175 | + }, |
| 176 | + source: Source, |
| 177 | +): void { |
| 178 | + const hasPresetReasons = feedback.presetReasons && feedback.presetReasons.length > 0; |
| 179 | + const writeInFeedback = feedback.writeInFeedback?.trim() ?? undefined; |
| 180 | + |
| 181 | + let feedbackType: 'preset' | 'writeIn' | 'both'; |
| 182 | + if (hasPresetReasons && writeInFeedback?.length) { |
| 183 | + feedbackType = 'both'; |
| 184 | + } else if (hasPresetReasons) { |
| 185 | + feedbackType = 'preset'; |
| 186 | + } else { |
| 187 | + feedbackType = 'writeIn'; |
| 188 | + } |
| 189 | + |
| 190 | + const eventData: AIFeedbackEvent = { |
| 191 | + feature: context.feature, |
| 192 | + rating: rating, |
| 193 | + feedbackType: feedbackType, |
| 194 | + presetReason: hasPresetReasons ? feedback.presetReasons!.join(', ') : undefined, |
| 195 | + 'writeInFeedback.length': writeInFeedback?.length ?? undefined, |
| 196 | + 'writeInFeedback.text': writeInFeedback?.length ? writeInFeedback : undefined, |
| 197 | + 'model.id': context.model.id, |
| 198 | + 'model.provider.id': context.model.providerId as any, |
| 199 | + 'model.provider.name': context.model.providerName, |
| 200 | + 'usage.promptTokens': context.usage?.promptTokens, |
| 201 | + 'usage.completionTokens': context.usage?.completionTokens, |
| 202 | + 'usage.totalTokens': context.usage?.totalTokens, |
| 203 | + 'usage.limits.used': context.usage?.limits?.used, |
| 204 | + 'usage.limits.limit': context.usage?.limits?.limit, |
| 205 | + 'usage.limits.resetsOn': context.usage?.limits?.resetsOn?.toISOString(), |
| 206 | + 'output.length': context.outputLength, |
| 207 | + }; |
| 208 | + |
| 209 | + container.telemetry.sendEvent('ai/feedback', eventData, source); |
| 210 | +} |
0 commit comments