fix: avoid false ProjectApiKey deprecation warning (#265)

* fix: avoid false ProjectApiKey deprecation warning

* ci: remove invalid workflow control characters

* docs: explain configuration restore approach

Author: marandaneto

.changeset/calm-badgers-bind.md

@@ -0,0 +1,6 @@
+---
+"PostHog": patch
+"PostHog.AspNetCore": patch
+---
+
+Prevent `ProjectToken`-only configuration from logging the deprecated `ProjectApiKey` warning.

.github/workflows/call-flags-project-board.yml

@@ -1,4 +1,4 @@
-# � SECURITY PLACEHOLDER - DO NOT USE THIS WORKFLOW NAME �
+# SECURITY PLACEHOLDER - DO NOT USE THIS WORKFLOW NAME
 #
 # This workflow previously existed and was compromised. This placeholder file
 # exists to allow blocking this workflow name in GitHub's branch protection rules.
@@ -21,5 +21,5 @@ jobs:
     steps:
       - name: This workflow is blocked
         run: |
-          echo "� A workflow with this name was previously compromised and is now blocked."
+          echo "A workflow with this name was previously compromised and is now blocked."
           exit 1

src/PostHog/Config/PostHogConfigurationBuilderExtensions.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 using static PostHog.Library.Ensure;
 
 namespace PostHog.Config;
@@ -31,12 +32,24 @@ public static IPostHogConfigurationBuilder PostConfigure(
     public static IPostHogConfigurationBuilder UseConfigurationSection(
         this IPostHogConfigurationBuilder builder,
         IConfigurationSection section) =>
-        NotNull(builder).Use(services
-            => services.Configure<PostHogOptions>(section));
-
-#if NETSTANDARD2_0 || NETSTANDARD2_1
-    static IServiceCollection Configure<T>(this IServiceCollection services, IConfigurationSection section)
-        where T : class =>
-        services.Configure<T>(section.Bind);
+        NotNull(builder).Use(services =>
+        {
+#if !(NETSTANDARD2_0 || NETSTANDARD2_1)
+            services.AddSingleton<IOptionsChangeTokenSource<PostHogOptions>>(
+                new ConfigurationChangeTokenSource<PostHogOptions>(section));
 #endif
+            services.Configure<PostHogOptions>(options =>
+            {
+                var projectKeyState = options.GetProjectKeyState();
+                section.Bind(options);
+
+                // ConfigurationBinder writes alias getter values back when their keys are absent. A raw
+                // ProjectApiKey getter would avoid this but break its public alias behavior, so restore raw values
+                // for absent keys instead.
+                options.RestoreProjectKeyState(
+                    projectKeyState,
+                    restoreProjectToken: section["ProjectToken"] is null,
+                    restoreProjectApiKey: section["ProjectApiKey"] is null);
+            });
+        });
 }

src/PostHog/Config/PostHogOptions.cs

@@ -30,6 +30,24 @@ public string? ProjectToken
 
     internal bool HasLegacyProjectApiKey => _projectApiKey is not null;
 
+    internal (string? ProjectToken, string? ProjectApiKey) GetProjectKeyState() =>
+        (_projectToken, _projectApiKey);
+
+    internal void RestoreProjectKeyState(
+        (string? ProjectToken, string? ProjectApiKey) state,
+        bool restoreProjectToken,
+        bool restoreProjectApiKey)
+    {
+        if (restoreProjectToken)
+        {
+            _projectToken = state.ProjectToken;
+        }
+        if (restoreProjectApiKey)
+        {
+            _projectApiKey = state.ProjectApiKey;
+        }
+    }
+
     internal void Normalize()
     {
         _projectToken = _projectToken.NullIfEmpty();

tests/UnitTests.AspNetCore/RegistrationTests.cs

@@ -3,6 +3,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using PostHog;
 using PostHog.Config;
@@ -41,6 +42,26 @@ public void ReadsSettingsFromPostHogConfigurationSection()
         Assert.Equal(TimeSpan.FromSeconds(10), options.FeatureFlagPollInterval);
     }
 
+    [Fact]
+    public void DoesNotLogLegacyWarningWhenOnlyProjectTokenIsConfigured()
+    {
+        var builder = WebApplication.CreateSlimBuilder();
+        builder.Configuration.AddInMemoryCollection(new Dictionary<string, string?>
+        {
+            ["PostHog:ProjectToken"] = "fake-not-so-secret",
+        });
+        using var logger = new FakeLoggerProvider();
+        builder.Services.AddSingleton<ILoggerFactory>(logger);
+
+        builder.AddPostHog();
+
+        using var provider = builder.Services.BuildServiceProvider();
+        Assert.NotNull(provider.GetRequiredService<IPostHogClient>());
+        Assert.DoesNotContain(
+            logger.GetAllEvents(minimumLevel: LogLevel.Warning),
+            log => log.Message?.Contains("ProjectApiKey is deprecated", StringComparison.Ordinal) == true);
+    }
+
     [Fact]
     public void ReadsSecretKeyFromPostHogConfigurationSection()
     {
@@ -81,12 +102,18 @@ public void ReadsLegacyProjectApiKeyFromPostHogConfigurationSection()
         {
             ["PostHog:ProjectApiKey"] = "fake-not-so-secret",
         });
+        using var logger = new FakeLoggerProvider();
+        services.AddSingleton<ILoggerFactory>(logger);
 
         builder.AddPostHog();
 
-        var provider = services.BuildServiceProvider();
+        using var provider = services.BuildServiceProvider();
+        Assert.NotNull(provider.GetRequiredService<IPostHogClient>());
         var options = provider.GetRequiredService<IOptions<PostHogOptions>>().Value;
         Assert.Equal("fake-not-so-secret", options.ProjectToken);
+        Assert.Contains(
+            logger.GetAllEvents(minimumLevel: LogLevel.Warning),
+            log => log.Message?.Contains("ProjectApiKey is deprecated", StringComparison.Ordinal) == true);
     }
 
     [Fact]

tests/UnitTests/Config/RegistrationTests.cs

@@ -155,6 +155,29 @@ public void CanReadLegacyProjectApiKeyConfiguration()
         Assert.Equal("fake-public-project-api-key", options.ProjectToken);
     }
 
+    [Fact]
+    public void LaterConfigurationSectionOverridesLegacyProjectApiKey()
+    {
+        var services = new ServiceCollection();
+        var configuration = new ConfigurationBuilder()
+            .AddInMemoryCollection(new Dictionary<string, string?>
+            {
+                ["First:ProjectApiKey"] = "first-project-api-key",
+                ["Second:ProjectApiKey"] = "second-project-api-key",
+            })
+            .Build();
+        services.AddPostHog(options =>
+        {
+            options.UseConfigurationSection(configuration.GetSection("First"));
+            options.UseConfigurationSection(configuration.GetSection("Second"));
+        });
+
+        var provider = services.BuildServiceProvider();
+        var options = provider.GetRequiredService<IOptions<PostHogOptions>>().Value;
+
+        Assert.Equal("second-project-api-key", options.ProjectToken);
+    }
+
     [Fact]
     public void ProjectApiKeyAliasMirrorsProjectToken()
     {