Abstract log Entry #1304
Draft
Abstract log Entry #1304
+963
−456
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
drmingdrmer
changed the title
drmingdrmer
force-pushed
the
179-log-id-list
branch
22 times, most recently
from
666e0c7 to
f0fd058
Compare
drmingdrmer
force-pushed
the
179-log-id-list
branch
from
f0fd058 to
b0e94bb
Compare
- Remove trait `FromAppData` that is used to create log `Entry` from
application data. Add `RaftEntry::new()`. Application should implement
this method.
- Change: trait `RaftLogId`: before this commit, it is used to defined a
`LogId` container, requiring methods `get_log_id()` and `set_log_id()`.
In this commit, `RaftLogId` defines the behavior of `LogId` itself,
requiring methods `new()`, `committed_leader_id()` and `index()`.
- The `RaftEntry` trait removed requirement of `RaftLogId`, due to the
`RaftLogId` behavior change, and requires application to implements
methods:
- `new()` to create a log `Entry`,
- `log_id_parts()`: to return references to the components of this
entry's log ID: the committed leader ID and index,
- `set_log_id()`: to update the log entry id.
And `RaftEntry` provides several default implemented methods:
- `new_blank()`, `new_normal()`, `new_membership()` to create
different kind of log `Entry`.
- `log_id()` returns an owned `LogId` instance,
- `index()` returns the log id index.
- Refactor: Introduce `RefLogId` as a reference to a log ID
Existing `LogIdOf<C>` provides a minimal storage implementation for
a log ID with essential properties. In contrast, `RefLogId` which
references a storage `LogIdOf<C>`, offers the same information as
`LogIdOf<C>` while adding additional system-defined properties.
For example, `LogIdOf<C>` defined by the application will not need
to implement `Ord`. However, `RefLogId`, used internally, will
provide a system-defined `Ord` implementation.
This change updates internal components to return `RefLogId` or
accept it as an argument where possible, enabling more flexibility
and consistency in handling log IDs.
- Update example `raft-kv-memstore-grpc`: implement log `Entry` and
other types with protobuf, such as state machine and RPC message
types; Implement snapshot streaming transmission; Remove `serde` from
this example.
- Part of databendlabs#1278
Upgrade tips:
1. **For applications using a custom `RaftEntry` implementation** (e.g.,
declared with `declare_raft_types!(MyTypes: Entry = MyEntry)`),
Update the `RaftEntry` implementation:
- Remove implementation of `FromAppData`;
- Add implementation of `new()`, `log_id_parts()` and
`set_log_id()` method.
2. **For applications using the default `Entry` provided by OpenRaft**:
- No changes are required.
drmingdrmer
force-pushed
the
179-log-id-list
branch
from
b0e94bb to
c63a958
Compare
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.
Changelog
There is a lot changes and this PR will be split into several smaller ones
This change is