♻️ Current situation

When a cached plugin is deserialized, the cached values are loaded into the "private" property _associatedHAPAccessory. Even if displayName is changed, the properties of _associatedHAPAccessory are never modified. When the plugin is serialized back to cache, it reads the properties of _associatedHAPAccessory.

See Accessory name cannot be updated

💡 Proposed solution

Add a method to update displayName in _associatedHAPAccessory without accessing the private variable.

However a user may modify `displayName` directly, so defensively sync `_associatedHAPAccessory.displayName` with `displayName` at the moment of serialization.

⚙️ Release Notes

➕ Additional Information

Note: As _associatedHAPAccessory.displayName is sync'd with displayName at the moment of serialization, the method updateDisplayName() is not strictly needed. A better approach would be to remove the displayName property and replace it with getter and setter methods:

  public getDisplayName(): string {
    return  this._associatedHAPAccessory.displayName;
  }

  public setDisplayName(name: string): void {
    this._associatedHAPAccessory.displayName = name;
  }

Ideally setDisplayName() would have a check to make sure that name is not null, undefined, or "" and/or return an error. However this will likely break Homebridge UI and a whole lot of plugins.

Testing

Added test method to verify that a call to updateDisplayName() updates both displayName and _associatedHAPAccessory.displayName.

Reviewer Nudging