Serialiser_Engine: Improve size of JSON by excluding empty IBHoMObject properties

[FraserGreenroyd]

Fixes #3017

Test file available here.

Test file is very simple - serialise any object implementing IBHoMObject (should be most - I went with an Environment oM Panel) without providing a Name or other property implemented from IBHoMObject - see that the JSON doesn't contain the key value pair for those properties. Then provide values to those properties and see them get included.

I opted to go with storing the property names on load so that if you're serialising a collection of IBHoMObjects, we don't lose time querying the same 5 property names over and over again. Also opted to query the IBHoMObject properties so that if we ever change them, we don't have to remember to update the list here.

I did consider the option of whether we would want to include empty properties if they were overridden (as @IsakNaslundBh has occasionally done to override the Name property so he can add his own description to it for certain Structural objects), but decided against it for now on the basis that this will only exclude them if they're empty - so even if they're overridden, if they have no value assigned, do we really want them taking up space in the JSON string? I'm arguing for not - but we could go the other way if there's strong argument to.

[adecler]

The code doesn't cover the case for the IEnumerable properties (i.e. Tags, Fragments, And CustomData) as they will show in json even if empty:

In this case, I wonder if it wouldn't be simpler to use a switch-case on prop.Name to explicitly list the properties to treat differently (simpler and more transparent) ?

[FraserGreenroyd]

🤦‍♂️ much cleaner! Have implemented the switch - though this does mean we'll need to keep it updated if we ever change the IBHoMObject properties - but given we haven't done that in years, I think that's a minimal overhead compared to the greater transparency this gives.

[adecler]

Now works as expected.
Happy with the state of the code.

[FraserGreenroyd]

@BHoMBot check compliance
@BHoMBot check required

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance
• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

There are 2 requests in the queue ahead of you.

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[FraserGreenroyd]

@BHoMBot check installer

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check installer

[FraserGreenroyd]

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: versioning, unit-tests, installer, ready-to-merge

[bhombot-ci]

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.