A little bit better API

mauroservienti · mauroservienti · commit 92f23c94f7bd · 2023-06-15T16:29:44.000+02:00
diff --git a/src/ServiceComposer.AspNetCore.Tests/API/APIApprovals.Approve_API.verified.txt b/src/ServiceComposer.AspNetCore.Tests/API/APIApprovals.Approve_API.verified.txt
@@ -60,19 +60,20 @@ namespace ServiceComposer.AspNetCore
         " removed in v3. Use attribute routing based composition, and CompositionEventHan" +
         "dler<TEvent>.", true)]
     public delegate System.Threading.Tasks.Task EventHandler<TEvent>(string requestId, [System.Runtime.CompilerServices.Dynamic] object viewModel, TEvent @event, Microsoft.AspNetCore.Routing.RouteData routeData, Microsoft.AspNetCore.Http.HttpRequest httpRequest);
-    public abstract class Gatherer
+    public abstract class Gatherer<T> : ServiceComposer.AspNetCore.IGatherer
+        where T :  class
     {
         protected Gatherer(string key) { }
         public string Key { get; }
-        public abstract System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context);
+        public abstract System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<T>> Gather(Microsoft.AspNetCore.Http.HttpContext context);
     }
-    public class HttpGatherer : ServiceComposer.AspNetCore.Gatherer
+    public class HttpGatherer : ServiceComposer.AspNetCore.Gatherer<System.Text.Json.Nodes.JsonNode>
     {
         public HttpGatherer(string key, string destinationUrl) { }
         public System.Func<Microsoft.AspNetCore.Http.HttpRequest, string, string> DefaultDestinationUrlMapper { get; }
         public string DestinationUrl { get; }
         public System.Func<Microsoft.AspNetCore.Http.HttpRequest, string, string> DestinationUrlMapper { get; init; }
-        public override System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context) { }
+        public override System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Text.Json.Nodes.JsonNode>> Gather(Microsoft.AspNetCore.Http.HttpContext context) { }
         protected virtual string MapDestinationUrl(Microsoft.AspNetCore.Http.HttpRequest request, string destination) { }
         protected virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Text.Json.Nodes.JsonNode>> TransformResponse(System.Net.Http.HttpResponseMessage responseMessage) { }
     }
@@ -117,6 +118,11 @@ namespace ServiceComposer.AspNetCore
         System.Threading.Tasks.Task Handle(Microsoft.AspNetCore.Http.HttpRequest request);
     }
     public interface IEndpointScopedViewModelFactory : ServiceComposer.AspNetCore.IViewModelFactory { }
+    public interface IGatherer
+    {
+        string Key { get; }
+        System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context);
+    }
     [System.Obsolete("IHandleRequests is obsoleted and will be treated as an error starting v2 and remo" +
         "ved in v3. Use attribute routing based composition and ICompositionRequestsHandl" +
         "er.", true)]
