[
https://issues.apache.org/jira/browse/BEAM-7393?focusedWorklogId=247140&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-247140
]
ASF GitHub Bot logged work on BEAM-7393:
----------------------------------------
Author: ASF GitHub Bot
Created on: 22/May/19 23:27
Start Date: 22/May/19 23:27
Worklog Time Spent: 10m
Work Description: youngoli commented on pull request #8655: [BEAM-7393]
Misc. improvements to Go error formatting.
URL: https://github.com/apache/beam/pull/8655
This is just three small changes:
1. Remove default top-level error messages. If a top-level msg wasn't set
then just don't display any. Originally top-level messages were always
displayed because it was assumed the error would be confusing if it started
with context instead of an error message. But in practice that's actually less
confusing.
Old behavior:
```
error message
Full Error:
context:
more context:
error message
```
New behavior:
```
context:
more context:
error message
```
2. Align the "Caused by:" msg on wrapped errors with the context
messages, to improve readability.
Old behavior:
```
error number 4
Caused by:
some context:
error number 3
Caused by:
error number 2
Caused by:
error number 1
```
New behavior:
```
error number 4
caused by:
some context:
error number 3
caused by:
error number 2
caused by:
error number 1
```
3. Improvement to an error message that I missed.
------------------------
Thank you for your contribution! Follow this checklist to help us
incorporate your contribution quickly and easily:
- [x] [**Choose
reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and
mention them in a comment (`R: @username`).
- [x] Format the pull request title like `[BEAM-XXX] Fixes bug in
ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA
issue, if applicable. This will automatically link the pull request to the
issue.
- [ ] If this contribution is large, please file an Apache [Individual
Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Apex | Dataflow | Flink | Gearpump | Samza | Spark
--- | --- | --- | --- | --- | --- | --- | ---
Go | [](https://builds.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/)
| --- | --- | --- | --- | --- | ---
Java | [](https://builds.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Apex/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Gearpump/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)
Python | [](https://builds.apache.org/job/beam_PostCommit_Python_Verify/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python3_Verify/lastCompletedBuild/)
| --- | [](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)
<br> [](https://builds.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PreCommit_Python_PVR_Flink_Cron/lastCompletedBuild/)
| --- | --- | ---
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website
--- | --- | --- | --- | ---
Non-portable | [](https://builds.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/)
| [](https://builds.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/)
Portable | --- | [](https://builds.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/)
| --- | ---
See
[.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md)
for trigger phrase, status and link of all Jenkins jobs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 247140)
Time Spent: 10m
Remaining Estimate: 0h
> Misc. improvements to error formatting.
> ---------------------------------------
>
> Key: BEAM-7393
> URL: https://issues.apache.org/jira/browse/BEAM-7393
> Project: Beam
> Issue Type: Sub-task
> Components: sdk-go
> Reporter: Daniel Oliveira
> Assignee: Daniel Oliveira
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Just need a second pass on error formatting. Two things are bothering me:
> # Default top-level messages are a bit too repetitive and obtuse. Right now
> if there's any kind of context or wrapping the top-level message is just the
> base error and this is usually confusing.
> # When an error is wrapped you have a line for "Caused by:" and it can be
> hard to read. Example:
> {noformat}
> error number 4
> caused by:
> some context:
> error number 3
> caused by:
> error number 2
> caused by:
> error number 1{noformat}
> Gotta make this example easier to read.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
