@homebridge-plugins/homebridge-ewelink 12.18.2 → 12.18.3-beta.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to `@homebridge-plugins/homebridge-ewelink` will be documented in this file.
 
+## v12.18.3 (Pending Release)
+
+### Changed
+
+- fix: keep saving eve history for a device with a slash in its name
+- fix: write eve history atomically, so an interrupted write cannot corrupt it
+- fix: recover from an unreadable eve history instead of retrying forever
+
 ## v12.18.2 (2026-08-09)
 
 ### Changed

package/lib/fakegato/fakegato-history.js

@@ -139,12 +139,15 @@ export default function (homebridge) {
             (err, loaded) => {
               if (err) {
                 this.log('FGH load error: %s.', err)
-              } else {
-                if (loaded) {
-                  this.log('FGH loaded from storage.')
-                }
-                this.loaded = true
+              } else if (loaded) {
+                this.log('FGH loaded from storage.')
               }
+              // Ready either way. A history that could not be read starts
+              // empty, which is the only thing left to do with it - leaving
+              // this unset instead would park save() in a 100ms retry that
+              // never ends, so a single unreadable file cost a busy loop for
+              // the lifetime of the plugin
+              this.loaded = true
             },
           )
         }.bind(this),
@@ -593,27 +596,37 @@ export default function (homebridge) {
       homebridge.globalFakeGatoStorage.read({
         service: this,
         callback: function (err, data) {
-          if (!err) {
-            if (data) {
-              try {
-                // this.log('[%s] read data [%s].', this.accessoryName, data)
-                const jsonFile = typeof data === 'object' ? data : JSON.parse(data)
-                this.firstEntry = jsonFile.firstEntry
-                this.lastEntry = jsonFile.lastEntry
-                this.usedMemory = jsonFile.usedMemory
-                this.refTime = jsonFile.refTime
-                this.initialTime = jsonFile.initialTime
-                this.history = jsonFile.history
-                this.extra = jsonFile.extra
-              } catch (e) {
-                this.log('FGH error fetching data - invalid JSON [%s].', e)
-                cb(e, false)
-              }
-              cb(null, true)
-            }
-          } else {
+          // No history stored yet, or a file with nothing in it. There is
+          // nothing to restore either way, and the caller still has to be told
+          // so: an empty file used to answer nothing at all, which left the
+          // service waiting to be loaded while save() retried every 100ms for
+          // as long as the plugin ran
+          if (err || !data) {
             cb(null, false)
+            return
+          }
+
+          try {
+            // this.log('[%s] read data [%s].', this.accessoryName, data)
+            const jsonFile = typeof data === 'object' ? data : JSON.parse(data)
+            this.firstEntry = jsonFile.firstEntry
+            this.lastEntry = jsonFile.lastEntry
+            this.usedMemory = jsonFile.usedMemory
+            this.refTime = jsonFile.refTime
+            this.initialTime = jsonFile.initialTime
+            this.history = jsonFile.history
+            this.extra = jsonFile.extra
+          } catch (e) {
+            // A file that will not parse was cut short. The entries are gone
+            // whatever happens next, so the caller is told once and the service
+            // starts empty - this used to report the failure and then
+            // immediately report success as well, over the top of it
+            this.log('FGH error fetching data - invalid JSON [%s].', e)
+            cb(e, false)
+            return
           }
+
+          cb(null, true)
         }.bind(this),
       })
     }

package/lib/fakegato/fakegato-storage.js

@@ -1,9 +1,31 @@
 import fs from 'node:fs'
 import os from 'node:os'
 import path from 'node:path'
+import process from 'node:process'
 
 const hostname = os.hostname().split('.')[0]
 
+/**
+ * Path separators, as the platform actually understands them.
+ *
+ * A history file is named after the accessory, and an accessory is named by
+ * whoever set the device up. A name carrying a separator stops being a name
+ * once it reaches `path.join`: it reads as a directory that does not exist, so
+ * the write fails with ENOENT and - because nothing here passes a callback -
+ * the error goes nowhere. A device called "Kitchen/Diner" simply never saved
+ * its history, with nothing in the log to say so. HAP-NodeJS guards its own
+ * storage keys against the same thing.
+ *
+ * Only genuine separators are replaced, and only where they are one. A
+ * backslash is an ordinary filename character on Linux, so replacing it there
+ * would rename the file of anyone already using one and lose their history.
+ */
+const PATH_SEPARATORS = process.platform === 'win32' ? /[\\/]/g : /\//g
+
+function toFileNamePart(name) {
+  return String(name ?? '').replace(PATH_SEPARATORS, '-')
+}
+
 export default class {
   constructor(params) {
     if (!params) {
@@ -27,7 +49,7 @@ export default class {
       const newWriter = {
         service,
         callback: params.callback,
-        fileName: `${hostname}_${service.accessoryName}_persist.json`,
+        fileName: `${hostname}_${toFileNamePart(service.accessoryName)}_persist.json`,
       }
       const onReady = typeof params.onReady === 'function' ? params.onReady : () => {}
       newWriter.storageHandler = fs
@@ -67,15 +89,36 @@ export default class {
           ? writer.callback
           : () => {}
       const fileLoc = path.join(writer.path, writer.fileName)
+      // Written to a temporary file and renamed over the target, so a write cut
+      // short by a restart or a power cut leaves the previous history intact
+      // rather than a half-written file that will not parse.
+      //
+      // The leading dot matters: this is HAP-NodeJS's persist directory, and it
+      // reads every file that does not start with one into memory at startup -
+      // so a temporary file left behind by a crash would be loaded, and kept,
+      // for the life of every run after it. The pid keeps child bridges sharing
+      // the directory from racing on the same temporary name.
+      const tempLoc = path.join(writer.path, `.${writer.fileName}.${process.pid}.tmp`)
       this.log(
         '[%s] FGS write file [%s] [%s].',
         params.service.accessoryName,
         fileLoc,
         params.data.substring(1, 81),
       )
-      writer.storageHandler.writeFile(fileLoc, params.data, 'utf8', (...args) => {
-        this.writing = false
-        callBack(args)
+      writer.storageHandler.writeFile(tempLoc, params.data, 'utf8', (writeErr) => {
+        if (writeErr) {
+          // the temporary file may never have been created, so a failure to
+          // remove it is not worth reporting over the write error itself
+          writer.storageHandler.unlink(tempLoc, () => {
+            this.writing = false
+            callBack(writeErr)
+          })
+          return
+        }
+        writer.storageHandler.rename(tempLoc, fileLoc, (renameErr) => {
+          this.writing = false
+          callBack(renameErr || null)
+        })
       })
     } else {
       setTimeout(() => this.write(params), 100)

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "Homebridge eWeLink",
   "alias": "eWeLink",
   "type": "module",
-  "version": "12.18.2",
+  "version": "12.18.3-beta.0",
   "description": "Homebridge plugin to integrate eWeLink devices into HomeKit.",
   "author": {
     "name": "bwp91",