Skip to content

Commit bee31d4

Browse files
committed
Add error handling and retry mechanism for commit message generation API failures
1 parent ceff480 commit bee31d4

5 files changed

Lines changed: 99 additions & 95 deletions

File tree

‎apps/editor/src/commands/generate-commit-message-command/generate-commit-message-command.ts‎

Lines changed: 82 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { build_commit_message_prompt } from './utils/build-commit-message-prompt
99
import { generate_commit_message_with_api } from './utils/generate-commit-message-with-api'
1010
import { ModelProvidersManager } from '@/services/model-providers-manager'
1111
import { t } from '@/i18n'
12+
import axios from 'axios'
1213

1314
export const generate_commit_message_command = (
1415
context: vscode.ExtensionContext
@@ -34,6 +35,7 @@ export const generate_commit_message_command = (
3435
let files_staged_by_action = false
3536
let is_single_change_flow = false
3637
const api_providers_manager = new ModelProvidersManager(context)
38+
let force_show_quick_pick = false
3739

3840
while (true) {
3941
const data = await get_prompt_data(source_control)
@@ -57,9 +59,12 @@ export const generate_commit_message_command = (
5759

5860
const api_config_data = await get_commit_message_config(
5961
context,
60-
show_back_button
62+
show_back_button,
63+
force_show_quick_pick
6164
)
6265

66+
force_show_quick_pick = false
67+
6368
if (api_config_data === 'back') {
6469
if (was_empty_stage) {
6570
if (!show_back_button) {
@@ -81,85 +86,94 @@ export const generate_commit_message_command = (
8186
return
8287
}
8388

84-
const commit_message = await generate_commit_message_with_api({
85-
endpoint_url: api_config_data.endpoint_url,
86-
provider: api_config_data.provider,
87-
config: api_config_data.config,
88-
message: message_prompt
89-
})
90-
91-
if (commit_message) {
92-
if (should_commit) {
93-
const edited_message = await new Promise<string | 'back' | undefined>(
94-
(resolve) => {
95-
const input_box = vscode.window.createInputBox()
96-
input_box.value = commit_message
97-
input_box.title = t('command.commit-message.input.title')
98-
input_box.prompt = t('command.commit-message.input.prompt')
99-
100-
if (has_default_config && !files_staged_by_action) {
101-
input_box.buttons = [
102-
{
103-
iconPath: new vscode.ThemeIcon('close'),
104-
tooltip: t('common.close')
105-
}
106-
]
107-
} else {
108-
input_box.buttons = [vscode.QuickInputButtons.Back]
109-
}
110-
111-
let is_resolved = false
89+
let commit_message: string
90+
try {
91+
commit_message = await generate_commit_message_with_api({
92+
endpoint_url: api_config_data.endpoint_url,
93+
provider: api_config_data.provider,
94+
config: api_config_data.config,
95+
message: message_prompt
96+
})
97+
} catch (error) {
98+
if (axios.isCancel(error)) {
99+
if (was_empty_stage) {
100+
await vscode.commands.executeCommand('git.unstageAll')
101+
}
102+
break
103+
} else {
104+
force_show_quick_pick = true
105+
continue
106+
}
107+
}
112108

113-
input_box.onDidTriggerButton((button) => {
114-
if (
115-
button === vscode.QuickInputButtons.Back ||
116-
button.tooltip === t('common.close')
117-
) {
118-
is_resolved = true
119-
resolve('back')
120-
input_box.hide()
109+
if (should_commit) {
110+
const edited_message = await new Promise<string | 'back' | undefined>(
111+
(resolve) => {
112+
const input_box = vscode.window.createInputBox()
113+
input_box.value = commit_message
114+
input_box.title = t('command.commit-message.input.title')
115+
input_box.prompt = t('command.commit-message.input.prompt')
116+
117+
if (has_default_config && !files_staged_by_action) {
118+
input_box.buttons = [
119+
{
120+
iconPath: new vscode.ThemeIcon('close'),
121+
tooltip: t('common.close')
121122
}
122-
})
123+
]
124+
} else {
125+
input_box.buttons = [vscode.QuickInputButtons.Back]
126+
}
127+
128+
let is_resolved = false
123129

124-
input_box.onDidAccept(() => {
130+
input_box.onDidTriggerButton((button) => {
131+
if (
132+
button === vscode.QuickInputButtons.Back ||
133+
button.tooltip === t('common.close')
134+
) {
125135
is_resolved = true
126-
resolve(input_box.value)
136+
resolve('back')
127137
input_box.hide()
128-
})
138+
}
139+
})
129140

130-
input_box.onDidHide(() => {
131-
if (!is_resolved) {
132-
resolve('back')
133-
}
134-
input_box.dispose()
135-
})
141+
input_box.onDidAccept(() => {
142+
is_resolved = true
143+
resolve(input_box.value)
144+
input_box.hide()
145+
})
136146

137-
input_box.show()
138-
}
139-
)
140-
141-
if (edited_message === 'back') {
142-
if (has_default_config) {
143-
if (files_staged_by_action) {
144-
await vscode.commands.executeCommand('git.unstageAll')
145-
} else {
146-
return
147+
input_box.onDidHide(() => {
148+
if (!is_resolved) {
149+
resolve('back')
147150
}
151+
input_box.dispose()
152+
})
153+
154+
input_box.show()
155+
}
156+
)
157+
158+
if (edited_message === 'back') {
159+
if (has_default_config) {
160+
if (files_staged_by_action) {
161+
await vscode.commands.executeCommand('git.unstageAll')
162+
} else {
163+
return
148164
}
149-
continue
150165
}
166+
continue
167+
}
151168

152-
if (edited_message) {
153-
repository.inputBox.value = edited_message
154-
await vscode.commands.executeCommand('git.commit', repository)
155-
} else if (was_empty_stage) {
156-
await vscode.commands.executeCommand('git.unstageAll')
157-
}
158-
} else {
159-
repository.inputBox.value = commit_message
169+
if (edited_message) {
170+
repository.inputBox.value = edited_message
171+
await vscode.commands.executeCommand('git.commit', repository)
172+
} else if (was_empty_stage) {
173+
await vscode.commands.executeCommand('git.unstageAll')
160174
}
161-
} else if (was_empty_stage) {
162-
await vscode.commands.executeCommand('git.unstageAll')
175+
} else {
176+
repository.inputBox.value = commit_message
163177
}
164178

165179
break

‎apps/editor/src/commands/generate-commit-message-command/utils/generate-commit-message-with-api.ts‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import * as vscode from 'vscode'
22
import axios from 'axios'
33
import { apply_reasoning_effort } from '@/utils/apply-reasoning-effort'
4-
import { dictionary } from '@shared/constants/dictionary'
54
import { make_api_request } from '@/utils/make-api-request'
65
import { Logger } from '@shared/utils/logger'
76
import { strip_wrapping_quotes } from './strip-wrapping-quotes'
@@ -13,7 +12,7 @@ export const generate_commit_message_with_api = async (params: {
1312
provider: any
1413
config: CommitMessageConfig
1514
message: string
16-
}): Promise<string | null> => {
15+
}): Promise<string> => {
1716
const messages = [
1817
{
1918
role: 'user',
@@ -66,23 +65,17 @@ export const generate_commit_message_with_api = async (params: {
6665

6766
if (!response_result) {
6867
if (token.isCancellationRequested) {
69-
return null
68+
throw new axios.Cancel('Operation cancelled by user')
7069
}
71-
vscode.window.showErrorMessage(
72-
dictionary.error_message.FAILED_TO_GENERATE_COMMIT_MESSAGE
73-
)
74-
return null
75-
} else {
76-
let commit_message = response_result.response
77-
commit_message = strip_wrapping_quotes(commit_message)
78-
// Sanitize to prevent shell syntax errors
79-
commit_message = commit_message.replace(/[<>`$()]/g, '')
80-
return commit_message
70+
throw new Error('API request failed to return a response')
8171
}
72+
73+
let commit_message = response_result.response
74+
commit_message = strip_wrapping_quotes(commit_message)
75+
// Sanitize to prevent shell syntax errors
76+
commit_message = commit_message.replace(/[<>`$()]/g, '')
77+
return commit_message
8278
} catch (error) {
83-
if (axios.isCancel(error)) {
84-
return null
85-
}
8679
Logger.error({
8780
function_name: 'generate_commit_message_with_api',
8881
message: 'Error during API request',

‎apps/editor/src/commands/generate-commit-message-command/utils/get-commit-message-config.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ export interface CommitMessageConfig {
2020

2121
export const get_commit_message_config = async (
2222
context: vscode.ExtensionContext,
23-
show_back_button: boolean = true
23+
show_back_button: boolean = true,
24+
force_quick_pick: boolean = false
2425
): Promise<
2526
| {
2627
config: CommitMessageConfig
@@ -32,7 +33,9 @@ export const get_commit_message_config = async (
3233
> => {
3334
const api_providers_manager = new ModelProvidersManager(context)
3435
let commit_message_config: CommitMessageConfig | null | undefined | 'back' =
35-
await api_providers_manager.get_default_commit_messages_config()
36+
force_quick_pick
37+
? undefined
38+
: await api_providers_manager.get_default_commit_messages_config()
3639

3740
if (!commit_message_config) {
3841
const configs =
@@ -46,9 +49,9 @@ export const get_commit_message_config = async (
4649
return null
4750
}
4851

49-
if (configs.length == 1) {
52+
if (configs.length == 1 && !force_quick_pick) {
5053
commit_message_config = configs[0]
51-
} else if (configs.length > 1) {
54+
} else if (configs.length >= 1) {
5255
const create_items = () => {
5356
const recent_ids =
5457
context.workspaceState.get<string[]>(

‎apps/editor/src/utils/make-api-request.ts‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -371,11 +371,6 @@ export const make_api_request = async (params: {
371371
}
372372

373373
if (axios.isCancel(error)) {
374-
Logger.info({
375-
function_name: 'make_api_request',
376-
message: 'Request canceled',
377-
data: error.message
378-
})
379374
throw error
380375
}
381376

‎packages/shared/src/constants/dictionary.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,6 @@ export const dictionary = {
280280
'Failed to get Git branches. Make sure you are in a Git repository.',
281281
API_KEY_MISSING_FOR_PROVIDER:
282282
'API key is missing for the selected provider. Please add it in the Settings tab.',
283-
FAILED_TO_GENERATE_COMMIT_MESSAGE: 'Failed to generate commit message.',
284283
CHECKPOINTS_ONLY_IN_WORKSPACE:
285284
'Checkpoints can only be used in a workspace.',
286285
GIT_EXTENSION_NOT_FOUND: 'Git extension not found.',
@@ -295,7 +294,7 @@ export const dictionary = {
295294
API_PAYLOAD_TOO_LARGE: 'API request failed. The context is too large.',
296295
API_BAD_REQUEST: 'API request failed. Bad request.',
297296
API_ENDPOINT_UNAVAILABLE:
298-
'Endpoint is currently unable to handle the request. Wait a few moments and retry or use another API provider.',
297+
'Endpoint is currently unable to handle the request.',
299298
API_INVALID_KEY: 'API request failed. Invalid API key.',
300299
API_REQUEST_FAILED: 'API request failed. Check console for details.',
301300
FAILED_TO_CREATE_ITEM: (item_id: string, error: any) =>

0 commit comments

Comments
 (0)