Merge pull request #794 from Cysharp/feature/UpdateDiagnosticHandlerApi

Update IStreamingHubDiagnosticHandler API
Cysharp · Jun 21, 2024 · b0dee9d · b0dee9d
2 parents 1a04afd + dbdc9dc
commit b0dee9d
Show file tree

Hide file tree

Showing 58 changed files with 213 additions and 128 deletions.
diff --git a/src/MagicOnion.Client.SourceGenerator/CodeGen/StaticStreamingHubClientGenerator.cs b/src/MagicOnion.Client.SourceGenerator/CodeGen/StaticStreamingHubClientGenerator.cs
@@ -304,6 +304,14 @@ static void EmitOnBroadcastEvent(StreamingHubClientBuildContext ctx)
         ctx.Writer.AppendLine("""
                             protected override void OnBroadcastEvent(global::System.Int32 methodId, global::System.ReadOnlyMemory<global::System.Byte> data)
                             {
+            """);
+        if (ctx.EnableStreamingHubDiagnosticHandler)
+        {
+            ctx.Writer.AppendLine("""
+                                diagnosticHandler?.OnBroadcastEventRaw(this, methodId, data);
+            """);
+        }
+        ctx.Writer.AppendLine("""
                                 switch (methodId)
                                 {
             """);
@@ -356,18 +364,31 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
     static void EmitOnResponseEvent(StreamingHubClientBuildContext ctx)
     {
         ctx.Writer.AppendLine("""
-                            protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                            protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                             {
                                 switch (methodId)
                                 {
             """);
         foreach (var method in ctx.Hub.Methods)
         {
-            ctx.Writer.AppendLineWithFormat($$"""
+            if (ctx.EnableStreamingHubDiagnosticHandler)
+            {
+                ctx.Writer.AppendLineWithFormat($$"""
+                                    case {{method.HubId}}: // {{method.MethodReturnType.ToDisplayName()}} {{method.MethodName}}({{method.Parameters.ToMethodSignaturize()}})
+                                        diagnosticHandler?.OnResponseEvent<{{ctx.Hub.GetClientFullName()}}, {{method.ResponseType.FullName}}>(this, "{{method.MethodName}}", data);
+                                        base.SetResultForResponse<{{method.ResponseType.FullName}}>(taskSource, data);
+                                        break;
+            """);
+            }
+            else
+            {
+                ctx.Writer.AppendLineWithFormat($$"""
                                     case {{method.HubId}}: // {{method.MethodReturnType.ToDisplayName()}} {{method.MethodName}}({{method.Parameters.ToMethodSignaturize()}})
-                                        base.SetResultForResponse<{{method.ResponseType.FullName}}>(taskCompletionSource, data);
+                                        base.SetResultForResponse<{{method.ResponseType.FullName}}>(taskSource, data);
                                         break;
             """);
+
+            }
         }
         ctx.Writer.AppendLine("""
                                 }

diff --git a/...lient.Unity/Assets/Scripts/MagicOnion/MagicOnion.Client/IStreamingHubDiagnosticHandler.cs b/...lient.Unity/Assets/Scripts/MagicOnion/MagicOnion.Client/IStreamingHubDiagnosticHandler.cs
@@ -24,6 +24,15 @@ public interface IStreamingHubDiagnosticHandler
         /// <param name="invokeMethod"></param>
         ValueTask<TResponse> OnMethodInvoke<THub, TRequest, TResponse>(THub hubInstance, int methodId, string methodName, TRequest request, bool isFireAndForget, InvokeMethodDelegate<TRequest, TResponse> invokeMethod);
 
+        /// <summary>
+        /// [Preview] The callback method when a method of HubReceiver is invoked. This API may change in the future.
+        /// </summary>
+        /// <typeparam name="THub"></typeparam>
+        /// <param name="hubInstance"></param>
+        /// <param name="methodId"></param>
+        /// <param name="data"></param>
+        void OnBroadcastEventRaw<THub>(THub hubInstance, int methodId, ReadOnlyMemory<byte> data);
+
         /// <summary>
         /// [Preview] The callback method when a method of HubReceiver is invoked. This API may change in the future.
         /// </summary>
@@ -33,5 +42,15 @@ public interface IStreamingHubDiagnosticHandler
         /// <param name="methodName"></param>
         /// <param name="value"></param>
         void OnBroadcastEvent<THub, T>(THub hubInstance, string methodName, T value);
+
+        /// <summary>
+        /// [Preview] The callback method when the return value of a hub method call is received. This API may change in the future.
+        /// </summary>
+        /// <typeparam name="THub"></typeparam>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="hubInstance"></param>
+        /// <param name="methodName"></param>
+        /// <param name="data"></param>
+        void OnResponseEvent<THub, T>(THub hubInstance, string methodName, ReadOnlyMemory<byte> data);
     }
 }
