Added the recommendation service

Author: Jonas Gauffin

src/Server/Coderr.Server.App/Modules/Mine/IRecommendationProvider.cs

@@ -0,0 +1,29 @@
+using System.Threading.Tasks;
+
+namespace Coderr.Server.App.Modules.Mine
+{
+    /// <summary>
+    ///     A provider that will suggest incidents
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         A provider can recommend several incident. If they do, it's recommended that each incident get a different
+    ///         score.
+    ///         If all providers are equally worth, they can give a score of 100 to the most recommended incident. However,
+    ///         some providers affect the business more (like partitions) and could therefore specify a score multiplier for
+    ///         all suggested incidents.
+    ///     </para>
+    ///     <para>
+    ///         The provider will be executed in a container scope.
+    ///     </para>
+    /// </remarks>
+    public interface IRecommendationProvider
+    {
+        /// <summary>
+        ///     Suggest an incident.
+        /// </summary>
+        /// <param name="context">Context information</param>
+        /// <returns>task</returns>
+        Task Recommend(RecommendIncidentContext context);
+    }
+}

src/Server/Coderr.Server.App/Modules/Mine/IRecommendationService.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Coderr.Server.App.Modules.Mine
+{
+    /// <summary>
+    /// Will gather all recommendations and sort them by the number of points.
+    /// </summary>
+    public interface IRecommendationService
+    {
+        Task<List<RecommendedIncident>> GetRecommendations(int accountId, int? applicationId = null);
+    }
+}

src/Server/Coderr.Server.App/Modules/Mine/RecommendIncidentContext.cs

@@ -0,0 +1,57 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Coderr.Server.App.Modules.Mine
+{
+    /// <summary>
+    ///     Context for <see cref="IRecommendationProvider" />
+    /// </summary>
+    public class RecommendIncidentContext
+    {
+        private readonly List<RecommendedIncident> _items;
+
+        public RecommendIncidentContext(List<RecommendedIncident> items)
+        {
+            _items = items ?? throw new ArgumentNullException(nameof(items));
+        }
+
+        /// <summary>
+        ///     User that want a suggestion
+        /// </summary>
+        public int AccountId { get; set; }
+
+        /// <summary>
+        ///     If the user have selected a specific application
+        /// </summary>
+        public int? ApplicationId { get; set; }
+
+        /// <summary>
+        /// Number of items each provider should suggest.
+        /// </summary>
+        public int NumberOfItems { get; set; } = 10;
+
+        /// <summary>
+        ///     Add another item.
+        /// </summary>
+        /// <param name="suggestion"></param>
+        /// <param name="scoreMultiplier">Used by providers that are worth more. 1 = equally worth. Corresponds to "Weight" for partitions. At most 10.</param>
+        public void Add(RecommendedIncident suggestion, double scoreMultiplier)
+        {
+            if (suggestion == null) throw new ArgumentNullException(nameof(suggestion));
+
+            // Should only suggest the same incident once.
+            // thus if there are multiple suggestions for the same incident, increase the importance
+            // and include both motivations.
+            var first = _items.FirstOrDefault(x => x.IncidentId == suggestion.IncidentId);
+            if (first != null)
+            {
+                first.Score += (int)(suggestion.Score * scoreMultiplier);
+                first.Motivation += "\r\n" + suggestion.Motivation;
+                return;
+            }
+
+            _items.Add(suggestion);
+        }
+    }
+}

src/Server/Coderr.Server.App/Modules/Mine/RecommendationService.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Coderr.Server.Abstractions.Boot;
+using log4net;
+
+namespace Coderr.Server.App.Modules.Mine
+{
+    [ContainerService]
+    public class RecommendationService : IRecommendationService
+    {
+        private readonly IRecommendationProvider[] _providers;
+        private ILog _logger = LogManager.GetLogger(typeof(RecommendationService));
+
+        public RecommendationService(IEnumerable<IRecommendationProvider> providers)
+        {
+            _providers = providers.ToArray();
+        }
+
+        public async Task<List<RecommendedIncident>> GetRecommendations(int accountId, int? applicationId = null)
+        {
+            var items = new List<RecommendedIncident>();
+            var context = new RecommendIncidentContext(items) { AccountId = accountId, ApplicationId = applicationId };
+            foreach (var provider in _providers)
+            {
+                try
+                {
+                    await provider.Recommend(context);
+                }
+                catch (Exception ex)
+                {
+                    _logger.Error("Provider " + provider.GetType().FullName + " failed.", ex);
+                }
+
+            }
+
+            return items.OrderByDescending(x => x.Score).Take(10).ToList();
+        }
+    }
+}

src/Server/Coderr.Server.App/Modules/Mine/RecommendedIncident.cs

