Feature: DtmClient add query single trans global status/detail (#88)

* feat(client): add query interface for global transaction

- Add Query method in DtmClient and IDtmClient to retrieve global transaction details
- Define TransGlobal class to represent the structure of a global transaction
- Update Constant to include new URL for query endpoint

* test(Dtmcli): add unit tests for DtmClient Query functionality

* sample(DtmSample): add query action to MsgTestController

Implement a new HTTP GET endpoint for querying transaction status

* feat(DtmClient): add QueryStatus method for query single global transaction status

* test(Dtmcli): improve unit test coverage

Author: wooln

samples/DtmSample/Controllers/MsgTestController.cs

@@ -276,5 +276,29 @@ public async Task<IActionResult> MsgWithTopic(CancellationToken cancellationToke
 
             return Ok(TransResponse.BuildSucceedResponse());
         }
+
+        /// <summary>
+        /// query
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("query")]
+        public async Task<IActionResult> Query(string gid, CancellationToken cancellationToken)
+        {
+            TransGlobal trans = await _dtmClient.Query(gid, cancellationToken);
+            return Ok(trans);
+        }
+
+        /// <summary>
+        /// query status
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("query-status")]
+        public async Task<IActionResult> QueryStatus(string gid, CancellationToken cancellationToken)
+        {
+            string status = await _dtmClient.QueryStatus(gid, cancellationToken);
+            return Ok(status);
+        }
     }
 }

src/Dtmcli/Constant.cs

@@ -56,6 +56,11 @@ internal static class Request
             internal const string BRANCH_COMPENSATE = "compensate";
 
             internal const string URL_NewGid = "/api/dtmsvr/newGid";
+            
+            /// <summary>
+            /// query single
+            /// </summary>
+            internal const string URL_Query = "/api/dtmsvr/query";
         }       
     }
 }

src/Dtmcli/DtmClient.cs

@@ -1,4 +1,5 @@
-using DtmCommon;
+using System;
+using DtmCommon;
 using Microsoft.Extensions.Options;
 using System.Collections.Generic;
 using System.Net.Http;
@@ -46,7 +47,7 @@ public HttpClient GetHttpClient(string name)
         {
             return _httpClientFactory.CreateClient(name);
         }
-
+        
         public async Task<HttpResponseMessage> PrepareWorkflow(TransBase tb, CancellationToken cancellationToken)
         {
             var url = string.Concat(_dtmOptions.DtmUrl.TrimEnd(Slash), Constant.Request.URLBASE_PREFIX, "prepareWorkflow");
@@ -133,6 +134,46 @@ public TransBase TransBaseFromQuery(Microsoft.AspNetCore.Http.IQueryCollection q
         }
 #endif
 
+        /// <summary>
+        /// Query single global transaction
+        /// </summary>
+        /// <param name="gid">global id</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        public async Task<TransGlobal> Query(string gid, CancellationToken cancellationToken)
+        {
+            if (string.IsNullOrEmpty(gid)) throw new ArgumentNullException(nameof(gid));
+
+            var url = string.Concat(_dtmOptions.DtmUrl.TrimEnd(Slash), Constant.Request.URL_Query, $"?gid={gid}");
+            var client = _httpClientFactory.CreateClient(Constant.DtmClientHttpName);
+            var response = await client.GetAsync(url, cancellationToken).ConfigureAwait(false);
+            var dtmContent = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+            DtmImp.Utils.CheckStatus(response.StatusCode, dtmContent);
+            return JsonSerializer.Deserialize<TransGlobal>(dtmContent, _jsonOptions);
+        }
+
+        /// <summary>
+        /// Query single global transaction status
+        /// </summary>
+        /// <param name="gid"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="NotImplementedException"></exception>
+        public async Task<string> QueryStatus(string gid, CancellationToken cancellationToken)
+        {
+            if (string.IsNullOrEmpty(gid)) throw new ArgumentNullException(nameof(gid));
+
+            var url = string.Concat(_dtmOptions.DtmUrl.TrimEnd(Slash), Constant.Request.URL_Query, $"?gid={gid}");
+            var client = _httpClientFactory.CreateClient(Constant.DtmClientHttpName);
+            var response = await client.GetAsync(url, cancellationToken).ConfigureAwait(false);
+            var dtmContent = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+            DtmImp.Utils.CheckStatus(response.StatusCode, dtmContent);
+            var graph = JsonSerializer.Deserialize<TransGlobalForStatus>(dtmContent, _jsonOptions);
+            return graph.Transaction == null
+                ? string.Empty
+                : graph.Transaction.Status;
+        }
+
         public class DtmGid
         {
             [JsonPropertyName("gid")]

src/Dtmcli/IDtmClient.cs

@@ -23,5 +23,9 @@ public interface IDtmClient
 #if NET5_0_OR_GREATER
         TransBase TransBaseFromQuery(Microsoft.AspNetCore.Http.IQueryCollection query);
 #endif
+        
+        Task<TransGlobal> Query(string gid, CancellationToken cancellationToken);
+        
+        Task<string> QueryStatus(string gid, CancellationToken cancellationToken);
     }
 }

