Add option to add caching library through the server SDK (#235)

Author: justindbaur

extensions/Bitwarden.Server.Sdk/src/Content/HostBuilderExtensions.cs

@@ -9,6 +9,9 @@
 using OpenTelemetry.Trace;
 using OpenTelemetry.Resources;
 #endif
+#if BIT_INCLUDE_CACHING
+using Bitwarden.Server.Sdk.Caching;
+#endif
 
 namespace Microsoft.Extensions.Hosting;
 
@@ -44,6 +47,10 @@ public static TBuilder UseBitwardenSdk<TBuilder>(this TBuilder builder)
         builder.Services.AddBitwardenAuthentication();
 #endif
 
+#if BIT_INCLUDE_CACHING
+        builder.Services.AddBitwardenCaching();
+#endif
+
         return builder;
     }
 
@@ -83,6 +90,13 @@ public static IHostBuilder UseBitwardenSdk(this IHostBuilder hostBuilder)
         });
 #endif
 
+#if BIT_INCLUDE_CACHING
+        hostBuilder.ConfigureServices((_, services) =>
+        {
+            services.AddBitwardenCaching();
+        });
+#endif
+
         return hostBuilder;
     }
 
@@ -176,6 +190,10 @@ private static void AddMetrics(
 
                 metrics.AddMeter("Bitwarden.*");
                 metrics.AddMeter("Bit.*");
+
+#if BIT_INCLUDE_CACHING
+                metrics.AddFusionCacheInstrumentation();
+#endif
             })
             .WithTracing(tracing =>
             {
@@ -188,6 +206,10 @@ private static void AddMetrics(
                 tracing.AddHttpClientInstrumentation();
                 tracing.AddEntityFrameworkCoreInstrumentation();
                 tracing.AddSqlClientInstrumentation();
+
+#if BIT_INCLUDE_CACHING
+                tracing.AddFusionCacheInstrumentation();
+#endif
             });
 
         if (configuration.GetValue(OtelDebuggingConfigKey, false))

extensions/Bitwarden.Server.Sdk/src/Sdk/Sdk.targets

@@ -31,6 +31,9 @@
     <!-- Authentication defaults to on -->
     <BitIncludeAuthentication Condition="'$(BitIncludeAuthentication)' == ''">true</BitIncludeAuthentication>
     <DefineConstants Condition="'$(BitIncludeAuthentication)' == 'true'">$(DefineConstants);BIT_INCLUDE_AUTHENTICATION</DefineConstants>
+    <!-- Caching defaults to off -->
+    <BitIncludeCaching Condition="'$(BitIncludeCaching)' == ''">false</BitIncludeCaching>
+    <DefineConstants Condition="'$(BitIncludeCaching)' == 'true'">$(DefineConstants);BIT_INCLUDE_CACHING</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(BitIncludeTelemetry)' == 'true'">
@@ -42,6 +45,9 @@
     <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.14.0" />
     <PackageReference Include="OpenTelemetry.Instrumentation.SqlClient" Version="1.12.0-beta.3" />
 
+    <!-- Add the Fusion cache open telemetry library when telemetry and caching are being used. -->
+    <PackageReference Condition="'$(BitIncludeCaching)' == 'true'" Include="ZiggyCreatures.FusionCache.OpenTelemetry" Version="2.5.0" />
+
     <Compile Include="$(SdkContentRoot)/OtelDebuggingHostedService.cs" />
   </ItemGroup>
 
@@ -52,4 +58,8 @@
   <ItemGroup Condition="'$(BitIncludeAuthentication)' == 'true'">
     <PackageReference Include="Bitwarden.Server.Sdk.Authentication" Version="0.6.0" />
   </ItemGroup>
+
+  <ItemGroup Condition="'$(BitIncludeCaching)' == 'true'">
+    <PackageReference Include="Bitwarden.Server.Sdk.Caching" Version="0.1.0" />
+  </ItemGroup>
 </Project>

extensions/Bitwarden.Server.Sdk/tests/Bitwarden.Server.Sdk.IntegrationTests/SdkTests.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics;
 using Microsoft.Build.Utilities.ProjectCreation;
 using Microsoft.Extensions.Logging;
 
@@ -8,16 +9,22 @@ public class SdkTests : MSBuildTestBase
     [Fact]
     public void NoOverridingProperties_CanCompile()
     {
-        ProjectCreator.Templates.SdkProject(out var result, out var buildOutput)
-            .TryGetConstant("BIT_INCLUDE_TELEMETRY", out var hasTelementryConstant)
-            .TryGetConstant("BIT_INCLUDE_FEATURES", out var hasFeaturesConstant)
-            .TryGetConstant("BIT_INCLUDE_AUTHENTICATION", out var hasAuthenticationConstant);
+        IEnumerable<(string Feature, bool DefaultValue)> featuresAndDefaults = [
+            ("TELEMETRY", true),
+            ("FEATURES", true),
+            ("AUTHENTICATION", true),
+            ("CACHING", false),
+        ];
+
+        var project = ProjectCreator.Templates.SdkProject(out var result, out var buildOutput);
 
         Assert.True(result, buildOutput.GetConsoleLog());
 
-        Assert.True(hasTelementryConstant);
-        Assert.True(hasFeaturesConstant);
-        Assert.True(hasAuthenticationConstant);
+        foreach (var (feature, expectedDefault) in featuresAndDefaults)
+        {
+            project.TryGetConstant($"BIT_INCLUDE_{feature}", out var actualValue);
+            Assert.Equal(expectedDefault, actualValue);
+        }
     }
 
     [Fact]
@@ -123,6 +130,24 @@ public void FeaturesTurnedOn_CanUseFeatureService()
         Assert.True(result, buildOutput.GetConsoleLog());
     }
 
