Plume
/
Plume
8
16
Fork 22
Code Issues 174 Pull-Requests 8 Releases 8 Wiki Aktivität

Label Meilensteine

Avoid panics #392

Zusammengeführt
elegaanz hat 8 Commits von result nach master vor 5 Jahren zusammengeführt
Diskussion 2 Commits 8 Geänderte Dateien 50
elegaanz hat vor 5 Jahren kommentiert (Migriert von github.com)
  • Use Result as much as possible
  • Display errors instead of panicking

TODO (maybe in another PR? this one is already quite big):

  • Find a way to merge Ructe/ErrorPage types, so that we can have routes returning Result<X, ErrorPage> instead of panicking when we have an Error
  • Display more details about the error, to make it easier to debug

(sorry, this isn't going to be fun to review, the diff is huge, but it is always the same changes)

- Use `Result` as much as possible - Display errors instead of panicking TODO (maybe in another PR? this one is already quite big): - Find a way to merge Ructe/ErrorPage types, so that we can have routes returning `Result<X, ErrorPage>` instead of panicking when we have an `Error` - Display more details about the error, to make it easier to debug (sorry, this isn't going to be fun to review, the diff is huge, but it is always the same changes)
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

(sorry, this isn't going to be fun to review, the diff is huge, but it is always the same changes)

I guess it wasn't fun to write either

> (sorry, this isn't going to be fun to review, the diff is huge, but it is always the same changes) I guess it wasn't fun to write either
igalic (Migriert von github.com) hat vor 5 Jahren überprüft
igalic (Migriert von github.com) hat einen Kommentar hinterlassen

first pass, not done yet

first pass, not done yet
plume-common/src/activity_pub/mod.rs
@ -122,3 +122,3 @@
act["@context"] = context();
let signed = act.sign(sender);
let signed = act.sign(sender).expect("activity_pub::broadcast: signature error");
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

i thought we're trying to avoid panics?

i thought we're trying to avoid panics?
plume-common/src/activity_pub/request.rs
@ -107,3 +107,3 @@
pub fn signature<S: Signer>(signer: &S, headers: &HeaderMap) -> HeaderValue {
pub fn signature<S: Signer>(signer: &S, headers: &HeaderMap) -> Result<HeaderValue, ()> {
let signed_string = headers
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

can you briefly explain this return signature?
maybe then I'll also understand the above expect()

can you briefly explain this return signature? maybe then I'll also understand the above `expect()`
plume-models/src/blogs.rs
@ -214,0 +170,4 @@
// We don't really care about all the following for remote instances
long_description: SafeString::new(""),
short_description: SafeString::new(""),
default_license: String::new(),
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

wow! that's some really nice refactoring! 👍

wow! that's some really nice refactoring! 👍
plume-models/src/blogs.rs
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

so, it's ok, or desired, that tests panic, right?

so, it's ok, or desired, that tests panic, right?
plume-models/src/comments.rs
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

neat!

neat!
plume-models/src/comments.rs
igalic (Migriert von github.com) hat vor 5 Jahren kommentiert

https://doc.rust-lang.org/std/result/enum.Result.html#method.map_err i read the doc, but still don't understand what this does

https://doc.rust-lang.org/std/result/enum.Result.html#method.map_err i read the doc, but still don't understand what this does
trinity-1686a hat vor 5 Jahren überprüft
plume-models/src/comments.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

I you understand map, this is basically the same thing, but for Err(_) instead of Ok(_). And passing Error::from is the equivalent to |e| e.from()
This is just mapping an error type to another

I you understand `map`, this is basically the same thing, but for `Err(_)` instead of `Ok(_)`. And passing `Error::from` is the equivalent to `|e| e.from()` This is just mapping an error type to another
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-common/src/activity_pub/mod.rs
@ -122,3 +122,3 @@
act["@context"] = context();
let signed = act.sign(sender);
let signed = act.sign(sender).expect("activity_pub::broadcast: signature error");
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

Ahah, right… It actually doesn't add a panic, we just panic "outside" of the function instead of "inside" because it wouldn't make much sense to return a Result from broadcast as it is always the main function of its thread.

Ahah, right… It actually doesn't add a panic, we just panic "outside" of the function instead of "inside" because it wouldn't make much sense to return a `Result` from `broadcast` as it is always the main function of its thread.
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-common/src/activity_pub/request.rs
@ -107,3 +107,3 @@
pub fn signature<S: Signer>(signer: &S, headers: &HeaderMap) -> HeaderValue {
pub fn signature<S: Signer>(signer: &S, headers: &HeaderMap) -> Result<HeaderValue, ()> {
let signed_string = headers
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

It says that it can either success with a HeaderValue, or fail with (), so we don't have much details about the error, we just know it failed, but it is probably enough to know that something failed in this function (or maybe not?)

It says that it can either success with a `HeaderValue`, or fail with `()`, so we don't have much details about the error, we just know it failed, but it is probably enough to know that something failed in this function (or maybe not?)
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-models/src/blogs.rs
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

Yes, tests should panic every time something is wrong, so that they fail and that we now something is broken.

Yes, tests should panic every time something is wrong, so that they fail and that we now something is broken.
codecov[bot] hat vor 5 Jahren kommentiert (Migriert von github.com)

Codecov Report

Merging #392 into master will increase coverage by 0.08%.
The diff coverage is 19.5%.

@@            Coverage Diff             @@
##           master     #392      +/-   ##
==========================================
+ Coverage   27.76%   27.85%   +0.08%     
==========================================
  Files          63       63              
  Lines        6302     7260     +958     
==========================================
+ Hits         1750     2022     +272     
- Misses       4552     5238     +686
# [Codecov](https://codecov.io/gh/Plume-org/Plume/pull/392?src=pr&el=h1) Report > Merging [#392](https://codecov.io/gh/Plume-org/Plume/pull/392?src=pr&el=desc) into [master](https://codecov.io/gh/Plume-org/Plume/commit/e2d5a5057c2009e25cbb0f5625de0d0ebe7875ca?src=pr&el=desc) will **increase** coverage by `0.08%`. > The diff coverage is `19.5%`. ```diff @@ Coverage Diff @@ ## master #392 +/- ## ========================================== + Coverage 27.76% 27.85% +0.08% ========================================== Files 63 63 Lines 6302 7260 +958 ========================================== + Hits 1750 2022 +272 - Misses 4552 5238 +686 ```
trinity-1686a hat vor 5 Jahren überprüft
trinity-1686a hat einen Kommentar hinterlassen
Besitzer

It seems good.
Some Result could/should be Result<()> instead.
The ? syntax is really helpful with error handling

It seems good. Some Result<T> could/should be Result<()> instead. The `?` syntax is really helpful with error handling
plume-models/src/blogs.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

I could see a use for knowing how many posts were deleted, and at first at assumed it's what it was. But after re-reading it's telling how many blogs where deleted, so the Ok(_) will only be 1 any, am I right?

I could see a use for knowing how many posts were deleted, and at first at assumed it's what it was. But after re-reading it's telling how many blogs where deleted, so the Ok(_) will only be 1 any, am I right?
plume-models/src/instance.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

If I'm not mistaken, the usize is going to be how many entries were affected, which is one?

If I'm not mistaken, the usize is going to be how many entries were affected, which is one?
plume-models/src/instance.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

If I'm not mistaken, the usize is going to be how many entries were affected, which is one?

If I'm not mistaken, the usize is going to be how many entries were affected, which is one?
plume-models/src/posts.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

I don't know if there are other places where unwrap_or_else(|_| ..) was replaced with unwrap_or(..), if so this comment also apply to them. I think it would be better to or_else(|_| ..)?, I think you already did it at other places

I don't know if there are other places where `unwrap_or_else(|_| ..)` was replaced with `unwrap_or(..)`, if so this comment also apply to them. I think it would be better to `or_else(|_| ..)?`, I think you already did it at other places
plume-models/src/tags.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

Same about returning Result<()> because it will be 1

Same about returning Result<()> because it will be 1
plume-models/src/users.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

same about Result<()>

same about `Result<()>`
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

Same about Result<()>

Same about `Result<()>`
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

Same about Result<()>

Same about `Result<()>`
src/main.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

I should have made this message from the start. Maybe add something about making sure no other instance of plume is already running here?

I should have made this message from the start. Maybe add something about making sure no other instance of plume is already running here?
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-models/src/blogs.rs
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

Yes, this result is not used anywhere, it just to have the right return type without having to .map(|_| ()), but maybe it's misleading?

Yes, this result is not used anywhere, it just to have the right return type without having to `.map(|_| ())`, but maybe it's misleading?
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-models/src/instance.rs
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

Yes, but https://github.com/Plume-org/Plume/pull/392#discussion_r244369771

Yes, but https://github.com/Plume-org/Plume/pull/392#discussion_r244369771
trinity-1686a hat vor 5 Jahren überprüft
plume-models/src/blogs.rs
trinity-1686a hat vor 5 Jahren kommentiert
Besitzer

I think it is, even more because we did not document any function (nor what they return)

I think it is, even more because we did not document any function (nor what they return)
elegaanz (Migriert von github.com) hat vor 5 Jahren überprüft
plume-models/src/blogs.rs
elegaanz (Migriert von github.com) hat vor 5 Jahren kommentiert

Ok, I'll change it then. 👍

Ok, I'll change it then. :+1:
trinity-1686a hat die Änderungen vor 5 Jahren genehmigt
trinity-1686a hat einen Kommentar hinterlassen
Besitzer

👍

:+1:

Reviewer

trinity-1686a hat die Änderungen vor 5 Jahren genehmigt
Der Pull Request wurde als 80a4dae8bd gemergt.
Siehe auch die Anleitung für die Kommandozeile.

Schritt 1:

Wechsle auf einen neuen Branch in deinem lokalen Repository und teste die Änderungen.
git checkout -b result master
git pull origin result

Schritt 2:

Führe die Änderungen zusammen und aktualisiere den Stand online auf Forgejo.
git checkout master
git merge --no-ff result
git push origin master
Anmelden, um an der Diskussion teilzunehmen.
Reviewer
Überprüfung anfordern
Keine Reviewer
trinity-1686a
Label
Label anwenden
Label entfernen   
A: API

Related to the REST API   
A: Backend

Code running on the server   
A: Federation

Stuff related to Federation   
A: Front-End

Related to the front-end   
A: I18N

Translations, and related code   
A: Meta

More about project management or code than the project itself   
A: Security
   
Build

The building, or installation process of Plume   
C: Bug

Something isn't working   
C: Discussion

We need to talk   
C: Enhancement

New feature or request   
C: Feature

This is a new feature   
Compatibility

Compatibility with different browsers, readers and OS   
Dependency

Related to an external package that Plume uses   
Design

UI/UX related issues and PRs   
Documentation
   
Good first issue

Good for newcomers   
Help welcome

Extra attention is needed   
Mobile

Issues affecting only mobile UX   
Rendering

How elements're rendered out for the end user   
S: Blocked

Something else needs to be fixed first   
S: Duplicate

This issue or pull request already exists   
S: Incomplete

This PR is not complete yet   
S: Instance specific

Issues concern a limited number of instances   
S: Invalid

This doesn't seem right   
S: Needs Voting/Discussion

Need to be discussed by the community (on Loomio)   
S: Ready for review

This PR is ready to be reviewed   
Suggestion

Proposed ideas worth considering   
S: Voted on Loomio

This is issue has been created after a vote on Loomio   
S: Wontfix

This will not be worked on
Kein Label
A: API
A: Backend
A: Federation
A: Front-End
A: I18N
A: Meta
A: Security
Build
C: Bug
C: Discussion
C: Enhancement
C: Feature
Compatibility
Dependency
Design
Documentation
Good first issue
Help welcome
Mobile
Rendering
S: Blocked
S: Duplicate
S: Incomplete
S: Instance specific
S: Invalid
S: Needs Voting/Discussion
S: Ready for review
Suggestion
S: Voted on Loomio
S: Wontfix
Meilenstein
Meilenstein setzen
Meilenstein entfernen
Keine Einträge
Kein Meilenstein
Zuständig
Benutzer zuweisen
Zuständige entfernen
Niemand zuständig
2 Beteiligte
Nachrichten
Fällig am
Das Fälligkeitsdatum ist ungültig oder außerhalb des zulässigen Bereichs. Bitte verwende das Format „jjjj-mm-tt“.

Kein Fälligkeitsdatum gesetzt.

Abhängigkeiten

Keine Abhängigkeiten gesetzt.

Referenz: Plume/Plume#392
Verfassen Vorschau
Laden…
Abbrechen
Speichern
Hier gibt es bis jetzt noch keinen Inhalt.
Branch „result“ löschen

Das Löschen eines Branches ist permanent. Es KANN NICHT rückgängig gemacht werden. Fortfahren?

Abbrechen
Ja