Upload error reporting

[codecovdesign]

Problem to solve

Description

In the scenario of failed uploads, we show in the aside, summary and empty state. The copy isn't as clear as it's a fragmented in the sections and the summary message is generic in that scenario.

Steps to Reproduce / Current UX

Solution (Latest)

The ask here is to make the error messagings clear and actionable.
In total, we have 5 upload errors and 4 to update. (no change for "Unknown error")

1. Processing failed --> Upload failed. Please rerun the upload.
2. Upload expired --> Upload exceeds the max. age of 12h. Please download and review your report or turn off the age check by visiting expired reports.
3. Unusable report --> Unusable report due to issues such as source code unavailability, path mismatch, empty report, or incorrect data format. Please visit our troubleshooting document for assistance.
4. Multiple flags --> Multiple flags detected. Please ensure one flag per upload.

See design for these error messagings:

Figma: link

Additional Information

[Adal3n3]

@nicholas-codecov On the upload status, what are the differences between "Processing failed" and "Unknown error"? Can you point me to the list of error scenarios, like upload incomplete, incorrect file format, etc.

[nicholas-codecov]

I'm not really sure of what the difference is on a technical level, this is just what we get back from the API and display it. Maybe @giovanni-guidini or @joseph-sentry can answer

[Adal3n3]

According to the Error reporting, we have 4 errors conditions

https://github.com/codecov/gazebo/blob/7c3919c56bf8cce36f90b3b3bdc94371ced6a7be/sr[…]ges/CommitDetailPage/CommitCoverage/UploadsCard/RenderError.jsx

const UploadErrorMessage = Object.freeze({
[ErrorCodeEnum.fileNotFoundInStorage]: 'processing failed',
[ErrorCodeEnum.reportExpired]: 'upload expired',
[ErrorCodeEnum.reportEmpty]: 'unusable report',
noMatch: 'unknown error',
})

1. Processing failed 


• The upload not found in storage
• If upload not found in storage will not have the download link.


2. Upload expired


• Codecov will reject reports that are over 12 hours old according to the timestamp in the report. This is to prevent reports that may have been accidentally checked into git.

3. Unusable report


• It can be caused by source code unavailability, path mismatch, empty report, or incorrect data format.

• It used to called “Report is empty”.
  -https://docs.codecov.com/docs/error-reference#unusable-reports
-https://github.com/codecov/gazebo/blob/7a86cc7f1ef9f8f006bb4053e0f8fdcf31c7e2df/src/pages/CommitDetailPage/CommitCoverage/UploadsCard/RenderError.jsx#L50-L60



4. Unknown error

   -According to Matt, it is genuinely unknown. Slack thread: https://sentry.slack.com/archives/C04NC9NNPEG/p1712350674153459

   -future work: make upload error reporting more consistent #1520

[Adal3n3]

Figma: link
The improvement here is to help developers understand their errors and provide an actionable next step for them to fix their errors. Here's the proposed error messages that covered above 4 errors:

[Adal3n3]

"Use proper placement: It is very important to place an error message closer to the area from where it belongs to. Users should not have to look here and there after reading the message that what it talks about."

The message on the left UI, I'm not sure they are the right location for the upload errors.

[drazisil-codecov]

I like option 2 in both cases, and see no problems with the other message changes. 👍

[Adal3n3]

@katia-sentry can you prioritize this?