Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Append a more explanatory error message for Compute Operation errors. #12333

Merged
merged 1 commit into from
Aug 18, 2022
Merged

Append a more explanatory error message for Compute Operation errors. #12333

merged 1 commit into from
Aug 18, 2022

Conversation

modular-magician
Copy link
Collaborator

Append LocalizedMessage.Message to the ComputeOperationError top-level Message as the string return value from Error() on the same, ComputeOpearationError.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

compute: improved error messaging for compute errors

Derived from GoogleCloudPlatform/magic-modules#6403

@modular-magician
Append a more explanatory error message for Compute Operation errors. (…
ec2d16c 
…hashicorp#6403)

* Prefer the Message field on LocalizedMessage to that of the top level Message.

* Also update go.sum

* Write full Operation error including ErrorInfo

Do not just write the Operation error's LocalizedMessage.Message, but
alos maintain the top level Message in the `Error() string` return value
and also serialize the ErrorInfo that might exists in the error response
as json to the returned error string.

* Don't need to write an additional new line

* Need encoding/json for ga too because of ErrorInfo

Since we're serializing ErrorInfo to json and appending to a buffer for
the ComputeOperationError message, we need encoding/json in ga too.

* Do not append ErrorInfo as JSON

Append LocalizedMessage.Message to Error.Message, but do not serailize
an ErrorInfo, if one were to exist, as JSON to the io.Writer.

* Need to import io for io.StringWriter

Signed-off-by: Modular Magician <[email protected]>
@modular-magician modular-magician merged commit 4930a5d into hashicorp:main Aug 18, 2022
@github-actions
Copy link

I'm going to lock this pull request 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 related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@modular-magician