@homebridge-plugins/homebridge-eufy-security 5.0.0-beta.16 → 5.0.0-beta.17

package/dist/diagnostics.js

@@ -270,13 +270,14 @@ const BUG_REPORT_FORM = 'https://github.com/homebridge-plugins/homebridge-eufy/i
 function bugReportUrl(session, missingEvidence, host) {
     const url = new URL(BUG_REPORT_FORM);
     url.searchParams.set('template', 'bug_report.yml');
+    url.searchParams.set('title', `[Diagnostics] ${BUG_REPORT_AREAS[session.profile]}: `);
     url.searchParams.set('environment', [
         `- **Plugin Version**: ${PLUGIN_VERSION}`,
         `- **eufy SDK**: ${SDK_VERSION}`,
         `- **Node.js Version**: ${process.version}`,
         `- **Homebridge Version**: ${host?.homebridge ?? ''}`,
         `- **OS**: ${process.platform} ${process.arch}`,
-        `- **Diagnostics profile**: ${session.profile} (${session.reproductionMode})`,
+        `- **Diagnostics profile**: ${session.profile}`,
         `- **Missing evidence**: ${missingEvidence.length ? missingEvidence.join(', ') : 'none'}`,
     ].join('\n'));
     url.searchParams.set('area', BUG_REPORT_AREAS[session.profile]);
@@ -289,7 +290,7 @@ const DIAGNOSTICS_PROFILES = {
     'live-media': ['plugin-log', 'sdk-log', 'homekit-log', 'ffmpeg-log'],
     'hksv-recording': ['plugin-log', 'sdk-log', 'ffmpeg-log'],
     'dashboard-ui': ['plugin-log', 'ui-log'],
-    other: ['plugin-log', 'sdk-log', 'homekit-log'],
+    other: ['plugin-log', 'sdk-log', 'homekit-log', 'ffmpeg-log'],
 };
 /** Narrows external profile input against the diagnostics-owned profile registry. */
 export function isDiagnosticsProfile(value) {
@@ -339,6 +340,22 @@ function activeDiagnosticsSession(storageRoot, now) {
     const session = readDiagnosticsSession(storageRoot);
     return session && Date.parse(session.expiresAt) > now ? session : undefined;
 }
+/**
+ * A session as it stands at `now`: a capture still running when its authorization ends is finished at that end.
+ *
+ * A finished capture can be reviewed and exported until the archive retention has elapsed past the end of its
+ * authorization, so a capture that ran out its 72 hours keeps what it captured.
+ */
+function settledDiagnosticsSession(session, now) {
+    const expiresAt = Date.parse(session.expiresAt);
+    const settled = session.reproductionStartedAt && !session.reproductionEndedAt && expiresAt <= now
+        ? { ...session, reproductionEndedAt: session.expiresAt }
+        : session;
+    return {
+        session: settled,
+        exportable: Boolean(settled.reproductionEndedAt) && now < expiresAt + SUPPORT_ARCHIVE_RETENTION_MS,
+    };
+}
 /**
  * Collapses one supplied string to bounded printable text, or nothing where none of it survives.
  *
@@ -577,6 +594,22 @@ export class GuidedDiagnostics {
         await this.ensureMarker(session, 'reproduction-started', session.reproductionStartedAt);
         return this.project(session);
     }
+    /**
+     * Deletes the persisted session without an archive, which also ends the verbose retention it authorized. UI events
+     * already queued are written first and later ones are refused until it is gone, so none lands after the delete.
+     */
+    async cancel() {
+        this.uiEventsClosing = true;
+        try {
+            await this.uiEventWrites;
+            this.pendingSupportArchive = undefined;
+            await rm(diagnosticsSessionPath(this.storageRoot), { force: true });
+            return await this.status();
+        }
+        finally {
+            this.uiEventsClosing = false;
+        }
+    }
     async endReproduction() {
         let session = this.requireAuthorized();
         if (!session.reproductionStartedAt) {
@@ -657,10 +690,16 @@ export class GuidedDiagnostics {
     /** Prepares the exact manifest and evidence snapshot that one subsequent export may encrypt. */
     async reviewSupportArchive() {
         await this.uiEventWrites;
-        const session = readDiagnosticsSession(this.storageRoot);
+        const persisted = readDiagnosticsSession(this.storageRoot);
+        const { session, exportable } = persisted
+            ? settledDiagnosticsSession(persisted, this.now())
+            : { session: undefined, exportable: false };
         if (!session?.reproductionStartedAt || !session.reproductionEndedAt) {
             throw new Error('A completed reproduction is required before archive review');
         }
+        if (!exportable) {
+            throw new Error('Diagnostics authorization is inactive or expired');
+        }
         const collected = await this.collectSupportEvidence(session);
         const reproductionStartedAt = Date.parse(session.reproductionStartedAt);
         const selected = DIAGNOSTICS_PROFILES[session.profile];
@@ -703,7 +742,13 @@ export class GuidedDiagnostics {
         this.pendingSupportArchive = { reviewId, manifest, evidence: collected };
         return { reviewId, manifest };
     }
-    /** Consumes one reviewed snapshot and returns an encrypted envelope without writing plaintext or an archive to disk. */
+    /**
+     * Consumes one reviewed snapshot and returns an encrypted envelope without writing plaintext or an archive to disk.
+     *
+     * The session outlives the export, because nothing here proves the envelope reached the reporter: a fresh review
+     * exports it again until the reporter leaves it with {@link cancel}, another capture replaces it, or the archive
+     * retention ends it.
+     */
     async exportSupportArchive(reviewId) {
         const pending = this.pendingSupportArchive;
         if (!pending || pending.reviewId !== reviewId) {
@@ -749,11 +794,12 @@ export class GuidedDiagnostics {
                 authTag: cipher.getAuthTag().toString('base64'),
                 ciphertext: ciphertext.toString('base64'),
             };
-            return {
+            const exported = {
                 filename: `homebridge-eufy-${pending.manifest.supportCaseId}.eufysupport.gz`,
                 mediaType: 'application/gzip',
                 archive: await gzip(Buffer.from(`${JSON.stringify(envelope)}\n`, 'utf8')),
             };
+            return exported;
         }
         finally {
             contentKey.fill(0);
@@ -1038,16 +1084,17 @@ export class GuidedDiagnostics {
             throw new Error('Diagnostics authorization is inactive or expired');
         return session;
     }
-    async project(session) {
-        if (!session) {
+    async project(persisted) {
+        if (!persisted) {
             return { status: 'inactive', selectedEvidence: [], missingEvidence: [], partialExportAvailable: false };
         }
+        const { session, exportable } = settledDiagnosticsSession(persisted, this.now());
         const selectedEvidence = DIAGNOSTICS_PROFILES[session.profile];
         const collected = session.reproductionStartedAt && session.reproductionEndedAt
             ? await this.collectSupportEvidence(session)
             : undefined;
         const missingEvidence = collected ? missingEvidenceClasses(selectedEvidence, collected) : [];
-        const expired = Date.parse(session.expiresAt) <= this.now();
+        const expired = Date.parse(session.expiresAt) <= this.now() && !exportable;
         const status = expired
             ? 'expired'
             : session.reproductionEndedAt
@@ -1066,7 +1113,7 @@ export class GuidedDiagnostics {
             expiresAt: session.expiresAt,
             ...(session.reproductionStartedAt ? { reproductionStartedAt: session.reproductionStartedAt } : {}),
             ...(session.reproductionEndedAt ? { reproductionEndedAt: session.reproductionEndedAt } : {}),
-            partialExportAvailable: Boolean(session.reproductionEndedAt),
+            partialExportAvailable: exportable,
             ...(session.affectedDevices === undefined ? {} : { affectedDevices: session.affectedDevices }),
             issueUrl: bugReportUrl(session, missingEvidence, readHostEnvironment(this.storageRoot)),
         };
@@ -1984,6 +2031,33 @@ const HOMEKIT_REASON_ACTIONS = {
     'camera-recording-unavailable:adapter-missing': 'log.action.setFfmpegPath',
     'camera-live-session-failed:adaptation-spawn-failed': 'log.action.checkFfmpegPath',
 };
+/** Projects a value onto an active condition, or nothing where the catalog does not write that code with those keys. */
+export function knownCondition(value) {
+    if (typeof value !== 'object' || value === null || Array.isArray(value))
+        return undefined;
+    const { code, summaryKey, actionKey, serials } = value;
+    if (typeof code !== 'string')
+        return undefined;
+    const runtime = Object.values(RUNTIME_CONDITIONS).find((condition) => condition.code === code);
+    const homeKit = Object.hasOwn(HOMEKIT_CONDITIONS, code)
+        ? HOMEKIT_CONDITIONS[code]
+        : undefined;
+    const [summary, ...actions] = runtime
+        ? [runtime.summaryKey, runtime.actionKey]
+        : homeKit
+            ? [
+                ...homeKit,
+                ...Object.entries(HOMEKIT_REASON_ACTIONS)
+                    .filter(([key]) => key.startsWith(`${code}:`))
+                    .map(([, action]) => action),
+            ]
+            : [];
+    const action = allowlistedLabel(actionKey, actions);
+    if (summary === undefined || summaryKey !== summary || action === undefined)
+        return undefined;
+    const named = Array.isArray(serials) ? serials.filter((serial) => typeof serial === 'string') : [];
+    return { code, summaryKey: summary, actionKey: action, ...(named.length === 0 ? {} : { serials: named }) };
+}
 /** HomeKit conditions that state a gap nothing in the user's setup closes, so an active one is not a warning. */
 const INFORMATIONAL_HOMEKIT_CONDITIONS = new Set(['recognized-device-not-represented']);
 /** The level and action one HomeKit condition is written with, decided once for the console and the record. */
@@ -2179,7 +2253,7 @@ export function reportRuntimeNotice(target, code, fields = {}) {
     const notice = RUNTIME_NOTICES[code];
     const durationMs = fields.durationMs === undefined ? undefined : Math.max(0, Math.trunc(fields.durationMs));
     const messageKey = durationMs !== undefined && 'durationMessageKey' in notice ? notice.durationMessageKey : notice.messageKey;
-    target[notice.level]?.(`[${code}] ${localize(target, messageKey, { durationMs: durationMs ?? 0 })}`);
+    target[notice.level]?.(`[${code}] ${localize(target, messageKey, { durationMs: durationMs ?? 0, finishBy: fields.finishBy ?? '' })}`);
     target.debug?.(JSON.stringify({
         scope: 'runtime-notice',
         level: notice.level,
@@ -2194,14 +2268,17 @@ export function reportRuntimeNotice(target, code, fields = {}) {
  * The file is the authority: the supplied identifier only names which window the caller believes was opened,
  * and a session the file does not hold as active changes nothing and reports nothing. A confirmed pickup emits
  * one operational record, which is the evidence that this process began retaining the window's scopes, taken
- * at the moment it did rather than whenever a later record arrives.
+ * at the moment it did rather than whenever a later record arrives, and its console line names the time the
+ * capture stops on its own.
  */
 export function armDiagnosticsAuthorization(target, storageRoot, supportCaseId, now = Date.now) {
-    if (!isSupportCaseId(supportCaseId) ||
-        activeDiagnosticsSession(storageRoot, now())?.supportCaseId !== supportCaseId) {
+    const session = activeDiagnosticsSession(storageRoot, now());
+    if (!isSupportCaseId(supportCaseId) || session?.supportCaseId !== supportCaseId) {
         return false;
     }
-    reportRuntimeNotice(target, 'diagnostics-authorization-armed');
+    reportRuntimeNotice(target, 'diagnostics-authorization-armed', {
+        finishBy: new Date(session.expiresAt).toLocaleString(),
+    });
     return true;
 }
 /** Emits the startup notice for discarded settings awaiting acknowledgement. */
@@ -2575,7 +2652,11 @@ export class DiagnosticConditions {
             const alias = this.aliases.get(serial);
             return name === undefined ? undefined : alias === undefined ? name : `${name} (${alias})`;
         })
-            .filter((named) => named !== undefined));
+            .filter((named) => named !== undefined), uniqueDeviceIds);
+    }
+    /** Every condition active now, each held from the transition that raised it to the one that clears it. */
+    current() {
+        return [...this.active.values()].map(({ condition }) => condition);
     }
     /**
      * The support-case alias for one device identity, minted on first use.
@@ -2593,13 +2674,16 @@ export class DiagnosticConditions {
     }
     write(code, active, reason, summaryKey, actionKey, level, fields = {}, conditionKey = code, 
     /** Accessory names for the console line only — never retained, see {@link DiagnosticConditions}. */
-    names) {
-        const fingerprint = JSON.stringify({ active, reason, ...fields });
+    names, serials = []) {
+        const fingerprint = JSON.stringify({ active, reason, ...fields, serials });
         if (active) {
-            if (this.active.get(conditionKey) === fingerprint) {
+            if (this.active.get(conditionKey)?.fingerprint === fingerprint) {
                 return;
             }
-            this.active.set(conditionKey, fingerprint);
+            this.active.set(conditionKey, {
+                fingerprint,
+                condition: { code, summaryKey, actionKey, ...(serials.length === 0 ? {} : { serials: [...serials] }) },
+            });
         }
         else if (!this.active.delete(conditionKey)) {
             return;