Re-enable but deprecate visible member of properties

[benfrancis]

Shortly after the 1.0 release, support for invisible properties (visible: false) of Things was removed from

• gateway
• gateway-addon-node
• gateway-addon-python
• gateway-addon-ipc-schema

In the 1.1.0-alpha.2 release this has resulted in the Zigbee, Z-Wave, HomeKit, Tuya add-ons (which still use this feature) being broken, as well as an unknown number of other add-ons.

A fix has landed for the Tuya adapter and there's an untested fix for the HomeKit adapter, but we don't know how many other add-ons might be affected.

Rather than making this breaking change in the 1.1 release and requiring a fix in all add-ons which use it, another option is to revert the changes at the gateway level in order to continue to support this feature, but print a deprecation warning on the console every time it's used. Then we can remove the feature entirely in a future release.

Apart from being a lot of work, my other concern with this approach is that there was a reported bug with this feature in 1.0 in which invisible properties were always shown to users even if set as not visible. I'm not sure what the UX impact is of this for add-ons which heavily use the feature, and whether that would need to be fixed or whether we leave it that way in order to encourage add-on developers to stop using the feature. Presumably whatever the effect is it has been the case for the past two years so users will already have noticed.

See also: #2670, WebThingsIO/homekit-adapter#62

The steps I think will be necessary to fix this at the gateway level:

• Fix gateway-addon-ipc-schema (Re-introduce the visible member of properties for the 1.1 release gateway-addon-ipc-schema#24)
  • Revert commit
  • Mark visible member as deprecated
  • Tag a new version
• Fix gateway-addon-node (Re-introduce visible member of property descriptions gateway-addon-node#119)
  • Revert commit
  • Bump schema submodule
  • Tag and release new version
• Fix gateway-addon-python (Re-introduce visible member of property descriptions gateway-addon-python#92)
  • Revert commit
  • Bump schema submodule
  • Tag and release new version
• Fix gateway (Bump gateway-addon-node and gateway-addon-python and set gateway version to 1.1.0-beta.1 #3042)
  • Revert commit
  • Bump gateway-addon-node version
  • Bump gateway-addon-python version
  • Bump gateway version
  • Tag and release new version

[freaktechnik]

Just to make sure we're not reverting too much, as far as I'm aware gateway 1.0 already ignored the actual value of visible and add-ons had to remove invisible properties themselves. It's just the gateway-addon-node/gateway-addon-python that changed behavior.

[benfrancis]

@freaktechnik That does seem to be the case from #2670 yes, though I think at the time it was considered more of a bug than a feature.

I'm not sure whether or not we should revert #2672, but it may have no effect (note that PR landed a few days after the 1.0 release).