Files
faceclaw/tests/evenhub-containers.test.cjs

144 lines
6.0 KiB
JavaScript

// The SDK 0.0.14 additions to the page-container payload: the contextual menu
// (`menuObject`) and text brightness (`textColor`).
//
// The payloads here were captured by running the real @evenrealities/
// even_hub_sdk 0.0.14 against a stub `flutter_inappwebview.callHandler` and
// recording what it sent, so they are the literal wire shapes, not a reading
// of the docs. The rules the parser enforces are the ones the SDK enforces
// app-side before it will call the host at all.
const test = require("node:test");
const assert = require("node:assert/strict");
const { parsePage, declaredMenuItems } = require("../.test-build/app/apps/evenhub/containers.js");
const menuItem = (itemID, itemName) => ({ itemName, itemID });
test("a menuObject becomes the page's contextual menu", () => {
const page = parsePage({
containerTotalNum: 1,
textObject: [{ containerID: 1, containerName: "main", content: "hi" }],
menuObject: { menuItems: [menuItem(1, "Pause"), menuItem(2, "Resume")] },
});
assert.deepEqual(page.menuItems, [
{ itemName: "Pause", itemID: 1 },
{ itemName: "Resume", itemID: 2 },
]);
});
test("a page with no menuObject has no menu, which is how rebuild clears one", () => {
const page = parsePage({ textObject: [{ containerID: 1, containerName: "main" }] });
assert.deepEqual(page.menuItems, []);
});
test("protobuf-style menu keys parse the same as camelCase", () => {
const page = parsePage({ Menu_Object: { Menu_Items: [{ Item_Name: "Go", Item_ID: 3 }] } });
assert.deepEqual(page.menuItems, [{ itemName: "Go", itemID: 3 }]);
});
test("menu entries the firmware cannot represent are dropped, not the whole page", () => {
const page = parsePage({
textObject: [{ containerID: 1, containerName: "main", content: "kept" }],
menuObject: {
menuItems: [
menuItem(0, "zero id"),
menuItem(1, "ok"),
menuItem(1, "duplicate id"),
menuItem(2, "x".repeat(33)),
menuItem(3, "x".repeat(32)),
],
},
});
assert.deepEqual(page.menuItems, [
{ itemName: "ok", itemID: 1 },
{ itemName: "x".repeat(32), itemID: 3 },
]);
assert.equal(page.containers.length, 1, "an invalid menu must not cost the app its containers");
});
test("itemName is measured in UTF-8 bytes, not characters", () => {
// 11 three-byte characters is 33 bytes: over the limit despite being short.
const overLimit = "あ".repeat(11);
const atLimit = "あ".repeat(10); // 30 bytes
const page = parsePage({ menuObject: { menuItems: [menuItem(1, overLimit), menuItem(2, atLimit)] } });
assert.deepEqual(page.menuItems, [{ itemName: atLimit, itemID: 2 }]);
});
test("a menu is capped at the firmware's ten entries", () => {
const menuItems = Array.from({ length: 12 }, (_, i) => menuItem(i + 1, `item ${i + 1}`));
const page = parsePage({ menuObject: { menuItems } });
assert.equal(page.menuItems.length, 10);
assert.equal(page.menuItems[9].itemID, 10);
assert.equal(declaredMenuItems({ menuObject: { menuItems } }).length, 12, "the raw count drives the dropped-items log");
});
test("textColor carries brightness levels 0 through 4", () => {
for (const level of [0, 1, 2, 3, 4]) {
const page = parsePage({ textObject: [{ containerID: 1, containerName: "t", textColor: level }] });
assert.equal(page.containers[0].textColor, level);
}
});
test("an omitted or out-of-range textColor falls back to the device default", () => {
for (const textObject of [
[{ containerID: 1, containerName: "t" }],
[{ containerID: 1, containerName: "t", textColor: 5 }],
[{ containerID: 1, containerName: "t", textColor: -1 }],
[{ containerID: 1, containerName: "t", textColor: 2.5 }],
]) {
const page = parsePage({ textObject });
assert.equal(page.containers[0].textColor, undefined);
}
});
test("borderWidth is clamped to stock's maximum of 5", () => {
const page = parsePage({
listObject: [{ containerID: 1, containerName: "l", borderWidth: 9 }],
textObject: [{ containerID: 2, containerName: "t", borderWidth: 12 }, { containerID: 3, containerName: "u", borderWidth: 3 }],
});
assert.deepEqual(page.containers.map((c) => c.borderWidth), [5, 5, 3]);
});
test("a list without isItemSelectBorderEn has no selection border (protobuf default 0)", () => {
const page = parsePage({ listObject: [{ containerID: 1, containerName: "l", itemContainer: { itemName: ["a"] } }] });
assert.equal(page.containers[0].selectBorder, false);
assert.equal(page.containers[0].itemWidth, 0);
});
test("flags accept booleans (extension layouts) as well as 0/1 (stock)", () => {
const page = parsePage({
listObject: [{ containerID: 1, containerName: "l", isEventCapture: true, preserve: true, itemContainer: { itemName: ["a"], isItemSelectBorderEn: true } }],
textObject: [
{ containerID: 2, containerName: "t", isEventCapture: 1, preserve: 1 },
{ containerID: 3, containerName: "u", isEventCapture: false, preserve: false },
],
});
assert.deepEqual(
page.containers.map((c) => [c.name, c.isEventCapture, c.preserve]),
[["l", true, true], ["t", true, true], ["u", false, false]],
);
assert.equal(page.containers[0].selectBorder, true);
});
test("a layout font is the default for text and list containers, which override it field by field", () => {
const page = parsePage({
font: { family: "Inter", size: 24 },
listObject: [{ containerID: 1, containerName: "l", font: { weight: "bold" } }],
textObject: [{ containerID: 2, containerName: "t" }, { containerID: 3, containerName: "u", font: { family: "Terminus" } }],
imageObject: [{ containerID: 4, containerName: "i" }],
});
assert.deepEqual(
page.containers.map((c) => [c.name, c.font]),
[
["l", { family: "Inter", size: 24, weight: 700 }],
["i", undefined],
["t", { family: "Inter", size: 24 }],
["u", { family: "Terminus", size: 24 }],
],
);
});
test("containers without a font anywhere keep the stock font", () => {
const page = parsePage({ textObject: [{ containerID: 1, containerName: "t", content: "x" }] });
assert.equal(page.containers[0].font, undefined);
});