Jira (PUP-8606) Module-defined data types are very verbose when displayed

[Michael Smith (JIRA)]

Michael Smith created an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed Issue Type: Bug Assignee: Unassigned Created: 2018/03/23 12:54 PM Priority: Normal Reporter: Michael Smith As noted in BOLT-413, the printable representation for certain data types is very verbose. For example, TargetSpec defined as an alias in Bolt displays as TargetSpec = Boltlib::TargetSpec = Variant[String[1], Object[{name => 'Target', attributes => {'uri' => String[1], 'options' => {type => Hash[String[1], Data], value => {}}}, functions => {'host' => Callable[[0, 0], String[1]], 'name' => Callable[[0, 0], String[1]], 'password' => Callable[[0, 0], Optional[String[1]]], 'port' => Callable[[0, 0], Optional[Integer]], 'protocol' => Callable[[0, 0], Optional[String[1]]], 'user' => Callable[[0, 0], Optional[String[1]]]}}], Array[Boltlib::TargetSpec]] This can be seen by running bolt plan show canary in Bolt 0.18.1 (once we get BOLT-407 fixed). I'd rather this use a succinct representation, like TargetSpec or TargetSpec = Bolt::TargetSpec. I see two possibilities for fixing this: a way to define how the Bolt::TargetSpec type should be displayed via to_s provide the original parameter text from the plan declaration as part of the type returned via the params_type accessor on a plan. Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[Michael Smith (JIRA)]

Michael Smith commented on PUP-8606

Re: Module-defined data types are very verbose when displayed An example of adding original text to the type at https://github.com/MikaelSmith/puppet/tree/PUP-8606. However I'm concerned about the memory implications of doing that on every type. I haven't dug into how else create_param_type is used.

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

I commented on your commit. I don't think it is a good idea to add a member variable to every type in the type system to hold the source text if that type was obtained from a parameter type expression. What is the problem you are trying to solve (apart from the string form being verbose as shown) - where/why do you end up with that particular string output? In general, there is obviously a trade off between being succinct (only showing a type alias for example), vs. showing all of the details. At first we only showed the alias, but then we got complaints that the output was too opaque. You may want to have your own function for determining how much to show - in this case TargetSpec is supposed to be a well known type, as opposed to something a user invented, and you may want to format different types with varying degree of detail/expansion. That is just impossible to have in the types themselves as it depends on the use case / context. (Often a to_s is where such conflicting requirements meet). To give a good recommendation what to do in your case depends on the details of where/when in occurs.

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

It may also be that we need to support a way to define a useful to_s implementation for registered types that should be opaque.

Add Comment

[Michael Smith (JIRA)]

Michael Smith commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

This happens when we get a list of parameters on a plan via PAL: https://github.com/puppetlabs/bolt/blob/0.18.0/lib/bolt/pal.rb#L204-L225 We iterate over the parameters and get a printable representation of the type. Is there a way to modify the Target and Error types so they aren't expanded? Currently they appear to be, which is where most of the verbosity comes from. Right now, Target is getting printed as

