Refactor errors to be more specific #3067

madsmtm · 2023-08-30T09:30:19Z

Move errors out of the generic error module, and into the module where they're used.

This should help the user with actually handling the errors (instead of just propagating them), and with seeing what kind of errors a method can return (more work is still needed in this area, but this is a first step towards that).

The public changes are:

error::ExternalError::Ignored -> event::RequestIgnored.
error::EventLoopError is split into:
- event_loop::EventLoopCreationError (with less variants).
- event_loop::EventLoopRunError (with less variants).
platform::startup_notify::EventLoopExtStartupNotify::request_activation_token now errors with platform::startup_notify::ActivationTokenNotFound instead of error::NotSupportedError.
error::ExternalError -> window::WindowError.
error::NotSupportedError -> window::NotSupportedError.

A few documents that guide decision making here:

Checklist:

Tested on all platforms changed
Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
- Unsure how much information is relevant here.
Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
Created or updated an example program if it would help users understand this functionality
Updated feature matrix, if new features were added or implemented

Builds upon #3066, DO NOT MERGE YET!

Similarly for EventLoop::with_user_event and EventLoopBuilder::with_user_event

notgull

It's also a good idea to extract the "could not find any backends" error in linux/mod.rs into its own variant.

src/event_loop.rs

src/platform/startup_notify.rs

daxpedda

Absolutely love this change, it's a great improvement imo!

Only reviewed the cross-platform stuff and Web, I think Web errors in general need an overhaul so I'm gonna leave things as they are.

src/event.rs

madsmtm · 2023-09-02T11:17:30Z

It's also a good idea to extract the "could not find any backends" error in linux/mod.rs into its own variant.

Fully agreed, ideally I'd get rid of the generic OsError, but we have to start somewhere.

kchibisov · 2023-09-07T06:50:41Z

src/error.rs

@@ -1,142 +1,36 @@
+use std::panic::Location;


What's the point of keeping this module then in the end? The OsError sounds like it should be in the platform module, since it depends on the platform. We could maybe name it differently, like PlatformError.

kchibisov · 2023-09-07T06:51:32Z

src/event.rs

+    }
+}
+
+impl std::error::Error for RequestIgnored {}


I think nothing stops from doing a proper import at the top.

kchibisov · 2023-09-07T06:51:50Z

src/event.rs

+/// The request to change the inner size synchronously was ignored.
+///
+/// See [`InnerSizeWriter::request_inner_size`] for details.
+#[derive(Debug)] // Explicitly not other traits, in case we want to extend it in the future
+pub struct RequestIgnored {
+    _priv: (),
+}
+
+impl fmt::Display for RequestIgnored {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
+        f.write_str("the request was ignored")
+    }
+}


What's the reason this error is here and not on the window for example?

kchibisov · 2023-09-07T06:52:32Z

src/event_loop.rs

+    /// Application has exit with an error status.
+    ExitFailure(i32),


This is likely gone with the recent rework.

kchibisov · 2023-09-07T06:53:39Z

src/platform/startup_notify.rs

