refactor: replace actors framework events boilerplate code with macros #237
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor the actors framework repeatable code into a macro to reduce boilerplate code when defining `EventBus`. * **Define EventBus Macro:** - Add `define_event_bus` macro in `client/actors-framework/src/event_bus.rs` to automate the definition and implementation of `EventBus` and `ProvidesEventBus` traits for different event types. - Replace existing `EventBus` and `ProvidesEventBus` trait implementations with the `define_event_bus` macro in `client/blockchain-service/src/events.rs` and `client/file-transfer-service/src/events.rs`. * **Derive Macro for EventBusMessage:** - Add a new derive macro `EventBusMessage` in `client/actors-framework/src/event_bus.rs` to automate the implementation of `EventBusMessage` trait for different event types. - Create a new crate `actors-framework-macro` and implement the derive macro `EventBusMessage` in `client/actors-framework-macro/src/lib.rs`. - Use `derive(EventBusMessage)` for all event types in `client/blockchain-service/src/events.rs` and `client/file-transfer-service/src/events.rs`. - Delete the lines with `impl EventBusMessage for ...` in `client/blockchain-service/src/events.rs` and `client/file-transfer-service/src/events.rs`. * **Cargo.toml Updates:** - Add `actors-framework-macro` dependency in `client/actors-framework/Cargo.toml`, `client/blockchain-service/Cargo.toml`, and `client/file-transfer-service/Cargo.toml`. - Add `actors-framework-macro` to the workspace in `Cargo.toml`. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Moonsong-Labs/storage-hub?shareId=XXXX-XXXX-XXXX-XXXX).
links234
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor the actors framework repeatable code into a macro to reduce boilerplate code when defining
EventBus.Define EventBus Macro:
define_event_busmacro inclient/actors-framework/src/event_bus.rsto automate the definition and implementation ofEventBusandProvidesEventBustraits for different event types.EventBusandProvidesEventBustrait implementations with thedefine_event_busmacro inclient/blockchain-service/src/events.rsandclient/file-transfer-service/src/events.rs.Derive Macro for EventBusMessage:
EventBusMessageinclient/actors-framework/src/event_bus.rsto automate the implementation ofEventBusMessagetrait for different event types.actors-framework-macroand implement the derive macroEventBusMessageinclient/actors-framework-macro/src/lib.rs.derive(EventBusMessage)for all event types inclient/blockchain-service/src/events.rsandclient/file-transfer-service/src/events.rs.impl EventBusMessage for ...inclient/blockchain-service/src/events.rsandclient/file-transfer-service/src/events.rs.Cargo.toml Updates:
actors-framework-macrodependency inclient/actors-framework/Cargo.toml,client/blockchain-service/Cargo.toml, andclient/file-transfer-service/Cargo.toml.actors-framework-macroto the workspace inCargo.toml.For more details, open the Copilot Workspace session.