Files
kandev/apps/web/components/azure-devops/azure-devops-workspace-defaults.ts
T
2026-08-16 12:08:59 +01:00

214 lines
7.5 KiB
TypeScript

/**
* Seed presets for a workspace that has never saved Azure DevOps settings.
*
* NOTHING in this file is translated, and nothing in it should be.
*
* - The `wiql` filters are Azure DevOps' query language — `[System.State]`,
* `@Me`, `ORDER BY` — i.e. code, on the same footing as Jira's JQL and
* Sentry's search syntax.
* - `label`, `hint` and `promptTemplate` are PERSISTED. They seed the
* editable drafts in azure-devops-default-queries.tsx and
* azure-devops-quick-actions.tsx and are written back to workspace settings
* as `AzureDevOpsQueryPreset` / `AzureDevOpsActionPreset`, so translating
* them would write locale-dependent values into a user's saved presets and
* leave them there after a locale switch. `promptTemplate` is additionally
* sent to the agent verbatim.
* - They must also keep matching the server-side defaults in
* `apps/backend/internal/azuredevops/workspace_settings.go`, which has no
* locale: the backend returns those records whenever the client asks for a
* reset, so a translated copy here would flip back to English on save.
*
* Localizing them needs a key/persisted-value split in the preset type — the
* same open item recorded for GitHub's `DEFAULT_PR_PRESETS` and Jira's
* `my-jira/presets.ts`.
*/
import type { AzureDevOpsActionPreset, AzureDevOpsQueryPreset } from "@/lib/types/azure-devops";
type Translate = (key: string) => string;
// i18n-exempt: WIQL is Azure DevOps' query language, not prose. See the file header.
const WIQL_START = "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @project";
const WIQL_ORDER = " ORDER BY [System.ChangedDate] DESC";
function wiql(condition?: string): string {
return `${WIQL_START}${condition ? ` AND ${condition}` : ""}${WIQL_ORDER}`;
}
// i18n-exempt: persisted preset seed, and must match the server-side defaults. See the file header.
export const DEFAULT_AZURE_WORK_ITEM_QUERIES: AzureDevOpsQueryPreset[] = [
{
id: "recent",
label: "Recently updated",
group: "inbox",
filters: { wiql: wiql(), top: 50 },
},
{
id: "assigned",
label: "Assigned to me",
group: "inbox",
filters: { wiql: wiql("[System.AssignedTo] = @Me"), top: 50 },
},
{
id: "active",
label: "Active",
group: "inbox",
filters: {
wiql: wiql("[System.State] <> 'Closed' AND [System.State] <> 'Done'"),
top: 50,
},
},
{
id: "created",
label: "Created by me",
group: "created",
filters: { wiql: wiql("[System.CreatedBy] = @Me"), top: 50 },
},
];
// i18n-exempt: persisted preset seed, and must match the server-side defaults. See the file header.
export const DEFAULT_AZURE_PULL_REQUEST_QUERIES: AzureDevOpsQueryPreset[] = [
{
id: "review-requested",
label: "Review requested",
group: "inbox",
filters: { status: "active", reviewer: "@me", creator: "" },
},
{
id: "active",
label: "Open",
group: "inbox",
filters: { status: "active", reviewer: "", creator: "" },
},
{
id: "completed",
label: "Completed",
group: "created",
filters: { status: "completed", reviewer: "", creator: "" },
},
{
id: "created",
label: "Created by me",
group: "created",
filters: { status: "active", reviewer: "", creator: "@me" },
},
];
// i18n-exempt: persisted preset seed, and must match the server-side defaults. See the file header.
export const DEFAULT_AZURE_WORK_ITEM_ACTIONS: AzureDevOpsActionPreset[] = [
{
id: "implement",
label: "Implement",
hint: "Build and open a PR",
icon: "code",
promptTemplate:
'Implement the Azure DevOps work item at {{url}} (title: "{{title}}"). Open a pull request when complete.',
},
{
id: "investigate",
label: "Investigate",
hint: "Find the root cause",
icon: "search",
promptTemplate:
'Investigate the Azure DevOps work item at {{url}} (title: "{{title}}"). Identify the root cause and summarize findings.',
},
{
id: "reproduce",
label: "Reproduce",
hint: "Document repro steps",
icon: "bug",
promptTemplate:
'Reproduce the Azure DevOps work item at {{url}} (title: "{{title}}"). Document the reproduction steps.',
},
];
// i18n-exempt: persisted preset seed, and must match the server-side defaults. See the file header.
export const DEFAULT_AZURE_PULL_REQUEST_ACTIONS: AzureDevOpsActionPreset[] = [
{
id: "review",
label: "Review",
hint: "Read the diff, flag issues",
icon: "eye",
promptTemplate:
"Review the Azure DevOps pull request at {{url}}. Provide feedback on code quality and correctness.",
},
{
id: "address-feedback",
label: "Address feedback",
hint: "Apply review comments",
icon: "message",
promptTemplate: "Review and address the feedback on the Azure DevOps pull request at {{url}}.",
},
{
id: "fix-ci",
label: "Fix CI",
hint: "Diagnose failing checks",
icon: "tool",
promptTemplate: "Investigate and fix CI failures for the Azure DevOps pull request at {{url}}.",
},
];
const QUERY_LABEL_KEYS: Record<string, string> = {
"work_item:recent": "azuredevops:defaultQueryRecentlyUpdated",
"work_item:assigned": "azuredevops:defaultQueryAssignedToMe",
"work_item:active": "azuredevops:defaultQueryActive",
"work_item:created": "azuredevops:defaultQueryCreatedByMe",
"pull_request:review-requested": "azuredevops:defaultQueryReviewRequested",
"pull_request:active": "azuredevops:defaultQueryOpen",
"pull_request:completed": "azuredevops:defaultQueryCompleted",
"pull_request:created": "azuredevops:defaultQueryCreatedByMe",
};
const ACTION_COPY_KEYS: Record<string, { labelKey: string; hintKey: string }> = {
"work_item:implement": {
labelKey: "azuredevops:defaultActionImplement",
hintKey: "azuredevops:defaultActionImplementHint",
},
"work_item:investigate": {
labelKey: "azuredevops:defaultActionInvestigate",
hintKey: "azuredevops:defaultActionInvestigateHint",
},
"work_item:reproduce": {
labelKey: "azuredevops:defaultActionReproduce",
hintKey: "azuredevops:defaultActionReproduceHint",
},
"pull_request:review": {
labelKey: "azuredevops:defaultActionReview",
hintKey: "azuredevops:defaultActionReviewHint",
},
"pull_request:address-feedback": {
labelKey: "azuredevops:defaultActionAddressFeedback",
hintKey: "azuredevops:defaultActionAddressFeedbackHint",
},
"pull_request:fix-ci": {
labelKey: "azuredevops:defaultActionFixCi",
hintKey: "azuredevops:defaultActionFixCiHint",
},
};
export function azureQueryDisplayLabel(
kind: "work_item" | "pull_request",
preset: AzureDevOpsQueryPreset,
t: Translate,
): string {
const defaults =
kind === "work_item" ? DEFAULT_AZURE_WORK_ITEM_QUERIES : DEFAULT_AZURE_PULL_REQUEST_QUERIES;
const baseline = defaults.find((candidate) => candidate.id === preset.id);
const key = QUERY_LABEL_KEYS[`${kind}:${preset.id}`];
return key && baseline?.label === preset.label ? t(key) : preset.label;
}
export function azureActionDisplayCopy(
kind: "work_item" | "pull_request",
action: AzureDevOpsActionPreset,
t: Translate,
): { label: string; hint: string } {
const defaults =
kind === "work_item" ? DEFAULT_AZURE_WORK_ITEM_ACTIONS : DEFAULT_AZURE_PULL_REQUEST_ACTIONS;
const baseline = defaults.find((candidate) => candidate.id === action.id);
const keys = ACTION_COPY_KEYS[`${kind}:${action.id}`];
if (!keys || baseline?.label !== action.label || baseline.hint !== action.hint) {
return { label: action.label, hint: action.hint };
}
return { label: t(keys.labelKey), hint: t(keys.hintKey) };
}