Expose Tags property in EventEnvelope
#6862
Merged
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
…ufus/akka.net into Query_Expose_tags_in_EventEnvelope
Aaronontheweb
requested changes
Jul 31, 2023
| public EventEnvelope(Offset offset, string persistenceId, long sequenceNr, object @event, long timestamp) | ||
| : this(offset, persistenceId, sequenceNr, @event, timestamp, null) |
There was a problem hiding this comment.
Want to use Array.Empty<string> here instead of a nullable array?
| @@ -50,28 +57,30 @@ public EventEnvelope(Offset offset, string persistenceId, long sequenceNr, objec | |||
|
|
|||
| public long Timestamp { get; } | |||
|
|
|||
| public bool Equals(EventEnvelope other) | |||
| public string[]? Tags { get; } | |||
There was a problem hiding this comment.
See previous comment about non-nullable Array.Empty<string>
| @@ -59,30 +65,32 @@ public virtual void ReadJournal_query_CurrentEventsByTag_should_find_existing_ev | |||
| var greenSrc = queries.CurrentEventsByTag("green", offset: NoOffset()); | |||
| var probe = greenSrc.RunWith(this.SinkProbe<EventEnvelope>(), Materializer); | |||
| probe.Request(2); | |||
| probe.ExpectNext<EventEnvelope>(p => p.PersistenceId == "a" && p.SequenceNr == 2L && p.Event.Equals("a green apple")); | |||
| probe.ExpectNext<EventEnvelope>(p => p.PersistenceId == "a" && p.SequenceNr == 4L && p.Event.Equals("a green banana")); | |||
| ExpectEnvelope(probe, "a", 2L, "a green apple", "green"); | |||
| @@ -188,7 +214,9 @@ public virtual void ReadJournal_query_CurrentEventsByTag_should_see_all_150_even | |||
| [Fact] | |||
| public void ReadJournal_query_CurrentEventsByTag_should_include_timestamp_in_EventEnvelope() | |||
| { | |||
| var queries = ReadJournal as ICurrentEventsByTagQuery; | |||
| if (ReadJournal is not ICurrentEventsByTagQuery queries) | |||
| throw IsTypeException.ForMismatchedType(nameof(ICurrentEventsByTagQuery), ReadJournal?.GetType().Name ?? "null"); | |||
There was a problem hiding this comment.
LGTM - shouldn't run these specs for journals that don't support it / should let the implementor know they've made a boo-boo.
| if (SupportsTagsInEventEnvelope) | ||
| { | ||
| envelope.Tags.Should().NotBeNull(); | ||
| envelope.Tags.Should().Contain(tag); |
| using static Akka.Persistence.Query.Offset; | ||
|
|
||
| #nullable enable |
|
@Arkatufus I think you need to update API approval here |
|
API Approval list updated |
Aaronontheweb
approved these changes
Aug 1, 2023
|
Nice one 👍🏻 |
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.
Changes
close #6849
TagsinEventEnvelopeThe
Tagsproperty is, by default, an empty array. It is up to the plugin implementation to populate it.The built-in SQLite and in-mem journal is set to populate the property only for
EventsByTagandCurrentEventsByTagqueries, all SQL based plugin "should" automatically inherit this. It is not populated on any other persistence queries at the moment.Full support is planned for
Akka.Persistence.Sqlplugin.Changes have been tested on
Akka.Persistence.SqlServerandAkka.Persistence.MongoDbto see if it breaks any API or unit test, they worked just fine.