src/Dtmcli/TransGlobal.cs

@@ -0,0 +1,89 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Dtmcli;
+
+/// <summary>
+/// query status only
+/// </summary>
+internal class TransGlobalForStatus
+{
+    [JsonPropertyName("transaction")] public DtmTransactionForStatus Transaction { get; set; }
+    
+    public class  DtmTransactionForStatus
+    {
+        [JsonPropertyName("status")] public string Status { get; set; }
+    }
+}
+
+// convert from json to c# code, json sample: saga succeed http (dtm-labs/dtm/qs/main.go) 
+public class TransGlobal
+{
+    [JsonPropertyName("branches")] public List<DtmBranch> Branches { get; set; }
+
+    [JsonPropertyName("transaction")] public DtmTransaction Transaction { get; set; }
+
+    public class DtmTransaction
+    {
+        [JsonPropertyName("id")] public int Id { get; set; }
+
+        [JsonPropertyName("create_time")] public DateTimeOffset CreateTime { get; set; }
+
+        [JsonPropertyName("update_time")] public DateTimeOffset UpdateTime { get; set; }
+
+        [JsonPropertyName("gid")] public string Gid { get; set; }
+
+        [JsonPropertyName("trans_type")] public string TransType { get; set; }
+
+        [JsonPropertyName("steps")] public List<TransactionStep> Steps { get; set; }
+
+        [JsonPropertyName("payloads")] public List<string> Payloads { get; set; }
+
+        [JsonPropertyName("status")] public string Status { get; set; }
+
+        // [JsonPropertyName("query_prepared")] public string QueryPrepared { get; set; }
+
+        [JsonPropertyName("protocol")] public string Protocol { get; set; }
+        
+        [JsonPropertyName("finish_time")] public DateTimeOffset FinishTime { get; set; }
+
+        [JsonPropertyName("options")] public string Options { get; set; }
+
+        [JsonPropertyName("next_cron_interval")]
+        public int NextCronInterval { get; set; }
+
+        [JsonPropertyName("next_cron_time")] public DateTimeOffset NextCronTime { get; set; }
+
+        // [JsonPropertyName("wait_result")] public bool WaitResult { get; set; }
+
+        [JsonPropertyName("concurrent")] public bool Concurrent { get; set; }
+    }
+
+    public class DtmBranch
+    {
+        [JsonPropertyName("id")] public int Id { get; set; }
+
+        [JsonPropertyName("create_time")] public DateTimeOffset CreateTime { get; set; }
+
+        [JsonPropertyName("update_time")] public DateTimeOffset UpdateTime { get; set; }
+
+        [JsonPropertyName("gid")] public string Gid { get; set; }
+
+        [JsonPropertyName("url")] public string Url { get; set; }
+
+        [JsonPropertyName("bin_data")] public string BinData { get; set; }
+
+        [JsonPropertyName("branch_id")] public string BranchId { get; set; }
+
+        [JsonPropertyName("op")] public string Op { get; set; }
+
+        [JsonPropertyName("status")] public string Status { get; set; }
+    }
+
+    public class TransactionStep
+    {
+        [JsonPropertyName("action")] public string Action { get; set; }
+        [JsonPropertyName("Compensate")] public string Compensate { get; set; }
+    }
+}