(feat) implement .clinerules-5m type rules which are sent along on a schedule

Author: charlessolar

src/core/prompts/sections/__tests__/custom-instructions-schedulable.test.ts

@@ -0,0 +1,111 @@
+/***********************************************
+ * FILE: custom-instructions-schedulable.test.ts
+ * CREATED: 2025-03-11 03:19:21
+ *
+ * CHANGELOG:
+ * - 2025-03-11 03:19:21: (Schedulable Rules - Implementation) Initial implementation of tests for schedulable rules integration with custom instructions
+ *
+ * PURPOSE:
+ * This file contains tests for schedulable rules integration with the custom instructions system.
+ *
+ * METHODS:
+ * - None (test file)
+ ***********************************************/
+
+import { addCustomInstructions } from "../custom-instructions"
+import { SchedulableRulesManager, SchedulableRule } from "../schedulable-rules"
+import * as fs from "fs/promises"
+
+// Mock dependencies
+jest.mock("fs/promises")
+jest.mock("../schedulable-rules")
+
+describe("addCustomInstructions with schedulable rules", () => {
+	let mockSchedulableRulesManager: jest.Mocked<SchedulableRulesManager>
+	const mockRules: SchedulableRule[] = [
+		{
+			filePath: "/path/to/.clinerules-5m",
+			fileName: ".clinerules-5m",
+			interval: 5 * 60 * 1000,
+			timeUnit: "m",
+			displayInterval: "5 minutes",
+			content: "Some rule content for 5 minutes",
+			lastExecuted: 0,
+		},
+		{
+			filePath: "/path/to/.clinerules-10s",
+			fileName: ".clinerules-10s",
+			interval: 10 * 1000,
+			timeUnit: "s",
+			displayInterval: "10 seconds",
+			content: "Some rule content for 10 seconds",
+			lastExecuted: 0,
+		},
+	]
+
+	beforeEach(() => {
+		jest.resetAllMocks()
+
+		// Mock SchedulableRulesManager
+		mockSchedulableRulesManager = {
+			resetAllRules: jest.fn(),
+			loadSchedulableRules: jest.fn(),
+			shouldExecuteRule: jest.fn(),
+			markRuleAsExecuted: jest.fn(),
+			getExecutableRules: jest.fn().mockResolvedValue(mockRules),
+			getAllRules: jest.fn(),
+		} as unknown as jest.Mocked<SchedulableRulesManager>
+
+		// Mock fs
+		;(fs.readFile as jest.Mock).mockImplementation((filePath: string) => {
+			if (filePath.endsWith(".clinerules")) {
+				return Promise.resolve("Generic rules content")
+			}
+			if (filePath.endsWith(".clinerules-code")) {
+				return Promise.resolve("Mode specific rules content")
+			}
+			return Promise.resolve("")
+		})
+	})
+
+	test("should include schedulable rules in custom instructions", async () => {
+		const result = await addCustomInstructions(
+			"Mode custom instructions",
+			"Global custom instructions",
+			"/fake/cwd",
+			"code",
+			{},
+			mockSchedulableRulesManager,
+		)
+
+		// Check that getExecutableRules was called
+		expect(mockSchedulableRulesManager.getExecutableRules).toHaveBeenCalledWith("/fake/cwd")
+
+		// Check that markRuleAsExecuted was called for each rule
+		expect(mockSchedulableRulesManager.markRuleAsExecuted).toHaveBeenCalledTimes(2)
+		expect(mockSchedulableRulesManager.markRuleAsExecuted).toHaveBeenCalledWith(mockRules[0])
+		expect(mockSchedulableRulesManager.markRuleAsExecuted).toHaveBeenCalledWith(mockRules[1])
+
+		// Check that the result includes the rule content
+		expect(result).toContain("Rules from .clinerules-5m (every 5 minutes)")
+		expect(result).toContain("Some rule content for 5 minutes")
+		expect(result).toContain("Rules from .clinerules-10s (every 10 seconds)")
+		expect(result).toContain("Some rule content for 10 seconds")
+	})
+
+	test("should work without a schedulable rules manager", async () => {
+		const result = await addCustomInstructions(
+			"Mode custom instructions",
+			"Global custom instructions",
+			"/fake/cwd",
+			"code",
+			{},
+		)
+
+		// Check that the result includes normal content but not schedulable rules
+		expect(result).not.toContain("Rules from .clinerules-5m")
+		expect(result).not.toContain("Rules from .clinerules-10s")
+		expect(result).toContain("Mode custom instructions")
+		expect(result).toContain("Global custom instructions")
+	})
+})

src/core/prompts/sections/__tests__/schedulable-rules.test.ts

