Added support for additional routes on the Dashboard (#1200)

* Add support for additional routes on the Dashboard * Add deserialization unit tests * Change routes from semicolon separated list to an array * Use blocks for bindings. Co-authored-by: Ante Marić <ante.maric@king-ict.hr> Co-authored-by: phoff <phoff@microsoft.com>
dotnet · Jan 20, 2022 · cad496f · cad496f
1 parent 873818f
commit cad496f
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 5 deletions.
diff --git a/docs/reference/schema.md b/docs/reference/schema.md
@@ -402,6 +402,10 @@ Specifies the protocol used by the binding. The protocol is used in [service dis
 
 Specifies the hostname used by the binding. The protocol is used in [service discovery](/docs/reference/service_discovery.md) to construct a URL. It's safe to omit the `host` when localhost should be used for local development.
 
+#### `routes` (`string[]`)
+
+Specifies the list of additional routes to show in Bindings on the Dashboard for easy access. Example route value: /swagger.
+
 #### `port` (string)
 
 Specifies the port used by the binding. The port is used in [service discovery](/docs/reference/service_discovery.md) to construct a URL.

diff --git a/src/Microsoft.Tye.Core/ApplicationFactory.cs b/src/Microsoft.Tye.Core/ApplicationFactory.cs
@@ -376,6 +376,7 @@ service is ProjectServiceBuilder project2 &&
                                 ContainerPort = configBinding.ContainerPort,
                                 Port = configBinding.Port,
                                 Protocol = configBinding.Protocol,
+                                Routes = configBinding.Routes
                             };
 
                             // Assume HTTP for projects only (containers may be different)

diff --git a/src/Microsoft.Tye.Core/BindingBuilder.cs b/src/Microsoft.Tye.Core/BindingBuilder.cs
@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
+
 namespace Microsoft.Tye
 {
     public sealed class BindingBuilder
@@ -12,5 +14,6 @@ public sealed class BindingBuilder
         public int? ContainerPort { get; set; }
         public string? Host { get; set; }
         public string? Protocol { get; set; }
+        public List<string> Routes { get; set; } = new List<string>();
     }
 }
diff --git a/src/Microsoft.Tye.Core/ConfigModel/ConfigServiceBinding.cs b/src/Microsoft.Tye.Core/ConfigModel/ConfigServiceBinding.cs
@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
+
 namespace Microsoft.Tye.ConfigModel
 {
     public class ConfigServiceBinding
@@ -12,5 +14,6 @@ public class ConfigServiceBinding
         public int? ContainerPort { get; set; }
         public string? Host { get; set; }
         public string? Protocol { get; set; }
+        public List<string> Routes { get; set; } = new List<string>();
     }
 }
diff --git a/src/Microsoft.Tye.Core/Serialization/ConfigServiceParser.cs b/src/Microsoft.Tye.Core/Serialization/ConfigServiceParser.cs
@@ -218,6 +218,14 @@ private static void HandleServiceBindingNameMapping(YamlMappingNode yamlMappingN
                     case "protocol":
                         binding.Protocol = YamlParser.GetScalarValue(key, child.Value);
                         break;
+                    case "routes":
+                        if (child.Value.NodeType != YamlNodeType.Sequence)
+                        {
+                            throw new TyeYamlException(child.Value.Start, CoreStrings.FormatExpectedYamlSequence(key));
+                        }
+
+                        HandleServiceBindingRoutes((child.Value as YamlSequenceNode)!, binding.Routes);
+                        break;
                     default:
                         throw new TyeYamlException(child.Key.Start, CoreStrings.FormatUnrecognizedKey(key));
                 }
@@ -571,6 +579,16 @@ private static void HandleServiceTags(YamlSequenceNode yamlSequenceNode, List<st
                 tags.Add(tag);
             }
         }