+    [Fact]
+    public void CachingTurnedOn_CanUseFusionCache()
+    {
+        ProjectCreator.Templates.SdkProject(
+            out var result,
+            out var buildOutput,
+            customAction: (project) =>
+            {
+                project.Property("BitIncludeCaching", bool.TrueString);
+            },
+            additional: """
+                app.MapGet("/test", ([FromKeyedServices("Test")]  ZiggyCreatures.Caching.Fusion.IFusionCache cache) => cache.GetOrSetAsync("Key", true));
+                """
+        );
+
+        Assert.True(result, buildOutput.GetConsoleLog());
+    }
+
     [Fact]
     public void AuthenticationTurnedOff_CanCompile()
     {
@@ -138,34 +163,59 @@ public void AuthenticationTurnedOff_CanCompile()
         Assert.True(result, buildOutput.GetConsoleLog());
     }
 
-    public static TheoryData<bool, bool, bool> MatrixData
-        => new MatrixTheoryData<bool, bool, bool>([true, false], [true, false], [true, false]);
+    public static TheoryData<string> PossibleVariantData()
+    {
+        string[] features = ["Telemetry", "Features", "Authentication", "Caching"];
+        var totalCombinations = (int)Math.Pow(2, features.Length);
 
-    // There will be some variants that disallow the use of feature Y if feature X is not also enabled.
-    // Use this set to exclude those known variants from being tested.
-    public static HashSet<(bool, bool, bool)> ExcludedVariants => [];
+        var theory = new TheoryData<string>();
 
-    [Theory, MemberData(nameof(MatrixData))]
-    public void AllVariants_Work(bool includeTelemetry, bool includeFeatures, bool includeAuthentication)
-    {
-        if (ExcludedVariants.Contains((includeTelemetry, includeFeatures, includeAuthentication)))
+        for (var i = 0; i < totalCombinations; i++)
+        {
+            var variant = new Dictionary<string, bool>();
+
+            for (var j = 0; j < features.Length; j++)
+            {
+                // Check if the j-th bit is set in i
+                variant[features[j]] = (i & (1 << j)) != 0;
+            }
+
+            // TODO: When there are variants that need to be skipped do so here but still add
+            // a row with a skip message
+            theory.Add(Serialize(variant));
+        }
+
+        return theory;
+
+        // We serialize it into a simple string so that it can be easily viewed in test explorer
+        static string Serialize(Dictionary<string, bool> features)
         {
-            Assert.Skip($"""
-                Excluded Variant Skipped:
-                    IncludeTelemetry = {includeTelemetry}
-                    IncludeFeatures = {includeFeatures}
-                    IncludeAuthentication = {includeAuthentication}
-                """);
+            return string.Join(',', features.Select(feature => $"{feature.Key}={feature.Value}"));
         }
+    }
+
+    [Theory, MemberData(nameof(PossibleVariantData))]
+    public void AllVariants_Work(string featureSets)
+    {
+        // Deserialize from simple string into dictionary
+        var features = featureSets.Split(",")
+            .Select(featureSet =>
+            {
+                var split = featureSet.Split("=");
+                Debug.Assert(split.Length == 2, "Invalid format");
+                return new KeyValuePair<string, bool>(split[0], bool.Parse(split[1]));
+            })
+            .ToDictionary();
 
         ProjectCreator.Templates.SdkProject(
             out var result,
             out var buildOutput,
             customAction: (project) =>
             {
-                project.Property("BitIncludeTelemetry", includeTelemetry.ToString());
-                project.Property("BitIncludeFeatures", includeFeatures.ToString());
-                project.Property("BitIncludeAuthentication", includeAuthentication.ToString());
+                foreach (var feature in features)
+                {
+                    project.Property($"BitInclude{feature.Key}", feature.Value.ToString());
+                }
             }
         );