Skip to content

Commit 998dcca

Browse files
AarononthewebAaronontheweb
authored
Exception serialization support for built-in messages (#6297)
* added end to end spec to validate error serialization for remote actor supervision * defined `.proto`s for `Status.Failure` and `Status.Success` * added `Status.,Failure` and `Status.Success` support to the `MiscMessageSerializer` * added tests to `MiscMessageSerializerSpec` * close #3903
1 parent 7f68c48 commit 998dcca

File tree

8 files changed

+793
-70
lines changed

8 files changed

+793
-70
lines changed

‎src/core/Akka.Remote.Tests/Serialization/Bugfix3903Spec.cs

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
//-----------------------------------------------------------------------
2+
// <copyright file="Bugfix3903Specs.cs" company="Akka.NET Project">
3+
// Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com>
4+
// Copyright (C) 2013-2022 .NET Foundation <https://github.com/akkadotnet/akka.net>
5+
// </copyright>
6+
//-----------------------------------------------------------------------
7+
8+
using System;
9+
using System.Threading.Tasks;
10+
using Akka.Actor;
11+
using Akka.Configuration;
12+
using Akka.TestKit;
13+
using Akka.Util.Internal;
14+
using Xunit;
15+
using Xunit.Abstractions;
16+
using FluentAssertions;
17+
18+
namespace Akka.Remote.Tests.Serialization
19+
{
20+
public class Bugfix3903Spec : AkkaSpec
21+
{
22+
// hocon config enabling akka.remote
23+
private static readonly Config Config = @"akka.actor.provider = remote
24+
akka.remote.dot-netty.tcp.hostname = localhost
25+
akka.remote.dot-netty.tcp.port = 0";
26+
27+
public Bugfix3903Spec(ITestOutputHelper outputHelper) : base(Config, outputHelper)
28+
{
29+
}
30+
31+
#region Internal Types
32+
33+
// parent actor type that will remotely deploy a child actor type onto a specific address
34+
private class ParentActor : ReceiveActor
35+
{
36+
// message type that includes an Address
37+
public class DeployChild
38+
{
39+
public DeployChild(Address address)
40+
{
41+
Address = address;
42+
}
43+
44+
public Address Address { get; }
45+
}
46+
47+
public ParentActor()
48+
{
49+
Receive<DeployChild>(s =>
50+
{
51+
// props to deploy an EchoActor at the address specified in DeployChild
52+
var props = Props.Create<EchoActor>().WithDeploy(new Deploy(new RemoteScope(s.Address)));
53+
var child = Context.ActorOf(props, "child");
54+
Sender.Tell(child);
55+
});
56+
}
57+
}
58+
59+
internal class EchoActor : ReceiveActor
60+
{
61+
public class Fail
62+
{
63+
public static readonly Fail Instance = new Fail();
64+
private Fail(){}
65+
}
66+
67+
public EchoActor()
68+
{
69+
// receive message that will cause this actor to fail
70+
Receive<Fail>(s =>
71+
{
72+
throw new ApplicationException("fail");
73+
});
74+
ReceiveAny(o => Sender.Tell(o));
75+
}
76+
}
77+
78+
#endregion
79+
80+
// a test where Sys starts a ParentActor and has it remotely deploy an EchoActor onto a second ActorSystem
81+
[Fact]
82+
public async Task ParentActor_should_be_able_to_deploy_EchoActor_to_remote_system()
83+
{
84+
// create a second ActorSystem
85+
var system2 = ActorSystem.Create(Sys.Name, Sys.Settings.Config);
86+
InitializeLogger(system2);
87+
try
88+
{
89+
// create a supervision strategy that will send a message to the TestActor including the exception of the child that failed
90+
var strategy = new OneForOneStrategy(ex =>
91+
{
92+
TestActor.Tell(ex);
93+
return Directive.Stop;
94+
});
95+
96+
// create a ParentActor in the first ActorSystem
97+
var parent = Sys.ActorOf(Props.Create<ParentActor>().WithSupervisorStrategy(strategy), "parent");
98+
99+
// have the ParentActor remotely deploy an EchoActor onto the second ActorSystem
100+
var child = await parent
101+
.Ask<IActorRef>(new ParentActor.DeployChild(
102+
system2.AsInstanceOf<ExtendedActorSystem>().Provider.DefaultAddress), RemainingOrDefault).ConfigureAwait(false);
103+
104+
// assert that Child is a remote actor reference
105+
child.Should().BeOfType<RemoteActorRef>();
106+
Watch(child);
107+
108+
// send a message to the EchoActor and verify that it is received
109+
(await child.Ask<string>("hello", RemainingOrDefault).ConfigureAwait(false)).Should().Be("hello");
110+
111+
// cause the child to crash
112+
child.Tell(EchoActor.Fail.Instance);
113+
var exception = ExpectMsg<ApplicationException>();
114+
exception.Message.Should().Be("fail");
115+
ExpectTerminated(child);
116+
}
117+
finally
118+
{
119+
// shut down the second ActorSystem
120+
Shutdown(system2);
121+
}
122+
}
123+
}
124+
}

‎src/core/Akka.Remote.Tests/Serialization/MiscMessageSerializerSpec.cs

+25-1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,30 @@ public void Can_serialize_IdentifyWithNull()
7676
AssertEqual(identify);
7777
}
7878