@@ -0,0 +1,51 @@
+namespace Coderr.Server.App.Modules.Mine
+{
+    /// <summary>
+    ///     A suggestion
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         The suggested incident service will enrich the information with incident details.
+    ///     </para>
+    /// </remarks>
+    public class RecommendedIncident
+    {
+        /// <summary>
+        ///     Application that the incident belongs to
+        /// </summary>
+        /// <remarks>
+        ///     <para>
+        ///         Will be enriched by the suggestion service if left 0
+        ///     </para>
+        /// </remarks>
+        public int ApplicationId { get; set; }
+
+        /// <summary>
+        ///     Name of the application
+        /// </summary>
+        /// <remarks>
+        ///     <para>
+        ///         Will be enriched by the suggestion service if left 0
+        ///     </para>
+        /// </remarks>
+        public string ApplicationName { get; set; }
+
+        /// <summary>
+        ///     Suggested incident
+        /// </summary>
+        public int IncidentId { get; set; }
+
+        /// <summary>
+        ///     Why this item was suggested.
+        /// </summary>
+        public string Motivation { get; set; }
+
+        /// <summary>
+        ///     Calculated score.
+        /// </summary>
+        /// <remarks>
+        ///     100 points should be distributed between all incidents that a provider recommends.
+        /// </remarks>
+        public int Score { get; set; }
+    }
+}

src/Server/Coderr.Server.SqlServer/Coderr - Backup.Server.SqlServer.csproj

@@ -0,0 +1,43 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <RootNamespace>Coderr.Server.SqlServer</RootNamespace>
+    <AssemblyName>Coderr.Server.SqlServer</AssemblyName>
+    <Configurations>Debug;Release;Premise</Configurations>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="DnsClient" Version="1.6.0" />
+    <PackageReference Include="DotNetCqs" Version="2.1.1" />
+    <PackageReference Include="Griffin.Framework" Version="2.1.1" />
+    <PackageReference Include="log4net" Version="2.0.14" />
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+    <PackageReference Include="System.Data.SqlClient" Version="4.8.3" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Coderr.Server.Api\Coderr.Server.Api.csproj" />
+    <ProjectReference Include="..\Coderr.Server.App\Coderr.Server.App.csproj" />
+    <ProjectReference Include="..\Coderr.Server.Domain\Coderr.Server.Domain.csproj" />
+    <ProjectReference Include="..\Coderr.Server.Infrastructure\Coderr.Server.Infrastructure.csproj" />
+    <ProjectReference Include="..\Coderr.Server.Abstractions\Coderr.Server.Abstractions.csproj" />
+    <ProjectReference Include="..\Coderr.Server.ReportAnalyzer.Abstractions\Coderr.Server.ReportAnalyzer.Abstractions.csproj" />
+    <ProjectReference Include="..\Coderr.Server.ReportAnalyzer\Coderr.Server.ReportAnalyzer.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="Schema\*.sql" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Remove="Schema\Coderr.v31.sql" />
+    <None Remove="Schema\Coderr.v32.sql" />
+    <None Remove="Schema\Coderr.v33.sql" />
+    <None Remove="Schema\Coderr.v34.sql" />
+    <None Remove="Schema\Coderr.v35.sql" />
+    <None Remove="Schema\Coderr.v36.sql" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Modules\Mine\Incidents\" />
+  </ItemGroup>
+</Project>

src/Server/Coderr.Server.SqlServer/Logs/LogsRepository.cs

@@ -6,7 +6,7 @@
 using Griffin.Data;
 using Newtonsoft.Json;
 
-namespace Coderr.Server.Common.Data.SqlServer.Logs
+namespace Coderr.Server.SqlServer.Logs
 {
     [ContainerService]
     public class LogsRepository : ILogsRepository

src/Server/Coderr.Server.SqlServer/Modules/Mine/Incidents/IncidentWithMostReportsProvider.cs

@@ -0,0 +1,50 @@
+using System.Linq;
+using System.Threading.Tasks;
+using Coderr.Server.Abstractions.Boot;
+using Coderr.Server.App.Modules.Mine;
+using Griffin.Data;
+using Griffin.Data.Mapper;
+
+namespace Coderr.Server.SqlServer.Modules.Mine.Incidents
+{
+    [ContainerService]
+    class IncidentWithMostReportsProvider : IRecommendationProvider
+    {
+        private readonly IAdoNetUnitOfWork _uow;
+
+        public IncidentWithMostReportsProvider(IAdoNetUnitOfWork uow)
+        {
+            _uow = uow;
+        }
+
+        public async Task Recommend(RecommendIncidentContext context)
+        {
+            var sql = context.ApplicationId > 0
+                ? $@"SELECT TOP(5) Incidents.Id IncidentId, Applications.Id as ApplicationId, Applications.Name as ApplicationName, ReportCount as Score, 'Replace' as Motivation
+                                FROM Incidents 
+                                JOIN Applications ON (Applications.Id = Incidents.ApplicationId)
+                                WHERE State = 0
+                                AND ApplicationId = {context.ApplicationId.Value}
+                                ORDER BY ReportCount DESC"
+                : $@"SELECT TOP(5) Incidents.Id IncidentId, Applications.Id as ApplicationId, Applications.Name as ApplicationName, ReportCount as Score, 'Replace' as Motivation
+                                FROM Incidents 
+                                JOIN Applications ON (Applications.Id = Incidents.ApplicationId)
+                                WHERE State = 0
+                                ORDER BY ReportCount DESC";
+
+            var items = await _uow.ToListAsync<RecommendedIncident>(new MirrorMapper<RecommendedIncident>(), sql);
+            if (!items.Any())
+                return;
+
+            var totalReports = (double)items.Sum(x => x.Score);
+            foreach (var item in items)
+            {
+                var count = item.Score;
+                item.Score = (int)((item.Score / totalReports) * 100);
+                item.Motivation = $"Frequently reported ({count:N0} times)";
+                context.Add(item, 1);
+            }
+
+        }
+    }
+}