@@ -188,7 +194,7 @@ namespace ServiceComposer.AspNetCore
     {
         public ScatterGatherOptions() { }
         public System.Type CustomAggregator { get; set; }
-        public System.Collections.Generic.IList<ServiceComposer.AspNetCore.Gatherer> Gatherers { get; set; }
+        public System.Collections.Generic.IList<ServiceComposer.AspNetCore.IGatherer> Gatherers { get; set; }
     }
     public static class ServiceCollectionExtensions
     {
diff --git a/src/ServiceComposer.AspNetCore.Tests/ScatterGather/Get_with_2_gatherers.cs b/src/ServiceComposer.AspNetCore.Tests/ScatterGather/Get_with_2_gatherers.cs
@@ -85,7 +85,7 @@ HttpClient ClientProvider(string name) =>
                 {
                     builder.MapScatterGather(template: "/samples", new ScatterGatherOptions
                     {
-                        Gatherers = new List<Gatherer>
+                        Gatherers = new List<IGatherer>
                         {
                             new HttpGatherer(key: "ASamplesSource", destinationUrl: "/samples/ASamplesSource"),
                             new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "/samples/AnotherSamplesSource")
diff --git a/src/ServiceComposer.AspNetCore.Tests/ScatterGather/When_using_query_string.cs b/src/ServiceComposer.AspNetCore.Tests/ScatterGather/When_using_query_string.cs
@@ -84,7 +84,7 @@ HttpClient ClientProvider(string name) =>
                 {
                     builder.MapScatterGather(template: "/samples", new ScatterGatherOptions
                     {
-                        Gatherers = new List<Gatherer>
+                        Gatherers = new List<IGatherer>
                         {
                             new HttpGatherer(key: "ASamplesSource", destinationUrl: "/samples/ASamplesSource"),
                             new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "/samples/AnotherSamplesSource")
diff --git a/src/ServiceComposer.AspNetCore/ScatterGather/Gatherer.cs b/src/ServiceComposer.AspNetCore/ScatterGather/Gatherer.cs
@@ -1,11 +1,18 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Text.Json.Nodes;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 
 namespace ServiceComposer.AspNetCore;
 
-public abstract class Gatherer
+public interface IGatherer
+{
+    string Key { get; }
+    Task<IEnumerable<object>> Gather(HttpContext context);
+}
+
+public abstract class Gatherer<T> : IGatherer where T : class
 {
     protected Gatherer(string key)
     {
@@ -14,5 +21,10 @@ protected Gatherer(string key)
 
     public string Key { get; }
 
-    public abstract Task<IEnumerable<object>> Gather(HttpContext context);
+    Task<IEnumerable<object>> IGatherer.Gather(HttpContext context)
+    {
+        return Gather(context).ContinueWith(t => (IEnumerable<object>)t.Result);
+    }
+
+    public abstract Task<IEnumerable<T>> Gather(HttpContext context);
 }
diff --git a/src/ServiceComposer.AspNetCore/ScatterGather/HttpGatherer.cs b/src/ServiceComposer.AspNetCore/ScatterGather/HttpGatherer.cs
@@ -8,7 +8,7 @@
 
 namespace ServiceComposer.AspNetCore;
 
-public class HttpGatherer : Gatherer
+public class HttpGatherer : Gatherer<JsonNode>
 {
     public HttpGatherer(string key, string destinationUrl)
         : base(key)
@@ -55,7 +55,7 @@ protected virtual async Task<IEnumerable<JsonNode>> TransformResponse(HttpRespon
         return nodes;
     }
 
-    public override async Task<IEnumerable<object>> Gather(HttpContext context)
+    public override async Task<IEnumerable<JsonNode>> Gather(HttpContext context)
     {
         var factory = context.RequestServices.GetRequiredService<IHttpClientFactory>();
         var client = factory.CreateClient(Key);
diff --git a/src/ServiceComposer.AspNetCore/ScatterGather/ScatterGatherOptions.cs b/src/ServiceComposer.AspNetCore/ScatterGather/ScatterGatherOptions.cs
@@ -18,5 +18,5 @@ internal IAggregator GetAggregator(HttpContext httpContext)
         return new DefaultAggregator();
     }
 
-    public IList<Gatherer> Gatherers { get; set; }
+    public IList<IGatherer> Gatherers { get; set; }
 }
diff --git a/src/Snippets/ScatterGather/CustomizingDownstreamURLs.cs b/src/Snippets/ScatterGather/CustomizingDownstreamURLs.cs
@@ -12,7 +12,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
     {
         app.UseEndpoints(builder => builder.MapScatterGather(template: "api/scatter-gather", new ScatterGatherOptions()
         {
-            Gatherers = new List<Gatherer>
+            Gatherers = new List<IGatherer>
             {
                 new HttpGatherer("ASamplesSource", "https://a.web.server/api/samples/ASamplesSource")
                 {
diff --git a/src/Snippets/ScatterGather/GatherMethodOverride.cs b/src/Snippets/ScatterGather/GatherMethodOverride.cs
@@ -14,7 +14,7 @@ public class CustomHttpGatherer : HttpGatherer
     {
         public CustomHttpGatherer(string key, string destination) : base(key, destination) { }
 
-        public override Task<IEnumerable<object>> Gather(HttpContext context)
+        public override Task<IEnumerable<JsonNode>> Gather(HttpContext context)
         {
 
             return base.Gather(context);
diff --git a/src/Snippets/ScatterGather/Startup.cs b/src/Snippets/ScatterGather/Startup.cs
@@ -14,7 +14,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
         app.UseRouting();
         app.UseEndpoints(builder => builder.MapScatterGather(template: "api/scatter-gather", new ScatterGatherOptions()
         {
-            Gatherers = new List<Gatherer>
+            Gatherers = new List<IGatherer>
             {
                 new HttpGatherer(key: "ASamplesSource", destinationUrl: "https://a.web.server/api/samples/ASamplesSource"),
                 new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "https://another.web.server/api/samples/AnotherSamplesSource")

Original file line number	Diff line number	Diff line change
`@@ -60,19 +60,20 @@ namespace ServiceComposer.AspNetCore`
`60`	`60`	`" removed in v3. Use attribute routing based composition, and CompositionEventHan" +`
`61`	`61`	`"dler<TEvent>.", true)]`
`62`	`62`	`public delegate System.Threading.Tasks.Task EventHandler<TEvent>(string requestId, [System.Runtime.CompilerServices.Dynamic] object viewModel, TEvent @event, Microsoft.AspNetCore.Routing.RouteData routeData, Microsoft.AspNetCore.Http.HttpRequest httpRequest);`
`63`		`- public abstract class Gatherer`
	`63`	`+ public abstract class Gatherer<T> : ServiceComposer.AspNetCore.IGatherer`
	`64`	`+ where T : class`
`64`	`65`	`{`
`65`	`66`	`protected Gatherer(string key) { }`
`66`	`67`	`public string Key { get; }`
`67`		`- public abstract System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context);`
	`68`	`+ public abstract System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<T>> Gather(Microsoft.AspNetCore.Http.HttpContext context);`
`68`	`69`	`}`
`69`		`- public class HttpGatherer : ServiceComposer.AspNetCore.Gatherer`
	`70`	`+ public class HttpGatherer : ServiceComposer.AspNetCore.Gatherer<System.Text.Json.Nodes.JsonNode>`
`70`	`71`	`{`
`71`	`72`	`public HttpGatherer(string key, string destinationUrl) { }`
`72`	`73`	`public System.Func<Microsoft.AspNetCore.Http.HttpRequest, string, string> DefaultDestinationUrlMapper { get; }`
`73`	`74`	`public string DestinationUrl { get; }`
`74`	`75`	`public System.Func<Microsoft.AspNetCore.Http.HttpRequest, string, string> DestinationUrlMapper { get; init; }`
`75`		`- public override System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context) { }`
	`76`	`+ public override System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Text.Json.Nodes.JsonNode>> Gather(Microsoft.AspNetCore.Http.HttpContext context) { }`
`76`	`77`	`protected virtual string MapDestinationUrl(Microsoft.AspNetCore.Http.HttpRequest request, string destination) { }`
`77`	`78`	`protected virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Text.Json.Nodes.JsonNode>> TransformResponse(System.Net.Http.HttpResponseMessage responseMessage) { }`
`78`	`79`	`}`
`@@ -117,6 +118,11 @@ namespace ServiceComposer.AspNetCore`
`117`	`118`	`System.Threading.Tasks.Task Handle(Microsoft.AspNetCore.Http.HttpRequest request);`
`118`	`119`	`}`
`119`	`120`	`public interface IEndpointScopedViewModelFactory : ServiceComposer.AspNetCore.IViewModelFactory { }`
	`121`	`+ public interface IGatherer`
	`122`	`+ {`
	`123`	`+ string Key { get; }`
	`124`	`+ System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>> Gather(Microsoft.AspNetCore.Http.HttpContext context);`
	`125`	`+ }`
`120`	`126`	`[System.Obsolete("IHandleRequests is obsoleted and will be treated as an error starting v2 and remo" +`
`121`	`127`	`"ved in v3. Use attribute routing based composition and ICompositionRequestsHandl" +`
`122`	`128`	`"er.", true)]`
`@@ -188,7 +194,7 @@ namespace ServiceComposer.AspNetCore`
`188`	`194`	`{`
`189`	`195`	`public ScatterGatherOptions() { }`
`190`	`196`	`public System.Type CustomAggregator { get; set; }`
`191`		`- public System.Collections.Generic.IList<ServiceComposer.AspNetCore.Gatherer> Gatherers { get; set; }`
	`197`	`+ public System.Collections.Generic.IList<ServiceComposer.AspNetCore.IGatherer> Gatherers { get; set; }`
`192`	`198`	`}`
`193`	`199`	`public static class ServiceCollectionExtensions`
`194`	`200`	`{`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ HttpClient ClientProvider(string name) =>`
`85`	`85`	`{`
`86`	`86`	`builder.MapScatterGather(template: "/samples", new ScatterGatherOptions`
`87`	`87`	`{`
`88`		`- Gatherers = new List<Gatherer>`
	`88`	`+ Gatherers = new List<IGatherer>`
`89`	`89`	`{`
`90`	`90`	`new HttpGatherer(key: "ASamplesSource", destinationUrl: "/samples/ASamplesSource"),`
`91`	`91`	`new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "/samples/AnotherSamplesSource")`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ HttpClient ClientProvider(string name) =>`
`84`	`84`	`{`
`85`	`85`	`builder.MapScatterGather(template: "/samples", new ScatterGatherOptions`
`86`	`86`	`{`
`87`		`- Gatherers = new List<Gatherer>`
	`87`	`+ Gatherers = new List<IGatherer>`
`88`	`88`	`{`
`89`	`89`	`new HttpGatherer(key: "ASamplesSource", destinationUrl: "/samples/ASamplesSource"),`
`90`	`90`	`new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "/samples/AnotherSamplesSource")`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`namespace ServiceComposer.AspNetCore;`
`10`	`10`
`11`		`-public class HttpGatherer : Gatherer`
	`11`	`+public class HttpGatherer : Gatherer<JsonNode>`
`12`	`12`	`{`
`13`	`13`	`public HttpGatherer(string key, string destinationUrl)`
`14`	`14`	`: base(key)`
`@@ -55,7 +55,7 @@ protected virtual async Task<IEnumerable<JsonNode>> TransformResponse(HttpRespon`
`55`	`55`	`return nodes;`
`56`	`56`	`}`
`57`	`57`
`58`		`- public override async Task<IEnumerable<object>> Gather(HttpContext context)`
	`58`	`+ public override async Task<IEnumerable<JsonNode>> Gather(HttpContext context)`
`59`	`59`	`{`
`60`	`60`	`var factory = context.RequestServices.GetRequiredService<IHttpClientFactory>();`
`61`	`61`	`var client = factory.CreateClient(Key);`
Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,5 @@ internal IAggregator GetAggregator(HttpContext httpContext)`
`18`	`18`	`return new DefaultAggregator();`
`19`	`19`	`}`
`20`	`20`
`21`		`- public IList<Gatherer> Gatherers { get; set; }`
	`21`	`+ public IList<IGatherer> Gatherers { get; set; }`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)`
`12`	`12`	`{`
`13`	`13`	`app.UseEndpoints(builder => builder.MapScatterGather(template: "api/scatter-gather", new ScatterGatherOptions()`
`14`	`14`	`{`
`15`		`- Gatherers = new List<Gatherer>`
	`15`	`+ Gatherers = new List<IGatherer>`
`16`	`16`	`{`
`17`	`17`	`new HttpGatherer("ASamplesSource", "https://a.web.server/api/samples/ASamplesSource")`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public class CustomHttpGatherer : HttpGatherer`
`14`	`14`	`{`
`15`	`15`	`public CustomHttpGatherer(string key, string destination) : base(key, destination) { }`
`16`	`16`
`17`		`- public override Task<IEnumerable<object>> Gather(HttpContext context)`
	`17`	`+ public override Task<IEnumerable<JsonNode>> Gather(HttpContext context)`
`18`	`18`	`{`
`19`	`19`
`20`	`20`	`return base.Gather(context);`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)`
`14`	`14`	`app.UseRouting();`
`15`	`15`	`app.UseEndpoints(builder => builder.MapScatterGather(template: "api/scatter-gather", new ScatterGatherOptions()`
`16`	`16`	`{`
`17`		`- Gatherers = new List<Gatherer>`
	`17`	`+ Gatherers = new List<IGatherer>`
`18`	`18`	`{`
`19`	`19`	`new HttpGatherer(key: "ASamplesSource", destinationUrl: "https://a.web.server/api/samples/ASamplesSource"),`
`20`	`20`	`new HttpGatherer(key: "AnotherSamplesSource", destinationUrl: "https://another.web.server/api/samples/AnotherSamplesSource")`