Allow AtLeastOnceDelivery parameters to be set from deriving classes (as intended) #3810

ondrejpialek · 2019-05-25T17:32:10Z

Currently all AtLeastOnceDelivery parameters are read from settings passed via ctor when the semantic is created. The documentation says that properties that expose these parameters may be overwritten in derived classes to provide different values. This however does not work. The semantic never reads from the derived actors themselves (it has no reference to the owning actor to even read the properties).

This PR makes the owning actors' properties non-virtual and write through, effectively encapsulating the ones of the semantic. The semantic is additionally updated to handle changing values even as the actor runs (so they can be modified even outside the actor's ctor and the new values will be picked up by the semantic).

The values from settings are still the default.

I also fixed the redelivery interval being fired at double the intended rate.

This might be a potentially breaking change, as the properties are no longer virtual. But anyone overwriting these was not getting what they wanted anyway - so perhaps a good thing they will get a compiler error and thus a chance to update their code to set the interval and other properties properly?

ondrejpialek · 2019-05-25T17:35:23Z

src/core/Akka.Persistence.Tests/AtLeastOnceDeliveryFailureSpec.cs


-            public override TimeSpan RedeliverInterval { get { return TimeSpan.FromMilliseconds(500); } }
+                RedeliverInterval = TimeSpan.FromMilliseconds(500);


This is a good example how these properties are now intended to be used; just set them anywhere from within the actor instead of overwriting.

ondrejpialek · 2019-05-25T17:38:36Z

src/core/Akka.Persistence/AtLeastOnceDeliverySemantic.cs

