@ajclarkson/homerun 0.0.1-edge.52a28ef → 0.0.1-edge.554fca4

package/dist/scripts/generate-ha-types.js

@@ -8,18 +8,14 @@ export function inferStateType(entity, allObservedStates) {
         case 'binary_sensor':
         case 'input_boolean':
         case 'switch':
-            return "'on' | 'off'";
+            return "'on' | 'off' | 'unavailable' | 'unknown'";
         case 'input_select': {
             const options = entity.attributes.options;
             if (Array.isArray(options) && options.length > 0) {
-                return options.map((o) => `'${o}'`).join(' | ');
+                return options.map((o) => `'${o}'`).join(' | ') + " | 'unavailable' | 'unknown'";
             }
             return 'string';
         }
-        case 'person': {
-            const states = allObservedStates ?? [entity.state];
-            return [...new Set(states)].map((s) => `'${s}'`).join(' | ');
-        }
         default:
             return 'string';
     }
@@ -37,18 +33,16 @@ export function generateFileContent(states) {
     const entries = states
         .map((s) => {
         const stateType = inferStateType(s, personStates.get(s.entity_id));
-        return `  '${s.entity_id}': { state: ${stateType} };`;
+        return `    '${s.entity_id}': { state: ${stateType} };`;
     })
         .join('\n');
     return `// generated — do not edit — run: npm run generate:ha-types
-export interface HAEntities {
+declare global {
+  interface HAEntities {
 ${entries}
+  }
 }
-
-export type HAState = {
-  <E extends keyof HAEntities>(entity: E): HAEntities[E]['state'];
-  <E extends string>(entity: E): string | undefined;
-};
+export {};
 `;
 }
 // ---------- CLI ----------

package/dist/src/framework/action-runtime.d.ts