+/// The error type for when the requested operation is not supported by the backend.
+#[derive(Debug)]
+pub struct ActivationTokenNotFound {
+    _marker: (),
+}
+
+impl fmt::Display for ActivationTokenNotFound {


Why it was changed to something that has nothing to do with the activation token. It can't be not found. It's either supported or not supported, which is why it was NotSupportedError.

kchibisov · 2023-09-07T06:54:57Z

src/window.rs

+#[derive(Debug)]
+pub enum WindowError {
+    /// The operation is not supported by the backend.
+    NotSupported(NotSupportedError),
+    /// The OS cannot perform the operation.
+    Os(OsError),
+}
+
+impl fmt::Display for WindowError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
+        match self {
+            Self::NotSupported(e) => write!(f, "window operation failed: {e}"),


Could just name it a RequestError. I'm also not a fan of TODO items in top level stuff, could just open an issue.

MarijnS95

Ack'ing the Android changes, good stuff!

MarijnS95 · 2024-01-31T09:09:35Z

src/platform_impl/android/mod.rs

    event::{self, InnerSizeWriter, StartCause},
-    event_loop::{self, ControlFlow, EventLoopWindowTarget as RootELW},
+    event_loop::{
+        self, ControlFlow, EventLoopCreationError, EventLoopRunError,
+        EventLoopWindowTarget as RootELW,
+    },
    platform::pump_events::PumpStatus,
    window::{
-        self, CursorGrabMode, ImePurpose, ResizeDirection, Theme, WindowButtons, WindowLevel,
+        self, CursorGrabMode, ImePurpose, NotSupportedError, ResizeDirection, Theme, WindowButtons,


Is it just me who thinks these self imports are funky?

kchibisov · 2024-02-04T13:52:42Z

ping @madsmtm

what should we do with this now?

madsmtm · 2024-02-04T15:14:43Z

what should we do with this now?

I still believe this is a change that should be done, but it'll need work, so I'll close this PR, and try to open new, smaller scoped ones for these error changes.

madsmtm added 2 commits August 30, 2023 11:17

Add Window::builder, which replaces WindowBuilder::new

b7c63b8

Add EventLoop::builder, which replaces EventLoopBuilder::new

007bc55

Similarly for EventLoop::with_user_event and EventLoopBuilder::with_user_event

madsmtm added S - api Design and usability C - needs discussion Direction must be ironed out labels Aug 30, 2023

madsmtm added 3 commits August 30, 2023 11:50

Refactor RequestIgnored error

24eb763

Clean up BadIcon Display messages, and fix Error::source

c593f12

Split EventLoopError into a Creation and a Run variant

687e2f6

madsmtm force-pushed the specific-errors branch from ecfd116 to c79d885 Compare August 30, 2023 10:55

Refactor window errors

2ce9572

madsmtm force-pushed the specific-errors branch from c79d885 to 2ce9572 Compare August 30, 2023 11:06

madsmtm added 2 commits August 30, 2023 13:32

Remove internal os_error! macro

87a6368

Add changelog entry

ad397f4

madsmtm force-pushed the specific-errors branch from ba28abf to ad397f4 Compare August 30, 2023 11:32

madsmtm mentioned this pull request Aug 30, 2023

Platform-Specific Enum Variants #3064

Open

madsmtm marked this pull request as ready for review August 30, 2023 12:01

madsmtm requested review from jackpot51, msiglreith, daxpedda and kchibisov as code owners August 30, 2023 12:01

madsmtm requested review from notgull and maroider and removed request for msiglreith and jackpot51 August 30, 2023 12:01

notgull requested changes Aug 30, 2023

View reviewed changes

src/event_loop.rs Outdated Show resolved Hide resolved

src/platform/startup_notify.rs Show resolved Hide resolved

daxpedda approved these changes Sep 2, 2023

View reviewed changes

src/event.rs Outdated Show resolved Hide resolved

src/event.rs Outdated Show resolved Hide resolved

madsmtm added 3 commits September 2, 2023 13:10

Fix docs on request_inner_size

64e316f

Make RequestIgnored not non_exhaustive (since it has a private field)

215e0fa

Slightly more descriptive error messages

f74cd5b

kchibisov requested changes Sep 7, 2023

View reviewed changes

notgull force-pushed the add-builders branch from 007bc55 to 7066db9 Compare January 27, 2024 18:11

madsmtm requested a review from MarijnS95 as a code owner January 27, 2024 18:11

Base automatically changed from add-builders to master January 27, 2024 18:16

MarijnS95 approved these changes Jan 31, 2024

View reviewed changes

madsmtm closed this Feb 4, 2024

madsmtm deleted the specific-errors branch February 4, 2024 15:14

madsmtm mentioned this pull request Feb 9, 2024

Add more specific error RequestIgnored #3481

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor errors to be more specific #3067

Refactor errors to be more specific #3067

madsmtm commented Aug 30, 2023 •

edited

Loading

notgull left a comment

daxpedda left a comment

madsmtm commented Sep 2, 2023

kchibisov Sep 7, 2023

kchibisov Sep 7, 2023

kchibisov Sep 7, 2023

kchibisov Sep 7, 2023

kchibisov Sep 7, 2023

kchibisov Sep 7, 2023

MarijnS95 left a comment

MarijnS95 Jan 31, 2024

kchibisov commented Feb 4, 2024

madsmtm commented Feb 4, 2024

		/// Application has exit with an error status.
		ExitFailure(i32),

Refactor errors to be more specific #3067

Refactor errors to be more specific #3067

Conversation

madsmtm commented Aug 30, 2023 • edited Loading

notgull left a comment

Choose a reason for hiding this comment

daxpedda left a comment

Choose a reason for hiding this comment

madsmtm commented Sep 2, 2023

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

kchibisov Sep 7, 2023

Choose a reason for hiding this comment

MarijnS95 left a comment

Choose a reason for hiding this comment

MarijnS95 Jan 31, 2024

Choose a reason for hiding this comment

kchibisov commented Feb 4, 2024

madsmtm commented Feb 4, 2024

madsmtm commented Aug 30, 2023 •

edited

Loading