Update diag convenience methods #449
Conversation
paultyng
changed the title
paultyng
force-pushed
the
diag
branch
2 times, most recently
from
6ac2dfc to
9309fb0
Compare
| // No configuration | ||
| if p.ConfigureFunc == nil && p.ConfigureContextFunc == nil { | ||
| return diags | ||
| return nil |
There was a problem hiding this comment.
I swapped some of these back, I think returning nil when possible is more clear that its not a potential error case. Preserving the go idioms if possible is still useful. When someone does have warnings or are propagating from diag aware functions, the top level diags and appends make sense, but otherwise, I think it may be more effort and compromises on clarity.
| // if err != nil { | ||
| // return diag.FromErr(err) | ||
| // } | ||
| func FromErr(err error) Diagnostics { |
There was a problem hiding this comment.
Overall I do like this pattern, however I would still like a convenience to create a singular Diagnostic from an error. Would it be crazy to keep the helpers for creating on a single diag, but then have a helper to quickly convert to the collection?
return diag.FromErr(err).ToDiags()
There was a problem hiding this comment.
It's valuable in scenarios where we have gathered warnings, and encounter a function that just returns a go error
if err != nil {
return append(diags, diag.FromErr(err))
}
There was a problem hiding this comment.
I think the thing is, that you are burdening the 80% case for the 20% case, and you could easily rewrite that second one as:
if err != nil {
return append(diags, diag.FromErr(err)...)
}There was a problem hiding this comment.
I wish the package was called diags with this model, but that would collide with calling your slice diags.
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
No description provided.