akka / akka-edge-rs

Akka Edge support in Rust
https://doc.akka.io/docs/akka-edge/current/
Other
9 stars 1 forks source link

UI in the sample makes it more complicated #82

Closed patriknw closed 11 months ago

patriknw commented 1 year ago

@johanandren and I had this opinion when we saw the UI PR, and we are both even more convinced when reading the guide. The UI code takes too much focus, and makes the initial installation more difficult.

It would be better to walk through the "core" features, step-by-step, without having to explain things like broadcast_event or shared model.

Curl would be perfectly fine for interacting with the sample.

At the end of the guide, it could have a step explaining what would be needed to add UI.

huntc commented 1 year ago

One thing I’ve strived for with the example is to make it real. It bothers me that examples out there leave so much out. And I think the UI visually demonstrates something quite distinct about Akka’s event driven approach.

However, I get the burden it’s introducing on the first time reader. I can remove it from the guide and leave it in the example. Does that work for you both?

patriknw commented 1 year ago

Sounds good to me

johanandren commented 1 year ago

I think it would be fine to keep in the guide, as long as it was a separate step where you didn't have to understand it to get the core APIs.

Hiding it is also ok, but I think it still changes how things are done, for example, if you didn't do an SSE UI, would you have the shared model at all?

huntc commented 1 year ago

if you didn't do an SSE UI, would you have the shared model at all?

Good question. When we get to the gRPC-web stuff I suspect that protobuf will become that shared model.

huntc commented 11 months ago

Are we ok to close this now given https://github.com/lightbend/akka-projection-temp/pull/23. Life is now much simpler... WDYT?

johanandren commented 11 months ago

I think it is ok now that the concerns are better separated 👍

patriknw commented 11 months ago

Great improvement. Maybe the shared model separation is not that important any more? Anyway, we can fine tune later.

huntc commented 11 months ago

I think there is still merit in the shared model. The UI is event sourcing its state to present to the user with the same methods that the backend is. This is also consistent with my production app, and I’ve found it to be very useful there.