First attempt at basic axum-style state management #138

TTWNO · 2024-03-11T02:31:19Z

First attempt at Axum-style state management. The final PR should have:

All should be able to implement some kind of state extraction, through types like the following:

LastFocusedItem
CurrentItem
CaretPosition
LastCaretPosition

Feel free to add additional items in the comments of this PR.

For right now, I've put together a basic EventHandlers type, that is able to connect up atspi events to various routers. At this time, I haven't seen how to add all the various parameters to a function yet, that's still to work on.

I'm hoping this makes for a more readable codebase. It sort of hides some of the complexity.

codecov · 2024-03-18T18:48:16Z

Codecov Report

Attention: Patch coverage is 0% with 129 lines in your changes missing coverage. Please review.

Project coverage is 15.47%. Comparing base (fa09dab) to head (50b61e3).
Report is 9 commits behind head on main.

❗ Current head 50b61e3 differs from pull request most recent head aa0b506

Please upload reports for the commit aa0b506 to get more accurate results.

Files	Patch %	Lines
odilia/src/tower.rs	0.00%	103 Missing ⚠️
odilia/src/main.rs	0.00%	23 Missing ⚠️
odilia/src/state.rs	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #138      +/-   ##
==========================================
- Coverage   18.90%   15.47%   -3.43%     
==========================================
  Files          20       20              
  Lines         984     1661     +677     
==========================================
+ Hits          186      257      +71     
- Misses        798     1404     +606

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

odilia/src/main.rs

albertotirla

relatively good so far, except the few points I outlined in the comments which should now hopefully be visible

odilia/src/main.rs

odilia/src/state.rs

odilia/src/tower.rs

albertotirla · 2024-04-07T10:06:20Z

odilia/src/tower.rs

+
+pub struct Handlers<S> {
+	state: S,
+	atspi_handlers: HashMap<(String, String), Vec<BoxService<Event, Response, Error>>>,


perhaps break this down with a type alias or something? that type signature is very verbose

Yeah, Clippy did tell me about this. Still working on exactly which types I want so I didn't want to make them aliased yet.

odilia/src/tower.rs

albertotirla · 2024-04-07T10:19:02Z

odilia/src/tower.rs

+		);
+		let input = ev.into();
+    // NOTE: Why not use join_all(...) ?
+    // Because this drives the futures concurrently, and we want ordered handlers.


maybe use the futures_unordered crate? produces a stream of futures, which if I remember correctly, you can get the results of concurrently and in order

I did mention in there that I can not have them compute concurrently, and why. The Vec<Command> may need to modify state.

isn't this the purpose of this refactor, to remove state handling within handlers, but modify state externally outside the handler? if we modify global state in there, we're back to no testability or very hard testability

A set of Commands are instructions on how to modify the state. Yes, the idea of this is to move the handling of state separate from the handling of actions. For example, an event may update speak some text, update the cache, fire a key event, or open a remote connection.

The implementations of these actions should be separate from their intention. If I want to speak x and y, then open a remote connection, that should be done through a set of commands, which are applied onto the state.

This way, we de-duplicate code, and de-couple the implmentation. So now, an addon can say "Hey, if I get this event, then I saw to beep at this frequency, or play this sound if some other condition is matched", and Odilia can respond without trying to give direct access to resources across FFI boundaries.

but then, state still doesn't have to be updated in the handler, no? and then, event handlers can indeed run in paralell

State will (eventually) be applied within a single call to a boxed service. But, since getting partial state is required (mostly) for each function, the functions that need state will need to be run in series to avoid sending out copies of stale data. Imagine that F1 updates the currently focused item, and F2 depends on the state of the currently focused item. If run in parallel, these functions will both get a copy of the current focused item at time 0, F1 will then run, producing a command to update the currently focused item, then F2 runs saying to speak the currently focused item and its role. This will result in speaking the last focused item instead of the current one.

odilia/src/tower.rs

odilia/src/main.rs

albertotirla

alright, reviewed the latest changes and left some feedback

odilia/src/tower.rs

albertotirla · 2024-04-15T19:03:42Z

odilia/src/tower.rs

@@ -27,17 +33,71 @@ type Response = Vec<Command>;
 type Request = Event;
 type Error = OdiliaError;

+pub struct SerialFutures<'a, T, O> {


from stackoverflow

you can directly use a stream of streams of future, where each future is converted to a stream and then flattened to force it to be poled to completion before anything else is. For that, you can use iter_ok, like so...

iter_ok(tasks).map(|f|f.into_stream()).flatten()

or this, where you get a single future which poles all of them to completion

let tasks = vec![ok(()), ok(()), ok(())]; let combined_task = iter_ok::<_, ()>(tasks).for_each(|f| f);

though I still question the doing of such serially, but this is an approach with mucbh less code, if it can be done

I like this! But we need concrete types since we need to return this from a function.

I tried really hard to use something more similar to this, especially in relation to not rolling our own SequentialFutures. That does seem silly after all.

I got really close but got slapped by the borrow checker. I can come back to this one.

odilia/src/tower.rs

TTWNO · 2024-04-18T08:44:40Z

Blocked on odilia-app/atspi#176

cargo fmt

Clippy

Adapt to i32 -> usize changes fmt

- Rename `get_children_caret` to `get_children_from_cursor` - Remove `async_trait` in favour of dep-less solution.

