This commit is contained in:
2026-03-15 20:08:10 -04:00
parent 33768b748c
commit 55a8c9432e
26 changed files with 3449 additions and 0 deletions

3
plugin-log-viewer/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
dist
node_modules
.paperclip-sdk

View File

@@ -0,0 +1,41 @@
# Log Viewer Plugin
A Paperclip plugin that monitors and displays agent run logs and activity in real-time.
## Features
- **Dashboard Widget**: Shows recent log activity on the main dashboard
- **Full Log Page**: View all captured events with filtering
- **Event Tracking**: Captures:
- Agent run started/finished/failed
- Issue created/updated
- Goal created
- Agent created
## Development
```bash
pnpm install
pnpm dev # watch builds
pnpm dev:ui # local dev server with hot-reload events
pnpm test
```
This scaffold snapshots `@paperclipai/plugin-sdk` and `@paperclipai/shared` from a local Paperclip checkout at:
`/home/mike/code/paperclip/packages/plugins/sdk`
The packed tarballs live in `.paperclip-sdk/` for local development. Before publishing this plugin, switch those dependencies to published package versions once they are available on npm.
## Install Into Paperclip
```bash
curl -X POST http://127.0.0.1:3100/api/plugins/install \
-H "Content-Type: application/json" \
-d '{"packageName":"/home/mike/code/paperclip_plugins/plugin-log-viewer","isLocalPath":true}'
```
## Build Options
- `pnpm build` uses esbuild presets from `@paperclipai/plugin-sdk/bundlers`.
- `pnpm build:rollup` uses rollup presets from the same SDK.

View File

@@ -0,0 +1,17 @@
import esbuild from "esbuild";
import { createPluginBundlerPresets } from "@paperclipai/plugin-sdk/bundlers";
const presets = createPluginBundlerPresets({ uiEntry: "src/ui/index.tsx" });
const watch = process.argv.includes("--watch");
const workerCtx = await esbuild.context(presets.esbuild.worker);
const manifestCtx = await esbuild.context(presets.esbuild.manifest);
const uiCtx = await esbuild.context(presets.esbuild.ui);
if (watch) {
await Promise.all([workerCtx.watch(), manifestCtx.watch(), uiCtx.watch()]);
console.log("esbuild watch mode enabled for worker, manifest, and ui");
} else {
await Promise.all([workerCtx.rebuild(), manifestCtx.rebuild(), uiCtx.rebuild()]);
await Promise.all([workerCtx.dispose(), manifestCtx.dispose(), uiCtx.dispose()]);
}

View File

@@ -0,0 +1,48 @@
{
"name": "@paperclipai/plugin-log-viewer",
"version": "0.1.0",
"type": "module",
"private": true,
"description": "A Paperclip plugin",
"scripts": {
"build": "node ./esbuild.config.mjs",
"build:rollup": "rollup -c",
"dev": "node ./esbuild.config.mjs --watch",
"dev:ui": "paperclip-plugin-dev-server --root . --ui-dir dist/ui --port 4177",
"test": "vitest run --config ./vitest.config.ts",
"typecheck": "tsc --noEmit"
},
"paperclipPlugin": {
"manifest": "./dist/manifest.js",
"worker": "./dist/worker.js",
"ui": "./dist/ui/"
},
"keywords": [
"paperclip",
"plugin",
"connector"
],
"author": "Plugin Author",
"license": "MIT",
"pnpm": {
"overrides": {
"@paperclipai/shared": "file:.paperclip-sdk/paperclipai-shared-0.3.1.tgz"
}
},
"devDependencies": {
"@paperclipai/shared": "file:.paperclip-sdk/paperclipai-shared-0.3.1.tgz",
"@paperclipai/plugin-sdk": "file:.paperclip-sdk/paperclipai-plugin-sdk-1.0.0.tgz",
"@rollup/plugin-node-resolve": "^16.0.1",
"@rollup/plugin-typescript": "^12.1.2",
"@types/node": "^24.6.0",
"@types/react": "^19.0.8",
"esbuild": "^0.27.3",
"rollup": "^4.38.0",
"tslib": "^2.8.1",
"typescript": "^5.7.3",
"vitest": "^3.0.5"
},
"peerDependencies": {
"react": ">=18"
}
}

