Do not directly use SQLitePCLRaw.bundle_green

This has been preventing other .NET 5+ (non-ASP.NET Core) users from easily depending on this package. We now use SQLitePCLRaw.core in this library and require downstream users to supply the correct platform dependency. ASP.NET Core users do not need to do anything since the web stack automatically calls `SQLitePCL.Batteries_V2.Init()` for them.
neosmart · Jun 29, 2023 · e8e5282 · e8e5282
1 parent f42614b
commit e8e5282
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 6 deletions.
diff --git a/SqliteCache.Tests/BasicTests.cs b/SqliteCache.Tests/BasicTests.cs
@@ -10,6 +10,13 @@ namespace NeoSmart.Caching.Sqlite.Tests
     [TestClass]
     public class BasicTests : IDisposable
     {
+        [AssemblyInitialize]
+        public static void SetSqliteProvider(TestContext _)
+        {
+            // SQLitePCL.raw.SetProvider(new SQLitePCL.SQLite3Provider_e_sqlite3());
+            SQLitePCL.Batteries_V2.Init();
+        }
+
         public static readonly Encoding DefaultEncoding = new UTF8Encoding(false);
         private readonly SqliteCacheOptions Configuration = new SqliteCacheOptions()
         {

diff --git a/SqliteCache.Tests/SqliteCache.Tests.csproj b/SqliteCache.Tests/SqliteCache.Tests.csproj
@@ -15,6 +15,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="MSTest.TestAdapter" Version="3.0.2" />
     <PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
+    <PackageReference Include="SQLitePCLRaw.bundle_green" Version="*" />
   </ItemGroup>
 
   <ItemGroup>
@@ -23,7 +24,6 @@
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net462'">
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" PrivateAssets="All" Version="1.0.3" />
-    <PackageReference Include="SQlitePCLRaw.bundle_e_sqlite3" PrivateAssets="All" Version="2.1.4" />
   </ItemGroup>
 
 </Project>
diff --git a/SqliteCache/SqliteCache.cs b/SqliteCache/SqliteCache.cs
@@ -29,7 +29,7 @@ public sealed class SqliteCache : IDistributedCache, IDisposable
 
         static SqliteCache()
         {
-            SQLitePCL.Batteries.Init();
+            // SQLitePCL.Batteries.Init();
         }
 
         public SqliteCache(IOptions<SqliteCacheOptions> options, ILogger<SqliteCache>? logger = null)

diff --git a/SqliteCache/SqliteCache.csproj b/SqliteCache/SqliteCache.csproj
@@ -1,11 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;netcoreapp3.1;net5.0;net6.0;</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
     <LangVersion>9.0</LangVersion>
     <AssemblyName>NeoSmart.Caching.Sqlite</AssemblyName>
     <RootNamespace>NeoSmart.Caching.Sqlite</RootNamespace>
-    <Version>6.1.0</Version>
+    <Version>7.0.0-preview1</Version>
     <Nullable>enable</Nullable>
     <Authors>Mahmoud Al-Qudsi, neosmart, mqudsi</Authors>
     <Company>NeoSmart Technologies</Company>
@@ -18,6 +18,14 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>idistributedcache, cache, sqlite, sqlitecache, distributed, aspnetcore, asp, core, performance</PackageTags>
     <PackageReleaseNotes>
+Version 7.0:
+- SqliteCache no longer depends on SQLitePCLRaw.bundle_green.
+
+  ASP.NET users do not have to change anything, but other .NET Core users will need to install either
+  SQLitePCLRaw.bundle_green and call `SQLitePCL.Batteries.Init()` before instantiating SqliteCache,
+  or else install the correct SQLitePCLRaw.provider.xxx version that matches the target platform and call
+  `SQLitePCL.raw.SetProvider(new SQLitePCL.SQLite3Provider_whatever())` before using SqliteCache.
+
 Version 6.1:
 - Add methods to clear the cache (SqliteCache.Clear() and SqliteCache.ClearAsync())
 - SQLitePCLRaw upgraded to 2.1.4
@@ -64,7 +72,8 @@ Version 3.1:
     <PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />
-    <PackageReference Include="SQLitePCLRaw.bundle_green" Version="2.1.4" />
+    <!--<PackageReference Include="SQLitePCLRaw.bundle_green" Version="2.1.4" />-->
+    <PackageReference Include="SQLitePCLRaw.core" Version="2.1.4" />
   </ItemGroup>
 
   <ItemGroup>