Merge pull request #18 from ajuna-network/add-ersistence-layer

Add Persistence Layer

Author: svnscha

Ajuna.AspNetCore/Persistence/ChangeRecord.cs

@@ -0,0 +1,38 @@
+using System;
+
+namespace Ajuna.AspNetCore.Persistence
+{
+   /// <summary>
+   /// Representation of a Node Storage Change 
+   /// </summary>
+   public class ChangeRecord
+   {
+      public ChangeRecord()
+      {
+      }
+      
+      public  ChangeRecord(string key, string identifier, ChangeAction action, string data )
+      {
+         Key = key;
+         Identifier = identifier;
+         Action = action;
+         Data = data;
+         UpdateDate = DateTimeOffset.Now;
+      }
+      
+      public string Key { get;  set; }
+      public string Identifier { get;  set; }
+      public ChangeAction Action { get;  set; }
+      public string Data { get;  set; }
+      public DateTimeOffset? UpdateDate { get;  set; }
+   }
+
+   public enum ChangeAction
+   {
+      Create,
+      Update,
+      Delete
+   }
+   
+}
+

Ajuna.AspNetCore/Persistence/StoragePersistenceChangeDelegate.cs

@@ -0,0 +1,57 @@
+using Ajuna.ServiceLayer.Storage;
+using System;
+using System.IO;
+
+namespace Ajuna.AspNetCore.Persistence
+{
+   /// <summary>
+   /// Responsible for storing all changes in a CSV file including the Identifier, Action type, Data and Update Date
+   /// </summary>
+   public class StoragePersistenceChangeDelegate : IStorageChangeDelegate
+   {
+      private readonly string _csvFilePath;
+
+      /// <param name="fileDirectory"> File Path where the CSV file will be located</param>
+      public StoragePersistenceChangeDelegate(string fileDirectory = null)
+      {
+         _csvFilePath = Path.Combine(fileDirectory ?? String.Empty, $"Storage_Changes_{DateTime.Now:yyyyMMdd_HH.mm.ss}.csv");
+      }
+      
+      public void OnUpdate(string identifier, string key, string data)
+      {
+         var change = new ChangeRecord(key, identifier, ChangeAction.Update, data);
+         StoreChange(change);
+      }
+
+      public void OnDelete(string identifier, string key, string data)
+      {
+         var change = new ChangeRecord(key, identifier, ChangeAction.Delete, data);
+         StoreChange(change);
+      }
+
+      public void OnCreate(string identifier, string key, string data)
+      {
+         var change = new ChangeRecord(key, identifier, ChangeAction.Create, data);
+         StoreChange(change);
+      }
+
+      private void StoreChange(ChangeRecord changeRecord)
+      {
+         if (!File.Exists(_csvFilePath))
+         {
+            // Create a file to write to.
+            using (StreamWriter sw = File.CreateText(_csvFilePath))
+            {
+               sw.WriteLine("Key,Identifier,Action,Data,UpdateDate");
+            }
+         }
+
+         // This text is always added, making the file longer over time
+         // if it is not deleted.
+         using (StreamWriter sw = File.AppendText(_csvFilePath))
+         {
+            sw.WriteLine(String.Join(",",changeRecord.Key, changeRecord.Identifier, changeRecord.Action, changeRecord.Data, changeRecord.UpdateDate));
+         }
+      }
+   }
+}

Ajuna.ServiceLayer/Storage/IStorageChangeDelegate.cs

