mirror of
https://github.com/PR0M3TH3AN/bitgate.git
synced 2026-10-27 16:41:03 +00:00
Renames the project and makes it as easy to adopt as BitLogin, which was the stated bar and which it did not previously meet. Rename (ADR 0005): @nostr-governance/* -> @bitgate/*, governance-* elements -> bitgate-*, createGovernanceRuntime -> createBitGate. "Governance" reads as DAO voting to this audience and named a category rather than a product; BitGate names the benefit and joins the bit- family that BitVid and BitRoad compose with. Domain types keep their names — the product is BitGate, the subject matter is still governance. The migration plan is left as written; this ADR records the change rather than rewriting history. Drop-in distribution (ADR 0006): adopting BitGate meant supplying a transport, authoring a policy, and wiring every element in JavaScript. Now: - createRelayTransport(urls) — WebSocket transport with reconnection, backoff, subscription replay, and cross-relay dedupe - policy presets (social, commerce, admin-only) addressable by name; the engine still carries no thresholds of its own - <bitgate-provider> — configuration in markup, with descendants finding the runtime through a bubbling context event rather than DOM walking, which breaks across shadow boundaries - npm run build:widget — a self-contained dist/bitgate.js That last one came from running it in a browser rather than from a test. Bare specifiers resolve in Node and vitest but not in a browser, so the widget source worked everywhere except a plain static page — the one place it exists to serve. The bundle is not committed: consumers build from reviewed source. Also found by running it: the provider's ready event fires during element upgrade, before a page that defines elements after parsing can attach a listener, so it now exposes `ready` as a promise too. Four bugs fixed along the way, three found by new tests and one by the browser: admin state stayed silent when a roster change altered capabilities but no denials; the relay transport sent every subscription twice on connect; the commerce preset computed a meaningless visibility verdict at checkout and could hide a listing from its own seller; <bitgate-status> threw on an unusable decision. 759 tests; lint, typecheck, and both builds clean.
322 lines
11 KiB
JavaScript
322 lines
11 KiB
JavaScript
// @vitest-environment happy-dom
|
|
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
import { createPolicyDefinition } from "@bitgate/core";
|
|
import {
|
|
createCommands,
|
|
createBitGate,
|
|
createMemoryTransport,
|
|
} from "@bitgate/runtime";
|
|
|
|
import { CAPABILITY_LABELS } from "../src/admin.js";
|
|
import { defineBitGateElements } from "../src/index.js";
|
|
import { shortenKey } from "../src/base.js";
|
|
|
|
const ROOT = "a1".repeat(32);
|
|
const MODERATOR = "b2".repeat(32);
|
|
const CURATOR = "c3".repeat(32);
|
|
const CREATOR = "d4".repeat(32);
|
|
const STRANGER = "f6".repeat(32);
|
|
const NOW = 1_750_000_000;
|
|
|
|
const POLICY = createPolicyDefinition({
|
|
id: "widget",
|
|
version: "1.0.0",
|
|
profiles: { feed: { name: "feed", reports: {}, mutes: {} } },
|
|
});
|
|
|
|
defineBitGateElements();
|
|
|
|
function makeRuntime(viewer) {
|
|
const runtime = createBitGate({
|
|
applicationId: "widget-test",
|
|
namespace: "widget",
|
|
transport: createMemoryTransport(),
|
|
policy: POLICY,
|
|
now: () => NOW,
|
|
root: ROOT,
|
|
});
|
|
runtime.admin.setRoles({
|
|
root: ROOT,
|
|
actors: {
|
|
[ROOT]: ["super_admin"],
|
|
[MODERATOR]: ["moderator"],
|
|
[CURATOR]: ["curator"],
|
|
},
|
|
});
|
|
if (viewer) {
|
|
runtime.setViewer(viewer);
|
|
}
|
|
return runtime;
|
|
}
|
|
|
|
/**
|
|
* @param {string} tag
|
|
* @param {any} runtime
|
|
* @param {Record<string, string>} [attributes]
|
|
* @returns {any}
|
|
*/
|
|
function mount(tag, runtime, attributes = {}) {
|
|
const element = /** @type {any} */ (document.createElement(tag));
|
|
for (const [name, value] of Object.entries(attributes)) {
|
|
element.setAttribute(name, value);
|
|
}
|
|
document.body.append(element);
|
|
element.runtime = runtime;
|
|
return element;
|
|
}
|
|
|
|
beforeEach(() => {
|
|
document.body.innerHTML = "";
|
|
});
|
|
|
|
describe("<bitgate-capabilities>", () => {
|
|
it("says when nobody is signed in", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime());
|
|
expect(panel.shadowRoot.textContent).toContain("Not signed in");
|
|
});
|
|
|
|
it("lists what a moderator holds", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime(MODERATOR));
|
|
const text = panel.shadowRoot.textContent;
|
|
expect(text).toContain(CAPABILITY_LABELS["contribute-user-deny"]);
|
|
expect(text).toContain(shortenKey(MODERATOR));
|
|
});
|
|
|
|
it("shows capabilities an actor lacks rather than omitting them", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime(CURATOR));
|
|
// A curator holds only contribute-user-deny, but every capability is
|
|
// listed so the boundary is legible.
|
|
for (const label of Object.values(CAPABILITY_LABELS)) {
|
|
expect(panel.shadowRoot.textContent).toContain(label);
|
|
}
|
|
});
|
|
|
|
it("marks held capabilities distinctly from unheld ones", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime(CURATOR));
|
|
const items = [...panel.shadowRoot.querySelectorAll("li")];
|
|
const held = items.filter((item) => item.textContent.includes("✓"));
|
|
expect(held).toHaveLength(1);
|
|
expect(held[0].textContent).toContain(CAPABILITY_LABELS["contribute-user-deny"]);
|
|
});
|
|
|
|
it("tells an account with no authority that it has none", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime(STRANGER));
|
|
expect(panel.shadowRoot.textContent).toContain("no governance capabilities");
|
|
});
|
|
|
|
it("grants the root everything", () => {
|
|
const panel = mount("bitgate-capabilities", makeRuntime(ROOT));
|
|
const held = [...panel.shadowRoot.querySelectorAll("li")].filter((item) =>
|
|
item.textContent.includes("✓"),
|
|
);
|
|
expect(held).toHaveLength(Object.keys(CAPABILITY_LABELS).length);
|
|
});
|
|
});
|
|
|
|
describe("<bitgate-action>", () => {
|
|
it("enables the control when the actor holds the capability", () => {
|
|
const action = mount("bitgate-action", makeRuntime(MODERATOR), {
|
|
capability: "contribute-user-deny",
|
|
label: "Restrict",
|
|
});
|
|
expect(action.shadowRoot.querySelector("#run").disabled).toBe(false);
|
|
});
|
|
|
|
it("disables it and explains why when they do not", () => {
|
|
const action = mount("bitgate-action", makeRuntime(CURATOR), {
|
|
capability: "contribute-event-deny",
|
|
label: "Restrict post",
|
|
});
|
|
|
|
expect(action.shadowRoot.querySelector("#run").disabled).toBe(true);
|
|
expect(action.shadowRoot.textContent).toContain("Requires permission to");
|
|
expect(action.shadowRoot.textContent).toContain(CAPABILITY_LABELS["contribute-event-deny"]);
|
|
});
|
|
|
|
it("keeps the control visible rather than hiding it", () => {
|
|
const action = mount("bitgate-action", makeRuntime(CURATOR), {
|
|
capability: "manage-roles",
|
|
label: "Edit roles",
|
|
});
|
|
expect(action.shadowRoot.querySelector("#run")).not.toBeNull();
|
|
expect(action.shadowRoot.textContent).toContain("Edit roles");
|
|
});
|
|
|
|
it("runs the action and announces completion", async () => {
|
|
const action = mount("bitgate-action", makeRuntime(MODERATOR), {
|
|
capability: "contribute-user-deny",
|
|
label: "Restrict",
|
|
});
|
|
action.action = vi.fn().mockResolvedValue({ ok: true });
|
|
|
|
const completed = vi.fn();
|
|
action.addEventListener("bitgate:action-completed", completed);
|
|
action.shadowRoot.querySelector("#run").click();
|
|
await action.pending;
|
|
expect(completed).toHaveBeenCalled();
|
|
|
|
expect(action.shadowRoot.textContent).toContain("Done");
|
|
});
|
|
|
|
it("reports a refusal with its stable code", async () => {
|
|
const action = mount("bitgate-action", makeRuntime(MODERATOR), {
|
|
capability: "contribute-user-deny",
|
|
label: "Restrict",
|
|
});
|
|
action.action = vi.fn().mockResolvedValue({ ok: false, code: "protected-target" });
|
|
|
|
const refused = vi.fn();
|
|
action.addEventListener("bitgate:action-refused", refused);
|
|
action.shadowRoot.querySelector("#run").click();
|
|
await action.pending;
|
|
expect(refused).toHaveBeenCalled();
|
|
|
|
expect(action.shadowRoot.textContent).toContain("protected-target");
|
|
});
|
|
|
|
it("reports a thrown failure without breaking the element", async () => {
|
|
const action = mount("bitgate-action", makeRuntime(MODERATOR), {
|
|
capability: "contribute-user-deny",
|
|
});
|
|
action.action = vi.fn().mockRejectedValue(new Error("relay down"));
|
|
|
|
const failed = vi.fn();
|
|
action.addEventListener("bitgate:action-failed", failed);
|
|
action.shadowRoot.querySelector("#run").click();
|
|
await action.pending;
|
|
expect(failed).toHaveBeenCalled();
|
|
|
|
expect(action.shadowRoot.textContent).toContain("relay down");
|
|
});
|
|
|
|
it("re-evaluates permission when the roster changes", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
const action = mount("bitgate-action", runtime, {
|
|
capability: "contribute-user-deny",
|
|
});
|
|
expect(action.shadowRoot.querySelector("#run").disabled).toBe(false);
|
|
|
|
runtime.admin.setRoles({ root: ROOT, actors: { [ROOT]: ["super_admin"] } });
|
|
expect(action.shadowRoot.querySelector("#run").disabled).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("<bitgate-admin-panel>", () => {
|
|
/**
|
|
* @param {any} runtime
|
|
* @param {Object} [options]
|
|
* @param {string} [options.source]
|
|
*/
|
|
function denyCreator(runtime, { source } = {}) {
|
|
runtime.admin.upsertContribution({
|
|
actor: source ? CURATOR : MODERATOR,
|
|
kind: "user-deny",
|
|
targets: [{ type: "user", pubkey: CREATOR }],
|
|
createdAt: NOW,
|
|
...(source ? { source } : {}),
|
|
});
|
|
}
|
|
|
|
it("reports when no runtime is attached", () => {
|
|
const panel = /** @type {any} */ (document.createElement("bitgate-admin-panel"));
|
|
document.body.append(panel);
|
|
expect(panel.shadowRoot.textContent).toContain("No runtime attached");
|
|
});
|
|
|
|
it("shows the roster summary", () => {
|
|
const panel = mount("bitgate-admin-panel", makeRuntime(MODERATOR));
|
|
expect(panel.shadowRoot.textContent).toContain(shortenKey(ROOT));
|
|
expect(panel.shadowRoot.textContent).toContain("actor(s)");
|
|
});
|
|
|
|
it("lists restricted accounts", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
denyCreator(runtime);
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
expect(panel.shadowRoot.textContent).toContain(shortenKey(CREATOR));
|
|
});
|
|
|
|
it("distinguishes a community list from a moderator action", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
denyCreator(runtime, { source: "curated-list" });
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
expect(panel.shadowRoot.textContent).toContain("community list");
|
|
});
|
|
|
|
it("attributes a direct action to a moderator", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
denyCreator(runtime);
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
expect(panel.shadowRoot.textContent).toContain("moderator");
|
|
expect(panel.shadowRoot.textContent).not.toContain("community list");
|
|
});
|
|
|
|
it("disables restriction for an actor without the capability", () => {
|
|
const panel = mount("bitgate-admin-panel", makeRuntime(STRANGER));
|
|
expect(panel.shadowRoot.querySelector("#deny").disabled).toBe(true);
|
|
expect(panel.shadowRoot.textContent).toContain("Requires permission");
|
|
});
|
|
|
|
it("issues the command through the runtime", async () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
const commands = createCommands(runtime);
|
|
vi.spyOn(commands, "denyUser").mockResolvedValue({ ok: true });
|
|
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
panel.commands = commands;
|
|
panel.shadowRoot.querySelector("#pubkey").value = CREATOR;
|
|
|
|
const restricted = vi.fn();
|
|
panel.addEventListener("bitgate:account-restricted", restricted);
|
|
panel.shadowRoot.querySelector("#deny").click();
|
|
await panel.pending;
|
|
expect(restricted).toHaveBeenCalled();
|
|
|
|
expect(commands.denyUser).toHaveBeenCalledWith(CREATOR);
|
|
});
|
|
|
|
it("surfaces a refusal from the command layer", async () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
const commands = createCommands(runtime);
|
|
vi.spyOn(commands, "denyUser").mockResolvedValue({ ok: false, code: "protected-target" });
|
|
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
panel.commands = commands;
|
|
panel.shadowRoot.querySelector("#pubkey").value = ROOT;
|
|
|
|
const refused = vi.fn();
|
|
panel.addEventListener("bitgate:action-refused", refused);
|
|
panel.shadowRoot.querySelector("#deny").click();
|
|
await panel.pending;
|
|
expect(refused).toHaveBeenCalled();
|
|
|
|
expect(panel.shadowRoot.textContent).toContain("protected-target");
|
|
});
|
|
|
|
it("warns when serving cached state", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
runtime.stale = true;
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
expect(panel.shadowRoot.textContent).toContain("relays unreachable");
|
|
});
|
|
|
|
it("updates when administrative state changes", () => {
|
|
const runtime = makeRuntime(MODERATOR);
|
|
const panel = mount("bitgate-admin-panel", runtime);
|
|
expect(panel.shadowRoot.textContent).toContain("Restricted accounts (0)");
|
|
|
|
denyCreator(runtime);
|
|
expect(panel.shadowRoot.textContent).toContain("Restricted accounts (1)");
|
|
});
|
|
});
|
|
|
|
describe("element registration", () => {
|
|
it("is idempotent", () => {
|
|
// Elements were registered at module load; a second call must not throw.
|
|
expect(() => defineBitGateElements()).not.toThrow();
|
|
expect(defineBitGateElements()).toEqual([]);
|
|
});
|
|
});
|