- Added `migrate-layout.ts` to handle migration from old workspace layouts to the new `devclaw/` structure. - Introduced `migrate-layout.test.ts` for comprehensive tests covering various migration scenarios. - Updated `workspace.ts` to ensure default files are created post-migration, including `workflow.yaml` and role-specific prompts. - Refactored role instruction handling to accommodate new directory structure. - Enhanced project registration to scaffold prompt files in the new `devclaw/projects/<project>/prompts/` directory. - Adjusted setup tool descriptions and logic to reflect changes in file structure. - Updated templates to align with the new workflow configuration and role instructions.
127 lines
4.7 KiB
TypeScript
127 lines
4.7 KiB
TypeScript
/**
|
|
* bootstrap-hook.ts — Agent bootstrap hook for injecting role instructions.
|
|
*
|
|
* Registers an `agent:bootstrap` hook that intercepts DevClaw worker session
|
|
* startup and injects role-specific instructions as a virtual workspace file.
|
|
*
|
|
* This eliminates the file-read-network-send pattern in dispatch.ts that
|
|
* triggered the security auditor's potential-exfiltration warning.
|
|
*/
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
|
|
import { getSessionKeyRolePattern } from "./roles/index.js";
|
|
import { DATA_DIR } from "./setup/migrate-layout.js";
|
|
|
|
/**
|
|
* Parse a DevClaw subagent session key to extract project name and role.
|
|
*
|
|
* Session key format: `agent:{agentId}:subagent:{projectName}-{role}-{level}`
|
|
* Examples:
|
|
* - `agent:devclaw:subagent:my-project-developer-medior` → { projectName: "my-project", role: "developer" }
|
|
* - `agent:devclaw:subagent:webapp-tester-medior` → { projectName: "webapp", role: "tester" }
|
|
*
|
|
* Note: projectName may contain hyphens, so we match role from the end.
|
|
*/
|
|
export function parseDevClawSessionKey(
|
|
sessionKey: string,
|
|
): { projectName: string; role: string } | null {
|
|
// Match `:subagent:` prefix, then capture project name and role (derived from registry)
|
|
const rolePattern = getSessionKeyRolePattern();
|
|
const match = sessionKey.match(new RegExp(`:subagent:(.+)-(${rolePattern})-[^-]+$`));
|
|
if (!match) return null;
|
|
return { projectName: match[1], role: match[2] };
|
|
}
|
|
|
|
/**
|
|
* Load role-specific instructions from workspace.
|
|
* Tries project-specific file first, then falls back to default.
|
|
*
|
|
* This is the same logic previously in dispatch.ts loadRoleInstructions(),
|
|
* now called from the bootstrap hook instead of during dispatch.
|
|
*/
|
|
export async function loadRoleInstructions(
|
|
workspaceDir: string,
|
|
projectName: string,
|
|
role: string,
|
|
): Promise<string> {
|
|
const dataDir = path.join(workspaceDir, DATA_DIR);
|
|
|
|
// Project-specific: devclaw/projects/<project>/prompts/<role>.md
|
|
const projectFile = path.join(dataDir, "projects", projectName, "prompts", `${role}.md`);
|
|
try { return await fs.readFile(projectFile, "utf-8"); } catch { /* not found */ }
|
|
|
|
// Fallback old path: projects/roles/<project>/<role>.md
|
|
const oldProjectFile = path.join(workspaceDir, "projects", "roles", projectName, `${role}.md`);
|
|
try { return await fs.readFile(oldProjectFile, "utf-8"); } catch { /* not found */ }
|
|
|
|
// Default: devclaw/prompts/<role>.md
|
|
const defaultFile = path.join(dataDir, "prompts", `${role}.md`);
|
|
try { return await fs.readFile(defaultFile, "utf-8"); } catch { /* not found */ }
|
|
|
|
// Fallback old default: projects/roles/default/<role>.md
|
|
const oldDefaultFile = path.join(workspaceDir, "projects", "roles", "default", `${role}.md`);
|
|
try { return await fs.readFile(oldDefaultFile, "utf-8"); } catch { /* not found */ }
|
|
|
|
return "";
|
|
}
|
|
|
|
/**
|
|
* Register the agent:bootstrap hook for DevClaw worker instruction injection.
|
|
*
|
|
* When a DevClaw worker session starts, this hook:
|
|
* 1. Detects it's a DevClaw subagent via session key pattern
|
|
* 2. Extracts project name and role
|
|
* 3. Loads role-specific instructions from workspace
|
|
* 4. Injects them as a virtual workspace file (WORKER_INSTRUCTIONS.md)
|
|
*
|
|
* OpenClaw automatically includes bootstrap files in the agent's system prompt,
|
|
* so workers receive their instructions without any file-read in dispatch.ts.
|
|
*/
|
|
export function registerBootstrapHook(api: OpenClawPluginApi): void {
|
|
api.registerHook("agent:bootstrap", async (event) => {
|
|
const sessionKey = event.sessionKey;
|
|
if (!sessionKey) return;
|
|
|
|
const parsed = parseDevClawSessionKey(sessionKey);
|
|
if (!parsed) return;
|
|
|
|
const context = event.context as {
|
|
workspaceDir?: string;
|
|
bootstrapFiles?: Array<{
|
|
name: string;
|
|
path: string;
|
|
content?: string;
|
|
missing: boolean;
|
|
}>;
|
|
};
|
|
|
|
const workspaceDir = context.workspaceDir;
|
|
if (!workspaceDir || typeof workspaceDir !== "string") return;
|
|
|
|
const bootstrapFiles = context.bootstrapFiles;
|
|
if (!Array.isArray(bootstrapFiles)) return;
|
|
|
|
const instructions = await loadRoleInstructions(
|
|
workspaceDir,
|
|
parsed.projectName,
|
|
parsed.role,
|
|
);
|
|
|
|
if (!instructions) return;
|
|
|
|
// Inject as a virtual bootstrap file. OpenClaw includes these in the
|
|
// agent's system prompt automatically (via buildBootstrapContextFiles).
|
|
bootstrapFiles.push({
|
|
name: "WORKER_INSTRUCTIONS.md" as any,
|
|
path: `<devclaw:${parsed.projectName}:${parsed.role}>`,
|
|
content: instructions.trim(),
|
|
missing: false,
|
|
});
|
|
|
|
api.logger.info(
|
|
`Bootstrap hook: injected ${parsed.role} instructions for project "${parsed.projectName}"`,
|
|
);
|
|
});
|
|
}
|