Modernize AkkaSpec and Akka.Remote DotNetty transport settings #6854
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
Arkatufus
commented
Jul 26, 2023
| HandshakeTimeout = config.GetTimeSpan("akka.remote.dot-netty.tcp.connection-timeout", null); | ||
| else if (enabledTransports.Contains("akka.remote.dot-netty.ssl")) | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.dot-netty.ssl.connection-timeout", null); | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.dot-netty.tcp.connection-timeout", TimeSpan.FromSeconds(15), allowInfinite:false); |
There was a problem hiding this comment.
Add default value to config value
Arkatufus
commented
Jul 26, 2023
Comment on lines
-55
to
-56
| else if (enabledTransports.Contains("akka.remote.dot-netty.ssl")) | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.dot-netty.ssl.connection-timeout", null); |
There was a problem hiding this comment.
Removed akka.remote.dot-netty.ssl, this HOCON path has not been used since 5 years ago
Arkatufus
commented
Jul 26, 2023
| else | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.handshake-timeout", TimeSpan.FromSeconds(20), allowInfinite:false); | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.handshake-timeout", TimeSpan.FromSeconds(15), allowInfinite:false); |
There was a problem hiding this comment.
Change default value to 15 to reflect actual HOCON default
Arkatufus
commented
Jul 26, 2023
Comment on lines
-355
to
-356
| # necessary to keep backwards compatibility | ||
| helios.tcp.transport-class = "Akka.Remote.Transport.Helios.HeliosTcpTransport, Akka.Remote.Transport.Helios" |
There was a problem hiding this comment.
Moved to code since this causes bugs
Arkatufus
commented
Jul 26, 2023
Comment on lines
+524
to
+555
| ssl { | ||
| certificate { | ||
| # Valid certificate path required | ||
| path = "" | ||
| # Valid certificate password required | ||
| password = "" | ||
| # Default key storage flag is "default-key-set" | ||
| # Available flags include: | ||
| # default-key-set | exportable | machine-key-set | persist-key-set | user-key-set | user-protected | ||
| # flags = [ "default-key-set" ] | ||
|
|
||
| # To use a Thumbprint instead of a file, set this to true | ||
| # And specify a thumbprint and it's storage location below | ||
| use-thumbprint-over-file = false | ||
|
|
||
| # Valid Thumbprint required (if use-thumbprint-over-file is true) | ||
| # A typical thumbprint is a format similar to: "45df32e258c92a7abf6c112e54912ab15bbb9eb0" | ||
| # On Windows machines, The thumbprint for an installed certificate can be located | ||
| # By using certlm.msc and opening the certificate under the 'Details' tab. | ||
| thumbprint = "" | ||
|
|
||
| # The Store name. Under windows The most common option is "My", which indicates the personal store. | ||
| # See System.Security.Cryptography.X509Certificates.StoreName for other common values. | ||
| store-name = "" | ||
|
|
||
| # Valid options : local-machine or current-user | ||
| # current-user indicates a certificate stored under the user's account | ||
| # local-machine indicates a certificate stored at an operating system level (potentially shared by users) | ||
| store-location = "current-user" | ||
| } | ||
| suppress-validation = false | ||
| } |
There was a problem hiding this comment.
Move the SSL configuration to its proper place
Arkatufus
commented
Jul 26, 2023
Arkatufus
commented
Jul 26, 2023
Comment on lines
+12
to
+24
| public sealed class DotNettySslSetup: Setup | ||
| { | ||
| public DotNettySslSetup(X509Certificate2 certificate, bool suppressValidation) | ||
| { | ||
| Certificate = certificate; | ||
| SuppressValidation = suppressValidation; | ||
| } | ||
|
|
||
| public X509Certificate2 Certificate { get; } | ||
| public bool SuppressValidation { get; } | ||
|
|
||
| internal SslSettings Settings => new SslSettings(Certificate, SuppressValidation); | ||
| } |
There was a problem hiding this comment.
This Setup class allows users to inject X509Certificate2 instance directly
Arkatufus
commented
Jul 26, 2023
Comment on lines
+137
to
+138
| var heliosFallbackConfig = system.Settings.Config.GetConfig("akka.remote.helios.tcp") | ||
| .WithFallback("transport-class = \"Akka.Remote.Transport.Helios.HeliosTcpTransport, Akka.Remote.Transport.Helios\""); |
There was a problem hiding this comment.
Moved the hard coded HOCON settings from pidgeon.conf here, value only get added when necessary
There was a problem hiding this comment.
Do we still need to support Helios?
Arkatufus
commented
Jul 26, 2023
Comment on lines
+142
to
+144
| var setup = system.Settings.Setup.Get<DotNettySslSetup>(); | ||
| var sslSettings = setup.HasValue ? setup.Value.Settings : null; | ||
| Settings = DotNettyTransportSettings.Create(config, sslSettings); |
There was a problem hiding this comment.
Setup class injection
Arkatufus
commented
Jul 26, 2023
| /// <param name="BatchWriterSettings"> | ||
| /// Used for performance-tuning the DotNetty channels to maximize I/O performance. | ||
| /// </param> | ||
| internal sealed record DotNettyTransportSettings( |
There was a problem hiding this comment.
Changed to record, safe API change, internal
Arkatufus
commented
Jul 26, 2023
Comment on lines
+145
to
+147
| var setup = system.Settings.Setup.Get<DotNettySslSetup>(); | ||
| var sslSettings = setup.HasValue ? setup.Value.Settings : null; | ||
| return Create(config, sslSettings); |
There was a problem hiding this comment.
Setup class injection
Arkatufus
commented
Jul 26, 2023
Comment on lines
+173
to
+178
| var host = config.GetString("hostname"); | ||
| if (string.IsNullOrWhiteSpace(host)) | ||
| host = IPAddress.Any.ToString(); | ||
|
|
||
| var publicHost = config.GetString("public-hostname"); | ||
| var publicPort = config.GetInt("public-port"); |
There was a problem hiding this comment.
Remove unnecessary default values
Arkatufus
commented
Jul 26, 2023
| ServerSocketWorkerPoolSize: ComputeWorkerPoolSize(config.GetConfig("server-socket-worker-pool")), | ||
| ClientSocketWorkerPoolSize: ComputeWorkerPoolSize(config.GetConfig("client-socket-worker-pool")), | ||
| MaxFrameSize: ToNullableInt(config.GetByteSize("maximum-frame-size", null)) ?? 128000, | ||
| Ssl: enableSsl ? SslSettings.CreateOrDefault(config.GetConfig("ssl"), sslSettings) : SslSettings.Empty, |
There was a problem hiding this comment.
the "ssl" path will always be present now since we fix the default HOCON.
Arkatufus
commented
Jul 26, 2023
Comment on lines
+231
to
+233
| floor: config.GetInt("pool-size-min", 2), | ||
| scalar: config.GetDouble("pool-size-factor", 1.0), | ||
| ceiling: config.GetInt("pool-size-max", 2)); |
There was a problem hiding this comment.
Add sensible default values
Aaronontheweb
approved these changes
Jul 27, 2023
| } | ||
| namespace Akka.Remote.Transport.DotNetty | ||
| { | ||
| public sealed class DotNettySslSetup : Akka.Actor.Setup.Setup |
There was a problem hiding this comment.
LGTM - need this for programmatic setup I take it.
Comment on lines
-55
to
-56
| else if (enabledTransports.Contains("akka.remote.dot-netty.ssl")) | ||
| HandshakeTimeout = config.GetTimeSpan("akka.remote.dot-netty.ssl.connection-timeout", null); |
Comment on lines
+524
to
+555
| ssl { | ||
| certificate { | ||
| # Valid certificate path required | ||
| path = "" | ||
| # Valid certificate password required | ||
| password = "" | ||
| # Default key storage flag is "default-key-set" | ||
| # Available flags include: | ||
| # default-key-set | exportable | machine-key-set | persist-key-set | user-key-set | user-protected | ||
| # flags = [ "default-key-set" ] | ||
|
|
||
| # To use a Thumbprint instead of a file, set this to true | ||
| # And specify a thumbprint and it's storage location below | ||
| use-thumbprint-over-file = false | ||
|
|
||
| # Valid Thumbprint required (if use-thumbprint-over-file is true) | ||
| # A typical thumbprint is a format similar to: "45df32e258c92a7abf6c112e54912ab15bbb9eb0" | ||
| # On Windows machines, The thumbprint for an installed certificate can be located | ||
| # By using certlm.msc and opening the certificate under the 'Details' tab. | ||
| thumbprint = "" | ||
|
|
||
| # The Store name. Under windows The most common option is "My", which indicates the personal store. | ||
| # See System.Security.Cryptography.X509Certificates.StoreName for other common values. | ||
| store-name = "" | ||
|
|
||
| # Valid options : local-machine or current-user | ||
| # current-user indicates a certificate stored under the user's account | ||
| # local-machine indicates a certificate stored at an operating system level (potentially shared by users) | ||
| store-location = "current-user" | ||
| } | ||
| suppress-validation = false | ||
| } |
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.
ActorSystemSetupconstructor variantChanges
AkkaSpecinjects_akkaSpecConfiginto theActorSystemSetupctor argumentDotNettyTransportSettings:record#nullable enableSetupsupport.DotNettySslSetupChecklist
For significant changes, please ensure that the following have been completed (delete if not relevant):