diff --git a/src/MagicOnion.Client/IStreamingHubDiagnosticHandler.cs b/src/MagicOnion.Client/IStreamingHubDiagnosticHandler.cs
@@ -24,6 +24,15 @@ public interface IStreamingHubDiagnosticHandler
         /// <param name="invokeMethod"></param>
         ValueTask<TResponse> OnMethodInvoke<THub, TRequest, TResponse>(THub hubInstance, int methodId, string methodName, TRequest request, bool isFireAndForget, InvokeMethodDelegate<TRequest, TResponse> invokeMethod);
 
+        /// <summary>
+        /// [Preview] The callback method when a method of HubReceiver is invoked. This API may change in the future.
+        /// </summary>
+        /// <typeparam name="THub"></typeparam>
+        /// <param name="hubInstance"></param>
+        /// <param name="methodId"></param>
+        /// <param name="data"></param>
+        void OnBroadcastEventRaw<THub>(THub hubInstance, int methodId, ReadOnlyMemory<byte> data);
+
         /// <summary>
         /// [Preview] The callback method when a method of HubReceiver is invoked. This API may change in the future.
         /// </summary>
@@ -33,5 +42,15 @@ public interface IStreamingHubDiagnosticHandler
         /// <param name="methodName"></param>
         /// <param name="value"></param>
         void OnBroadcastEvent<THub, T>(THub hubInstance, string methodName, T value);
+
+        /// <summary>
+        /// [Preview] The callback method when the return value of a hub method call is received. This API may change in the future.
+        /// </summary>
+        /// <typeparam name="THub"></typeparam>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="hubInstance"></param>
+        /// <param name="methodName"></param>
+        /// <param name="data"></param>
+        void OnResponseEvent<THub, T>(THub hubInstance, string methodName, ReadOnlyMemory<byte> data);
     }
 }