1217
plugin-log-viewer/pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,28 @@
import { nodeResolve } from "@rollup/plugin-node-resolve";
import typescript from "@rollup/plugin-typescript";
import { createPluginBundlerPresets } from "@paperclipai/plugin-sdk/bundlers";
const presets = createPluginBundlerPresets({ uiEntry: "src/ui/index.tsx" });
function withPlugins(config) {
if (!config) return null;
return {
...config,
plugins: [
nodeResolve({
extensions: [".ts", ".tsx", ".js", ".jsx", ".mjs"],
}),
typescript({
tsconfig: "./tsconfig.json",
declaration: false,
declarationMap: false,
}),
],
};
}
export default [
withPlugins(presets.rollup.manifest),
withPlugins(presets.rollup.worker),
withPlugins(presets.rollup.ui),
].filter(Boolean);

View File

@@ -0,0 +1,53 @@
import type { PaperclipPluginManifestV1 } from "@paperclipai/plugin-sdk";
const manifest: PaperclipPluginManifestV1 = {
id: "paperclipai.plugin-log-viewer",
apiVersion: 1,
version: "0.1.0",
displayName: "Log Viewer",
description: "Monitor and view agent run logs and activity in real-time",
author: "FrenoCorp",
categories: ["automation", "ui"],
capabilities: [
"events.subscribe",
"plugin.state.read",
"plugin.state.write",
"activity.read"
],
entrypoints: {
worker: "./dist/worker.js",
ui: "./dist/ui"
},
ui: {
slots: [
{
type: "dashboardWidget",
id: "log-viewer-widget",
displayName: "Log Activity",
exportName: "DashboardWidget"
},
{
type: "page",
id: "logs",
displayName: "Log Viewer",
exportName: "LogsPage"
}
],
launchers: [
{
id: "open-logs",
displayName: "View Logs",
placementZone: "globalToolbarButton",
action: {
type: "navigate",
target: "/plugins/log-viewer"
},
render: {
environment: "hostRoute"
}
}
]
}
};
export default manifest;

View File