+
+        private static void HandleServiceBindingRoutes(YamlSequenceNode yamlSequenceNode, List<string> routes)
+        {
+            foreach (var child in yamlSequenceNode!.Children)
+            {
+                var route = YamlParser.GetScalarValue(child);
+                routes.Add(route);
+            }
+        }
+
         private static void HandleServiceDockerArgsNameMapping(YamlMappingNode yamlMappingNode, IDictionary<string, string> dockerArguments)
         {
             foreach (var child in yamlMappingNode!.Children)

diff --git a/src/Microsoft.Tye.Hosting/Dashboard/Pages/Index.razor b/src/Microsoft.Tye.Hosting/Dashboard/Pages/Index.razor
@@ -2,6 +2,12 @@
 @inject Application application
 @implements IDisposable
 
+<style>
+    .binding {
+        display: block;
+    }
+</style>
+
 <h1>Services</h1>
 <table class="table service-table">
     <thead>
@@ -54,16 +60,21 @@
                                 if (b.Protocol == "http" || b.Protocol == "https")
                                 {
                                     var url = GetUrl(b);
-                                    <span><a href="@url" target="_blank">@url</a></span>
+                                    <span class="binding"><a href="@url" target="_blank">@url</a></span>
+                                    foreach (var r in b.Routes)
+                                    {
+                                        var routeUrl = url + r;
+                                        <span class="binding"><a href="@routeUrl" target="_blank">@routeUrl</a></span>
+                                    }
                                 }
                                 else
                                 {
-                                    <span>@GetUrl(b)</span>
+                                    <span class="binding">@GetUrl(b)</span>
                                 }
                             }
                             else
                             {
-                                <span>@b.ConnectionString</span>
+                                <span class="binding">@b.ConnectionString</span>
                             }
                         }
                     }

diff --git a/src/Microsoft.Tye.Hosting/DockerRunner.cs b/src/Microsoft.Tye.Hosting/DockerRunner.cs
@@ -94,6 +94,7 @@ service.Description.RunInfo is IngressRunInfo ||
                         Protocol = binding.Protocol
                     };
                     b.ReplicaPorts.Add(b.Port.Value);
+                    b.Routes.AddRange(binding.Routes);
                     proxyDescription.Bindings.Add(b);
                 }
                 var proxyContainerService = new Service(proxyDescription, ServiceSource.Host);

diff --git a/src/Microsoft.Tye.Hosting/Model/ServiceBinding.cs b/src/Microsoft.Tye.Hosting/Model/ServiceBinding.cs
@@ -17,5 +17,6 @@ public class ServiceBinding
         public string? IPAddress { get; set; }
         public string? Protocol { get; set; }
         public List<int> ReplicaPorts { get; } = new List<int>();
+        public List<string> Routes { get; } = new List<string>();
     }
 }
diff --git a/src/tye/ApplicationBuilderExtensions.cs b/src/tye/ApplicationBuilderExtensions.cs
@@ -174,15 +174,17 @@ public static Application ToHostingApplication(this ApplicationBuilder applicati
 
                 foreach (var binding in service.Bindings)
                 {
-                    description.Bindings.Add(new ServiceBinding()
+                    var sb = new ServiceBinding()
                     {
                         ConnectionString = binding.ConnectionString,
                         Host = binding.Host,
                         ContainerPort = binding.ContainerPort,
                         Name = binding.Name,
                         Port = binding.Port,
                         Protocol = binding.Protocol,
-                    });
+                    };
+                    sb.Routes.AddRange(binding.Routes);
+                    description.Bindings.Add(sb);
                 }
 
                 services.Add(service.Name, new Service(description, service.Source));

diff --git a/test/UnitTests/TyeDeserializationTests.cs b/test/UnitTests/TyeDeserializationTests.cs
@@ -82,6 +82,9 @@ public void ComprehensionalTest()
       containerPort: 80
       host: localhost
       protocol: http
+      routes:
+      - /swagger
+      - /graphql
   - name: appB
     project: ApplicationB/ApplicationB.csproj
     replicas: 2
@@ -155,6 +158,9 @@ public void ServicesSetCorrectly()
       containerPort: 80
       host: localhost
       protocol: http
+      routes:
+      - /swagger
+      - /graphql
   - name: appB
     project: ApplicationB/ApplicationB.csproj
     replicas: 2