| | | 1 | | using Elsa.Hosting.Management.Contracts; |
| | | 2 | | using Elsa.Hosting.Management.Options; |
| | | 3 | | using Microsoft.Extensions.Logging; |
| | | 4 | | using Microsoft.Extensions.Options; |
| | | 5 | | using System.Security.Cryptography; |
| | | 6 | | |
| | | 7 | | namespace Elsa.Hosting.Management.Services; |
| | | 8 | | |
| | | 9 | | /// <summary> |
| | | 10 | | /// Resolves the application instance name from <see cref="ApplicationInstanceOptions"/>, allowing a |
| | | 11 | | /// stable name to be configured so that per-instance transport entities are reused across restarts |
| | | 12 | | /// instead of accumulating. Falls back to a random name when no stable name is configured, which |
| | | 13 | | /// preserves the previous default behaviour. |
| | | 14 | | /// </summary> |
| | | 15 | | /// <remarks> |
| | | 16 | | /// Resolution order: |
| | | 17 | | /// <list type="number"> |
| | | 18 | | /// <item><description><see cref="ApplicationInstanceOptions.InstanceName"/> when set.</description></item> |
| | | 19 | | /// <item><description>The environment variable named by <see cref="ApplicationInstanceOptions.InstanceNameEnvironmentVa |
| | | 20 | | /// <item><description>A randomly generated name (legacy behaviour).</description></item> |
| | | 21 | | /// </list> |
| | | 22 | | /// </remarks> |
| | | 23 | | public class ConfiguredApplicationInstanceNameProvider : IApplicationInstanceNameProvider |
| | | 24 | | { |
| | | 25 | | internal const int AzureServiceBusSubscriptionNameMaxLength = 50; |
| | | 26 | | internal const string TriggerChangeTokenSignalEndpointNameSuffix = "-elsa-tct"; |
| | | 27 | | private const int ShortenedNameHashLength = 16; |
| | 1 | 28 | | internal static readonly int ConfiguredInstanceNameMaxLength = AzureServiceBusSubscriptionNameMaxLength - TriggerCha |
| | | 29 | | |
| | | 30 | | private readonly string _instanceName; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// Initializes a new instance of the <see cref="ConfiguredApplicationInstanceNameProvider"/> class. |
| | | 34 | | /// </summary> |
| | 20 | 35 | | public ConfiguredApplicationInstanceNameProvider( |
| | 20 | 36 | | IOptions<ApplicationInstanceOptions> options, |
| | 20 | 37 | | RandomIntIdentityGenerator randomIdentityGenerator, |
| | 20 | 38 | | ILogger<ConfiguredApplicationInstanceNameProvider> logger) |
| | | 39 | | { |
| | 20 | 40 | | var value = options.Value; |
| | | 41 | | |
| | 20 | 42 | | if (!string.IsNullOrWhiteSpace(value.InstanceName)) |
| | | 43 | | { |
| | 11 | 44 | | _instanceName = ResolveConfiguredInstanceName(value.InstanceName, $"{nameof(ApplicationInstanceOptions)}.{na |
| | 6 | 45 | | return; |
| | | 46 | | } |
| | | 47 | | |
| | 9 | 48 | | if (!string.IsNullOrWhiteSpace(value.InstanceNameEnvironmentVariable)) |
| | | 49 | | { |
| | 7 | 50 | | var environmentVariable = value.InstanceNameEnvironmentVariable.Trim(); |
| | 7 | 51 | | var fromEnvironment = Environment.GetEnvironmentVariable(environmentVariable); |
| | | 52 | | |
| | 7 | 53 | | if (!string.IsNullOrWhiteSpace(fromEnvironment)) |
| | | 54 | | { |
| | 5 | 55 | | _instanceName = ResolveConfiguredInstanceName(fromEnvironment, $"environment variable '{environmentVaria |
| | 5 | 56 | | return; |
| | | 57 | | } |
| | | 58 | | |
| | 2 | 59 | | logger.LogWarning( |
| | 2 | 60 | | "The configured instance-name environment variable '{EnvironmentVariable}' is not set or empty. Falling |
| | 2 | 61 | | "A random name causes per-instance transport entities (such as the Azure Service Bus change-token subscr |
| | 2 | 62 | | "which can accumulate until the transport's per-topic limit is reached.", |
| | 2 | 63 | | environmentVariable); |
| | | 64 | | } |
| | | 65 | | |
| | 4 | 66 | | _instanceName = randomIdentityGenerator.GenerateId(); |
| | 4 | 67 | | } |
| | | 68 | | |
| | | 69 | | /// <inheritdoc /> |
| | 15 | 70 | | public string GetName() => _instanceName; |
| | | 71 | | |
| | | 72 | | private static string ResolveConfiguredInstanceName(string value, string source, ILogger logger) |
| | | 73 | | { |
| | 16 | 74 | | var instanceName = value.Trim(); |
| | 16 | 75 | | var isTooLong = instanceName.Length > ConfiguredInstanceNameMaxLength; |
| | 16 | 76 | | var hasInvalidCharacters = !IsValidConfiguredInstanceName(instanceName); |
| | | 77 | | |
| | 16 | 78 | | if (hasInvalidCharacters) |
| | | 79 | | { |
| | 5 | 80 | | var errors = new List<string> |
| | 5 | 81 | | { |
| | 5 | 82 | | $"The configured application instance name from {source} contains invalid characters. " + |
| | 5 | 83 | | "Use only letters, numbers, periods, hyphens, or underscores, and start and end the value with a letter |
| | 5 | 84 | | }; |
| | | 85 | | |
| | 5 | 86 | | if (isTooLong) |
| | | 87 | | { |
| | 1 | 88 | | errors.Add( |
| | 1 | 89 | | $"The configured application instance name from {source} is {instanceName.Length} characters long, b |
| | 1 | 90 | | $"The value is used to create per-instance transport entities such as '{instanceName}{TriggerChangeT |
| | | 91 | | } |
| | | 92 | | |
| | 5 | 93 | | throw new InvalidOperationException(string.Join(" ", errors)); |
| | | 94 | | } |
| | | 95 | | |
| | 11 | 96 | | if (!isTooLong) |
| | 7 | 97 | | return instanceName; |
| | | 98 | | |
| | 4 | 99 | | var shortenedName = ShortenConfiguredInstanceName(instanceName); |
| | | 100 | | |
| | 4 | 101 | | logger.LogWarning( |
| | 4 | 102 | | "The configured application instance name from {Source} is {Length} characters long, exceeding the {MaxLengt |
| | 4 | 103 | | "Using deterministic shortened instance name '{ShortenedName}' instead.", |
| | 4 | 104 | | source, |
| | 4 | 105 | | instanceName.Length, |
| | 4 | 106 | | ConfiguredInstanceNameMaxLength, |
| | 4 | 107 | | shortenedName); |
| | | 108 | | |
| | 4 | 109 | | return shortenedName; |
| | | 110 | | } |
| | | 111 | | |
| | | 112 | | private static bool IsValidConfiguredInstanceName(string instanceName) |
| | | 113 | | { |
| | 16 | 114 | | return instanceName.Length > 0 |
| | 16 | 115 | | && IsAsciiLetterOrDigit(instanceName[0]) |
| | 16 | 116 | | && IsAsciiLetterOrDigit(instanceName[^1]) |
| | 334 | 117 | | && instanceName.All(c => IsAsciiLetterOrDigit(c) || c is '.' or '-' or '_'); |
| | | 118 | | } |
| | | 119 | | |
| | | 120 | | private static bool IsAsciiLetterOrDigit(char value) => |
| | 349 | 121 | | value is >= 'a' and <= 'z' or >= 'A' and <= 'Z' or >= '0' and <= '9'; |
| | | 122 | | |
| | | 123 | | private static string ShortenConfiguredInstanceName(string instanceName) |
| | | 124 | | { |
| | 4 | 125 | | var hash = Convert.ToHexString(SHA256.HashData(System.Text.Encoding.UTF8.GetBytes(instanceName))).ToLowerInvaria |
| | 4 | 126 | | var prefixLength = ConfiguredInstanceNameMaxLength - hash.Length - 1; |
| | 4 | 127 | | var prefix = instanceName[..prefixLength]; |
| | | 128 | | |
| | 4 | 129 | | return $"{prefix}-{hash}"; |
| | | 130 | | } |
| | | 131 | | } |