@@ -0,0 +1,187 @@
import { usePluginData, usePluginAction, type PluginWidgetProps, type PluginPageProps } from "@paperclipai/plugin-sdk/ui";
interface LogEntry {
id: string;
eventType: string;
entityId: string;
entityType: string;
timestamp: string;
data?: Record<string, unknown>;
}
interface HealthData {
status: "ok" | "degraded" | "error";
checkedAt: string;
logCount: number;
}
export function DashboardWidget(_props: PluginWidgetProps) {
const { data, loading, error, refresh } = usePluginData<HealthData>("health");
const { data: logs } = usePluginData<LogEntry[]>("logs");
if (loading) return <div>Loading...</div>;
if (error) return <div>Error: {error.message}</div>;
const recentLogs = logs?.slice(0, 3) ?? [];
return (
<div style={{ display: "grid", gap: "0.5rem", padding: "0.5rem" }}>
<div style={{ display: "flex", justifyContent: "space-between", alignItems: "center" }}>
<strong>Log Activity</strong>
<span style={{ fontSize: "0.75rem", color: "#666" }}>
{data?.logCount ?? 0} events
</span>
</div>
{recentLogs.length === 0 ? (
<div style={{ fontSize: "0.875rem", color: "#888" }}>No recent activity</div>
) : (
<div style={{ display: "grid", gap: "0.25rem" }}>
{recentLogs.map((log) => (
<div
key={log.id}
style={{
fontSize: "0.75rem",
padding: "0.25rem",
backgroundColor: "#f5f5f5",
borderRadius: "4px",
display: "grid",
gridTemplateColumns: "1fr auto",
gap: "0.5rem"
}}
>
<span style={{ fontWeight: 500 }}>{formatEventType(log.eventType)}</span>
<span style={{ color: "#888" }}>{formatTime(log.timestamp)}</span>
</div>
))}
</div>
)}
<button
onClick={() => void refresh()}
style={{
fontSize: "0.75rem",
padding: "0.25rem 0.5rem",
marginTop: "0.25rem"
}}
>
Refresh
</button>
</div>
);
}
export function LogsPage(_props: PluginPageProps) {
const { data: logs, loading, error, refresh } = usePluginData<LogEntry[]>("logs");
const clearLogs = usePluginAction("clear-logs");
const handleClear = async () => {
await clearLogs();
void refresh();
};
if (loading) return <div>Loading logs...</div>;
if (error) return <div>Error: {error.message}</div>;
return (
<div style={{ padding: "1rem", maxWidth: "800px", margin: "0 auto" }}>
<div style={{ display: "flex", justifyContent: "space-between", alignItems: "center", marginBottom: "1rem" }}>
<h1 style={{ fontSize: "1.5rem", fontWeight: 600 }}>Log Viewer</h1>
<div style={{ display: "flex", gap: "0.5rem" }}>
<button
onClick={() => void refresh()}
style={{
padding: "0.5rem 1rem",
backgroundColor: "#f5f5f5",
border: "1px solid #ddd",
borderRadius: "4px",
cursor: "pointer"
}}
>
Refresh
</button>
<button
onClick={() => void handleClear()}
style={{
padding: "0.5rem 1rem",
backgroundColor: "#fee",
border: "1px solid #fcc",
borderRadius: "4px",
cursor: "pointer",
color: "#c00"
}}
>
Clear Logs
</button>
</div>
</div>
<div style={{ display: "grid", gap: "0.5rem" }}>
{!logs || logs.length === 0 ? (
<div style={{ padding: "2rem", textAlign: "center", color: "#888" }}>
No log entries yet. Activity will appear here as events occur.
</div>
) : (
logs.map((log) => (
<div
key={log.id}
style={{
padding: "0.75rem",
backgroundColor: "#fff",
border: "1px solid #eee",
borderRadius: "6px",
display: "grid",
gridTemplateColumns: "auto 1fr auto",
gap: "1rem",
alignItems: "center"
}}
>
<span
style={{
padding: "0.25rem 0.5rem",
borderRadius: "4px",
fontSize: "0.75rem",
fontWeight: 500,
backgroundColor: getEventColor(log.eventType),
color: "#fff"
}}
>
{formatEventType(log.eventType)}
</span>
<div style={{ display: "grid", gap: "0.25rem" }}>
<div style={{ fontSize: "0.875rem", fontWeight: 500 }}>
{log.entityType}: {log.entityId.slice(0, 8)}...
</div>
{log.data?.companyId ? (
<div style={{ fontSize: "0.75rem", color: "#888" }}>
Company: {String(log.data.companyId as string).slice(0, 8)}...
</div>
) : null}
</div>
<span style={{ fontSize: "0.75rem", color: "#888" }}>
{formatTime(log.timestamp)}
</span>
</div>
))
)}
</div>
</div>
);
}
function formatEventType(eventType: string): string {
const parts = eventType.split(".");
return parts[parts.length - 1] ?? eventType;
}
function formatTime(timestamp: string): string {
const date = new Date(timestamp);
return date.toLocaleTimeString([], { hour: "2-digit", minute: "2-digit" });
}
function getEventColor(eventType: string): string {
if (eventType.includes("failed")) return "#c00";
if (eventType.includes("finished")) return "#4a4";
if (eventType.includes("started")) return "#48a";
if (eventType.includes("created")) return "#4a8";
if (eventType.includes("updated")) return "#888";
return "#666";
}

View File