- Remove unused deps - Use if let ... on loop { ... } instead of while let Some(...) - Switch to using the ChoiceService model - Remove attempt at "generic handlers"; handled by ChoiceService

…ture to tokio Move futures-concurrency to workspace

Stop using channels to communicate commands

…corded)

- Move `AccessiblePrimitive` to common from cache - Add `CaretPos` and `Focus` variants to `Command`

TTWNO marked this pull request as draft March 11, 2024 05:47

This was linked to issues Mar 16, 2024

Purify Event Dispatching and Handling #118

Open

Use The Type System to Hold Cache Consistency #122

Open

Use Axum-style State Management #133

Open

TTWNO force-pushed the axum-style-handlers branch from fb58126 to 3e8392c Compare March 18, 2024 18:45

TTWNO force-pushed the axum-style-handlers branch 3 times, most recently from d19748f to 7c32b7b Compare March 21, 2024 17:15

albertotirla reviewed Apr 7, 2024

View reviewed changes

odilia/src/main.rs Outdated Show resolved Hide resolved

albertotirla requested changes Apr 10, 2024

View reviewed changes

albertotirla reviewed Apr 15, 2024

View reviewed changes

TTWNO added 17 commits April 26, 2024 13:31

Additional type fixups, handling of legacy cache item

ac469e7

cargo fmt

Desugar AFIT for send bounds enforcement

eac59eb

children_num i32 -> usize

11e1c28

Clippy

Re-add old text interfaces to cache

b2522e1

i32 -> usize for string positioning

00244c5

Adapt to i32 -> usize changes fmt

Add clippy exceptions for cache crate

83df5ac

Fix clippy issues

2c24792

Fix test compiles

a6cf72e

Fix deps

af3766c

Remove the old code in state

4dc666f

Fix tests

bcc54e1

formatting

6592710

Various cleanups

371145e

- Rename `get_children_caret` to `get_children_from_cursor` - Remove `async_trait` in favour of dep-less solution.

Change debug level, and use question mark syntax

e0a9830

Remove unused trait

f8f0849

Remove unused dep

40300f7

Remove config from state as it is unused

dd20e58

TTWNO added 29 commits June 16, 2024 23:04

Add tokio-console feature to main odilia binary

beb33e6

Cleanups and new inner services

81f1d1c

- Remove unused deps - Use if let ... on loop { ... } instead of while let Some(...) - Switch to using the ChoiceService model - Remove attempt at "generic handlers"; handled by ChoiceService

Move to mutli-threaded runtime; add channel indirection on zbus messages

ee628c3

Add comments explaining channel redirection

8a052c0

Create CacheEvent from state + E (event)

327a069

Add clone for choice service

a810f53

public new function in IterService

874506a

Use command sub-service to layer atspi responses

6269b56

Use futures-concurrency as workspace package, add rt-multi-thread fea…

587976c

…ture to tokio Move futures-concurrency to workspace

Stop using channels to communicate commands

334fc2b

Stop using channels to communicate commands

Add instrumenting on try_from_state

6dceede

Add caret_moved handler (which does not work due to no focus being re…

1a716af

…corded)

Various improvements to common

91eaa6a

- Move `AccessiblePrimitive` to common from cache - Add `CaretPos` and `Focus` variants to `Command`

Remove AccessiblePrimitive from cache

6e965ee

Add tracing option to common, make atspi-proxies a dep

44f8fb7

Update AccessiblePrimitive location

49dcb02

Add AccessibleHistory and CurrentCaretPos state structs

e7c1165

Add focus changed and caret pos updater handlers

b65260c

Update cargo lock

8bdcdf7

Speak entire item upon focus

f08d9fe

Add ability to unwrap Infallible values, then map them

beacfe2

Add new ServiceExt API for DX

55edb3d

Use new Odilia-specific ServiceExt

2dc1257

Remove return type generic on HandlerService

9ce4a00

Remove unused imports

9abc9ed

fmt

2df29ab

Add iter_into combinator

c86d61c

Add static version of Chooser trait

dd45acd

Use ChooserStatic trait, iter_into combinator

aa0b506

TTWNO marked this pull request as ready for review June 19, 2024 19:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First attempt at basic axum-style state management #138

First attempt at basic axum-style state management #138

TTWNO commented Mar 11, 2024 •

edited

codecov bot commented Mar 18, 2024 •

edited

albertotirla left a comment

albertotirla Apr 7, 2024

TTWNO Apr 10, 2024

albertotirla Apr 7, 2024

TTWNO Apr 10, 2024

albertotirla Apr 15, 2024

TTWNO Apr 16, 2024

albertotirla Apr 16, 2024

TTWNO Apr 16, 2024

albertotirla left a comment

albertotirla Apr 15, 2024

TTWNO Apr 15, 2024

TTWNO Apr 16, 2024

TTWNO commented Apr 18, 2024

First attempt at basic axum-style state management #138

Are you sure you want to change the base?

First attempt at basic axum-style state management #138

Conversation

TTWNO commented Mar 11, 2024 • edited

codecov bot commented Mar 18, 2024 • edited

Codecov Report

albertotirla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albertotirla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TTWNO commented Apr 18, 2024

TTWNO commented Mar 11, 2024 •

edited

codecov bot commented Mar 18, 2024 •

edited