@@ -1,5 +1,6 @@
 namespace Ajuna.ServiceLayer.Storage
 {
+   // This Delegate can be passed to the Storage classes and be triggered on every storage change
    public interface IStorageChangeDelegate
    {
       void OnUpdate(string identifier, string key, string data);

Ajuna.ServiceLayer/Storage/TypedMapStorage.cs

@@ -10,19 +10,23 @@ namespace Ajuna.ServiceLayer.Storage
       internal string Identifier { get; private set; }
       public Dictionary<string, T> Dictionary { get; private set; }
       public IStorageDataProvider DataProvider { get; private set; }
-      public IStorageChangeDelegate ChangeDelegate { get; private set; }
+      
+      /// <summary>
+      /// A ChangeDelegate can be added in order to act upon any Storage Changes
+      /// </summary>
+      public List<IStorageChangeDelegate> ChangeDelegates { get; private set; }
 
       public TypedMapStorage(string identifier, IStorageDataProvider dataProvider)
       {
          Identifier = identifier;
          DataProvider = dataProvider;
       }
 
-      public TypedMapStorage(string identifier, IStorageDataProvider dataProvider, IStorageChangeDelegate changeDelegate)
+      public TypedMapStorage(string identifier, IStorageDataProvider dataProvider, List<IStorageChangeDelegate>  changeDelegates)
       {
          Identifier = identifier;
          DataProvider = dataProvider;
-         ChangeDelegate = changeDelegate;
+         ChangeDelegates = changeDelegates;
       }
 
       public async Task InitializeAsync(string module, string moduleItem)
@@ -47,7 +51,7 @@ public void Update(string key, string data)
          {
             Dictionary.Remove(key);
             Log.Debug($"[{Identifier}] item {{key}} was deleted.", key);
-            ChangeDelegate?.OnDelete(Identifier, key, data);
+            ChangeDelegates?.ForEach(x=>x.OnDelete(Identifier, key, data));
          }
          else
          {
@@ -58,13 +62,13 @@ public void Update(string key, string data)
             {
                Dictionary[key] = iType;
                Log.Debug($"[{Identifier}] item {{key}} was updated.", key);
-               ChangeDelegate?.OnUpdate(Identifier, key, data);
+               ChangeDelegates?.ForEach(x=>x.OnUpdate(Identifier, key, data));
             }
             else
             {
                Dictionary.Add(key, iType);
                Log.Debug($"[{Identifier}] item {{key}} was created.", key);
-               ChangeDelegate?.OnCreate(Identifier, key, data);
+               ChangeDelegates?.ForEach(x=>x.OnCreate(Identifier, key, data));
             }
          }
       }

Ajuna.ServiceLayer/Storage/TypedStorage.cs

@@ -1,5 +1,6 @@
 using Ajuna.NetApi.Model.Types;
 using Serilog;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace Ajuna.ServiceLayer.Storage
@@ -9,19 +10,23 @@ namespace Ajuna.ServiceLayer.Storage
       internal string Identifier { get; private set; }
       public T Store { get; private set; }
       public IStorageDataProvider DataProvider { get; private set; }
-      public IStorageChangeDelegate ChangeDelegate { get; private set; }
+      
+      /// <summary>
+      /// A ChangeDelegate can be added in order to act upon any Storage Changes
+      /// </summary>
+      public List<IStorageChangeDelegate> ChangeDelegates { get; private set; }
 
       public TypedStorage(string identifier, IStorageDataProvider dataProvider)
       {
          Identifier = identifier;
          DataProvider = dataProvider;
       }
 
-      public TypedStorage(string identifier, IStorageDataProvider dataProvider, IStorageChangeDelegate changeDelegate)
+      public TypedStorage(string identifier, IStorageDataProvider dataProvider, List<IStorageChangeDelegate>  changeDelegates)
       {
          Identifier = identifier;
          DataProvider = dataProvider;
-         ChangeDelegate = changeDelegate;
+         ChangeDelegates = changeDelegates;
       }
 
       public async Task InitializeAsync(string module, string moduleItem)
@@ -49,7 +54,7 @@ public void Update(string data)
             Store = iType;
             Log.Debug($"[{Identifier}] item was updated.");
 
-            ChangeDelegate?.OnUpdate(Identifier, string.Empty, data);
+            ChangeDelegates?.ForEach(x=>x.OnUpdate(Identifier, string.Empty, data));
          }
       }
    }

README.md

