Merge pull request #5 from felixclase/develop

Version Alpha..

Author: felixclase

.gitignore

@@ -328,3 +328,4 @@ ASALocalRun/
 
 # MFractors (Xamarin productivity tool) working folder 
 .mfractor/
+*.db

README.md

@@ -5,7 +5,10 @@
 [![License MIT](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 
 ## Overview
-SQLite storage for Hangfire
+
+An Alternative SQLite Storage for Hangfire.
+
+This project was created by abandonment **Hangfire.SQLite** storage (https://github.com/wanlitao/HangfireExtension), as an alternative to use SQLite with Hangfire.
 
 ## Build Status
 `Platform` | `Master` | `Develop`
@@ -15,22 +18,36 @@ SQLite storage for Hangfire
 
 ## Installation
 
-## Usage
+Install a package from Nuget.
 
-### DotNetCore
+```
+Install-Package Hangfire.Storage.SQLite
+```
 
-### NetFramework
+## Usage
+
+This is how you connect to an SQLite instance
+```csharp
+GlobalConfiguration.Configuration.UseSQLiteStorage();
+```
 
 ### Example
 
-#### Options
+```csharp
+services.AddHangfire(configuration => configuration
+            .UseSimpleAssemblyNameTypeSerializer()
+            .UseRecommendedSerializerSettings()
+            .UseSQLiteStorage());
+```
 
 ## Thanks
 
+This project is mainly based on **Hangfire.LiteDB** storage by [@codeyu](https://github.com/codeyu) (https://github.com/codeyu/Hangfire.LiteDB)
+
 ## Donation
 If this project help you reduce time to develop, you can give me a cup of coffee :) 
 
 [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=RMLQM296TCM38&item_name=For+the+development+of+Hangfire.Storage.SQLite&currency_code=USD&source=url)
 
 ## License
-This project is under MIT license. You can obtain the license copy [here](https://github.com/felixclase/Hangfire.Storage.SQLite/blob/develop/LICENSE).
+This project is under MIT license. You can obtain the license copy [here](https://github.com/felixclase/Hangfire.Storage.SQLite/blob/develop/LICENSE).

src/main/Hangfire.Storage.SQLite/CountersAggregator.cs

@@ -1,10 +1,137 @@
-using System;
+using Hangfire.Annotations;
+using Hangfire.Logging;
+using Hangfire.Server;
+using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text;
+using System.Threading;
+using Hangfire.Storage.SQLite.Entities;
 
 namespace Hangfire.Storage.SQLite
 {
-    public class CountersAggregator
+    /// <summary>
+    /// Represents Counter collection aggregator for SQLite database
+    /// </summary> 
+    #pragma warning disable CS0618
+    public class CountersAggregator : IBackgroundProcess, IServerComponent
+    #pragma warning restore CS0618
     {
+        private static readonly ILog Logger = LogProvider.For<CountersAggregator>();
+        private const int NumberOfRecordsInSinglePass = 1000;
+
+        private static readonly TimeSpan DelayBetweenPasses = TimeSpan.FromMilliseconds(500);
+
+        private readonly SQLiteStorage _storage;
+        private readonly TimeSpan _interval;
+
+        /// <summary>
+        /// Constructs Counter collection aggregator
+        /// </summary>
+        /// <param name="storage">SQLite storage</param>
+        /// <param name="interval">Checking interval</param>
+        public CountersAggregator(SQLiteStorage storage, TimeSpan interval)
+        {
+            _storage = storage ?? throw new ArgumentNullException(nameof(storage));
+            _interval = interval;
+        }
+
+        /// <summary>
+        /// Runs aggregator
+        /// </summary>
+        /// <param name="context">Background processing context</param>
+        public void Execute([NotNull] BackgroundProcessContext context)
+        {
+            Execute(context.StoppingToken);
+        }
+
+        /// <summary>
+        /// Runs aggregator
+        /// </summary>
+        /// <param name="cancellationToken">Cancellation token</param>
+        public void Execute(CancellationToken cancellationToken)
+        {
+            Logger.DebugFormat("Aggregating records in 'Counter' table...");
+
+            long removedCount = 0;
+            
+            do
+            {
+                using (var storageConnection = (HangfireSQLiteConnection)_storage.GetConnection())
+                {
+                    var storageDb = storageConnection.DbContext;
+
+                    var recordsToAggregate = storageDb
+                        .CounterRepository
+                        .Take(NumberOfRecordsInSinglePass)
+                        .ToList();
+
+                    var recordsToMerge = recordsToAggregate
+                        .GroupBy(_ => _.Key).Select(_ => new
+                        {
+                            _.Key,
+                            Value = _.Sum(x => x.Value),
+                            ExpireAt = _.Max(x => x.ExpireAt)
+                        });
+
+                    foreach (var id in recordsToAggregate.Select(_ => _.Id))
+                    {
+                        storageDb
+                            .CounterRepository
+                            .Delete(_ => _.Id == id);
+                        removedCount++;
+                    }
+
+                    foreach (var item in recordsToMerge)
+                    {
+                        AggregatedCounter aggregatedItem = storageDb
+                            .AggregatedCounterRepository
+                            .FirstOrDefault(_ => _.Key == item.Key);
+
+                        if (aggregatedItem != null)
+                        {
+                            var aggregatedCounters = storageDb.AggregatedCounterRepository.Where(_ => _.Key == item.Key).ToList();
+
+                            foreach (var counter in aggregatedCounters)
+                            {
+                                counter.Value = counter.Value + item.Value;
+                                counter.ExpireAt = item.ExpireAt > aggregatedItem.ExpireAt
+                                    ? (item.ExpireAt > DateTime.MinValue ? item.ExpireAt : DateTime.MinValue)
+                                    : (aggregatedItem.ExpireAt > DateTime.MinValue ? 
+                                        aggregatedItem.ExpireAt : DateTime.MinValue);
+                                storageDb.Database.Update(counter);
+                            }
+                        }
+                        else
+                        {
+                            storageDb
+                                .Database
+                                .Insert(new AggregatedCounter
+                                {
+                                    Key = item.Key,
+                                    Value = item.Value,
+                                    ExpireAt = item.ExpireAt
+                                });
+                        }
+                    }
+                }
+
+                if (removedCount >= NumberOfRecordsInSinglePass)
+                {
+                    cancellationToken.WaitHandle.WaitOne(DelayBetweenPasses);
+                    cancellationToken.ThrowIfCancellationRequested();
+                }
+            } while (removedCount >= NumberOfRecordsInSinglePass);
+
+            cancellationToken.WaitHandle.WaitOne(_interval);
+        }
+
+        /// <summary>
+        /// Returns text representation of the object
+        /// </summary>
+        public override string ToString()
+        {
+            return "SQLite Counter Collection Aggregator";
+        }
     }
 }

src/main/Hangfire.Storage.SQLite/EnqueuedAndFetchedCountDto.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Hangfire.Storage.SQLite
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    public class EnqueuedAndFetchedCountDto
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+        public int? EnqueuedCount { get; set; }
+        /// <summary>
+        /// 
+        /// </summary>
+        public int? FetchedCount { get; set; }
+    }
+}

src/main/Hangfire.Storage.SQLite/Entities/AggregatedCounter.cs

@@ -5,13 +5,13 @@
 
 namespace Hangfire.Storage.SQLite.Entities
 {
-    internal class AggregatedCounter
+    public class AggregatedCounter
     {
         [PrimaryKey]
         [MaxLength(DefaultValues.MaxLengthKeyColumn)]
         public string Key { get; set; }
 
-        public int Value { get; set; }
+        public decimal Value { get; set; }
 
         [Indexed(Name = "IX_AggregatedCounter_ExpireAt", Order = 1, Unique = false)]
         public DateTime ExpireAt { get; set; }

src/main/Hangfire.Storage.SQLite/Entities/Counter.cs

@@ -5,15 +5,18 @@
 
 namespace Hangfire.Storage.SQLite.Entities
 {
-    internal class Counter
+    public class Counter
     {
         [PrimaryKey]
+        [MaxLength(DefaultValues.MaxLengthKeyColumn)]
+        public string Id { get; set; }
+
         [MaxLength(DefaultValues.MaxLengthKeyColumn)]
         public string Key { get; set; }
 
-        public int Value { get; set; }
+        public decimal Value { get; set; }
 
         [Indexed(Name = "IX_Counter_ExpireAt", Order = 1, Unique = false)]
-        public DateTime? ExpireAt { get; set; }
+        public DateTime ExpireAt { get; set; }
     }
 }

src/main/Hangfire.Storage.SQLite/Entities/DistributedLock.cs

@@ -0,0 +1,31 @@
+using SQLite;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Hangfire.Storage.SQLite.Entities
+{
+    /// <summary>
+    /// Document used for holding a distributed lock in SQLite.
+    /// </summary>
+    public class DistributedLock
+    {
+        /// <summary>
+        /// The unique id of the document.
+        /// </summary>
+        [PrimaryKey]
+        public string Id { get; set; }
+
+        /// <summary>
+        /// The name of the resource being held.
+        /// </summary>
+        public string Resource { get; set; }
+
+        /// <summary>
+        /// The timestamp for when the lock expires.
+        /// This is used if the lock is not maintained or 
+        /// cleaned up by the owner (e.g. process was shut down).
+        /// </summary>
+        public DateTime ExpireAt { get; set; }
+    }
+}

…/Hangfire.Storage.SQLite/Entities/Job.cs …e.Storage.SQLite/Entities/HangfireJob.cssrc/main/Hangfire.Storage.SQLite/Entities/Job.cs renamed to src/main/Hangfire.Storage.SQLite/Entities/HangfireJob.cs src/main/Hangfire.Storage.SQLite/Entities/Job.cs renamed to src/main/Hangfire.Storage.SQLite/Entities/HangfireJob.cs

@@ -5,7 +5,8 @@
 
 namespace Hangfire.Storage.SQLite.Entities
 {
-    internal class Job
+    [Table("Job")]
+    public class HangfireJob
     {
         [PrimaryKey, AutoIncrement]
         public int Id { get; set; }
@@ -17,14 +18,14 @@ internal class Job
         public string StateName { get; set; }
 
         [MaxLength(DefaultValues.MaxLengthVarCharColumn)]
-        public string InvocationDate { get; set; }
+        public string InvocationData { get; set; }
 
         [MaxLength(DefaultValues.MaxLengthVarCharColumn)]
         public string Arguments { get; set; }
 
         public DateTime CreatedAt { get; set; }
 
         [Indexed(Name = "IX_Job_ExpireAt", Order = 2, Unique = false)]
-        public DateTime? ExpireAt { get; set; }
+        public DateTime ExpireAt { get; set; }
     }
 }

src/main/Hangfire.Storage.SQLite/Entities/HangfireList.cs

@@ -6,12 +6,17 @@
 namespace Hangfire.Storage.SQLite.Entities
 {
     [Table("List")]
-    internal class HangfireList
+    public class HangfireList
     {
+        private string _listPK = string.Empty;
+        
         [PrimaryKey]
-        public string ListPK { get { return Id + "_" + Key; } }
+        public string ListPK { 
+            get => Id + "_" + Key;
+            set => _listPK = value;
+        }
 
-        [AutoIncrement]
+        //[AutoIncrement]
         [Indexed(Name = "IX_List_Id", Order = 1, Unique = false)]
         public int Id { get; set; }
 
@@ -23,6 +28,6 @@ internal class HangfireList
         public string Value { get; set; }
 
         [Indexed(Name = "IX_List_ExpireAt", Order = 3, Unique = false)]
-        public DateTime? ExpireAt { get; set; }
+        public DateTime ExpireAt { get; set; }
     }
 }

…ngfire.Storage.SQLite/Entities/Server.cs …torage.SQLite/Entities/HangfireServer.cssrc/main/Hangfire.Storage.SQLite/Entities/Server.cs renamed to src/main/Hangfire.Storage.SQLite/Entities/HangfireServer.cs src/main/Hangfire.Storage.SQLite/Entities/Server.cs renamed to src/main/Hangfire.Storage.SQLite/Entities/HangfireServer.cs

@@ -5,7 +5,8 @@
 
 namespace Hangfire.Storage.SQLite.Entities
 {
-    internal class Server
+    [Table("Server")]
+    public class HangfireServer
     {
         [PrimaryKey]
         [MaxLength(DefaultValues.MaxLengthIdColumn)]