Object[{name => 'Target', attributes => {'uri' => String[1], 'options' => {type => Hash[String[1], Data], value => {}}}, functions => {'host' => Callable[[0, 0], String[1]], 'name' => Callable[[0, 0], String[1]], 'password' => Callable[[0, 0], Optional[String[1]]], 'port' => Callable[[0, 0], Optional[Integer]], 'protocol' => Callable[[0, 0], Optional[String[1]]], 'user' => Callable[[0, 0], Optional[String[1]]]}}

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

Michael Smith Ok, got it - you get the signature and want to display parameters. Thomas Hallgren can types like Target be made to show less information by default, or should we have a special (polymorph) function to get the desired strings?

Add Comment

[Thomas Hallgren (JIRA)]

Thomas Hallgren commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

This looks like a bug to me. An Object type should represent itself with its name only, not the full spec. The type in the example should present itself as: TargetSpec = Boltlib::TargetSpec = Variant[String[1], Target, Array[Boltlib::TargetSpec]]

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg updated an issue

Puppet / PUP-8606

Module-defined data types are very verbose when displayed

Change By: Henrik Lindberg Fix Version/s: PUP 5.5.1

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg assigned an issue to Thomas Hallgren

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Henrik Lindberg Assignee: Thomas Hallgren

Add Comment

[Geoff Nichols (JIRA)]

Geoff Nichols updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Geoff Nichols Team: Platform Core

Add Comment

[Kenn Hussey (JIRA)]

Kenn Hussey updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Kenn Hussey Flagged: Impediment

Add Comment

[Kenn Hussey (JIRA)]

[Kenn Hussey (JIRA)]

Kenn Hussey updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Kenn Hussey Fix Version/s: PUP 5.5.1 Fix Version/s: PUP 5.5.2

Add Comment

[Kenn Hussey (JIRA)]

Kenn Hussey updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Kenn Hussey Fix Version/s: PUP 5.5.2 Fix Version/s: PUP 5.5.3

Add Comment

[Michael Smith (JIRA)]

Michael Smith commented on PUP-8606

Re: Module-defined data types are very verbose when displayed Thomas Hallgren any hope of fixing this sometime soon? Or suggestions how I should go about it?

Add Comment

[Thomas Hallgren (JIRA)]

Thomas Hallgren commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

On PTO. Will take a look next week. Den tor 21 juni 2018 22:08Michael Smith (JIRA) <

Add Comment

[Kenn Hussey (JIRA)]

Kenn Hussey updated an issue

Puppet / PUP-8606

Module-defined data types are very verbose when displayed

Change By: Kenn Hussey Flagged: Impediment

Add Comment

[Thomas Hallgren (JIRA)]

Thomas Hallgren updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Thomas Hallgren Fix Version/s: PUP 5.5.3 Fix Version/s: PUP 5.5.z

Add Comment

[Kenn Hussey (JIRA)]

Kenn Hussey updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Kenn Hussey Flagged: Impediment

Add Comment

[Rob Braden (JIRA)]

Rob Braden updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Rob Braden Team: Platform Core Coremunity

Add Comment

[Rob Braden (JIRA)]

Rob Braden assigned an issue to Unassigned

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Rob Braden Assignee: Thomas Hallgren

Add Comment

[Rob Braden (JIRA)]

Rob Braden updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Rob Braden Team: Coremunity Platform Core

Add Comment

[Rob Braden (JIRA)]

Rob Braden updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Rob Braden Sub-team: Language

Add Comment

[Michael Smith (JIRA)]

Michael Smith commented on PUP-8606

Re: Module-defined data types are very verbose when displayed Some additional notes for when I get back to this: the issue probably needs to be addressed somewhere in TypeMismatchDescriber, TypeFormatter or possibly StringConverter. The type is expanded when it should not be. There is logic for type expansion in the Mismatch Describer.

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Puppet / PUP-8606

Module-defined data types are very verbose when displayed

Change By: Josh Cooper Fix Version/s: PUP 5.5.z Fix Version/s: PUP 6.y

Add Comment

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)

[David McTavish (Jira)]

David McTavish updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: David McTavish Labels: final_triage

Add Comment

This message was sent by Atlassian Jira (v8.13.2#813002-sha1:c495a97)

[David McTavish (Jira)]

David McTavish updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: David McTavish Priority: Normal Low

Add Comment

[Josh Cooper (Jira)]

Josh Cooper commented on PUP-8606

Re: Module-defined data types are very verbose when displayed michael.smith lucy Is this still needed for Bolt? It seems somewhat related (but different) to the PR Arthur put up for PUP-11127.

Add Comment

This message was sent by Atlassian Jira (v8.20.2#820002-sha1:829506d)

[Michael Smith (Jira)]

Michael Smith commented on PUP-8606

Re: Module-defined data types are very verbose when displayed

I don't think it was ever addressed, and does seem related to that issue.

Add Comment

[Molly Waggett (Jira)]

Molly Waggett updated an issue

Puppet / PUP-8606

Module-defined data types are very verbose when displayed

Change By: Molly Waggett Labels: final_triage

Add Comment

[Molly Waggett (Jira)]

Molly Waggett updated an issue

Puppet / PUP-8606 Module-defined data types are very verbose when displayed

Change By: Molly Waggett Team: Froyo Phoenix

Add Comment