Add UC SQLite dependency and configure a default SQLite connection string when developing locally

Author: mattbrailsford

Directory.Packages.props

@@ -10,7 +10,8 @@
     <GlobalPackageReference Include="Umbraco.JsonSchema.Extensions" Version="0.3.0" PrivateAssets="all" />
   </ItemGroup>
   <ItemGroup>
-    <PackageVersion Include="Umbraco.Commerce.Cms.Startup" Version="[15.0.0-rc1, 16)" />
-    <PackageVersion Include="Umbraco.Deploy.Infrastructure" Version="[15.0.0, 16)" />
+    <PackageVersion Include="Umbraco.Commerce.Cms.Startup" Version="[15.0.0, 15.999.999)" />
+    <PackageVersion Include="Umbraco.Commerce.Persistance.Sqlite" Version="[15.0.0, 15.999.999)" />
+    <PackageVersion Include="Umbraco.Deploy.Infrastructure" Version="[15.0.1, 16)" />
   </ItemGroup>
 </Project>

src/Umbraco.Commerce.Deploy/Composing/UmbracoCommerceDeployComposer.cs

@@ -2,16 +2,27 @@
 using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Umbraco.Commerce.Cms;
+using Umbraco.Commerce.Core.Data;
+using Umbraco.Commerce.Extensions;
+using Umbraco.Extensions;
 
 namespace Umbraco.Commerce.Deploy.Composing
 {
+    [ComposeAfter(typeof(UmbracoCommerceComposer))]
     public class UmbracoCommerceDeployComposer : IComposer
     {
         public void Compose(IUmbracoBuilder builder)
         {
             builder.Services.AddOptions<UmbracoCommerceDeploySettings>()
                 .Bind(builder.Config.GetSection("Umbraco:Commerce:Deploy"));
 
+            // Ensure SQLite support for local development
+            builder.WithUmbracoCommerceBuilder().AddSQLite();
+
+            builder.Services.AddUnique<IConfigureOptions<ConnectionStringConfig>, ConfigureUmbracoCommerceConnectionString>();
+
             builder.Services.AddSingleton<UmbracoCommerceDeploySettingsAccessor>();
 
             builder.Components()

src/Umbraco.Commerce.Deploy/Configuration/ConfigureUmbracoCommerceConnectionString.cs

@@ -0,0 +1,55 @@
+using System;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+using Umbraco.Commerce.Core.Data;
+using Umbraco.Deploy.Core.Configuration.DeployConfiguration;
+using Umbraco.Extensions;
+using UcConstants = Umbraco.Commerce.Core.Constants;
+using UmbConstants = Umbraco.Cms.Core.Constants;
+
+namespace Umbraco.Commerce.Deploy.Configuration;
+
+public class ConfigureUmbracoCommerceConnectionString(IConfiguration configuration, IOptionsMonitor<DeploySettings> deploySettings) : IConfigureNamedOptions<ConnectionStringConfig>
+{
+    public void Configure(ConnectionStringConfig connectionStringConfig)
+        => Configure(Options.DefaultName, connectionStringConfig);
+
+    public void Configure(string? name, ConnectionStringConfig connectionStringConfig)
+    {
+        // Default to using Umbraco Commerce connection name
+        if (name == Options.DefaultName)
+        {
+            name = UcConstants.System.ConnectionStringName;
+        }
+
+        // Skip non-empty connection string and only configure Umbraco Commerce connection name
+        if ((connectionStringConfig != null
+            && !string.IsNullOrWhiteSpace(connectionStringConfig.ConnectionString)
+            && !string.IsNullOrWhiteSpace(connectionStringConfig.ProviderName))
+            || name != UcConstants.System.ConnectionStringName)
+        {
+            return;
+        }
+
+        // Get Umbraco connection string
+        _ = configuration.GetUmbracoConnectionString(UmbConstants.System.UmbracoConnectionName, out var providerName);
+        var umbDbProviderName = providerName;
+
+        // If Umbraco is configured to use SQLIte, then configure Umbraco Commerce to use it's own SQLite database
+        if (umbDbProviderName != null && umbDbProviderName.Contains("SQLite", StringComparison.InvariantCultureIgnoreCase))
+        {
+            var dataDirectory = AppDomain.CurrentDomain.GetData("DataDirectory")?.ToString();
+            var ucDbConnectionString = $"Data Source={dataDirectory}/Umbraco.Commerce.sqlite.db;Mode=ReadWrite;Foreign Keys=True;Pooling=True;Cache=Private";
+            var ucDbProviderName = Persistence.Sqlite.Constants.ProviderName;
+
+            // Update configuration
+            configuration[$"ConnectionStrings:{name}"] = ucDbConnectionString;
+            configuration[$"ConnectionStrings:{name}{ConnectionStringConfig.ProviderNamePostfix}"] = ucDbProviderName;
+
+            // Update options
+            connectionStringConfig.Name = name;
+            connectionStringConfig.ConnectionString = ucDbConnectionString;
+            connectionStringConfig.ProviderName = ucDbProviderName;
+        }
+    }
+}

src/Umbraco.Commerce.Deploy/Umbraco.Commerce.Deploy.csproj

@@ -9,6 +9,7 @@
 
     <ItemGroup>
         <PackageReference Include="Umbraco.Commerce.Cms.Startup" />
+        <PackageReference Include="Umbraco.Commerce.Persistence.Sqlite" />
         <PackageReference Include="Umbraco.Deploy.Infrastructure" />
     </ItemGroup>