-            var interval = new TimeSpan(RedeliverInterval.Ticks / 2);
-            _redeliverScheduleCancelable = _context.System.Scheduler.ScheduleTellRepeatedlyCancelable(interval, interval, _context.Self,
+            var delay = new TimeSpan(RedeliverInterval.Ticks / 2);
+            _redeliverScheduleCancelable = _context.System.Scheduler.ScheduleTellRepeatedlyCancelable(delay, RedeliverInterval, _context.Self,


Was this a bug? The first parameter is the initial delay of the very first callback. The second parameter is then the interval this will fire in, so this should be the whole RedeliverInterval, not half?

yeah, must have been a bug. Nice catch.

Aaronontheweb · 2019-05-25T20:23:36Z

@ondrejpialek need to approve the public API changes: https://getakka.net/community/public-api-changes.html

Aaronontheweb · 2019-05-25T20:23:49Z

That'll get the failing unit test to pass.

ondrejpialek · 2019-05-27T11:35:26Z

Sorry I haven't read that part of the docs. That explains that popup I saw and the files I had to exclude from the commit :) Will add it and update the PR.

Delete the received file committed by mistake

ondrejpialek · 2019-05-27T11:51:02Z

PR ready @Aaronontheweb

Aaronontheweb · 2019-05-27T19:34:31Z

Thank you!

…

Sent from my iPhone

On May 27, 2019, at 6:51 AM, Ondrej Pialek ***@***.***> wrote: PR ready @Aaronontheweb — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

Horusiath · 2019-05-29T06:13:48Z

src/core/Akka.Persistence/AtLeastOnceDeliverySemantic.cs

+            get => _redeliverInterval;
+            set
+            {
+                if (_redeliverInterval != value)


Doesn't this looks too surprising? I mean, using setter is usually considered to be simple operation with no side effect (except changing value type). The fact, that it resets schedule may be the source of problems, for example in debugging, in the future.

It's here so that the semantic behaves "correctly", e.g. if you set a different interval it should send things at a different interval. I agree that having too much logic in setters is not great though (thought I thought it's acceptable and tried to limit the resets by checking for a change).

What do you propose? Have a method instead for changing this? Or have this read only and only accept the value via ctor? Or making this smarter by calculating the correct delay between the elapsed time and new interval?

AFAIK those configuration values should be defined exactly once - when an actor is created. I'd probably need verify it somehow, but we're having a state machines here, so changing this value in different actor "state" may result in different side effects - and I'm not sure if all of them are acceptable.

Simplest way I can think of ATM to make it break the actor would be to call RedeliverInterval = x in actor's PostStop method after calling base.PostStop(), which is cancelling all scheduled messages. Any call like this one made afterwards would trigger it to schedule the message back again, but never actually cancel.

That would not happen the way it's currently written as it checks for _redeliverScheduleCancelable being active before restarting it.

if (_redeliverScheduleCancelable != null) { _redeliverScheduleCancelable.Cancel(); _redeliverScheduleCancelable = null; StartRedeliverTask(); }

But if you prefer not to have these mutable I can redo this PR in a different way - the values would be set via ctor only (at the cost of having to read the redelivery settings in two places (both AtLeastOnce actors that use this semantic).

The problem with that approach is that the AtLeastOnceDeliverySemantic is created in the actor's ctor and you should not access virtual fields inside a ctor, so the only way that comes in mind is specifying two ctors for each actor so that you can specify these parameters calling the right base ctor.

Actually there is already a ctor on the actors that takes the redelivery settings. So perhaps we make the properties non-virtual in order not to confuse the developers (as overwriting has no effect currently) and we fix the docs to say to use the overloaded ctor instead of overwriting?

It would be nice, but the problem is backwards compatibility. I think, we can stay with your current approach. Any thoughts @Aaronontheweb ?

@ondrejpialek @Horusiath

Actually there is already a ctor on the actors that takes the redelivery settings. So perhaps we make the properties non-virtual in order not to confuse the developers (as overwriting has no effect currently) and we fix the docs to say to use the overloaded ctor instead of overwriting?

Since this is going into the v1.4 branch and we can afford to take some more liberties with the API there - if overriding the properties already has no effect, I don't see an issue with removing the virtual modifier on those properties and just having developers use the constructor overload instead. I think making these settings immutable and settable through the constructor is probably the best way to go, in order to avoid having those side effects during the processing of the state machine as @Horusiath mentioned.

Can you go ahead with those changes @ondrejpialek ?

Horusiath · 2019-05-29T06:15:21Z

src/core/Akka.Persistence/AtLeastOnceDeliverySemantic.cs

+
+                    if (deliveriesAboveThreshold.Length > 0)
+                    {
+                        _context.Self.Tell(new UnconfirmedWarning(deliveriesAboveThreshold));


Same here, the last thing I would expect from using (this.WarnAfterNumberOfUnconfirmedAttempts = 5) is that it may send messages to actors and allocate extra arrays.

Again - this is to make the logic correct - if you start with 10, have 6 unconfirmed, then switch to 5 then you should receive the warning.

What do you think is best? Have this read only (and accept the value only via ctor?) or not trigger immediately but wait for next unconfirmed message?

Agree with @Horusiath - this should be immutable I think. Pick your strategy and stick with it at the time the actor starts.

Aaronontheweb · 2019-06-03T13:43:08Z

@Horusiath saw that you tagged me here - my apologies for the delay! I'll take a look at this today.

Aaronontheweb

Need to make this immutable, but otherwise this is a very important and much-needed change.

Aaronontheweb · 2019-06-21T09:48:24Z

src/core/Akka.API.Tests/CoreAPISpec.ApprovePersistence.approved.txt

@@ -16,11 +16,11 @@ namespace Akka.Persistence
    {
        protected AtLeastOnceDeliveryActor() { }
        protected AtLeastOnceDeliveryActor(Akka.Persistence.PersistenceSettings.AtLeastOnceDeliverySettings settings) { }
-        public int MaxUnconfirmedMessages { get; }
-        public virtual System.TimeSpan RedeliverInterval { get; }


I'm ok with this change.

Aaronontheweb · 2019-06-21T09:49:08Z

src/core/Akka.Persistence/AtLeastOnceDeliveryReceiveActor.cs

+        public int MaxUnconfirmedMessages
+        {
+            get => _atLeastOnceDeliverySemantic.MaxUnconfirmedMessages;
+            set => _atLeastOnceDeliverySemantic.MaxUnconfirmedMessages = value;


All of these settings should be immutable and overloadable via the CTOR, as you mentioned @ondrejpialek

Aaronontheweb · 2019-06-21T09:50:11Z

src/core/Akka.Persistence/AtLeastOnceDeliverySemantic.cs

+
+                    if (deliveriesAboveThreshold.Length > 0)
+                    {
+                        _context.Self.Tell(new UnconfirmedWarning(deliveriesAboveThreshold));


Agree with @Horusiath - this should be immutable I think. Pick your strategy and stick with it at the time the actor starts.

Aaronontheweb · 2019-06-21T09:50:46Z

src/core/Akka.Persistence/AtLeastOnceDeliverySemantic.cs

-            var interval = new TimeSpan(RedeliverInterval.Ticks / 2);
-            _redeliverScheduleCancelable = _context.System.Scheduler.ScheduleTellRepeatedlyCancelable(interval, interval, _context.Self,
+            var delay = new TimeSpan(RedeliverInterval.Ticks / 2);
+            _redeliverScheduleCancelable = _context.System.Scheduler.ScheduleTellRepeatedlyCancelable(delay, RedeliverInterval, _context.Self,


yeah, must have been a bug. Nice catch.

Added a .ctor overload to AtLeastOnceDelivery actors that allows to tweak default settings so that the user does not have to construct and specify all settings manually.

ondrejpialek

Hello @Aaronontheweb @Horusiath,

I have updated my PR and removed the setters from the properties. I added a convenience constructor overload for the actors to simplify tweaking the settings from a parent constructor call. Let me know what you think (see comments in the relevant code).

Cheers,
Ondrej.

ondrejpialek · 2019-07-12T13:51:21Z

src/core/Akka.Persistence.Tests/AtLeastOnceDeliveryFailureSpec.cs

@@ -136,7 +136,8 @@ internal class ChaosSender : AtLeastOnceDeliveryActor

            public ILoggingAdapter Log { get { return _log ?? (_log = Context.GetLogger()); }}

-            public ChaosSender(IActorRef destination, IActorRef probe)
+            public ChaosSender(IActorRef destination, IActorRef probe) 
+                : base(x => x.WithRedeliverInterval(TimeSpan.FromMilliseconds(500)))


This is a new ctor overload, see comment on the base class

src/core/Akka.Persistence/AtLeastOnceDelivery.cs

Aaronontheweb

LGTM - going to wait on CI

Aaronontheweb · 2019-07-12T19:23:57Z

@Horusiath I'm good with this - any objections?

…(as intended) (akkadotnet#3810) * Allow various redelivery parameters to be tweaked from derived classes * Adding API change declaration * Merge API changes to approved for PR review Delete the received file committed by mistake * Making various AtLeastOnceDelivery settings read-only Added a .ctor overload to AtLeastOnceDelivery actors that allows to tweak default settings so that the user does not have to construct and specify all settings manually.

Allow various redelivery parameters to be tweaked from derived classes

09e4cab

ondrejpialek commented May 25, 2019

View reviewed changes

ondrejpialek added 3 commits May 27, 2019 13:44

Adding API change declaration

8e1ace6

Merge branch 'dev' into at-least-once-fix

0f0a52e

Merge API changes to approved for PR review

dc8113d

Delete the received file committed by mistake

Horusiath reviewed May 29, 2019

View reviewed changes

Aaronontheweb requested changes Jun 21, 2019

View reviewed changes

ondrejpialek added 2 commits July 12, 2019 14:47

Merge branch 'dev' into at-least-once-fix

526777b

Making various AtLeastOnceDelivery settings read-only

2d32faa

Added a .ctor overload to AtLeastOnceDelivery actors that allows to tweak default settings so that the user does not have to construct and specify all settings manually.

ondrejpialek commented Jul 12, 2019

View reviewed changes

Merge branch 'dev' into at-least-once-fix

4330b19

Aaronontheweb self-requested a review July 12, 2019 17:30

Aaronontheweb approved these changes Jul 12, 2019

View reviewed changes

Aaronontheweb added the akka-persistence label Jul 12, 2019

Aaronontheweb added this to the 1.4.0 milestone Jul 12, 2019

Aaronontheweb added 4 commits July 16, 2019 08:20

Merge branch 'dev' into at-least-once-fix

7a215dd

Merge branch 'dev' into at-least-once-fix

e2cf449

Merge branch 'dev' into at-least-once-fix

c21c4c6

Merge branch 'dev' into at-least-once-fix

1db9ef8

Horusiath self-requested a review July 20, 2019 18:34

Horusiath approved these changes Jul 20, 2019

View reviewed changes

Horusiath merged commit 2c78120 into akkadotnet:dev Jul 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow AtLeastOnceDelivery parameters to be set from deriving classes (as intended) #3810

Allow AtLeastOnceDelivery parameters to be set from deriving classes (as intended) #3810

ondrejpialek commented May 25, 2019 •

edited

Loading

ondrejpialek May 25, 2019

ondrejpialek May 25, 2019

Aaronontheweb Jun 21, 2019

Aaronontheweb commented May 25, 2019

Aaronontheweb commented May 25, 2019

ondrejpialek commented May 27, 2019

ondrejpialek commented May 27, 2019

Aaronontheweb commented May 27, 2019 via email

Horusiath May 29, 2019

ondrejpialek May 29, 2019 •

edited

Loading

Horusiath May 30, 2019

ondrejpialek May 30, 2019 •

edited

Loading

ondrejpialek May 30, 2019 •

edited

Loading

Horusiath May 31, 2019

Aaronontheweb Jun 21, 2019

Horusiath May 29, 2019

ondrejpialek May 29, 2019

Aaronontheweb Jun 21, 2019

Aaronontheweb commented Jun 3, 2019

Aaronontheweb left a comment

Aaronontheweb Jun 21, 2019

Aaronontheweb Jun 21, 2019

Aaronontheweb Jun 21, 2019

Aaronontheweb Jun 21, 2019

ondrejpialek left a comment •

edited

Loading

ondrejpialek Jul 12, 2019

Aaronontheweb left a comment

Aaronontheweb commented Jul 12, 2019


		public override TimeSpan RedeliverInterval { get { return TimeSpan.FromMilliseconds(500); } }
		RedeliverInterval = TimeSpan.FromMilliseconds(500);

Allow AtLeastOnceDelivery parameters to be set from deriving classes (as intended) #3810

Allow AtLeastOnceDelivery parameters to be set from deriving classes (as intended) #3810

Conversation

ondrejpialek commented May 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaronontheweb commented May 25, 2019

Aaronontheweb commented May 25, 2019

ondrejpialek commented May 27, 2019

ondrejpialek commented May 27, 2019

Aaronontheweb commented May 27, 2019 via email

Choose a reason for hiding this comment

ondrejpialek May 29, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejpialek May 30, 2019 • edited Loading

Choose a reason for hiding this comment

ondrejpialek May 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaronontheweb commented Jun 3, 2019

Aaronontheweb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejpialek left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaronontheweb left a comment

Choose a reason for hiding this comment

Aaronontheweb commented Jul 12, 2019

ondrejpialek commented May 25, 2019 •

edited

Loading

ondrejpialek May 29, 2019 •

edited

Loading

ondrejpialek May 30, 2019 •

edited

Loading

ondrejpialek May 30, 2019 •

edited

Loading

ondrejpialek left a comment •

edited

Loading