feat(Telemetry): enhance telemetry metadata and build configuration

- Added support for telemetry build channel and configuration in the project file, allowing for better tracking of build environments.
- Updated TelemetryEnvelopeFactory to include new metadata attributes for build channel and configuration, improving telemetry insights.
- Modified the release script to set the appropriate build channel based on the environment, ensuring accurate telemetry reporting.

Author: BAKAOLC

STS2-RitsuLib.csproj

@@ -26,6 +26,9 @@
         <EnableDynamicLoading>true</EnableDynamicLoading>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <NoWarn>$(NoWarn);CS0436</NoWarn>
+        <RitsuLibTelemetryBuildChannel Condition="'$(RitsuLibTelemetryBuildChannel)' == '' and '$(Configuration)' == 'Debug'">local_debug</RitsuLibTelemetryBuildChannel>
+        <RitsuLibTelemetryBuildChannel Condition="'$(RitsuLibTelemetryBuildChannel)' == ''">local_release</RitsuLibTelemetryBuildChannel>
+        <RitsuLibTelemetryBuildConfiguration Condition="'$(RitsuLibTelemetryBuildConfiguration)' == ''">$(Configuration)</RitsuLibTelemetryBuildConfiguration>
     </PropertyGroup>
 
     <PropertyGroup Label="NuGet package">
@@ -63,6 +66,14 @@
     </Target>
 
     <ItemGroup>
+        <AssemblyAttribute Include="System.Reflection.AssemblyMetadataAttribute">
+            <_Parameter1>RitsuLibTelemetryBuildChannel</_Parameter1>
+            <_Parameter2>$(RitsuLibTelemetryBuildChannel)</_Parameter2>
+        </AssemblyAttribute>
+        <AssemblyAttribute Include="System.Reflection.AssemblyMetadataAttribute">
+            <_Parameter1>RitsuLibTelemetryBuildConfiguration</_Parameter1>
+            <_Parameter2>$(RitsuLibTelemetryBuildConfiguration)</_Parameter2>
+        </AssemblyAttribute>
         <PackageReference Include="Krafs.Publicizer" Version="2.3.0" PrivateAssets="all"/>
         <PackageReference Include="System.IO.Hashing" Version="9.0.0"/>
     </ItemGroup>

Telemetry/Core/TelemetryEnvelopeFactory.cs

@@ -1,3 +1,4 @@
+using System.Reflection;
 using System.Text.Json.Nodes;
 using STS2RitsuLib.Telemetry.RunHistory;
 
@@ -6,7 +7,17 @@ namespace STS2RitsuLib.Telemetry
     internal static class TelemetryEnvelopeFactory
     {
         internal const string BasePayloadOverrideKey = "__ritsulib_base_payload";
+        private const string DevPackageVersionPrefix = "9999.0.0-dev.";
         private static readonly string SessionId = Guid.NewGuid().ToString("N");
+        private static readonly Assembly Assembly = typeof(Const).Assembly;
+
+        private static readonly string InformationalVersion =
+            Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ??
+            Const.Version;
+
+        private static readonly IReadOnlyDictionary<string, string> Metadata =
+            Assembly.GetCustomAttributes<AssemblyMetadataAttribute>()
+                .ToDictionary(x => x.Key, x => x.Value ?? "", StringComparer.OrdinalIgnoreCase);
 
         internal static TelemetryEnvelope Create(
             TelemetryApplicant applicant,
@@ -39,13 +50,46 @@ internal static TelemetryEnvelope Create(
                 ["anonymous_install_id"] = TelemetryIdentityStore.AnonymousInstallId,
                 ["session_id"] = SessionId,
                 ["ritsulib_version"] = Const.Version,
+                ["ritsulib_informational_version"] = InformationalVersion,
+                ["ritsulib_build_channel"] = ResolveBuildChannel(),
+                ["ritsulib_build_configuration"] = ResolveBuildConfiguration(),
                 ["applicant_id"] = applicant.ApplicantId,
                 ["owner_mod_id"] = applicant.OwnerModId,
                 ["applicant_display_name"] = applicant.ResolveDisplayName(),
                 ["platform"] = Environment.OSVersion.Platform.ToString(),
             };
         }
 
+        private static string ResolveBuildChannel()
+        {
+            if (Metadata.TryGetValue("RitsuLibTelemetryBuildChannel", out var channel) &&
+                !string.IsNullOrWhiteSpace(channel))
+                return channel;
+
+            // ReSharper disable once ConvertIfStatementToReturnStatement
+            if (InformationalVersion.StartsWith(DevPackageVersionPrefix, StringComparison.OrdinalIgnoreCase))
+                return "dev";
+
+#if DEBUG
+            return "local_debug";
+#else
+            return "release";
+#endif
+        }
+
+        private static string ResolveBuildConfiguration()
+        {
+            if (Metadata.TryGetValue("RitsuLibTelemetryBuildConfiguration", out var configuration) &&
+                !string.IsNullOrWhiteSpace(configuration))
+                return configuration;
+
+#if DEBUG
+            return "Debug";
+#else
+            return "Release";
+#endif
+        }
+
         private static JsonObject BuildPayload(
             TelemetryApplicant applicant,
             TelemetryRequest request,

scripts/release_lib/nuget.py

@@ -130,6 +130,9 @@ def run_pack(
         args.append(f"/p:Version={override}")
         args.append(f"/p:PackageVersion={override}")
         args.append(f"/p:AssemblyInformationalVersion={override}")
+        args.append("/p:RitsuLibTelemetryBuildChannel=dev")
+    else:
+        args.append("/p:RitsuLibTelemetryBuildChannel=release")
     if sts2_api_signature_root is not None:
         args.append(f"/p:Sts2ApiSignatureRoot={sts2_api_signature_root}")
     if sts2_dir is not None: