-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add EventLog abstraction (implemented by AkkaPersistenceEventLog and KafkaEventLog). #14
Open
odd
wants to merge
1
commit into
krasserm:master
Choose a base branch
from
odd:event-log-abstraction
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
74 changes: 74 additions & 0 deletions
74
src/main/scala/com/github/krasserm/ases/log/EventLog.scala
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
/* | ||
* Copyright 2017 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package com.github.krasserm.ases.log | ||
|
||
import scala.concurrent.Future | ||
import scala.reflect.ClassTag | ||
import akka.{Done, NotUsed} | ||
import akka.stream.scaladsl.{Flow, Sink, Source} | ||
import com.github.krasserm.ases.{Delivery, Durable, Emitted} | ||
|
||
/** | ||
* Akka Stream API for events logs. Each individual event log is identified | ||
* by an identifier. The type of the identifier (supplied as type argument | ||
* `Identifier`) will depend on the concrete event log implementation. | ||
*/ | ||
trait EventLog[Identifier] { | ||
|
||
/** | ||
* Creates a flow representing the event log identified by `identifier`. | ||
* Input events are written to the journal and emitted as output events | ||
* after successful write. Before input events are requested from upstream | ||
* the flow emits events that have been previously written to the journal | ||
* (recovery phase). | ||
* | ||
* During recovery, events are emitted as [[Delivered]] messages, recovery completion | ||
* is signaled as [[Recovered]] message, both subtypes of [[Delivery]]. After recovery, | ||
* events are again emitted as [[Delivered]] messages. | ||
* | ||
* It is the application's responsibility to ensure that there is only a | ||
* single materialized instance with given `persistenceId` writing to the | ||
* journal. | ||
* | ||
* @param identifier identifier of the event log. | ||
* @tparam A event type. Only events that are instances of given type are | ||
* emitted by the flow. | ||
*/ | ||
def flow[A: ClassTag](identifier: Identifier): Flow[Emitted[A], Delivery[Durable[A]], NotUsed] | ||
|
||
/** | ||
* Creates a source that replays events of the event log identified by `identifier`. | ||
* The source completes when the end of the log has been reached. | ||
* | ||
* During recovery, events are emitted as [[Delivered]] messages, recovery completion | ||
* is signaled as [[Recovered]] message, both subtypes of [[Delivery]]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A source from a Kafka event log continues to emit |
||
* | ||
* @param identifier identifier of the event log. | ||
* @tparam A event type. Only events that are instances of given type are | ||
* emitted by the source. | ||
*/ | ||
def source[A: ClassTag](identifier: Identifier): Source[Delivery[Durable[A]], NotUsed] | ||
|
||
/** | ||
* Creates a sink that writes events to the event log identified by | ||
* `identifier`. | ||
* | ||
* @param identifier persistence id of the event log. | ||
*/ | ||
def sink[A](identifier: Identifier): Sink[Emitted[A], Future[Done]] | ||
|
||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an implementation detail of the Akka Persistence event log. Multiple materialization of a Kafka event log for the same topic partition can be made. Also,
persistenceId
refers to an implementation detail here.