-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Handle errors more gracefully when reading custom instructions from files #1093
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
138 changes: 138 additions & 0 deletions
138
src/core/prompts/sections/__tests__/custom-instructions.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| import { loadRuleFiles, addCustomInstructions } from "../custom-instructions" | ||
| import fs from "fs/promises" | ||
|
|
||
| // Mock fs/promises | ||
| jest.mock("fs/promises") | ||
| const mockedFs = jest.mocked(fs) | ||
|
|
||
| describe("loadRuleFiles", () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks() | ||
| }) | ||
|
|
||
| it("should combine content from multiple rule files when they exist", async () => { | ||
| mockedFs.readFile.mockImplementation(((filePath: string | Buffer | URL | number) => { | ||
| if (filePath.toString().endsWith(".clinerules")) { | ||
| return Promise.resolve("cline rules content") | ||
| } | ||
| if (filePath.toString().endsWith(".cursorrules")) { | ||
| return Promise.resolve("cursor rules content") | ||
| } | ||
| return Promise.reject({ code: "ENOENT" }) | ||
| }) as any) | ||
|
|
||
| const result = await loadRuleFiles("/fake/path") | ||
| expect(result).toBe( | ||
| "\n# Rules from .clinerules:\ncline rules content\n" + | ||
| "\n# Rules from .cursorrules:\ncursor rules content\n", | ||
| ) | ||
| }) | ||
|
|
||
| it("should handle when no rule files exist", async () => { | ||
| mockedFs.readFile.mockRejectedValue({ code: "ENOENT" }) | ||
|
|
||
| const result = await loadRuleFiles("/fake/path") | ||
| expect(result).toBe("") | ||
| }) | ||
|
|
||
| it("should throw on unexpected errors", async () => { | ||
| const error = new Error("Permission denied") as NodeJS.ErrnoException | ||
| error.code = "EPERM" | ||
| mockedFs.readFile.mockRejectedValue(error) | ||
|
|
||
| await expect(async () => { | ||
| await loadRuleFiles("/fake/path") | ||
| }).rejects.toThrow() | ||
| }) | ||
|
|
||
| it("should skip directories with same name as rule files", async () => { | ||
| mockedFs.readFile.mockImplementation(((filePath: string | Buffer | URL | number) => { | ||
| if (filePath.toString().endsWith(".clinerules")) { | ||
| return Promise.reject({ code: "EISDIR" }) | ||
| } | ||
| if (filePath.toString().endsWith(".cursorrules")) { | ||
| return Promise.resolve("cursor rules content") | ||
| } | ||
| return Promise.reject({ code: "ENOENT" }) | ||
| }) as any) | ||
|
|
||
| const result = await loadRuleFiles("/fake/path") | ||
| expect(result).toBe("\n# Rules from .cursorrules:\ncursor rules content\n") | ||
| }) | ||
| }) | ||
|
|
||
| describe("addCustomInstructions", () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks() | ||
| }) | ||
|
|
||
| it("should combine all instruction types when provided", async () => { | ||
| mockedFs.readFile.mockResolvedValue("mode specific rules") | ||
|
|
||
| const result = await addCustomInstructions( | ||
| "mode instructions", | ||
| "global instructions", | ||
| "/fake/path", | ||
| "test-mode", | ||
| { preferredLanguage: "Spanish" }, | ||
| ) | ||
|
|
||
| expect(result).toContain("Language Preference:") | ||
| expect(result).toContain("Spanish") | ||
| expect(result).toContain("Global Instructions:\nglobal instructions") | ||
| expect(result).toContain("Mode-specific Instructions:\nmode instructions") | ||
| expect(result).toContain("Rules from .clinerules-test-mode:\nmode specific rules") | ||
| }) | ||
|
|
||
| it("should return empty string when no instructions provided", async () => { | ||
| mockedFs.readFile.mockRejectedValue({ code: "ENOENT" }) | ||
|
|
||
| const result = await addCustomInstructions("", "", "/fake/path", "", {}) | ||
| expect(result).toBe("") | ||
| }) | ||
|
|
||
| it("should handle missing mode-specific rules file", async () => { | ||
| mockedFs.readFile.mockRejectedValue({ code: "ENOENT" }) | ||
|
|
||
| const result = await addCustomInstructions( | ||
| "mode instructions", | ||
| "global instructions", | ||
| "/fake/path", | ||
| "test-mode", | ||
| ) | ||
|
|
||
| expect(result).toContain("Global Instructions:") | ||
| expect(result).toContain("Mode-specific Instructions:") | ||
| expect(result).not.toContain("Rules from .clinerules-test-mode") | ||
| }) | ||
|
|
||
| it("should throw on unexpected errors", async () => { | ||
| const error = new Error("Permission denied") as NodeJS.ErrnoException | ||
| error.code = "EPERM" | ||
| mockedFs.readFile.mockRejectedValue(error) | ||
|
|
||
| await expect(async () => { | ||
| await addCustomInstructions("", "", "/fake/path", "test-mode") | ||
| }).rejects.toThrow() | ||
| }) | ||
|
|
||
| it("should skip mode-specific rule files that are directories", async () => { | ||
| mockedFs.readFile.mockImplementation(((filePath: string | Buffer | URL | number) => { | ||
| if (filePath.toString().includes(".clinerules-test-mode")) { | ||
| return Promise.reject({ code: "EISDIR" }) | ||
| } | ||
| return Promise.reject({ code: "ENOENT" }) | ||
| }) as any) | ||
|
|
||
| const result = await addCustomInstructions( | ||
| "mode instructions", | ||
| "global instructions", | ||
| "/fake/path", | ||
| "test-mode", | ||
| ) | ||
|
|
||
| expect(result).toContain("Global Instructions:\nglobal instructions") | ||
| expect(result).toContain("Mode-specific Instructions:\nmode instructions") | ||
| expect(result).not.toContain("Rules from .clinerules-test-mode") | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly, consider using a shared helper for error checks here as well to improve maintainability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, thanks!