[Feature] check object properties (during object creation)

[mcm1957]

js controller should check state configuration when cretaing or extending a state.
Especially role shoul dbe checked against data type and read/write settings.

I.e. role indocator is incompatible with write=true or type=string

When checking ONLY during creation/extending the number od log entries should be acceptable.

Config could be either hardcoded or extendable by using a cached schema from online service. The later approach would allow to check if a role is defined at all too.

[mcm1957]

As there has been some concern about performance impact (at telegram) I would like to state;

The check should ONLY be performed when really creating or modifying a state - NOT at every access. As states should not be created over and over the impact should be acceptable.

Its totally ok to miss modifications done by users to existing states - its not the goal to detect such changes, the goal is to give feeback to developers to write correct state definitions. As states are likely to be created dynamically, its impossible to check them by repo checker.

[foxriver76]

So it is more like an extended object creation check, we already have them when objects are created or extended. We would need to extend that by a check which checks if write, read and type match the state definitions.

We could maybe create a file which holds like Record<string, {write: boolean, read: boolean, type: ioBroker.AllowedStateType}> as a single point of truth. Meaning creating the docs automatically out of it (not on dev releases only real releases) + using it as validation, so docs + validation would be in sync.

[mcm1957]

Well
The technical details are know by you best.

I would suggest to check

Type
Role
Read write

Against each other. And of course unknow roles must be allowed unless we can gurantte a very fast update of roles without explicit user action. Updating with js-controller releases would be to slow as users ste likely several releases behind.

[Apollon77]

I fixed the wording in at least headline ... it is about objects ... not states

[mcm1957]

Well - as the discussion continues outsides I would like to give this issue a push up.

I really would suggest to check the roles whenever an object is created or extended.

The list of valid state roles and other Info to check (R/W, type, ...) could be loaded using the same mechanism as we already use to load jsonConfig schema. This would guarantee a fast update if new roles are accepted.

Failing should be reported as a log and if possible as a feedback at sentry so that we can create a Issue at the adapter an potentially check when releasing new versions.