@@ -9,6 +9,9 @@ export interface ExecutionContext {
     automationId: string;
     location: string;
     subsystem: string;
+    rootCorrelationId?: string;
+    parentCorrelationId?: string;
+    parentAutomationId?: string;
 }
 interface Deps {
     haClient: HAClient;
@@ -17,13 +20,20 @@ interface Deps {
     eventPublisher: EventPublisher;
     dryRun: boolean;
     metrics?: MetricsBackend;
+    commandAck?: {
+        enabled: boolean;
+        timeoutMs: number;
+    };
 }
 export declare class ActionRuntime {
     private readonly deps;
     constructor(deps: Deps);
+    private handleAckTimeout;
     execute(actions: Action[], ctx: ExecutionContext): Promise<void>;
     private runAction;
     private dispatch;
-    private makeEvent;
+    private baseFields;
+    private makeStartedEvent;
+    private makeResultEvent;
 }
 export {};

package/dist/src/framework/action-runtime.js

@@ -1,7 +1,90 @@
+function safeStringify(err) {
+    try {
+        return JSON.stringify(err);
+    }
+    catch {
+        return String(err);
+    }
+}
+// HA `data` keys are conventionally the same name as the attribute they end up setting
+// (temperature, brightness, position, ...) — true across core and third-party integrations
+// as a platform-wide naming convention, not something homerun needs to hand-map per service.
+// These are the known exceptions: call parameters that don't name a resulting attribute.
+const NON_ATTRIBUTE_DATA_KEYS = new Set(['transition', 'entity_id']);
+// `set_value` on these domains sets the entity's top-level `state` directly — unlike most
+// services, where a `data` key names the attribute it ends up on, these have no attribute
+// called `value` at all. Found the hard way (#153): computeExpectedAck's generic convention
+// falsely flagged every number/input_text room-sensor feed call as an ack timeout, since
+// `attributes.value` never existed to satisfy.
+const SET_VALUE_TO_STATE_DOMAINS = new Set(['number', 'input_number', 'input_text', 'input_select', 'text']);
+// Domains/services excluded from tracking entirely rather than guessing at a convention that
+// doesn't hold cleanly — group membership attributes don't reliably come back as an exact
+// match of what was passed (ordering, or reflecting the whole group rather than the delta).
+// scene.turn_on is here for a different reason (#156): a scene entity's `state` is a
+// last-activated timestamp, not 'on'/'off', so the generic turn_on special-case never
+// matches — and even a timestamp-based check would only confirm HA accepted the call, not
+// that the scene's member entities (the things that actually matter) responded. Real
+// coverage would mean tracking each member entity individually — see #155.
+const UNTRACKED_SERVICES = new Set(['media_player.join', 'media_player.unjoin', 'scene.turn_on']);
+// Computes the field/attribute -> value map a dispatched call is expected to produce, or
+// undefined if there's nothing to track (no inferable fields, an excluded service, or the
+// entity already matches every expected field — an idempotent call that legitimately produces
+// no state_changed at all). See #55's design discussion for why this is convention-based
+// rather than a per-service table.
+function computeExpectedAck(action, current) {
+    if (UNTRACKED_SERVICES.has(`${action.domain}.${action.service}`))
+        return undefined;
+    const expected = {};
+    if (action.service === 'turn_on') {
+        expected.state = 'on';
+    }
+    else if (action.service === 'turn_off') {
+        expected.state = 'off';
+    }
+    else if (action.service === 'set_value' && SET_VALUE_TO_STATE_DOMAINS.has(action.domain) && action.data?.value !== undefined) {
+        expected.state = action.data.value;
+    }
+    for (const [key, value] of Object.entries(action.data ?? {})) {
+        if (NON_ATTRIBUTE_DATA_KEYS.has(key))
+            continue;
+        if ('state' in expected && key === 'value' && SET_VALUE_TO_STATE_DOMAINS.has(action.domain))
+            continue;
+        expected[key] = value;
+    }
+    if (Object.keys(expected).length === 0)
+        return undefined;
+    // See ha-client.ts's ackSatisfied for why `state` needs string coercion (#158) — the same
+    // number-vs-string gap applies here to the idempotency pre-check.
+    const alreadySatisfied = Object.entries(expected).every(([key, value]) => key === 'state' ? current !== undefined && String(current.state) === String(value) : current?.attributes[key] === value);
+    if (alreadySatisfied)
+        return undefined;
+    return expected;
+}
 export class ActionRuntime {
     deps;
     constructor(deps) {
         this.deps = deps;
+        this.deps.haClient.on('action_ack_timeout', (e) => this.handleAckTimeout(e));
+    }
+    handleAckTimeout(e) {
+        this.deps.metrics?.incrementCounter('homerun_action_ack_timeout_total', {
+            location: e.location,
+            action_type: e.action.type,
+        });
+        this.deps.eventPublisher.publishActionEvent({
+            schema: 'home.events.v2',
+            correlation_id: e.correlationId,
+            root_correlation_id: e.rootCorrelationId ?? e.correlationId,
+            automation_id: e.automationId,
+            location: e.location,
+            subsystem: e.subsystem,
+            timestamp: new Date().toISOString(),
+            ...(this.deps.dryRun ? { dry_run: true } : {}),
+            event_type: 'action_ack_timeout',
+            action: e.action,
+            entity: e.entity_id,
+            expected: e.expected,
+        });
     }
     async execute(actions, ctx) {
         for (const action of actions) {
@@ -10,32 +93,63 @@ export class ActionRuntime {
     }
     async runAction(action, ctx) {
         const labels = { location: ctx.location, action_type: action.type };
-        this.deps.eventPublisher.publishActionEvent(this.makeEvent(ctx, 'action_started', action));
+        this.deps.eventPublisher.publishActionEvent(this.makeStartedEvent(ctx, action));
         this.deps.metrics?.incrementCounter('homerun_actions_dispatched_total', labels);
         const start = performance.now();
         try {
             if (!this.deps.dryRun) {
-                await this.dispatch(action);
+                await this.dispatch(action, ctx);
             }
             const duration = (performance.now() - start) / 1000;
             this.deps.metrics?.observeHistogram('homerun_action_duration_seconds', duration, labels);
             this.deps.metrics?.incrementCounter('homerun_actions_succeeded_total', labels);
-            this.deps.eventPublisher.publishActionEvent(this.makeEvent(ctx, 'action_result', action, { reason: 'ok' }));
+            this.deps.eventPublisher.publishActionEvent(this.makeResultEvent(ctx, action, 'ok'));
         }
         catch (err) {
             const duration = (performance.now() - start) / 1000;
             this.deps.metrics?.observeHistogram('homerun_action_duration_seconds', duration, labels);
             this.deps.metrics?.incrementCounter('homerun_actions_failed_total', labels);
-            const reason = err instanceof Error ? err.message : String(err);
-            this.deps.eventPublisher.publishActionEvent(this.makeEvent(ctx, 'action_result', action, { reason }));
+            const error = err instanceof Error
+                ? err.message
+                : typeof err === 'object' && err !== null
+                    ? safeStringify(err)
+                    : String(err);
+            this.deps.eventPublisher.publishActionEvent(this.makeResultEvent(ctx, action, 'error', error));
         }
     }
-    async dispatch(action) {
+    async dispatch(action, ctx) {
         switch (action.type) {
-            case 'ha.call_service':
-                await this.deps.haClient.callService(action.domain, action.service, action.target, action.data);
+            case 'ha.call_service': {
+                const entityId = action.target?.entity_id;
+                if (this.deps.commandAck?.enabled && entityId) {
+                    const expected = computeExpectedAck(action, this.deps.haClient.state(entityId));
+                    if (expected) {
+                        this.deps.haClient.registerPendingAck(entityId, {
+                            correlationId: ctx.correlationId,
+                            rootCorrelationId: ctx.rootCorrelationId,
+                            automationId: ctx.automationId,
+                            location: ctx.location,
+                            subsystem: ctx.subsystem,
+                            action,
+                            expected,
+                        }, this.deps.commandAck.timeoutMs);
+                    }
+                }
+                await this.deps.haClient.callService(action.domain, action.service, action.target, action.data, {
+                    correlationId: ctx.correlationId,
+                    rootCorrelationId: ctx.rootCorrelationId,
+                    automationId: ctx.automationId,
+                });
                 break;
+            }
             case 'mqtt.publish':
+                if (action.impliesEntity) {
+                    this.deps.haClient.registerPendingWrite(action.impliesEntity, {
+                        correlationId: ctx.correlationId,
+                        rootCorrelationId: ctx.rootCorrelationId,
+                        automationId: ctx.automationId,
+                    });
+                }
                 await this.deps.mqttClient.publishAsync(action.topic, action.payload, { retain: action.retain ?? false });
                 break;
             case 'timer.start':
@@ -50,18 +164,30 @@ export class ActionRuntime {
             }
         }
     }
-    makeEvent(ctx, event_type, action, extra = {}) {
+    baseFields(ctx) {
         return {
-            schema: 'home.events.v1',
+            schema: 'home.events.v2',
             correlation_id: ctx.correlationId,
+            root_correlation_id: ctx.rootCorrelationId ?? ctx.correlationId,
             automation_id: ctx.automationId,
             location: ctx.location,
             subsystem: ctx.subsystem,
-            event_type,
-            actions: [action],
             timestamp: new Date().toISOString(),
             ...(this.deps.dryRun ? { dry_run: true } : {}),
-            ...extra,
+            ...(ctx.parentCorrelationId && { parent_correlation_id: ctx.parentCorrelationId }),
+            ...(ctx.parentAutomationId && { parent_automation_id: ctx.parentAutomationId }),
+        };
+    }
+    makeStartedEvent(ctx, action) {
+        return { ...this.baseFields(ctx), event_type: 'action_started', action };
+    }
+    makeResultEvent(ctx, action, status, error) {
+        return {
+            ...this.baseFields(ctx),
+            event_type: 'action_result',
+            action,
+            status,
+            ...(error !== undefined && { error }),
         };
     }
 }

package/dist/src/framework/api-server.js

@@ -64,7 +64,8 @@ export class ApiServer {
             json(res, 404, { error: `no automation with id "${id}"` });
             return;
         }
-        this.deps.onTrigger(automation, { type: 'on_start', correlation_id: crypto.randomUUID() });
+        const correlation_id = crypto.randomUUID();
+        this.deps.onTrigger(automation, { type: 'on_start', correlation_id, root_correlation_id: correlation_id });
         json(res, 200, { ok: true });
     }
     postReload(res) {

package/dist/src/framework/config.d.ts

@@ -20,6 +20,13 @@ declare const ConfigSchema: z.ZodObject<{
     metrics: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
+    events: z.ZodDefault<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    commandAck: z.ZodDefault<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        timeoutMs: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export type HomerunConfig = z.infer<typeof ConfigSchema>;
 export declare function parseConfig(configContent: string, secretsContent?: string): HomerunConfig;

package/dist/src/framework/config.js

@@ -9,6 +9,8 @@ function isSecretRef(v) {
 const secretTag = defineScalarTag('!secret', {
     implicit: false,
     resolve: (source) => ({ __secret: source }),
+    // Load-only tag — config is never dumped back to YAML, so identify() is unreachable.
+    identify: () => false,
 });
 const SCHEMA_WITH_SECRET = CORE_SCHEMA.withTags(secretTag);
 const ConfigSchema = z.object({
@@ -32,6 +34,17 @@ const ConfigSchema = z.object({
     metrics: z.object({
         enabled: z.boolean().default(false),
     }).default({ enabled: false }),
+    events: z.object({
+        // Defaults to true — preserves existing behaviour for deployments that don't set this.
+        enabled: z.boolean().default(true),
+    }).default({ enabled: true }),
+    commandAck: z.object({
+        // Opt-in: unlike events.enabled, this is new/experimental behaviour with no prior
+        // installed base to preserve, so it defaults off rather than needing a reason to disable.
+        enabled: z.boolean().default(false),
+        // Needs to accommodate slow Zigbee mesh round-trips, not just fast local calls.
+        timeoutMs: z.coerce.number().int().min(0).default(8_000),
+    }).default({ enabled: false, timeoutMs: 8_000 }),
 });
 function resolveSecrets(value, secrets) {
     if (isSecretRef(value)) {

package/dist/src/framework/event-publisher.d.ts

@@ -1,19 +1,46 @@
 import type { MqttClient } from 'mqtt';
 import type { Action } from '../types/actions.js';
-export interface ObsEvent {
-    schema: 'home.events.v1';
+import type { TriggerSummary } from '../types/triggers.js';
+type ObsEventBase = {
+    schema: 'home.events.v2';
     correlation_id: string;
+    root_correlation_id: string;
+    parent_correlation_id?: string;
+    parent_automation_id?: string;
     automation_id: string;
     location: string;
     subsystem: string;
-    event_type: 'decision' | 'abort' | 'action_started' | 'action_result';
-    decision?: string;
-    reason?: string;
-    inputs?: Record<string, unknown>;
-    actions?: Action[];
-    dry_run?: boolean;
     timestamp: string;
-}
+    dry_run?: boolean;
+};
+export type ObsEvent = ObsEventBase & ({
+    event_type: 'decision';
+    trigger: TriggerSummary;
+    decision: string;
+    reason?: string;
+    conditions?: Record<string, unknown>;
+    actions: Action[];
+    hasAction: boolean;
+} | {
+    event_type: 'abort';
+    trigger: TriggerSummary;
+    abort_kind: 'disabled' | 'unhandled_error' | 'guard' | 'unavailable_input';
+    reason?: string;
+    entity?: string;
+} | {
+    event_type: 'action_started';
+    action: Action;
+} | {
+    event_type: 'action_result';
+    action: Action;
+    status: 'ok' | 'error';
+    error?: string;
+} | {
+    event_type: 'action_ack_timeout';
+    action: Action;
+    entity: string;
+    expected: Record<string, unknown>;
+});
 export type LifecycleEventType = 'server_started' | 'server_stopping' | 'rescan_complete' | 'ha_reconnected';
 export interface LifecycleEvent {
     schema: 'home.lifecycle.v1';
@@ -24,11 +51,15 @@ export interface LifecycleEvent {
 }
 export declare class EventPublisher {
     private readonly mqtt;
+    private readonly enabled;
     private readonly listeners;
-    constructor(mqtt: MqttClient);
+    constructor(mqtt: MqttClient, enabled?: boolean);
     subscribe(listener: (event: ObsEvent) => void): () => void;
     publishDecision(event: ObsEvent): void;
     publishActionEvent(event: ObsEvent): void;
     publishLifecycle(type: LifecycleEventType, automationCount: number, dryRun?: boolean): void;
     private publish;
+    private safeSerialize;
+    private notifyListeners;
 }
+export {};

package/dist/src/framework/event-publisher.js

@@ -1,8 +1,14 @@
 export class EventPublisher {
     mqtt;
+    enabled;
     listeners = [];
-    constructor(mqtt) {
+    // `enabled` gates MQTT publishing of decision/action ObsEvents only (mirrors metrics.enabled;
+    // see #144) — publishLifecycle (status/online heartbeat) is unaffected, and listeners (the
+    // /events SSE endpoint, any future persistent store) are always notified regardless, so
+    // consumers that don't want the MQTT stream aren't forced to lose in-process observability too.
+    constructor(mqtt, enabled = true) {
         this.mqtt = mqtt;
+        this.enabled = enabled;
     }
     subscribe(listener) {
         this.listeners.push(listener);
@@ -13,18 +19,25 @@ export class EventPublisher {
         };
     }
     publishDecision(event) {
-        const payload = JSON.stringify(event);
-        const ns = event.dry_run ? 'homerun/dev' : 'homerun';
-        this.publish(`${ns}/events`, payload, false);
-        this.publish(`${ns}/${event.location}/${event.subsystem}/decision`, payload, true);
-        for (const l of this.listeners)
-            l(event);
+        if (this.enabled) {
+            const payload = this.safeSerialize(event);
+            if (payload !== undefined) {
+                const ns = event.dry_run ? 'homerun/dev' : 'homerun';
+                this.publish(`${ns}/events`, payload, false);
+                this.publish(`${ns}/${event.location}/${event.subsystem}/decision`, payload, true);
+            }
+        }
+        this.notifyListeners(event);
     }
     publishActionEvent(event) {
-        const ns = event.dry_run ? 'homerun/dev' : 'homerun';
-        this.publish(`${ns}/events`, JSON.stringify(event), false);
-        for (const l of this.listeners)
-            l(event);
+        if (this.enabled) {
+            const payload = this.safeSerialize(event);
+            if (payload !== undefined) {
+                const ns = event.dry_run ? 'homerun/dev' : 'homerun';
+                this.publish(`${ns}/events`, payload, false);
+            }
+        }
+        this.notifyListeners(event);
     }
     publishLifecycle(type, automationCount, dryRun = false) {
         const event = {
@@ -44,4 +57,29 @@ export class EventPublisher {
             console.error(`[EventPublisher] MQTT publish failed on ${topic}:`, err);
         });
     }
+    // Observability must never affect automation behaviour — a decision/action event that fails
+    // to serialize (e.g. conditions defaulting to a context object with a circular reference) must
+    // not throw, since runPipeline awaits this alongside actionRuntime.execute() in the same
+    // Promise.all; a synchronous throw here would silently prevent real actions from ever running.
+    safeSerialize(event) {
+        try {
+            return JSON.stringify(event);
+        }
+        catch (err) {
+            console.error(`[EventPublisher] failed to serialize ${event.event_type} event for ${event.automation_id} — MQTT publish skipped:`, err);
+            return undefined;
+        }
+    }
+    // Isolates listeners from each other and from the publisher — the same reliability principle
+    // applied to subscribers (e.g. the /events SSE endpoint) as to serialization above.
+    notifyListeners(event) {
+        for (const l of this.listeners) {
+            try {
+                l(event);
+            }
+            catch (err) {
+                console.error('[EventPublisher] listener threw, continuing:', err);
+            }
+        }
+    }
 }

package/dist/src/framework/ha-client.d.ts

@@ -1,5 +1,6 @@
 import { type HassServiceTarget } from 'home-assistant-js-websocket';
 import { EventEmitter } from 'node:events';
+import type { Action } from '../types/actions.js';
 export interface EntityState {
     entity_id: string;
     state: string;
@@ -7,7 +8,12 @@ export interface EntityState {
     last_changed: string;
     last_updated: string;
 }
-export type HAState = (entity: string) => EntityState | undefined;
+declare global {
+    interface HAEntities {
+    }
+}
+type _HAStateKey = keyof HAEntities extends never ? string : keyof HAEntities;
+export type HAState = <E extends _HAStateKey>(entity: E) => (E extends keyof HAEntities ? EntityState & HAEntities[E] : EntityState) | undefined;
 export interface HAContext {
     entitiesByLabel: (label: string) => string[];
     labelsFor: (entity: string) => string[];
@@ -18,20 +24,44 @@ export interface StateChangedEvent {
     old_state: EntityState | undefined;
     new_state: EntityState;
     correlation_id: string;
+    parent_correlation_id?: string;
+    root_correlation_id?: string;
+    parent_automation_id?: string;
+}
+export interface WriteOrigin {
+    correlationId: string;
+    rootCorrelationId?: string;
+    automationId: string;
+}
+export interface AckOrigin {
+    correlationId: string;
+    rootCorrelationId?: string;
+    automationId: string;
+    location: string;
+    subsystem: string;
+    action: Action;
+    expected: Record<string, unknown>;
+}
+export interface AckTimeoutEvent extends AckOrigin {
+    entity_id: string;
 }
 export declare interface HAClient {
     on(event: 'state_changed', listener: (e: StateChangedEvent) => void): this;
     on(event: 'ready', listener: () => void): this;
     on(event: 'reconnected', listener: () => void): this;
+    on(event: 'action_ack_timeout', listener: (e: AckTimeoutEvent) => void): this;
     emit(event: 'state_changed', e: StateChangedEvent): boolean;
     emit(event: 'ready'): boolean;
     emit(event: 'reconnected'): boolean;
+    emit(event: 'action_ack_timeout', e: AckTimeoutEvent): boolean;
 }
 export declare class HAClient extends EventEmitter {
     private readonly stateCache;
     private readonly labelToEntities;
     private readonly entityToLabels;
     private readonly areaToEntities;
+    private readonly pendingWrites;
+    private readonly pendingAcks;
     private connection;
     private reconnecting;
     private _readyResolve;
@@ -39,10 +69,17 @@ export declare class HAClient extends EventEmitter {
     readonly state: HAState;
     readonly context: HAContext;
     get entityCount(): number;
-    callService(domain: string, service: string, target?: HassServiceTarget, data?: Record<string, unknown>): Promise<void>;
+    get registryStats(): {
+        labels: number;
+        areas: number;
+    };
+    callService(domain: string, service: string, target?: HassServiceTarget, data?: Record<string, unknown>, origin?: WriteOrigin): Promise<void>;
+    registerPendingWrite(entityId: string, origin: WriteOrigin): void;
+    registerPendingAck(entityId: string, origin: AckOrigin, timeoutMs: number): void;
     disconnect(): void;
     connect(url: string, token: string): Promise<void>;
     private repopulateCache;
     private diffAndUpdate;
     private loadEntityRegistry;
 }
+export {};