Service Discovery: Expose Instance ID in IServiceInstance (#1597)

Author: bart-vmware

src/Common/src/Common/Discovery/IServiceInstance.cs

@@ -11,6 +11,11 @@ public interface IServiceInstance
     /// </summary>
     string ServiceId { get; }
 
+    /// <summary>
+    /// Gets the instance ID as registered by the discovery client.
+    /// </summary>
+    string InstanceId { get; }
+
     /// <summary>
     /// Gets the hostname of the registered service instance.
     /// </summary>

src/Common/src/Common/PublicAPI.Unshipped.txt

@@ -1 +1,2 @@
 #nullable enable
+Steeltoe.Common.Discovery.IServiceInstance.InstanceId.get -> string!

src/Configuration/test/ConfigServer.Test/ConfigServerConfigurationProviderTest.cs

@@ -373,8 +373,8 @@ public void UpdateSettingsFromDiscovery_UpdatesSettingsCorrectly()
 
         List<IServiceInstance> instances =
         [
-            new TestServiceInstance("i1", new Uri("https://foo.bar:8888/"), metadata1),
-            new TestServiceInstance("i2", new Uri("https://foo.bar.baz:9999/"), metadata2)
+            new TestServiceInstance("s", "i1", new Uri("https://foo.bar:8888/"), metadata1),
+            new TestServiceInstance("s", "i2", new Uri("https://foo.bar.baz:9999/"), metadata2)
         ];
 
         provider.UpdateSettingsFromDiscovery(instances, options);
@@ -416,9 +416,10 @@ private static string GetEncodedUserPassword(string user, string password)
         return Convert.ToBase64String(Encoding.ASCII.GetBytes($"{user}:{password}"));
     }
 
-    private sealed class TestServiceInstance(string serviceId, Uri uri, IReadOnlyDictionary<string, string?> metadata) : IServiceInstance
+    private sealed class TestServiceInstance(string serviceId, string instanceId, Uri uri, IReadOnlyDictionary<string, string?> metadata) : IServiceInstance
     {
         public string ServiceId { get; } = serviceId;
+        public string InstanceId { get; } = instanceId;
         public string Host { get; } = uri.Host;
         public int Port { get; } = uri.Port;
         public bool IsSecure { get; } = uri.Scheme == Uri.UriSchemeHttps;

src/Discovery/src/Configuration/ConfigurationServiceInstance.cs

@@ -22,6 +22,9 @@ public sealed class ConfigurationServiceInstance : IServiceInstance
     [Required]
     public string? ServiceId { get; set; }
 
+    /// <inheritdoc />
+    public string InstanceId => string.Empty;
+
     /// <inheritdoc />
     [Required]
     public string? Host { get; set; }

src/Discovery/src/Configuration/PublicAPI.Unshipped.txt

@@ -1 +1,2 @@
 #nullable enable
+Steeltoe.Discovery.Configuration.ConfigurationServiceInstance.InstanceId.get -> string!

src/Discovery/src/Consul/ConsulServiceInstance.cs

@@ -16,6 +16,9 @@ internal sealed class ConsulServiceInstance : IServiceInstance
     /// <inheritdoc />
     public string ServiceId { get; }
 
+    /// <inheritdoc />
+    public string InstanceId { get; }
+
     /// <inheritdoc />
     public string Host { get; }
 
@@ -48,6 +51,7 @@ internal ConsulServiceInstance(ServiceEntry serviceEntry)
         Metadata = serviceEntry.Service.Meta.AsReadOnly();
         IsSecure = serviceEntry.Service.Meta != null && serviceEntry.Service.Meta.TryGetValue("secure", out string? secureString) && bool.Parse(secureString);
         ServiceId = serviceEntry.Service.Service;
+        InstanceId = serviceEntry.Service.ID;
         Port = serviceEntry.Service.Port;
         Uri = new Uri($"{(IsSecure ? "https" : "http")}://{Host}:{Port}");
     }

src/Discovery/src/Consul/Registry/ConsulRegistration.cs

@@ -22,9 +22,7 @@ internal sealed class ConsulRegistration : IServiceInstance
     /// <inheritdoc />
     public string ServiceId { get; }
 
-    /// <summary>
-    /// Gets the instance ID as registered by the Consul server.
-    /// </summary>
+    /// <inheritdoc />
     public string InstanceId { get; }
 
     /// <inheritdoc />

src/Discovery/src/Consul/ThisServiceInstance.cs

@@ -15,6 +15,9 @@ internal sealed class ThisServiceInstance : IServiceInstance
     /// <inheritdoc />
     public string ServiceId { get; }
 
+    /// <inheritdoc />
+    public string InstanceId { get; }
+
     /// <inheritdoc />
     public string Host { get; }
 
@@ -35,6 +38,7 @@ public ThisServiceInstance(ConsulRegistration registration)
         ArgumentNullException.ThrowIfNull(registration);
 
         ServiceId = registration.ServiceId;
+        InstanceId = registration.InstanceId;
         Host = registration.Host;
         IsSecure = registration.IsSecure;
         Port = registration.Port;

src/Discovery/src/Eureka/EurekaServiceInstance.cs

@@ -13,6 +13,7 @@ namespace Steeltoe.Discovery.Eureka;
 internal sealed class EurekaServiceInstance : IServiceInstance
 {
     public string ServiceId { get; }
+    public string InstanceId { get; }
     public string Host { get; }
     public int Port { get; }
     public bool IsSecure { get; }
@@ -24,6 +25,7 @@ public EurekaServiceInstance(InstanceInfo instance)
         ArgumentNullException.ThrowIfNull(instance);
 
         ServiceId = instance.AppName;
+        InstanceId = instance.InstanceId;
         Host = instance.HostName;
         Port = GetPort(instance);
         IsSecure = instance.IsSecurePortEnabled;

src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesResolver.cs

@@ -138,6 +138,7 @@ private sealed class JsonSerializableServiceInstance : IServiceInstance
         // Trust that deserialized instances meet the IServiceInstance contract, so suppress nullability warnings.
 
         public string ServiceId { get; set; } = null!;
+        public string InstanceId { get; set; } = null!;
         public string Host { get; set; } = null!;
         public int Port { get; set; }
         public bool IsSecure { get; set; }
@@ -151,6 +152,7 @@ public static JsonSerializableServiceInstance CopyFrom(IServiceInstance instance
             return new JsonSerializableServiceInstance
             {
                 ServiceId = instance.ServiceId,
+                InstanceId = instance.InstanceId,
                 Host = instance.Host,
                 Port = instance.Port,
                 IsSecure = instance.IsSecure,