mirror of
https://github.com/openclaw/openclaw.git
synced 2026-08-05 19:41:50 +00:00
06480d767c
* feat(dashboard): pin canvas widgets through board domain * feat(control-ui): wire session dashboards end to end * fix(control-ui): preserve direct reset confirmation * fix(control-ui): localize dashboard default tab * test(dashboard): satisfy changed typecheck gate * fix(dashboard): satisfy changed lint gate * fix(dashboard): harden pinned widget lifecycle * fix(dashboard): use extracted mock normalizer * test(dashboard): reconcile hardened board admission tests * fix(dashboard): align grant and canvas protocol requests * fix(dashboard): preserve refresh and pin invariants * fix(boards): treat missing board tables as empty on read-only paths * fix(boards): accept read-only handles in board table probe * fix(control-ui): preserve virtual board widget types * fix(dashboard): align view types with protocol * fix(dashboard): keep resolved board view typed * chore(canvas): drop test-only html read wrapper * chore(release): defer dashboard note generation * fix(protocol): align board widget put params type * fix(control-ui): preserve queued reset approval * fix(control-ui): gate dashboard pinning capability * chore(test): isolate dashboard capability fixture * fix(control-ui): refresh dashboard pin affordance
209 lines
7.1 KiB
TypeScript
209 lines
7.1 KiB
TypeScript
// Core Canvas document storage and URL contract coverage.
|
|
import { mkdtemp, mkdir, readFile, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
import {
|
|
createCanvasDocument,
|
|
readCanvasDocumentHtmlSource,
|
|
resolveCanvasDocumentsDir,
|
|
resolveCanvasHttpPathToLocalPath,
|
|
} from "./documents.js";
|
|
|
|
const tempDirs: string[] = [];
|
|
|
|
afterEach(async () => {
|
|
await Promise.all(tempDirs.splice(0).map((dir) => rm(dir, { recursive: true, force: true })));
|
|
});
|
|
|
|
async function createTempDir(label = "openclaw-canvas-documents-"): Promise<string> {
|
|
const dir = await mkdtemp(path.join(tmpdir(), label));
|
|
tempDirs.push(dir);
|
|
return dir;
|
|
}
|
|
|
|
function resolveCanvasDocumentDir(stateDir: string, documentId: string): string {
|
|
return path.join(resolveCanvasDocumentsDir(stateDir), documentId);
|
|
}
|
|
|
|
describe("canvas documents", () => {
|
|
it("builds entry urls for materialized path documents under managed storage", async () => {
|
|
const stateDir = await createTempDir();
|
|
const workspaceDir = await createTempDir("openclaw-canvas-documents-workspace-");
|
|
await mkdir(path.join(workspaceDir, "player"), { recursive: true });
|
|
await writeFile(path.join(workspaceDir, "player/index.html"), "<div>ok</div>", "utf8");
|
|
|
|
const document = await createCanvasDocument(
|
|
{
|
|
kind: "html_bundle",
|
|
entrypoint: { type: "path", value: "player/index.html" },
|
|
},
|
|
{ stateDir, workspaceDir },
|
|
);
|
|
|
|
expect(document.entryUrl).toContain("/__openclaw__/canvas/documents/");
|
|
expect(document.localEntrypoint).toBe("index.html");
|
|
expect(resolveCanvasDocumentDir(stateDir, document.id)).toContain(stateDir);
|
|
});
|
|
|
|
it("materializes inline html bundles as index documents", async () => {
|
|
const stateDir = await createTempDir();
|
|
const document = await createCanvasDocument(
|
|
{
|
|
kind: "html_bundle",
|
|
title: "Preview",
|
|
entrypoint: {
|
|
type: "html",
|
|
value:
|
|
"<!doctype html><html><head><style>.demo{color:red}</style></head><body><div class='demo'>Front</div></body></html>",
|
|
},
|
|
},
|
|
{ stateDir },
|
|
);
|
|
|
|
const indexHtml = await readFile(
|
|
path.join(resolveCanvasDocumentDir(stateDir, document.id), "index.html"),
|
|
"utf8",
|
|
);
|
|
expect(indexHtml).toContain("<div class='demo'>Front</div>");
|
|
expect(indexHtml).toContain("<style>.demo{color:red}</style>");
|
|
expect(document.title).toBe("Preview");
|
|
expect(document.entryUrl).toBe(`/__openclaw__/canvas/documents/${document.id}/index.html`);
|
|
await expect(readCanvasDocumentHtmlSource(document.id, { stateDir })).resolves.toEqual({
|
|
html: indexHtml,
|
|
});
|
|
});
|
|
|
|
it("reports the document sandbox policy alongside board source bytes", async () => {
|
|
const stateDir = await createTempDir();
|
|
const document = await createCanvasDocument(
|
|
{
|
|
kind: "html_bundle",
|
|
entrypoint: { type: "html", value: "<script>ready()</script>" },
|
|
cspSandbox: "scripts",
|
|
},
|
|
{ stateDir },
|
|
);
|
|
|
|
await expect(readCanvasDocumentHtmlSource(document.id, { stateDir })).resolves.toEqual({
|
|
html: "<script>ready()</script>",
|
|
cspSandbox: "scripts",
|
|
});
|
|
});
|
|
|
|
it("reuses a supplied stable id by replacing the prior materialized view", async () => {
|
|
const stateDir = await createTempDir();
|
|
const first = await createCanvasDocument(
|
|
{
|
|
id: "status-card",
|
|
kind: "html_bundle",
|
|
entrypoint: { type: "html", value: "<div>first</div>" },
|
|
},
|
|
{ stateDir },
|
|
);
|
|
const second = await createCanvasDocument(
|
|
{
|
|
id: "status-card",
|
|
kind: "html_bundle",
|
|
entrypoint: { type: "html", value: "<div>second</div>" },
|
|
},
|
|
{ stateDir },
|
|
);
|
|
|
|
expect(first.id).toBe("status-card");
|
|
expect(second.id).toBe("status-card");
|
|
const indexHtml = await readFile(
|
|
path.join(resolveCanvasDocumentDir(stateDir, second.id), "index.html"),
|
|
"utf8",
|
|
);
|
|
expect(indexHtml).toContain("second");
|
|
expect(indexHtml).not.toContain("first");
|
|
});
|
|
|
|
it("copies declared assets into managed storage", async () => {
|
|
const stateDir = await createTempDir();
|
|
const workspaceDir = await createTempDir("openclaw-canvas-documents-workspace-");
|
|
await mkdir(path.join(workspaceDir, "collection.media"), { recursive: true });
|
|
await writeFile(path.join(workspaceDir, "collection.media/audio.mp3"), "audio", "utf8");
|
|
|
|
const document = await createCanvasDocument(
|
|
{
|
|
kind: "html_bundle",
|
|
entrypoint: { type: "html", value: "<audio></audio>" },
|
|
assets: [
|
|
{
|
|
logicalPath: "collection.media/audio.mp3",
|
|
sourcePath: "collection.media/audio.mp3",
|
|
contentType: "audio/mpeg",
|
|
},
|
|
],
|
|
},
|
|
{ stateDir, workspaceDir },
|
|
);
|
|
|
|
expect(document.assets).toEqual([
|
|
{ logicalPath: "collection.media/audio.mp3", contentType: "audio/mpeg" },
|
|
]);
|
|
await expect(
|
|
readFile(
|
|
path.join(resolveCanvasDocumentDir(stateDir, document.id), "collection.media/audio.mp3"),
|
|
"utf8",
|
|
),
|
|
).resolves.toBe("audio");
|
|
});
|
|
|
|
it("wraps local and remote PDF documents in index viewer pages", async () => {
|
|
const stateDir = await createTempDir();
|
|
const workspaceDir = await createTempDir("openclaw-canvas-documents-workspace-");
|
|
await writeFile(path.join(workspaceDir, "demo.pdf"), "%PDF-1.4", "utf8");
|
|
const localDocument = await createCanvasDocument(
|
|
{ kind: "document", entrypoint: { type: "path", value: "demo.pdf" } },
|
|
{ stateDir, workspaceDir },
|
|
);
|
|
const remoteDocument = await createCanvasDocument(
|
|
{
|
|
kind: "document",
|
|
entrypoint: { type: "url", value: "https://example.com/demo.pdf" },
|
|
},
|
|
{ stateDir },
|
|
);
|
|
|
|
const localHtml = await readFile(
|
|
path.join(resolveCanvasDocumentDir(stateDir, localDocument.id), "index.html"),
|
|
"utf8",
|
|
);
|
|
const remoteHtml = await readFile(
|
|
path.join(resolveCanvasDocumentDir(stateDir, remoteDocument.id), "index.html"),
|
|
"utf8",
|
|
);
|
|
expect(localHtml).toContain('data="demo.pdf"');
|
|
expect(remoteHtml).toContain('data="https://example.com/demo.pdf"');
|
|
});
|
|
|
|
it("rejects traversal and malformed encoded hosted paths", async () => {
|
|
const stateDir = await createTempDir();
|
|
expect(
|
|
resolveCanvasHttpPathToLocalPath(
|
|
"/__openclaw__/canvas/documents/../collection.media/index.html",
|
|
{ stateDir },
|
|
),
|
|
).toBeNull();
|
|
|
|
const documentDir = resolveCanvasDocumentDir(stateDir, "cv_malformed");
|
|
await mkdir(documentDir, { recursive: true });
|
|
await writeFile(path.join(documentDir, "%E0%A4%A.html"), "literal-percent-name", "utf8");
|
|
expect(
|
|
resolveCanvasHttpPathToLocalPath(
|
|
"/__openclaw__/canvas/documents/cv_malformed/%E0%A4%A.html",
|
|
{ stateDir },
|
|
),
|
|
).toBeNull();
|
|
expect(
|
|
resolveCanvasHttpPathToLocalPath(
|
|
"/__openclaw__/canvas/documents/cv_malformed/%25E0%25A4%25A.html",
|
|
{ stateDir },
|
|
),
|
|
).toBe(path.join(documentDir, "%E0%A4%A.html"));
|
|
});
|
|
});
|