File size: 10,780 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | import crypto from "node:crypto";
import fs from "node:fs/promises";
import path from "node:path";
import type { PluginLogger } from "openclaw/plugin-sdk/diffs";
import type { DiffArtifactMeta, DiffOutputFormat } from "./types.js";
const DEFAULT_TTL_MS = 30 * 60 * 1000;
const MAX_TTL_MS = 6 * 60 * 60 * 1000;
const SWEEP_FALLBACK_AGE_MS = 24 * 60 * 60 * 1000;
const DEFAULT_CLEANUP_INTERVAL_MS = 5 * 60 * 1000;
const VIEWER_PREFIX = "/plugins/diffs/view";
type CreateArtifactParams = {
html: string;
title: string;
inputKind: DiffArtifactMeta["inputKind"];
fileCount: number;
ttlMs?: number;
};
type CreateStandaloneFileArtifactParams = {
format?: DiffOutputFormat;
ttlMs?: number;
};
type StandaloneFileMeta = {
kind: "standalone_file";
id: string;
createdAt: string;
expiresAt: string;
filePath: string;
};
type ArtifactMetaFileName = "meta.json" | "file-meta.json";
export class DiffArtifactStore {
private readonly rootDir: string;
private readonly logger?: PluginLogger;
private readonly cleanupIntervalMs: number;
private cleanupInFlight: Promise<void> | null = null;
private nextCleanupAt = 0;
constructor(params: { rootDir: string; logger?: PluginLogger; cleanupIntervalMs?: number }) {
this.rootDir = path.resolve(params.rootDir);
this.logger = params.logger;
this.cleanupIntervalMs =
params.cleanupIntervalMs === undefined
? DEFAULT_CLEANUP_INTERVAL_MS
: Math.max(0, Math.floor(params.cleanupIntervalMs));
}
async createArtifact(params: CreateArtifactParams): Promise<DiffArtifactMeta> {
await this.ensureRoot();
const id = crypto.randomBytes(10).toString("hex");
const token = crypto.randomBytes(24).toString("hex");
const artifactDir = this.artifactDir(id);
const htmlPath = path.join(artifactDir, "viewer.html");
const ttlMs = normalizeTtlMs(params.ttlMs);
const createdAt = new Date();
const expiresAt = new Date(createdAt.getTime() + ttlMs);
const meta: DiffArtifactMeta = {
id,
token,
title: params.title,
inputKind: params.inputKind,
fileCount: params.fileCount,
createdAt: createdAt.toISOString(),
expiresAt: expiresAt.toISOString(),
viewerPath: `${VIEWER_PREFIX}/${id}/${token}`,
htmlPath,
};
await fs.mkdir(artifactDir, { recursive: true });
await fs.writeFile(htmlPath, params.html, "utf8");
await this.writeMeta(meta);
this.scheduleCleanup();
return meta;
}
async getArtifact(id: string, token: string): Promise<DiffArtifactMeta | null> {
const meta = await this.readMeta(id);
if (!meta) {
return null;
}
if (meta.token !== token) {
return null;
}
if (isExpired(meta)) {
await this.deleteArtifact(id);
return null;
}
return meta;
}
async readHtml(id: string): Promise<string> {
const meta = await this.readMeta(id);
if (!meta) {
throw new Error(`Diff artifact not found: ${id}`);
}
const htmlPath = this.normalizeStoredPath(meta.htmlPath, "htmlPath");
return await fs.readFile(htmlPath, "utf8");
}
async updateFilePath(id: string, filePath: string): Promise<DiffArtifactMeta> {
const meta = await this.readMeta(id);
if (!meta) {
throw new Error(`Diff artifact not found: ${id}`);
}
const normalizedFilePath = this.normalizeStoredPath(filePath, "filePath");
const next: DiffArtifactMeta = {
...meta,
filePath: normalizedFilePath,
imagePath: normalizedFilePath,
};
await this.writeMeta(next);
return next;
}
async updateImagePath(id: string, imagePath: string): Promise<DiffArtifactMeta> {
return this.updateFilePath(id, imagePath);
}
allocateFilePath(id: string, format: DiffOutputFormat = "png"): string {
return path.join(this.artifactDir(id), `preview.${format}`);
}
async createStandaloneFileArtifact(
params: CreateStandaloneFileArtifactParams = {},
): Promise<{ id: string; filePath: string; expiresAt: string }> {
await this.ensureRoot();
const id = crypto.randomBytes(10).toString("hex");
const artifactDir = this.artifactDir(id);
const format = params.format ?? "png";
const filePath = path.join(artifactDir, `preview.${format}`);
const ttlMs = normalizeTtlMs(params.ttlMs);
const createdAt = new Date();
const expiresAt = new Date(createdAt.getTime() + ttlMs).toISOString();
const meta: StandaloneFileMeta = {
kind: "standalone_file",
id,
createdAt: createdAt.toISOString(),
expiresAt,
filePath: this.normalizeStoredPath(filePath, "filePath"),
};
await fs.mkdir(artifactDir, { recursive: true });
await this.writeStandaloneMeta(meta);
this.scheduleCleanup();
return {
id,
filePath: meta.filePath,
expiresAt: meta.expiresAt,
};
}
allocateImagePath(id: string, format: DiffOutputFormat = "png"): string {
return this.allocateFilePath(id, format);
}
scheduleCleanup(): void {
this.maybeCleanupExpired();
}
async cleanupExpired(): Promise<void> {
await this.ensureRoot();
const entries = await fs.readdir(this.rootDir, { withFileTypes: true }).catch(() => []);
const now = Date.now();
await Promise.all(
entries
.filter((entry) => entry.isDirectory())
.map(async (entry) => {
const id = entry.name;
const meta = await this.readMeta(id);
if (meta) {
if (isExpired(meta)) {
await this.deleteArtifact(id);
}
return;
}
const standaloneMeta = await this.readStandaloneMeta(id);
if (standaloneMeta) {
if (isExpired(standaloneMeta)) {
await this.deleteArtifact(id);
}
return;
}
const artifactPath = this.artifactDir(id);
const stat = await fs.stat(artifactPath).catch(() => null);
if (!stat) {
return;
}
if (now - stat.mtimeMs > SWEEP_FALLBACK_AGE_MS) {
await this.deleteArtifact(id);
}
}),
);
}
private async ensureRoot(): Promise<void> {
await fs.mkdir(this.rootDir, { recursive: true });
}
private maybeCleanupExpired(): void {
const now = Date.now();
if (this.cleanupInFlight || now < this.nextCleanupAt) {
return;
}
this.nextCleanupAt = now + this.cleanupIntervalMs;
const cleanupPromise = this.cleanupExpired()
.catch((error) => {
this.nextCleanupAt = 0;
this.logger?.warn(`Failed to clean expired diff artifacts: ${String(error)}`);
})
.finally(() => {
if (this.cleanupInFlight === cleanupPromise) {
this.cleanupInFlight = null;
}
});
this.cleanupInFlight = cleanupPromise;
}
private artifactDir(id: string): string {
return this.resolveWithinRoot(id);
}
private async writeMeta(meta: DiffArtifactMeta): Promise<void> {
await this.writeJsonMeta(meta.id, "meta.json", meta);
}
private async readMeta(id: string): Promise<DiffArtifactMeta | null> {
const parsed = await this.readJsonMeta(id, "meta.json", "diff artifact");
if (!parsed) {
return null;
}
return parsed as DiffArtifactMeta;
}
private async writeStandaloneMeta(meta: StandaloneFileMeta): Promise<void> {
await this.writeJsonMeta(meta.id, "file-meta.json", meta);
}
private async readStandaloneMeta(id: string): Promise<StandaloneFileMeta | null> {
const parsed = await this.readJsonMeta(id, "file-meta.json", "standalone diff");
if (!parsed) {
return null;
}
try {
const value = parsed as Partial<StandaloneFileMeta>;
if (
value.kind !== "standalone_file" ||
typeof value.id !== "string" ||
typeof value.createdAt !== "string" ||
typeof value.expiresAt !== "string" ||
typeof value.filePath !== "string"
) {
return null;
}
return {
kind: value.kind,
id: value.id,
createdAt: value.createdAt,
expiresAt: value.expiresAt,
filePath: this.normalizeStoredPath(value.filePath, "filePath"),
};
} catch (error) {
this.logger?.warn(`Failed to normalize standalone diff metadata for ${id}: ${String(error)}`);
return null;
}
}
private metaFilePath(id: string, fileName: ArtifactMetaFileName): string {
return path.join(this.artifactDir(id), fileName);
}
private async writeJsonMeta(
id: string,
fileName: ArtifactMetaFileName,
data: unknown,
): Promise<void> {
await fs.writeFile(this.metaFilePath(id, fileName), JSON.stringify(data, null, 2), "utf8");
}
private async readJsonMeta(
id: string,
fileName: ArtifactMetaFileName,
context: string,
): Promise<unknown | null> {
try {
const raw = await fs.readFile(this.metaFilePath(id, fileName), "utf8");
return JSON.parse(raw) as unknown;
} catch (error) {
if (isFileNotFound(error)) {
return null;
}
this.logger?.warn(`Failed to read ${context} metadata for ${id}: ${String(error)}`);
return null;
}
}
private async deleteArtifact(id: string): Promise<void> {
await fs.rm(this.artifactDir(id), { recursive: true, force: true }).catch(() => {});
}
private resolveWithinRoot(...parts: string[]): string {
const candidate = path.resolve(this.rootDir, ...parts);
this.assertWithinRoot(candidate);
return candidate;
}
private normalizeStoredPath(rawPath: string, label: string): string {
const candidate = path.isAbsolute(rawPath)
? path.resolve(rawPath)
: path.resolve(this.rootDir, rawPath);
this.assertWithinRoot(candidate, label);
return candidate;
}
private assertWithinRoot(candidate: string, label = "path"): void {
const relative = path.relative(this.rootDir, candidate);
if (
relative === "" ||
(!relative.startsWith(`..${path.sep}`) && relative !== ".." && !path.isAbsolute(relative))
) {
return;
}
throw new Error(`Diff artifact ${label} escapes store root: ${candidate}`);
}
}
function normalizeTtlMs(value?: number): number {
if (!Number.isFinite(value) || value === undefined) {
return DEFAULT_TTL_MS;
}
const rounded = Math.floor(value);
if (rounded <= 0) {
return DEFAULT_TTL_MS;
}
return Math.min(rounded, MAX_TTL_MS);
}
function isExpired(meta: { expiresAt: string }): boolean {
const expiresAt = Date.parse(meta.expiresAt);
if (!Number.isFinite(expiresAt)) {
return true;
}
return Date.now() >= expiresAt;
}
function isFileNotFound(error: unknown): boolean {
return error instanceof Error && "code" in error && error.code === "ENOENT";
}
|