@@ -54,7 +54,7 @@ Using a terminal of your choice, create a new directory for your project and exe
 ```sh
 dotnet new sln
 dotnet new ajuna \
-   --sdk_version 0.1.14 \
+   --sdk_version 0.1.15 \
    --rest_service AjunaExample.RestService \
    --net_api AjunaExample.NetApi \
    --rest_client AjunaExample.RestClient \

Tools/Ajuna.DotNet.Template/templates/Ajuna/.template.config/template.json

@@ -12,7 +12,7 @@
    "symbols": {
       "sdk_version": {
          "datatype": "string",
-         "defaultValue": "0.1.14",
+         "defaultValue": "0.1.15",
          "description": "Uses the given Ajuna SDK version.",
          "replaces": "AJUNA_SDK_VERSION",
          "type": "parameter"

Tools/Ajuna.DotNet.Template/templates/Ajuna/Ajuna.RestService/Startup.cs

@@ -1,4 +1,5 @@
 using Ajuna.AspNetCore;
+using Ajuna.AspNetCore.Persistence;
 using Ajuna.AspNetCore.Extensions;
 using Ajuna.RestService.Formatters;
 using Ajuna.ServiceLayer;
@@ -48,6 +49,15 @@ public class Startup
       private IStorageDataProvider _storageDataProvider;
       private readonly StorageSubscriptionChangeDelegate _storageChangeDelegate = new StorageSubscriptionChangeDelegate();
 
+      // Delegate for adding local persistence for any Storage Changes
+      // Changes are going to be saved in a CSV file. The default location of the CSV file will be in project root.
+      // Alternatively, please set the fileDirectory parameter in the constructor below.
+      private readonly StoragePersistenceChangeDelegate _storagePersistenceChangeDelegate = new StoragePersistenceChangeDelegate();
+      
+      // Set to true to activate persistence 
+      private readonly bool _useLocalStoragePersistence = false;
+
+
       /// <summary>
       /// >> Startup
       /// Constructs and initializes the Startup class.
@@ -60,7 +70,7 @@ public Startup(IConfiguration configuration)
       }
 
       /// <summary>
-      /// Retreives the service configuration.
+      /// Retrieves the service configuration.
       /// </summary>
       public IConfiguration Configuration { get; }
 
@@ -104,15 +114,20 @@ public void ConfigureServices(IServiceCollection services)
             c.CustomSchemaIds(type => type.ToString());
             c.SwaggerDoc("v1", new OpenApiInfo { Title = "Ajuna.RestService", Version = "v1" });
          });
-
       }
 
       private List<IStorage> GetRuntimeStorages()
       {
+         var storageChangeDelegates = new List<IStorageChangeDelegate> {_storageChangeDelegate,};
+          
+         // If true, add local storage persistence
+         if(_useLocalStoragePersistence)
+            storageChangeDelegates.Add(_storagePersistenceChangeDelegate);
+      
          return Assembly.GetExecutingAssembly()
             .GetTypes()
             .Where(anyType => anyType.IsClass && typeof(IStorage).IsAssignableFrom(anyType))
-            .Select(storageType => (IStorage)Activator.CreateInstance(storageType, new object[] { _storageDataProvider, _storageChangeDelegate }))
+            .Select(storageType => (IStorage)Activator.CreateInstance(storageType, new object[] { _storageDataProvider, storageChangeDelegates }))
             .ToList();
       }
 

Tools/Ajuna.DotNet/Service/Node/RestServiceStorageModuleBuilder.cs

@@ -77,7 +77,7 @@ private void CreateStorage(CodeNamespace typeNamespace)
          };
 
          constructor.Parameters.Add(new CodeParameterDeclarationExpression(new CodeTypeReference("IStorageDataProvider"), "storageDataProvider"));
-         constructor.Parameters.Add(new CodeParameterDeclarationExpression(new CodeTypeReference("IStorageChangeDelegate"), "storageChangeDelegate"));
+         constructor.Parameters.Add(new CodeParameterDeclarationExpression(new CodeTypeReference("List<IStorageChangeDelegate>"), "storageChangeDelegates"));
          constructor.Comments.AddRange(GetComments(new string[] { $"{ClassName} constructor." }));
 
          targetClass.Members.Add(constructor);
@@ -174,7 +174,7 @@ private void CreateStorage(CodeNamespace typeNamespace)
                    new CodeExpression[] {
                         new CodePrimitiveExpression($"{Module.Storage.Prefix}.{entry.Name}"),
                         new CodeVariableReferenceExpression("storageDataProvider"),
-                        new CodeVariableReferenceExpression("storageChangeDelegate")
+                        new CodeVariableReferenceExpression("storageChangeDelegates")
                    })));
 
                // create initialize records foreach storage

Version.props

@@ -4,9 +4,9 @@
       <!-- Configuration -->
       <VersionMajor>0</VersionMajor>
       <VersionMinor>1</VersionMinor>
-      <VersionPatch>14</VersionPatch>
+      <VersionPatch>15</VersionPatch>
       <AssemblyVersion>$(VersionMajor).$(VersionMinor).$(VersionPatch)</AssemblyVersion>
-      <AjunaPackageVersion>0.1.14</AjunaPackageVersion>
+      <AjunaPackageVersion>0.1.15</AjunaPackageVersion>
 
       <!-- Variables -->
       <AjunaVersion>$(AssemblyVersion)</AjunaVersion>