PR feedback unify taking version in SDK

open-telemetry · Apr 8, 2024 · d8f9a1a · d8f9a1a
1 parent 5d382f0
commit d8f9a1a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 25 deletions.
diff --git a/src/OpenTelemetry/OpenTelemetry.csproj b/src/OpenTelemetry/OpenTelemetry.csproj
@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <Compile Include="$(RepoRoot)\src\Shared\AssemblyVersionExtensions.cs" Link="Includes\AssemblyVersionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Configuration\*.cs" Link="Includes\Configuration\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\EnvironmentVariables\*.cs" Link="Includes\EnvironmentVariables\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\MathHelper.cs" Link="Includes\MathHelper.cs" />

diff --git a/src/OpenTelemetry/Sdk.cs b/src/OpenTelemetry/Sdk.cs
@@ -5,8 +5,8 @@
 #if EXPOSE_EXPERIMENTAL_FEATURES && NET8_0_OR_GREATER
 using System.Diagnostics.CodeAnalysis;
 #endif
-using System.Reflection;
 using OpenTelemetry.Context.Propagation;
+using OpenTelemetry.Instrumentation;
 using OpenTelemetry.Internal;
 using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
@@ -31,8 +31,8 @@ static Sdk()
         Activity.ForceDefaultIdFormat = true;
         SelfDiagnostics.EnsureInitialized();
 
-        var assemblyInformationalVersion = typeof(Sdk).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
-        InformationalVersion = ParseAssemblyInformationalVersion(assemblyInformationalVersion);
+        var sdkAssembly = typeof(Sdk).Assembly;
+        InformationalVersion = sdkAssembly.GetPackageVersion();
     }
 
     /// <summary>
@@ -110,24 +110,4 @@ static LoggerProviderBuilder CreateLoggerProviderBuilder()
     {
         return new LoggerProviderBuilderBase();
     }
-
-    internal static string ParseAssemblyInformationalVersion(string? informationalVersion)
-    {
-        if (string.IsNullOrWhiteSpace(informationalVersion))
-        {
-            informationalVersion = "1.0.0";
-        }
-
-        /*
-         * InformationalVersion will be in the following format:
-         *   {majorVersion}.{minorVersion}.{patchVersion}.{pre-release label}.{pre-release version}.{gitHeight}+{Git SHA of current commit}
-         * Ex: 1.5.0-alpha.1.40+807f703e1b4d9874a92bd86d9f2d4ebe5b5d52e4
-         * The following parts are optional: pre-release label, pre-release version, git height, Git SHA of current commit
-         */
-
-        var indexOfPlusSign = informationalVersion!.IndexOf('+');
-        return indexOfPlusSign > 0
-            ? informationalVersion.Substring(0, indexOfPlusSign)
-            : informationalVersion;
-    }
 }
diff --git a/src/Shared/AssemblyVersionExtensions.cs b/src/Shared/AssemblyVersionExtensions.cs
@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 using System.Reflection;
 
 namespace OpenTelemetry.Instrumentation;
@@ -12,8 +14,15 @@ public static string GetPackageVersion(this Assembly assembly)
         // MinVer https://github.com/adamralph/minver?tab=readme-ov-file#version-numbers
         // together with Microsoft.SourceLink.GitHub https://github.com/dotnet/sourcelink
         // fills AssemblyInformationalVersionAttribute by
-        // `{NuGetPackageVersion}+{CommitHash}`, e.g. `1.7.0-beta.1.86+33d5521a73e881ac59d4bf1213765270ec2422ff`.
+        // {majorVersion}.{minorVersion}.{patchVersion}.{pre-release label}.{pre-release version}.{gitHeight}+{Git SHA of current commit}
+        // Ex: 1.5.0-alpha.1.40+807f703e1b4d9874a92bd86d9f2d4ebe5b5d52e4
+        // The following parts are optional: pre-release label, pre-release version, git height, Git SHA of current commit
         // For package version, value of AssemblyInformationalVersionAttribute without commit hash is returned.
-        return assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()!.InformationalVersion.Split(new[] { '+' }, 2)[0];
+
+        var informationalVersion = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()!.InformationalVersion;
+        var indexOfPlusSign = informationalVersion!.IndexOf('+');
+        return indexOfPlusSign > 0
+            ? informationalVersion.Substring(0, indexOfPlusSign)
+            : informationalVersion;
     }
 }