@@ -0,0 +1,130 @@
import { definePlugin, runWorker } from "@paperclipai/plugin-sdk";
interface LogEntry {
id: string;
eventType: string;
entityId: string;
entityType: string;
timestamp: string;
data?: Record<string, unknown>;
}
const MAX_LOG_ENTRIES = 100;
const plugin = definePlugin({
async setup(ctx) {
const recentLogs: LogEntry[] = [];
async function addLogEntry(eventType: string, entityId: string, entityType: string, data?: Record<string, unknown>) {
const entry: LogEntry = {
id: `log_${Date.now()}_${Math.random().toString(36).substr(2, 9)}`,
eventType,
entityId,
entityType,
timestamp: new Date().toISOString(),
data
};
recentLogs.unshift(entry);
if (recentLogs.length > MAX_LOG_ENTRIES) {
recentLogs.pop();
}
await ctx.state.set(
{ scopeKind: "instance", stateKey: "recent_logs" },
recentLogs
);
}
ctx.events.on("agent.run.started", async (event) => {
const runId = event.entityId ?? "unknown";
await addLogEntry("agent.run.started", runId, "run", {
companyId: event.companyId
});
ctx.logger.info("Agent run started", { runId });
});
ctx.events.on("agent.run.finished", async (event) => {
const runId = event.entityId ?? "unknown";
await addLogEntry("agent.run.finished", runId, "run", {
companyId: event.companyId
});
ctx.logger.info("Agent run finished", { runId });
});
ctx.events.on("agent.run.failed", async (event) => {
const runId = event.entityId ?? "unknown";
await addLogEntry("agent.run.failed", runId, "run", {
companyId: event.companyId
});
ctx.logger.info("Agent run failed", { runId });
});
ctx.events.on("issue.created", async (event) => {
const issueId = event.entityId ?? "unknown";
await addLogEntry("issue.created", issueId, "issue", {
companyId: event.companyId
});
ctx.logger.info("Issue created", { issueId });
});
ctx.events.on("issue.updated", async (event) => {
const issueId = event.entityId ?? "unknown";
await addLogEntry("issue.updated", issueId, "issue", {
companyId: event.companyId
});
ctx.logger.info("Issue updated", { issueId });
});
ctx.events.on("goal.created", async (event) => {
const goalId = event.entityId ?? "unknown";
await addLogEntry("goal.created", goalId, "goal", {
companyId: event.companyId
});
ctx.logger.info("Goal created", { goalId });
});
ctx.events.on("agent.created", async (event) => {
const agentId = event.entityId ?? "unknown";
await addLogEntry("agent.created", agentId, "agent", {
companyId: event.companyId
});
ctx.logger.info("Agent created", { agentId });
});
ctx.data.register("logs", async () => {
const stored = await ctx.state.get(
{ scopeKind: "instance", stateKey: "recent_logs" }
);
return (stored as LogEntry[] | null) ?? recentLogs;
});
ctx.data.register("health", async () => {
return {
status: "ok",
checkedAt: new Date().toISOString(),
logCount: recentLogs.length
};
});
ctx.actions.register("clear-logs", async () => {
recentLogs.length = 0;
await ctx.state.set(
{ scopeKind: "instance", stateKey: "recent_logs" },
[]
);
ctx.logger.info("Logs cleared");
return { success: true };
});
ctx.actions.register("ping", async () => {
ctx.logger.info("Ping action invoked");
return { pong: true, at: new Date().toISOString() };
});
},
async onHealth() {
return { status: "ok", message: "Plugin worker is running" };
}
});
export default plugin;
runWorker(plugin, import.meta.url);

View File

@@ -0,0 +1,26 @@
import { describe, expect, it } from "vitest";
import { createTestHarness } from "@paperclipai/plugin-sdk/testing";
import manifest from "../src/manifest.js";
import plugin from "../src/worker.js";
describe("plugin log viewer", () => {
it("registers data + actions and handles events", async () => {
const harness = createTestHarness({ manifest, capabilities: [...manifest.capabilities, "events.emit"] });
await plugin.definition.setup(harness.ctx);
await harness.emit("issue.created", { companyId: "comp_1" }, { entityId: "iss_1", entityType: "issue", companyId: "comp_1" });
const logs = await harness.getData<Array<{ eventType: string; entityId: string }>>("logs");
expect(logs).toBeDefined();
expect(logs.length).toBeGreaterThan(0);
expect(logs[0].eventType).toBe("issue.created");
expect(logs[0].entityId).toBe("iss_1");
const health = await harness.getData<{ status: string; logCount: number }>("health");
expect(health.status).toBe("ok");
expect(health.logCount).toBe(1);
const action = await harness.performAction<{ pong: boolean }>("ping");
expect(action.pong).toBe(true);
});
});

View File

@@ -0,0 +1,27 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"lib": [
"ES2022",
"DOM"
],
"jsx": "react-jsx",
"strict": true,
"skipLibCheck": true,
"declaration": true,
"declarationMap": true,
"sourceMap": true,
"outDir": "dist",
"rootDir": "."
},
"include": [
"src",
"tests"
],
"exclude": [
"dist",
"node_modules"
]
}

View File

@@ -0,0 +1,8 @@
import { defineConfig } from "vitest/config";
export default defineConfig({
test: {
include: ["tests/**/*.spec.ts"],
environment: "node",
},
});