@@ -0,0 +1,215 @@
+/***********************************************
+ * FILE: schedulable-rules.test.ts
+ * CREATED: 2025-03-11 03:18:01
+ *
+ * CHANGELOG:
+ * - 2025-03-11 03:18:01: (Schedulable Rules - Implementation) Initial implementation of unit tests for parseTimeInterval and SchedulableRulesManager
+ * - 2025-03-11 03:53:05: (Schedulable Rules - Bug Fix) Fixed import path for utils/logging module in test mocks
+ * - 2025-03-11 03:53:37: (Schedulable Rules - Bug Fix) Added explicit mock implementations for fs/promises readdir and readFile functions
+ *
+ * PURPOSE:
+ * This file contains tests for the schedulable rules implementation.
+ *
+ * METHODS:
+ * - None (test file)
+ ***********************************************/
+
+import { parseTimeInterval, SchedulableRule, SchedulableRulesManager } from "../schedulable-rules"
+import * as fs from "fs/promises"
+import * as path from "path"
+
+// Mock dependencies
+jest.mock("fs/promises", () => ({
+	readdir: jest.fn(),
+	readFile: jest.fn(),
+}))
+jest.mock("../../../../utils/logging", () => ({
+	logger: {
+		info: jest.fn(),
+		debug: jest.fn(),
+		error: jest.fn(),
+	},
+}))
+
+describe("parseTimeInterval", () => {
+	test("should correctly parse seconds", () => {
+		const result = parseTimeInterval("5s")
+		expect(result.interval).toBe(5 * 1000)
+		expect(result.unit).toBe("s")
+		expect(result.display).toBe("5 seconds")
+	})
+
+	test("should correctly parse minutes", () => {
+		const result = parseTimeInterval("10m")
+		expect(result.interval).toBe(10 * 60 * 1000)
+		expect(result.unit).toBe("m")
+		expect(result.display).toBe("10 minutes")
+	})
+
+	test("should correctly parse hours", () => {
+		const result = parseTimeInterval("2h")
+		expect(result.interval).toBe(2 * 60 * 60 * 1000)
+		expect(result.unit).toBe("h")
+		expect(result.display).toBe("2 hours")
+	})
+
+	test("should correctly parse days", () => {
+		const result = parseTimeInterval("1d")
+		expect(result.interval).toBe(24 * 60 * 60 * 1000)
+		expect(result.unit).toBe("d")
+		expect(result.display).toBe("1 day")
+	})
+
+	test("should handle singular units correctly", () => {
+		const result = parseTimeInterval("1s")
+		expect(result.display).toBe("1 second")
+	})
+
+	test("should throw an error for invalid formats", () => {
+		expect(() => parseTimeInterval("5x")).toThrow()
+		expect(() => parseTimeInterval("abc")).toThrow()
+		expect(() => parseTimeInterval("5")).toThrow()
+	})
+})
+
+describe("SchedulableRulesManager", () => {
+	let manager: SchedulableRulesManager
+	const mockRules: SchedulableRule[] = [
+		{
+			filePath: "/path/to/.clinerules-5m",
+			fileName: ".clinerules-5m",
+			interval: 5 * 60 * 1000,
+			timeUnit: "m",
+			displayInterval: "5 minutes",
+			content: "Some rule content",
+			lastExecuted: 0,
+		},
+		{
+			filePath: "/path/to/.clinerules-10s",
+			fileName: ".clinerules-10s",
+			interval: 10 * 1000,
+			timeUnit: "s",
+			displayInterval: "10 seconds",
+			content: "Another rule content",
+			lastExecuted: 0,
+		},
+	]
+
+	beforeEach(() => {
+		jest.resetAllMocks()
+		manager = new SchedulableRulesManager()
+
+		// Mock readdir to return rule files
+		const mockFiles = [".clinerules-5m", ".clinerules-10s", "other-file.txt"]
+		;(fs.readdir as jest.Mock).mockResolvedValue(mockFiles)
+
+		// Mock readFile to return content
+		;(fs.readFile as jest.Mock).mockImplementation((filePath) => {
+			if (filePath.includes(".clinerules-5m")) {
+				return Promise.resolve("Some rule content")
+			} else if (filePath.includes(".clinerules-10s")) {
+				return Promise.resolve("Another rule content")
+			}
+			return Promise.resolve("")
+		})
+	})
+
+	test("should load schedulable rules from directory", async () => {
+		const rules = await manager.loadSchedulableRules("/fake/cwd")
+
+		expect(fs.readdir).toHaveBeenCalledWith("/fake/cwd")
+		expect(rules).toHaveLength(2)
+		expect(rules[0].fileName).toBe(".clinerules-5m")
+		expect(rules[1].fileName).toBe(".clinerules-10s")
+	})
+
+	test("should check if a rule should be executed", () => {
+		// Rule should execute if it has never been executed
+		expect(manager.shouldExecuteRule(mockRules[0])).toBe(true)
+
+		// Mark the rule as executed
+		manager.markRuleAsExecuted(mockRules[0])
+
+		// Rule should not execute immediately after being marked
+		expect(manager.shouldExecuteRule(mockRules[0])).toBe(false)
+
+		// Simulate time passing (manually setting lastExecutionTimes)
+		const sixMinutesAgo = Date.now() - 6 * 60 * 1000
+		Object.defineProperty(manager, "lastExecutionTimes", {
+			value: new Map([[mockRules[0].fileName, sixMinutesAgo]]),
+		})
+
+		// Now the rule should execute again (5 minutes have passed)
+		expect(manager.shouldExecuteRule(mockRules[0])).toBe(true)
+	})
+
+	test("should return executable rules", async () => {
+		// Mock implementation to return our test rules
+		jest.spyOn(manager, "loadSchedulableRules").mockResolvedValue(mockRules)
+
+		// Initially, all rules should be executable
+		let executableRules = await manager.getExecutableRules("/fake/cwd")
+		expect(executableRules).toHaveLength(2)
+
+		// Mark one rule as executed
+		manager.markRuleAsExecuted(mockRules[0])
+
+		// Mock shouldExecuteRule to return false for the first rule
+		jest.spyOn(manager, "shouldExecuteRule").mockImplementation((rule) => {
+			return rule.fileName !== mockRules[0].fileName
+		})
+
+		// Now only one rule should be executable
+		executableRules = await manager.getExecutableRules("/fake/cwd")
+		expect(executableRules).toHaveLength(1)
+		expect(executableRules[0].fileName).toBe(mockRules[1].fileName)
+	})
+
+	test("should reset all rules", () => {
+		// Mark rules as executed
+		manager.markRuleAsExecuted(mockRules[0])
+		manager.markRuleAsExecuted(mockRules[1])
+
+		// Verify the lastExecutionTimes map has entries
+		expect((manager as any).lastExecutionTimes.size).toBe(2)
+
+		// Reset all rules
+		manager.resetAllRules()
+
+		// Verify the lastExecutionTimes map is cleared
+		expect((manager as any).lastExecutionTimes.size).toBe(0)
+	})
+
+	test("should handle errors when loading rules", async () => {
+		// Mock readdir to throw an error
+		;(fs.readdir as jest.Mock).mockRejectedValue(new Error("Directory not found"))
+
+		const rules = await manager.loadSchedulableRules("/fake/cwd")
+
+		// Should return empty array on error
+		expect(rules).toEqual([])
+	})
+
+	test("should get all rules with next execution time", async () => {
+		// Mock implementation to return our test rules
+		jest.spyOn(manager, "loadSchedulableRules").mockResolvedValue(mockRules)
+
+		// Mark one rule as executed 3 minutes ago
+		const threeMinutesAgo = Date.now() - 3 * 60 * 1000
+		Object.defineProperty(manager, "lastExecutionTimes", {
+			value: new Map([[mockRules[0].fileName, threeMinutesAgo]]),
+		})
+
+		const rulesWithStatus = await manager.getAllRules("/fake/cwd")
+
+		expect(rulesWithStatus).toHaveLength(2)
+
+		// First rule should have nextExecution time of approximately 2 minutes (5 - 3)
+		const twoMinutesMs = 2 * 60 * 1000
+		expect(rulesWithStatus[0].nextExecution).toBeGreaterThan(twoMinutesMs - 100)
+		expect(rulesWithStatus[0].nextExecution).toBeLessThan(twoMinutesMs + 100)
+
+		// Second rule should have nextExecution time of 0 (never executed)
+		expect(rulesWithStatus[1].nextExecution).toBe(0)
+	})
+})

