Envelope By Sketch has a null profile and new unexpected types.

[ikeough]

Two recent changes to "Envelope By Level" should be discussed as they paint a picture of how Hypar will break in the future when function authors change the interface of their function.

1. The Envelope schema has a Profile property which has recently started returning null. This breaks all functions which currently use that profile (ex: Facade).
2. The "Envelope By Sketch" function now generates elements of type Elements.LevelPerimeter. Functions which consume "Levels" don't know anything about this type so they ignore it during deserialization.

Neither of these changes were obvious to consumers of "Levels". The code generator correctly generated updated class files for the updated schemas, and the compiler identified locations where API calls needed to be adjusted. In the first case, nothing in the tooling can identify when a function author decides to stop using a property. This may be an oversight, or an attempt at deprecation, but the consuming function needs to know. In the second case, a new type was introduced into the system but we do not currently track type dependencies so the "Facade" function could not know that the "Envelope by Sketch" function had begun generating a type that it did not understand.

The easiest short term solution is to update the documentation to the "Envelope By Sketch" function to say something like: "This function generates Envelope and LevelPerimeter objects. To get the perimeter of an envelope, use the LevelPerimeter object at the corresponding level." For properties which are deprecated, the property should not be removed and a deprecation message should be included in the property's description.

@anthonyhauck @mattc

[anthonyhauck]

"LevelsByEnvelope" generates both Levels and LevelPerimeters.
"EnvelopeBySketch" never generated Levels or LevelPerimeters, and still doesn't.
I didn't make any changes to "EnvelopeBySketch" later than 6 days ago:

The issue in Facade seems to be that it makes a Level, and the creation call changed -- since in another context you'd asserted...

...I thought you were just reading Levels, not creating them. I should have checked.

Happy to update documentation, but where should that happen?
It can appear in the relevant GitHub repo, but there's no guarantee a repo will be public.

[ikeough]

You are correct, I misspoke. The note should be on Levels By Envelope and should not mention Envelope. This comment could go, for now, in the description of the function, as that’s the only place we have to document this currently. That will in turn show up in the README and also in the function’s description in the app. Ian Keough @ikeough

…

On Dec 16, 2019, at 2:32 AM, Anthony Hauck ***@***.***> wrote: "LevelsByEnvelope" generates both Levels and LevelPerimeters. "EnvelopeBySketch" never generated Levels or LevelPerimeters, and still doesn't. I didn't make any changes to "EnvelopeBySketch" later than 6 days ago: The issue in Facade seems to be that it makes a Level, and the creation call changed -- since in another context you'd asserted... ...I thought you were just reading Levels, not creating them. I should have checked. Happy to update documentation, but where should that happen? It can appear in the relevant GitHub repo, but there's no guarantee a repo will be public. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[ikeough]

The levels that are created in Facade are only created for testing (ex: in Function Builder). Ian Keough @ikeough

…

On Dec 16, 2019, at 2:32 AM, Anthony Hauck ***@***.***> wrote: "LevelsByEnvelope" generates both Levels and LevelPerimeters. "EnvelopeBySketch" never generated Levels or LevelPerimeters, and still doesn't. I didn't make any changes to "EnvelopeBySketch" later than 6 days ago: The issue in Facade seems to be that it makes a Level, and the creation call changed -- since in another context you'd asserted... ...I thought you were just reading Levels, not creating them. I should have checked. Happy to update documentation, but where should that happen? It can appear in the relevant GitHub repo, but there's no guarantee a repo will be public. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[anthonyhauck]

Updated description and repo README.