fix(question-label-truncator): fix type errors and add test coverage
- Remove invalid Pick<Plugin> type usage - Add explicit input/output type annotations - Add comprehensive test suite (5 tests) - Tests verify truncation at 30 chars with '...' suffix
This commit is contained in:
parent
04fb339622
commit
ec32dd65c2
136
src/hooks/question-label-truncator/index.test.ts
Normal file
136
src/hooks/question-label-truncator/index.test.ts
Normal file
@ -0,0 +1,136 @@
|
|||||||
|
import { describe, it, expect } from "bun:test";
|
||||||
|
import { createQuestionLabelTruncatorHook } from "./index";
|
||||||
|
|
||||||
|
describe("createQuestionLabelTruncatorHook", () => {
|
||||||
|
const hook = createQuestionLabelTruncatorHook();
|
||||||
|
|
||||||
|
describe("tool.execute.before", () => {
|
||||||
|
it("truncates labels exceeding 30 characters with ellipsis", async () => {
|
||||||
|
// #given
|
||||||
|
const longLabel = "This is a very long label that exceeds thirty characters";
|
||||||
|
const input = { tool: "AskUserQuestion" };
|
||||||
|
const output = {
|
||||||
|
args: {
|
||||||
|
questions: [
|
||||||
|
{
|
||||||
|
question: "Choose an option",
|
||||||
|
options: [
|
||||||
|
{ label: longLabel, description: "A long option" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// #when
|
||||||
|
await hook["tool.execute.before"]?.(input as any, output as any);
|
||||||
|
|
||||||
|
// #then
|
||||||
|
const truncatedLabel = (output.args as any).questions[0].options[0].label;
|
||||||
|
expect(truncatedLabel.length).toBeLessThanOrEqual(30);
|
||||||
|
expect(truncatedLabel).toBe("This is a very long label t...");
|
||||||
|
expect(truncatedLabel.endsWith("...")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("preserves labels within 30 characters", async () => {
|
||||||
|
// #given
|
||||||
|
const shortLabel = "Short label";
|
||||||
|
const input = { tool: "AskUserQuestion" };
|
||||||
|
const output = {
|
||||||
|
args: {
|
||||||
|
questions: [
|
||||||
|
{
|
||||||
|
question: "Choose an option",
|
||||||
|
options: [
|
||||||
|
{ label: shortLabel, description: "A short option" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// #when
|
||||||
|
await hook["tool.execute.before"]?.(input as any, output as any);
|
||||||
|
|
||||||
|
// #then
|
||||||
|
const resultLabel = (output.args as any).questions[0].options[0].label;
|
||||||
|
expect(resultLabel).toBe(shortLabel);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("handles exactly 30 character labels without truncation", async () => {
|
||||||
|
// #given
|
||||||
|
const exactLabel = "Exactly thirty chars here!!!!!"; // 30 chars
|
||||||
|
expect(exactLabel.length).toBe(30);
|
||||||
|
const input = { tool: "ask_user_question" };
|
||||||
|
const output = {
|
||||||
|
args: {
|
||||||
|
questions: [
|
||||||
|
{
|
||||||
|
question: "Choose",
|
||||||
|
options: [{ label: exactLabel }],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// #when
|
||||||
|
await hook["tool.execute.before"]?.(input as any, output as any);
|
||||||
|
|
||||||
|
// #then
|
||||||
|
const resultLabel = (output.args as any).questions[0].options[0].label;
|
||||||
|
expect(resultLabel).toBe(exactLabel);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("ignores non-AskUserQuestion tools", async () => {
|
||||||
|
// #given
|
||||||
|
const input = { tool: "Bash" };
|
||||||
|
const output = {
|
||||||
|
args: { command: "echo hello" },
|
||||||
|
};
|
||||||
|
const originalArgs = { ...output.args };
|
||||||
|
|
||||||
|
// #when
|
||||||
|
await hook["tool.execute.before"]?.(input as any, output as any);
|
||||||
|
|
||||||
|
// #then
|
||||||
|
expect(output.args).toEqual(originalArgs);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("handles multiple questions with multiple options", async () => {
|
||||||
|
// #given
|
||||||
|
const input = { tool: "AskUserQuestion" };
|
||||||
|
const output = {
|
||||||
|
args: {
|
||||||
|
questions: [
|
||||||
|
{
|
||||||
|
question: "Q1",
|
||||||
|
options: [
|
||||||
|
{ label: "Very long label number one that needs truncation" },
|
||||||
|
{ label: "Short" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
question: "Q2",
|
||||||
|
options: [
|
||||||
|
{ label: "Another extremely long label for testing purposes" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// #when
|
||||||
|
await hook["tool.execute.before"]?.(input as any, output as any);
|
||||||
|
|
||||||
|
// #then
|
||||||
|
const q1opts = (output.args as any).questions[0].options;
|
||||||
|
const q2opts = (output.args as any).questions[1].options;
|
||||||
|
|
||||||
|
expect(q1opts[0].label).toBe("Very long label number one ...");
|
||||||
|
expect(q1opts[0].label.length).toBeLessThanOrEqual(30);
|
||||||
|
expect(q1opts[1].label).toBe("Short");
|
||||||
|
expect(q2opts[0].label).toBe("Another extremely long labe...");
|
||||||
|
expect(q2opts[0].label.length).toBeLessThanOrEqual(30);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@ -1,5 +1,3 @@
|
|||||||
import type { Plugin } from "@opencode-ai/plugin";
|
|
||||||
|
|
||||||
const MAX_LABEL_LENGTH = 30;
|
const MAX_LABEL_LENGTH = 30;
|
||||||
|
|
||||||
interface QuestionOption {
|
interface QuestionOption {
|
||||||
@ -42,20 +40,20 @@ function truncateQuestionLabels(args: AskUserQuestionArgs): AskUserQuestionArgs
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export function createQuestionLabelTruncatorHook(): Pick<
|
export function createQuestionLabelTruncatorHook() {
|
||||||
Plugin,
|
|
||||||
"tool.execute.before"
|
|
||||||
> {
|
|
||||||
return {
|
return {
|
||||||
"tool.execute.before": async (input, output) => {
|
"tool.execute.before": async (
|
||||||
|
input: { tool: string },
|
||||||
|
output: { args: Record<string, unknown> }
|
||||||
|
): Promise<void> => {
|
||||||
const toolName = input.tool?.toLowerCase();
|
const toolName = input.tool?.toLowerCase();
|
||||||
|
|
||||||
if (toolName === "askuserquestion" || toolName === "ask_user_question") {
|
if (toolName === "askuserquestion" || toolName === "ask_user_question") {
|
||||||
const args = output.args as AskUserQuestionArgs | undefined;
|
const args = output.args as unknown as AskUserQuestionArgs | undefined;
|
||||||
|
|
||||||
if (args?.questions) {
|
if (args?.questions) {
|
||||||
const truncatedArgs = truncateQuestionLabels(args);
|
const truncatedArgs = truncateQuestionLabels(args);
|
||||||
Object.assign(output.args as object, truncatedArgs);
|
Object.assign(output.args, truncatedArgs);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user