diff --git a/.../Resources/GenerateGenericsStreamingHubTest/HubReceiver/0003_TempProject_MyHubClient.g.cs b/.../Resources/GenerateGenericsStreamingHubTest/HubReceiver/0003_TempProject_MyHubClient.g.cs
@@ -58,7 +58,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...csStreamingHubTest/HubReceiver_ArrayFormatter_KnownType/0003_TempProject_MyHubClient.g.cs b/...csStreamingHubTest/HubReceiver_ArrayFormatter_KnownType/0003_TempProject_MyHubClient.g.cs
@@ -76,7 +76,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...icsStreamingHubTest/HubReceiver_ArrayFormatter_UserType/0003_TempProject_MyHubClient.g.cs b/...icsStreamingHubTest/HubReceiver_ArrayFormatter_UserType/0003_TempProject_MyHubClient.g.cs
@@ -52,7 +52,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...urces/GenerateGenericsStreamingHubTest/HubReceiver_Enum/0004_TempProject_MyHubClient.g.cs b/...urces/GenerateGenericsStreamingHubTest/HubReceiver_Enum/0004_TempProject_MyHubClient.g.cs
@@ -52,7 +52,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...icsStreamingHubTest/HubReceiver_ListFormatter_KnownType/0003_TempProject_MyHubClient.g.cs b/...icsStreamingHubTest/HubReceiver_ListFormatter_KnownType/0003_TempProject_MyHubClient.g.cs
@@ -58,7 +58,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...ricsStreamingHubTest/HubReceiver_ListFormatter_UserType/0003_TempProject_MyHubClient.g.cs b/...ricsStreamingHubTest/HubReceiver_ListFormatter_UserType/0003_TempProject_MyHubClient.g.cs
@@ -52,7 +52,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...teGenericsStreamingHubTest/HubReceiver_MultipleTypeArgs/0003_TempProject_MyHubClient.g.cs b/...teGenericsStreamingHubTest/HubReceiver_MultipleTypeArgs/0003_TempProject_MyHubClient.g.cs
@@ -58,7 +58,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...ces/GenerateGenericsStreamingHubTest/HubReceiver_Nested/0003_TempProject_MyHubClient.g.cs b/...ces/GenerateGenericsStreamingHubTest/HubReceiver_Nested/0003_TempProject_MyHubClient.g.cs
@@ -64,7 +64,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...nerateGenericsStreamingHubTest/HubReceiver_Nested_Array/0003_TempProject_MyHubClient.g.cs b/...nerateGenericsStreamingHubTest/HubReceiver_Nested_Array/0003_TempProject_MyHubClient.g.cs
@@ -52,7 +52,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...enerateGenericsStreamingHubTest/HubReceiver_Nested_Enum/0004_TempProject_MyHubClient.g.cs b/...enerateGenericsStreamingHubTest/HubReceiver_Nested_Enum/0004_TempProject_MyHubClient.g.cs
@@ -52,7 +52,7 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {

diff --git a/...s/Resources/GenerateGenericsStreamingHubTest/Parameters/0003_TempProject_MyHubClient.g.cs b/...s/Resources/GenerateGenericsStreamingHubTest/Parameters/0003_TempProject_MyHubClient.g.cs
@@ -54,15 +54,15 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {
                         case -1005848884: // Task A(global::TempProject.MyGenericObject<global::System.Int32> a)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case -955516027: // Task B(global::TempProject.MyGenericObject<global::TempProject.MyObject> a)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                     }
                 }

diff --git a/...icsStreamingHubTest/Parameters_ArrayFormatter_KnownType/0003_TempProject_MyHubClient.g.cs b/...icsStreamingHubTest/Parameters_ArrayFormatter_KnownType/0003_TempProject_MyHubClient.g.cs
@@ -66,24 +66,24 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {
                         case 1774317884: // Task<Nil> GetStringValuesAsync(global::System.String[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case -400881550: // Task<Nil> GetIntValuesAsync(global::System.Int32[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case 309063297: // Task<Nil> GetInt32ValuesAsync(global::System.Int32[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case 702446639: // Task<Nil> GetSingleValuesAsync(global::System.Single[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case 2082077357: // Task<Nil> GetBooleanValuesAsync(global::System.Boolean[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                     }
                 }

diff --git a/...ricsStreamingHubTest/Parameters_ArrayFormatter_UserType/0003_TempProject_MyHubClient.g.cs b/...ricsStreamingHubTest/Parameters_ArrayFormatter_UserType/0003_TempProject_MyHubClient.g.cs
@@ -50,12 +50,12 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {
                         case -209315513: // Task<Nil> GetValuesAsync(global::TempProject.MyResponse[] arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                     }
                 }

diff --git a/...ricsStreamingHubTest/Parameters_ListFormatter_KnownType/0003_TempProject_MyHubClient.g.cs b/...ricsStreamingHubTest/Parameters_ListFormatter_KnownType/0003_TempProject_MyHubClient.g.cs
@@ -54,15 +54,15 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {
                         case 1774317884: // Task<Nil> GetStringValuesAsync(global::System.Collections.Generic.List<global::System.String> arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                         case -400881550: // Task<Nil> GetIntValuesAsync(global::System.Collections.Generic.List<global::System.Int32> arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                     }
                 }

diff --git a/...ericsStreamingHubTest/Parameters_ListFormatter_UserType/0003_TempProject_MyHubClient.g.cs b/...ericsStreamingHubTest/Parameters_ListFormatter_UserType/0003_TempProject_MyHubClient.g.cs
@@ -50,12 +50,12 @@ protected override void OnBroadcastEvent(global::System.Int32 methodId, global::
                     }
                 }
 
-                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                 {
                     switch (methodId)
                     {
                         case -209315513: // Task<Nil> GetValuesAsync(global::System.Collections.Generic.List<global::TempProject.MyResponse> arg0)
-                            base.SetResultForResponse<global::MessagePack.Nil>(taskCompletionSource, data);
+                            base.SetResultForResponse<global::MessagePack.Nil>(taskSource, data);
                             break;
                     }
                 }
-Original file line number
+Diff line change
@@ Expand Up @@
                         }
                     }
-                    protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskCompletionSource, global::System.ReadOnlyMemory<global::System.Byte> data)
+                    protected override void OnResponseEvent(global::System.Int32 methodId, global::System.Object taskSource, global::System.ReadOnlyMemory<global::System.Byte> data)
                     {
                         switch (methodId)
                         {
@@ Expand Down @@