Skip to content

[Query] Add non-generic ReadJournalFor API #7679

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 5, 2025
Merged

[Query] Add non-generic ReadJournalFor API #7679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f563300
[Query] Add non-generic `ReadJournalFor` API
Arkatufus Jun 4, 2025
2044b4a
Merge branch 'dev' into Add-non-generic-ReadJornalFor
Aaronontheweb Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApprovePersistenceQuery.DotNet.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,10 @@ namespace Akka.Persistence.Query
public Akka.Event.ILoggingAdapter Log { get; }
public static Akka.Persistence.Query.PersistenceQuery Get(Akka.Actor.ActorSystem system) { }
public static Akka.Configuration.Config GetDefaultConfig<TJournal>() { }
public static Akka.Configuration.Config GetDefaultConfig(System.Type journalType) { }
public TJournal ReadJournalFor<TJournal>(string readJournalPluginId)
where TJournal : Akka.Persistence.Query.IReadJournal { }
public Akka.Persistence.Query.IReadJournal ReadJournalFor(System.Type readJournalType, string readJournalPluginId) { }
}
public class static PersistenceQueryExtensions
{
Expand Down
2 changes: 2 additions & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApprovePersistenceQuery.Net.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,10 @@ namespace Akka.Persistence.Query
public Akka.Event.ILoggingAdapter Log { get; }
public static Akka.Persistence.Query.PersistenceQuery Get(Akka.Actor.ActorSystem system) { }
public static Akka.Configuration.Config GetDefaultConfig<TJournal>() { }
public static Akka.Configuration.Config GetDefaultConfig(System.Type journalType) { }
public TJournal ReadJournalFor<TJournal>(string readJournalPluginId)
where TJournal : Akka.Persistence.Query.IReadJournal { }
public Akka.Persistence.Query.IReadJournal ReadJournalFor(System.Type readJournalType, string readJournalPluginId) { }
}
public class static PersistenceQueryExtensions
{
Expand Down
21 changes: 16 additions & 5 deletions src/core/Akka.Persistence.Query/PersistenceQuery.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ namespace Akka.Persistence.Query
{
public sealed class PersistenceQuery : IExtension
{
private static readonly Type ReadJournalType = typeof(IReadJournal);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type cache of IReadJournal


private readonly ExtendedActorSystem _system;
private readonly ConcurrentDictionary<string, IReadJournal> _readJournalPluginExtensionIds = new();
private ILoggingAdapter _log;
Expand All @@ -34,18 +36,24 @@ public PersistenceQuery(ExtendedActorSystem system)
}

public TJournal ReadJournalFor<TJournal>(string readJournalPluginId) where TJournal : IReadJournal
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old API is left intact

=> (TJournal) ReadJournalFor(typeof(TJournal), readJournalPluginId);

public IReadJournal ReadJournalFor(Type readJournalType, string readJournalPluginId)
{
if(!ReadJournalType.IsAssignableFrom(readJournalType))
throw new ArgumentException("Must implement IReadJournal interface", nameof(readJournalType));
Comment on lines +43 to +44
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added type checking code to make sure that readJournalType implements IReadJournal


if(_readJournalPluginExtensionIds.TryGetValue(readJournalPluginId, out var plugin))
return (TJournal)plugin;
return plugin;

lock (_lock)
{
if (_readJournalPluginExtensionIds.TryGetValue(readJournalPluginId, out plugin))
return (TJournal)plugin;
return plugin;

plugin = CreatePlugin(readJournalPluginId, GetDefaultConfig<TJournal>()).GetReadJournal();
plugin = CreatePlugin(readJournalPluginId, GetDefaultConfig(readJournalType)).GetReadJournal();
_readJournalPluginExtensionIds[readJournalPluginId] = plugin;
return (TJournal)plugin;
return plugin;
}
}

Expand Down Expand Up @@ -79,8 +87,11 @@ private IReadJournalProvider CreateType(Type pluginType, object[] parameters)
}

public static Config GetDefaultConfig<TJournal>()
=> GetDefaultConfig(typeof(TJournal));

public static Config GetDefaultConfig(Type journalType)
{
var defaultConfigMethod = typeof(TJournal).GetMethod("DefaultConfiguration", BindingFlags.Public | BindingFlags.Static);
var defaultConfigMethod = journalType.GetMethod("DefaultConfiguration", BindingFlags.Public | BindingFlags.Static);
return defaultConfigMethod?.Invoke(null, null) as Config;
}
}
Expand Down