agama-project / agama / 22897556027

77%

Build Type

push

github

Committed by web-flow

Commit Message

feat(web): add error page (#3261)

## Problem

When Agama crashes due to an unexpected error, an ugly page with a
cryptic error message is shown most of the time.

## Solution

Render a more appealing `ErrorPage` with a better formatted error
message, filtering out third-party references from the stack trace and
pointing to the exact location where the error originated (or at least
something more accurate than what was displayed until now).

## Note about error location

The new `ErrorPage` introduces
[**StackTracey**](https://github.com/xpl/stacktracey) as a dependency,
which allows using `withSources`/`withSourcesAsync` to display the
original source location instead of the compiled build location, by
leveraging source maps.

The output is equivalent to using `source-maps-cli` as described at
https://lists.opensuse.org/archives/list/yast-devel@lists.opensuse.org/thread/OHU6OJAMXTPD6SXXOGKC6Q2K6U7RBFDO/,
though be aware the location might be approximate. Not entirely sure
why, possibly because it is the original file without comment lines and
other build optimizations. In any case, `React.createElement` line in
the examples points exactly to the problem, at least in the manual
testing done to validate these changes.

## Note about the `as-table` dependency

This PR uses the `.asTable()` method, which pulls in the `as-table`
dependency from the same author as StackTracey. Although `as-table` has
not been updated in a long time, it only has one further dependency
(also from the same author) and does not appear to be a problem. In any
case, as documented in the code:

> It can be dropped at any point if any problem is found, but for now it
gives us better formatted error messages at almost no cost.

## Tests

- Added unit tests
- Tested manually

## Follow-up

Among other ~crazy ideas~ improvements, maybe the download logs button
could be added to such an error page if the server still alive. But out
of the scope of this _fast-track_ PR intended for bot... (continued)

Run Details

3150 of 5091 branches covered (61.87%)

Branch coverage included in aggregate %.

41 of 41 new or added lines in 4 files covered. (100.0%)

15 existing lines in 2 files now uncovered.

20463 of 25629 relevant lines covered (79.84%)

82.61 hits per line