src/core/prompts/sections/custom-instructions.ts

@@ -1,5 +1,6 @@
 import fs from "fs/promises"
 import path from "path"
+import { SchedulableRulesManager } from "./schedulable-rules"
 
 async function safeReadFile(filePath: string): Promise<string> {
 	try {
@@ -34,6 +35,7 @@ export async function addCustomInstructions(
 	cwd: string,
 	mode: string,
 	options: { preferredLanguage?: string; rooIgnoreInstructions?: string } = {},
+	schedulableRulesManager?: SchedulableRulesManager,
 ): Promise<string> {
 	const sections = []
 
@@ -64,6 +66,7 @@ export async function addCustomInstructions(
 	// Add rules - include both mode-specific and generic rules if they exist
 	const rules = []
 
+	// Add mode-specific rules first if they exist
 	// Add mode-specific rules first if they exist
 	if (modeRuleContent && modeRuleContent.trim()) {
 		const modeRuleFile = `.clinerules-${mode}`
@@ -74,12 +77,20 @@ export async function addCustomInstructions(
 		rules.push(options.rooIgnoreInstructions)
 	}
 
+	// Add schedulable rules if manager is provided
+	if (schedulableRulesManager) {
+		const executableRules = await schedulableRulesManager.getExecutableRules(cwd)
+		for (const rule of executableRules) {
+			rules.push(`# Rules from ${rule.fileName} (every ${rule.displayInterval}):\n${rule.content}`)
+			schedulableRulesManager.markRuleAsExecuted(rule)
+		}
+	}
+
 	// Add generic rules
 	const genericRuleContent = await loadRuleFiles(cwd)
 	if (genericRuleContent && genericRuleContent.trim()) {
 		rules.push(genericRuleContent.trim())
 	}
-
 	if (rules.length > 0) {
 		sections.push(`Rules:\n\n${rules.join("\n\n")}`)
 	}