github-community-projects / private-mirrors

A GitHub App that allows you to contribute upstream using private mirrors of public projects

MIT License

119 stars 12 forks source link

feat: add error messages to error flashes #179

Closed sutterj closed 2 months ago

sutterj commented 2 months ago

Pull Request

Proposed Changes

Closes #128
- Add error messages to error flashes
- Display error messages if error when creating, editing, and deleting mirrors

Readiness Checklist

Author/Contributor

[ ] If documentation is needed for this change, has that been included in this pull request
[X] run npm run lint and fix any linting issues that have been introduced
[X] run npm run test and run tests
[ ] If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

[X] Label as either bug, documentation, enhancement, infrastructure, maintenance, or breaking

sutterj commented 2 months ago

Currently there is some handling in the create procedure to make a "pretty" message if one already exists:

This is the only error that has this, so is it worthwhile to do this for the other procedures or is that too specific/tedious because of the number of possible errors:

zkoppert commented 2 months ago

Currently there is some handling in the create procedure to make a "pretty" message if one already exists:

This is the only error that has this, so is it worthwhile to do this for the other procedures or is that too specific/tedious because of the number of possible errors:

@ahpook thoughts?

ahpook commented 2 months ago

Hmmm. How many potential other messages are we looking at? The json barf is pretty ugly ...

Is the format predictable enough to extract the message field and pretty-print that with a generic "Failed to create mirror. Error was: " banner?

sutterj commented 2 months ago

I'm not really sure how many, but I would guess that the name conflict one is probably the most common and that one is already covered. I would imagine that the API is consistent and returns a message field though and that would be easy to add to the banner by itself.