This website requires JavaScript.

polyphony/sonata

polyphony/sonata

Code Issues 14 Pull requests 4 Projects Releases Packages Activity Actions

feat: Errors returned as JSON #8

Merged

ava merged 2 commits from Guinness/sonata:feat/error-middleware into main

2025年09月05日 18:40:56 +02:00

Conversation 3 Commits 2 Files changed 2 +42 -1

Guinness commented

2025年09月05日 17:07:26 +02:00

Contributor

Copy link

This commit implements an error handler as a middleware.

For now it handles ParseJsonError with a specific case and the rest of
the errors are json serialized.

.-(17:02:09)-(~)------------------------------------------------------------------------------(neha@vali)-
`---> curl -d '{"tosConsent":false}' -H "Content-Type: application/json" -X POST localhost:3011/.p2/auth/register
{"cause":"parse error: missing field `localName` at line 1 column 20","error":"ParseJsonError"}% 
.-(17:06:07)-(~)------------------------------------------------------------------------------(neha@vali)-
`---> curl -H "Content-Type: application/json" -X POST http://localhost:3011/.p2/auth/register
{"cause":"parse error: EOF while parsing a value at line 1 column 0","error":"ParseJsonError"}%

Fixes #2

This commit implements an error handler as a middleware. For now it handles ParseJsonError with a specific case and the rest of the errors are json serialized. ``` .-(17:02:09)-(~)------------------------------------------------------------------------------(neha@vali)- `---> curl -d '{"tosConsent":false}' -H "Content-Type: application/json" -X POST localhost:3011/.p2/auth/register {"cause":"parse error: missing field `localName` at line 1 column 20","error":"ParseJsonError"}% .-(17:06:07)-(~)------------------------------------------------------------------------------(neha@vali)- `---> curl -H "Content-Type: application/json" -X POST http://localhost:3011/.p2/auth/register {"cause":"parse error: EOF while parsing a value at line 1 column 0","error":"ParseJsonError"}% ``` Fixes https://codeberg.org/polyphony/sonata/issues/2

error-returned.png

39 KiB

error-returned.png

Guinness added 1 commit

2025年09月05日 17:07:26 +02:00

feat: Errors returned as JSON bb04918c98

This commit implements an error handler as a middleware.
For now it handles ParseJsonError with a specific case and the rest of
the errors are json serialized.

ava requested changes

2025年09月05日 18:33:33 +02:00

Dismissed

ava left a comment

Copy link

Just the tiniest change request, but thank you for this PR! :)

Just the tiniest change request, but thank you for this PR! :)

src/api/middlewares/mod.rs Outdated

@ -62,0 +89,4 @@

asyncfn call(&self,req: poem::Request)-> poem::Result<Self::Output>{

letresp=self.ep.call(req).await;

matchresp{

Ok(_resp)=>Ok(_resp.into_response()),

ava commented

2025年09月05日 18:31:52 +02:00

Owner

Copy link

Ok(resp) => Ok(resp.into_response()),

Since the binding is used, the underscore is no longer useful

```suggestion Ok(resp) => Ok(resp.into_response()), ``` Since the binding is used, the underscore is no longer useful

ava marked this conversation as resolved

Guinness added 1 commit

2025年09月05日 18:36:40 +02:00

fix: use bound variable df602dbe07

ava approved these changes

2025年09月05日 18:40:16 +02:00

ava merged commit f5b5a76641 into main

2025年09月05日 18:40:56 +02:00

ava referenced this pull request from a commit

2025年09月05日 18:40:58 +02:00

Merge pull request 'feat: Errors returned as JSON' (#8) from Guinness/sonata:feat/error-middleware into main

ava commented

2025年09月05日 18:40:58 +02:00

Owner

Copy link

Thank you a lot for your time and effort! ^^ The PR is very appreciated :)

Thank you a lot for your time and effort! ^^ The PR is very appreciated :)

doesnm referenced this pull request

2025年09月05日 18:42:03 +02:00

sonata gives non-json errors in invalid schema or json errors #2

Sign in to join this conversation.

No reviewers

ava

Labels

Clear labels

Difficulty: Complex

Archived

Difficulty: Easy

Archived

Difficulty: Medium

Archived

Difficulty: Trivial

Archived

Difficulty: what

Archived

Priority: Critical

Archived

Archived

Archived

Priority: Medium

Archived

Status: Abandoned

Archived

Status: Accepted

Archived

Status: Available

Archived

Status: Blocked

Archived

Status: Completed

Archived

Status: In Progress

Archived

Status: On Hold

Archived

Status: Pending

Archived

Status: Review Needed

Archived

Status: Revision Needed

Archived

Archived

Type: Enhancement

Archived

Type: Maintenance

Archived

Archived

Highest priority issue

High priority issue

D (Medium-High)

Medium to high priority issue

Medium priority issue

Low priority issue

Lowest priority issue

Something is not as expected. For specifications or guidelines, an under-/overspecification is also considered a bug.

Regular maintainance tasks, version bumps, lint fixes

Documentation changes

This issue is a collection of other, related issues.

New functionality

Improve existing functionality

A specific work item. Can be part of an epic

Change related to CI or testing

👁️Reviewed

This issue or pull request already exists

👁️Reviewed

👁️Reviewed

This issue has been reviewed and a resolution is desired

👁️Reviewed

This issue won't be fixed

📋️Kind/Security

This is security issue

Archived

Somebody has started to work on this but abandoned work

Something is blocking this issue or pull request

Archived

This label is intended to be used when an outside collaborator is pursuing the completion of this issue, since they cannot be directly assigned to the task.

Feedback is required to reproduce issue or to continue work

Measure of time-to-implement and cognitive complexity of the task. "Hard" tasks usually take >15h to complete. Extremely unlikely to be suitable for first-time-contributors.

Measure of time-to-implement and cognitive complexity of the task. "Hard" tasks usually take 3h-15h to complete. Very likely not suitable for first-time-contributors.

Measure of time-to-implement and cognitive complexity of the task. "Medium" tasks usually take 30min-3h to complete. Likely not suitable for first-time-contributors.

Measure of time-to-implement and cognitive complexity of the task. "Easy" tasks usually take 15-30min to complete. Likely suitable for first-time-contributors.

Measure of time-to-implement and cognitive complexity of the task. "Trivial" tasks usually take 1-15min to complete. Very likely suitable for first-time-contributors.

Breaking change that won't be backward compatible

Good First Issue

This issue is a good task to take on if you are new to the project or the repository and looking to contribute.

No labels

Difficulty: Complex

Difficulty: Easy

Difficulty: Medium

Difficulty: Trivial

Difficulty: what

Priority: Critical

Priority: Medium

Status: Abandoned

Status: Accepted

Status: Available

Status: Blocked

Status: Completed

Status: In Progress

Status: On Hold

Status: Pending

Status: Review Needed

Status: Revision Needed

Type: Enhancement

Type: Maintenance

D (Medium-High)

👁️Reviewed

👁️Reviewed

👁️Reviewed

👁️Reviewed

📋️Kind/Security

Good First Issue

Clear milestone

No items

No milestone

Clear projects

No items

No project

Clear assignees

No assignees

2 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

polyphony/sonata!8

No description provided.

Delete branch "Guinness/sonata:feat/error-middleware"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?