apps/Alex2Node
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

test: read an ErrorResponse off the broker; every answer has its own messageId

Browse source 
Step 2 replaced uuid by crypto.randomUUID() at three call sites (AlexaStatusMessage, AlexaErrorResponse,
Device.sendSceneResponse) and only the first was asserted, in the ES module test. With the messageId dropped or set
to a constant in the other two, the suite still passed 22/22, and no test read an ErrorResponse at all.

New: an ErrorResponse compared whole against the documented shape (header, endpoint, payload, no context), and one
test that sends two directives each to a light, an unreachable light and a scene and requires six different
version 4 UUIDs. The Response, StateReport, scene and change report tests check the messageId too; the pattern
lives in the harness.

Checked in a scratch copy: a missing or constant messageId at each of the three sites now fails the suite (the
missing one in AlexaStatusMessage does not compile). No change to src/ or dist/. npm test: 24 pass in 5.5 s.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
David 2026-09-28 14:26:44 +00:00
parent 1d88c7811a
commit f74773132a
4 changed files with 78 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

76
test/directives.test.js
View file

@ -4,9 +4,9 @@
const { test } = require("node:test");
const assert = require("node:assert/strict");
const {
Alex2MQTT, AlexaInterfaceType, DisplayCategory, PowerController, EndpointHealth, TemperatureSensorScale,
Alex2MQTT, AlexaErrorType, AlexaInterfaceType, DisplayCategory, PowerController, EndpointHealth, TemperatureSensorScale,
} = require("alex2node");
const { setup, directive, until } = require("./helpers/harness.js");
const { setup, directive, until, UUID_V4 } = require("./helpers/harness.js");
// A light that answers every directive with its new power state and ReportState with "off at 0 %".
function diningRoomLight(bridge) {
@ -29,6 +29,28 @@ function diningRoomLight(bridge) {
return lamp;
}
// A light that is not there: every directive is answered with ENDPOINT_UNREACHABLE.
function unpluggedLight(bridge) {
const lamp = bridge.registerDevice("Garage Light", "5020AB", DisplayCategory.LIGHT);
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
lamp.on("Event", (request) => {
const error = lamp.getErrorMessage(request.header.correlationToken);
error.setErrorMessage(AlexaErrorType.ENDPOINT_UNREACHABLE, "the light is unplugged");
error.send();
});
return lamp;
}
// A scene that answers Activate and Deactivate with the matching event.
function eveningScene(bridge) {
const scene = bridge.registerDevice("Evening", "scene-1", DisplayCategory.SCENE_TRIGGER);
scene.addCapability(AlexaInterfaceType.SCENE_CONTROLLER);
scene.on("Event", (request) => {
scene.sendSceneResponse(request.header.correlationToken, request.header.name === "Activate");
});
return scene;
}
test("a directive reaches the \"Event\" listener and is answered with a Response carrying its correlationToken", async () => {
const { alexa, bridge } = await setup(Alex2MQTT, "root");
const dispatched = [];
@ -40,6 +62,7 @@ test("a directive reaches the \"Event\" listener and is answered with a Response
const [response] = alexa.on("root/5020AA/alexaResponce");
assert.equal(response.event.header.name, "Response");
assert.equal(response.event.header.correlationToken, "ct1");
assert.match(response.event.header.messageId, UUID_V4);
assert.equal(response.context.properties.find((p) => p.name === "powerState").value, "ON");
assert.deepEqual(dispatched, [{ endpointId: "5020AA", namespace: "Alexa.PowerController", name: "TurnOn" }]);
});
@ -53,26 +76,65 @@ test("ReportState reaches the \"ReportState\" listener and is answered with a St
const [report] = alexa.on("root/5020AA/alexaResponce");
assert.equal(report.event.header.name, "StateReport");
assert.equal(report.event.header.correlationToken, "ct2");
assert.match(report.event.header.messageId, UUID_V4);
assert.deepEqual(report.context.properties.map((p) => [p.name, p.value]), [["powerState", "OFF"], ["brightness", 0]]);
});
test("getErrorMessage: the directive is answered with an ErrorResponse, the error type and message as its payload", async () => {
const { alexa, bridge } = await setup(Alex2MQTT, "root");
unpluggedLight(bridge);
alexa.send("root", directive("Alexa.PowerController", "TurnOn", "5020AB", "ct4"));
await until(() => alexa.on("root/5020AB/alexaResponce").length === 1, 3000, "error response");
const [answer] = alexa.on("root/5020AB/alexaResponce");
const { messageId, ...header } = answer.event.header;
assert.match(messageId, UUID_V4);
// The event alone, without a context (Alexa.ErrorResponse, "Synchronous error response")
assert.deepEqual({ ...answer, event: { ...answer.event, header } }, {
event: {
header: { namespace: "Alexa", name: "ErrorResponse", correlationToken: "ct4", payloadVersion: "3" },
endpoint: { endpointId: "5020AB" },
payload: { type: "ENDPOINT_UNREACHABLE", message: "the light is unplugged" },
},
});
});
test("SceneController: Activate is answered with ActivationStarted", async () => {
const { alexa, bridge } = await setup(Alex2MQTT, "root");
const scene = bridge.registerDevice("Evening", "scene-1", DisplayCategory.SCENE_TRIGGER);
scene.addCapability(AlexaInterfaceType.SCENE_CONTROLLER);
scene.on("Event", (request) => {
scene.sendSceneResponse(request.header.correlationToken, request.header.name === "Activate");
});
eveningScene(bridge);
alexa.send("root", directive("Alexa.SceneController", "Activate", "scene-1", "ct3"));
await until(() => alexa.on("root/scene-1/alexaResponce").length === 1, 3000, "scene response");
const [started] = alexa.on("root/scene-1/alexaResponce");
assert.equal(started.event.header.namespace, "Alexa.SceneController");
assert.equal(started.event.header.name, "ActivationStarted");
assert.match(started.event.header.messageId, UUID_V4);
assert.equal(started.event.payload.cause.type, "VOICE_INTERACTION");
assert.ok(started.event.payload.timestamp);
});
test("no two answers share a messageId: Response, ErrorResponse and the scene events each get a new one", async () => {
const { alexa, bridge } = await setup(Alex2MQTT, "root");
diningRoomLight(bridge);
unpluggedLight(bridge);
eveningScene(bridge);
const answers = () => alexa.got.filter((m) => m.topic.endsWith("/alexaResponce")).map((m) => m.payload.event.header);
for (const token of ["first", "second"]) {
alexa.send("root", directive("Alexa.PowerController", "TurnOn", "5020AA", token));
alexa.send("root", directive("Alexa.PowerController", "TurnOn", "5020AB", token));
alexa.send("root", directive("Alexa.SceneController", "Activate", "scene-1", token));
}
await until(() => answers().length === 6, 3000, "six answers");
assert.deepEqual(
answers().map((header) => header.name).sort(),
["ActivationStarted", "ActivationStarted", "ErrorResponse", "ErrorResponse", "Response", "Response"]
);
const ids = answers().map((header) => header.messageId);
for (const id of ids) assert.match(id, UUID_V4);
assert.equal(new Set(ids).size, 6, `a messageId is used twice: ${ids.join(" ")}`);
});
test("the temperature helpers convert Fahrenheit to Celsius (as 1.4.0 did)", async () => {
const { bridge } = await setup(Alex2MQTT, "root");
const lamp = diningRoomLight(bridge);