79+
[Theory]
80+
[InlineData(null)]
81+
[InlineData(1)]
82+
[InlineData("hi")]
83+
public void Can_serialize_StatusSuccess(object payload)
84+
{
85+
var success = new Status.Success(payload);
86+
AssertEqual(success);
87+
}
88+
89+
[Theory]
90+
[InlineData(null)]
91+
[InlineData(1)]
92+
[InlineData("hi")]
93+
public void Can_serialize_StatusFailure(object payload)
94+
{
95+
var success = new Status.Failure(new ApplicationException("foo"),payload);
96+
// can't use AssertEqual here since the Exception data isn't 100% identical after round-trip serialization
97+
var deserialized = AssertAndReturn(success);
98+
deserialized.State.Should().BeEquivalentTo(success.State);
99+
deserialized.Cause.Message.Should().BeEquivalentTo(success.Cause.Message);
100+
deserialized.Cause.Should().BeOfType(success.Cause.GetType());
101+
}
102+
79103
[Fact]
80104
public void Can_serialize_ActorIdentity()
81105
{
@@ -372,7 +396,7 @@ private T AssertAndReturn<T>(T message)
372396
private void AssertEqual<T>(T message)
373397
{
374398
var deserialized = AssertAndReturn(message);
375-
Assert.Equal(message, deserialized);
399+
deserialized.Should().BeEquivalentTo(message);
376400
}
377401
}
378402
}

‎src/core/Akka.Remote/Configuration/Remote.conf

+2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ akka {
3939
"Akka.Actor.PoisonPill, Akka" = akka-misc
4040
"Akka.Actor.Kill, Akka" = akka-misc
4141
"Akka.Actor.PoisonPill, Akka" = akka-misc
42+
"Akka.Actor.Status+Failure, Akka" = akka-misc
43+
"Akka.Actor.Status+Success, Akka" = akka-misc
4244
#"Akka.Actor.LocalScope, Akka" = akka-misc
4345
"Akka.Actor.RemoteScope, Akka" = akka-misc
4446
"Akka.Routing.FromConfig, Akka" = akka-misc

‎src/core/Akka.Remote/Serialization/ExceptionSupport.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public Exception ExceptionFromProtoNet(Proto.Msg.ExceptionData proto)
150150
return obj;
151151
}
152152

153-
private string ValueOrNull(string value)
153+
private static string ValueOrNull(string value)
154154
=> string.IsNullOrEmpty(value) ? null : value;
155155
}
156156
}

‎src/core/Akka.Remote/Serialization/MessageContainerSerializer.cs

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
using System.Linq;
1010
using System.Runtime.Serialization;
1111
using Akka.Actor;
12-
using Akka.Remote.Serialization.Proto.Msg;
1312
using Akka.Serialization;
1413
using Akka.Util;
1514
using Google.Protobuf;
@@ -108,7 +107,7 @@ public override object FromBinary(byte[] bytes, Type type)
108107
return new ActorSelectionMessage(message, elements);
109108
}
110109

111-
private Proto.Msg.Selection BuildPattern(string matcher, Proto.Msg.Selection.Types.PatternType tpe)
110+
private static Proto.Msg.Selection BuildPattern(string matcher, Proto.Msg.Selection.Types.PatternType tpe)
112111
{
113112
var selection = new Proto.Msg.Selection { Type = tpe };
114113
if (matcher != null)

0 commit comments

Comments
 (0)