Added test project and fixed v0.5 admin routing updates.

HeyJoel · HeyJoel · commit 64ee4645999d · 2018-09-19T16:00:14.000+01:00
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Cofoundry.Plugins.ErrorLogging.Admin.csproj b/src/Cofoundry.Plugins.ErrorLogging.Admin/Cofoundry.Plugins.ErrorLogging.Admin.csproj
@@ -15,7 +15,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cofoundry.Web.Admin" Version="0.4.1" />
+    <PackageReference Include="Cofoundry.Web.Admin" Version="0.5.0-beta0004" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Api/ErrorLoggingApiRouteRegistration.cs b/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Api/ErrorLoggingApiRouteRegistration.cs
@@ -0,0 +1,23 @@
+﻿using Cofoundry.Web;
+using Microsoft.AspNetCore.Routing;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Cofoundry.Web.Admin;
+
+namespace Cofoundry.Plugins.ErrorLogging.Admin
+{
+    public class ErrorLoggingApiRouteRegistration : IOrderedRouteRegistration
+    {
+        public int Ordering => (int)RouteRegistrationOrdering.Early;
+
+        public void RegisterRoutes(IRouteBuilder routeBuilder)
+        {
+            routeBuilder
+                .ForAdminApiController<ErrorsApiController>("plugins/errors")
+                .MapGet()
+                .MapGetById("{errorId:int}")
+                ;
+        }
+    }
+}
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Api/Errors/ErrorsApiController.cs b/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Api/Errors/ErrorsApiController.cs
@@ -10,7 +10,6 @@
 
 namespace Cofoundry.Plugins.ErrorLogging.Admin
 {
-    [Route(RouteConstants.PluginApiRoutePrefix + "/Errors")]
     public class ErrorsApiController : BaseAdminApiController
     {
         private const string ID_ROUTE = "{errorId:int}";
@@ -27,7 +26,6 @@ IApiResponseHelper apiResponseHelper
             _apiResponseHelper = apiResponseHelper;
         }
 
-        [HttpGet]
         public async Task<IActionResult> Get([FromQuery] SearchErrorSummariesQuery query)
         {
             if (query == null) query = new SearchErrorSummariesQuery();
@@ -36,8 +34,7 @@ public async Task<IActionResult> Get([FromQuery] SearchErrorSummariesQuery query
             return _apiResponseHelper.SimpleQueryResponse(this, results);
         }
         
-        [HttpGet(ID_ROUTE)]
-        public async Task<IActionResult> Get(int errorId)
+        public async Task<IActionResult> GetById(int errorId)
         {
             var query = new GetErrorDetailsByIdQuery(errorId);
             var result = await _queryExecutor.ExecuteAsync(query);
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Bootstrap/ErrorsModuleRegistration.cs b/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Bootstrap/ErrorsModuleRegistration.cs
@@ -9,6 +9,13 @@ namespace Cofoundry.Plugins.ErrorLogging.Admin
 {
     public class ErrorsModuleRegistration : IPluginAngularModuleRegistration
     {
+        private readonly AdminSettings _adminSettings;
+
+        public ErrorsModuleRegistration(AdminSettings adminSettings)
+        {
+            _adminSettings = adminSettings;
+        }
+
         public AdminModule GetModule()
         {
             var module = new AdminModule()
@@ -18,7 +25,7 @@ public AdminModule GetModule()
                 Description = "View the site error logs.",
                 MenuCategory = AdminModuleMenuCategory.Settings,
                 PrimaryOrdering = AdminModuleMenuPrimaryOrdering.Tertiary,
-                Url = new ErrorsRouteLibrary().List(),
+                Url = new ErrorsRouteLibrary(_adminSettings).List(),
                 RestrictedToPermission = new ErrorLogReadPermission()
             };
 
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Constants/ErrorsRouteLibrary.cs b/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Constants/ErrorsRouteLibrary.cs
@@ -1,4 +1,5 @@
-﻿using Cofoundry.Web.Admin;
+﻿using Cofoundry.Domain;
+using Cofoundry.Web.Admin;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -7,23 +8,13 @@ namespace Cofoundry.Plugins.ErrorLogging.Admin
 {
     public class ErrorsRouteLibrary : ModuleRouteLibrary
     {
-        #region statics
-
         public const string RoutePrefix = "errors";
 
-        #endregion
-
-        #region constructor
-
-        public ErrorsRouteLibrary()
-            : base(RoutePrefix, RouteConstants.PluginModuleResourcePathPrefix)
+        public ErrorsRouteLibrary(AdminSettings adminSetting)
+            : base(adminSetting, RoutePrefix, RouteConstants.PluginModuleResourcePathPrefix)
         {
         }
 
-        #endregion
-
-        #region routes
-
         public string List()
         {
             return AngularRoute();
@@ -33,7 +24,5 @@ public string Details(int id)
         {
             return AngularRoute(id.ToString());
         }
-
-        #endregion
     }
 }
diff --git a/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Content/js/errors_min.js b/src/Cofoundry.Plugins.ErrorLogging.Admin/Plugins/Admin/Modules/Errors/Content/js/errors_min.js
diff --git a/src/Cofoundry.Plugins.ErrorLogging.sln b/src/Cofoundry.Plugins.ErrorLogging.sln
@@ -3,9 +3,13 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.26430.13
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cofoundry.Plugins.ErrorLogging", "Cofoundry.Plugins.ErrorLogging\Cofoundry.Plugins.ErrorLogging.csproj", "{770CBAB8-61A8-4B87-8A03-B142BB61599A}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cofoundry.Plugins.ErrorLogging", "Cofoundry.Plugins.ErrorLogging\Cofoundry.Plugins.ErrorLogging.csproj", "{770CBAB8-61A8-4B87-8A03-B142BB61599A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cofoundry.Plugins.ErrorLogging.Admin", "Cofoundry.Plugins.ErrorLogging.Admin\Cofoundry.Plugins.ErrorLogging.Admin.csproj", "{6C9E6D5E-2591-4F1C-966D-31E2E3FF84CB}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cofoundry.Plugins.ErrorLogging.Admin", "Cofoundry.Plugins.ErrorLogging.Admin\Cofoundry.Plugins.ErrorLogging.Admin.csproj", "{6C9E6D5E-2591-4F1C-966D-31E2E3FF84CB}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{FA681052-563E-46F8-8346-48E1E6747041}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ErrorLoggingExample", "ErrorLoggingExample\ErrorLoggingExample.csproj", "{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -21,8 +25,18 @@ Global
 		{6C9E6D5E-2591-4F1C-966D-31E2E3FF84CB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6C9E6D5E-2591-4F1C-966D-31E2E3FF84CB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6C9E6D5E-2591-4F1C-966D-31E2E3FF84CB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{73C1E2F0-B848-4EEB-A1A6-36CD96F2CE62} = {FA681052-563E-46F8-8346-48E1E6747041}
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {03096141-C2F9-4E8F-BCA8-3DDC89D62D1D}
+	EndGlobalSection
 EndGlobal
diff --git a/src/Cofoundry.Plugins.ErrorLogging/Cofoundry.Plugins.ErrorLogging.csproj b/src/Cofoundry.Plugins.ErrorLogging/Cofoundry.Plugins.ErrorLogging.csproj
@@ -15,7 +15,7 @@
   </PropertyGroup>
   
   <ItemGroup>
-    <PackageReference Include="Cofoundry.Web" Version="0.4.1" />
+    <PackageReference Include="Cofoundry.Web" Version="0.5.0-beta0004" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ErrorLoggingExample/Controllers/TestController.cs b/src/ErrorLoggingExample/Controllers/TestController.cs
@@ -0,0 +1,17 @@
+﻿using Microsoft.AspNetCore.Mvc;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace ErrorLoggingExample.Controllers
+{
+    public class TestController : Controller
+    {
+        [Route("test")]
+        public IActionResult Index()
+        {
+            throw new Exception("Test Exception.");
+        }
+    }
+}
diff --git a/src/ErrorLoggingExample/ErrorLoggingExample.csproj b/src/ErrorLoggingExample/ErrorLoggingExample.csproj
@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="wwwroot\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Cofoundry.Web.Admin" Version="0.5.0-beta0004" />
+    <PackageReference Include="Microsoft.AspNetCore.App" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Cofoundry.Plugins.ErrorLogging.Admin\Cofoundry.Plugins.ErrorLogging.Admin.csproj" />
+    <ProjectReference Include="..\Cofoundry.Plugins.ErrorLogging\Cofoundry.Plugins.ErrorLogging.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/src/ErrorLoggingExample/Program.cs b/src/ErrorLoggingExample/Program.cs
@@ -0,0 +1,28 @@
+﻿using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+
+namespace ErrorLoggingExample
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateWebHostBuilder(args).Build().Run();
+        }
+
+        public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost
+            .CreateDefaultBuilder(args)
+            .UseStartup<Startup>()
+            .ConfigureAppConfiguration((hostContext, config) =>
+            {
+                config.AddJsonFile("appsettings.local.json", optional: true);
+            });
+    }
+}
diff --git a/src/ErrorLoggingExample/Properties/launchSettings.json b/src/ErrorLoggingExample/Properties/launchSettings.json
@@ -0,0 +1,27 @@
+﻿{
+  "iisSettings": {
+    "windowsAuthentication": false, 
+    "anonymousAuthentication": true, 
+    "iisExpress": {
+      "applicationUrl": "http://localhost:59589",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "ErrorLoggingExample": {
+      "commandName": "Project",
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/src/ErrorLoggingExample/Startup.cs b/src/ErrorLoggingExample/Startup.cs
@@ -0,0 +1,33 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Cofoundry.Web;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace ErrorLoggingExample
+{
+    public class Startup
+    {
+        public IConfiguration Configuration { get; }
+
+        public Startup(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services
+                .AddMvc()
+                .AddCofoundry(Configuration);
+        }
+
+        public void Configure(IApplicationBuilder app)
+        {
+            app.UseCofoundry();
+        }
+    }
+}
diff --git a/src/ErrorLoggingExample/appsettings.json b/src/ErrorLoggingExample/appsettings.json
@@ -0,0 +1,5 @@
+﻿{
+  "Cofoundry": {
+    "Database:ConnectionString": "Server=.\\sqlexpress;Database=Cofoundry.ErrorLoggingExample;Integrated Security=True;MultipleActiveResultSets=True"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@`
`10`	`10`
`11`	`11`	`namespace Cofoundry.Plugins.ErrorLogging.Admin`
`12`	`12`	`{`
`13`		`- [Route(RouteConstants.PluginApiRoutePrefix + "/Errors")]`
`14`	`13`	`public class ErrorsApiController : BaseAdminApiController`
`15`	`14`	`{`
`16`	`15`	`private const string ID_ROUTE = "{errorId:int}";`
`@@ -27,7 +26,6 @@ IApiResponseHelper apiResponseHelper`
`27`	`26`	`_apiResponseHelper = apiResponseHelper;`
`28`	`27`	`}`
`29`	`28`
`30`		`- [HttpGet]`
`31`	`29`	`public async Task<IActionResult> Get([FromQuery] SearchErrorSummariesQuery query)`
`32`	`30`	`{`
`33`	`31`	`if (query == null) query = new SearchErrorSummariesQuery();`
`@@ -36,8 +34,7 @@ public async Task<IActionResult> Get([FromQuery] SearchErrorSummariesQuery query`
`36`	`34`	`return _apiResponseHelper.SimpleQueryResponse(this, results);`
`37`	`35`	`}`
`38`	`36`
`39`		`- [HttpGet(ID_ROUTE)]`
`40`		`- public async Task<IActionResult> Get(int errorId)`
	`37`	`+ public async Task<IActionResult> GetById(int errorId)`
`41`	`38`	`{`
`42`	`39`	`var query = new GetErrorDetailsByIdQuery(errorId);`
`43`	`40`	`var result = await _queryExecutor.ExecuteAsync(query);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using Cofoundry.Web.Admin;`
	`1`	`+using Cofoundry.Domain;`
	`2`	`+using Cofoundry.Web.Admin;`
`2`	`3`	`using System;`
`3`	`4`	`using System.Collections.Generic;`
`4`	`5`	`using System.Linq;`
`@@ -7,23 +8,13 @@ namespace Cofoundry.Plugins.ErrorLogging.Admin`
`7`	`8`	`{`
`8`	`9`	`public class ErrorsRouteLibrary : ModuleRouteLibrary`
`9`	`10`	`{`
`10`		`- #region statics`
`11`		`-`
`12`	`11`	`public const string RoutePrefix = "errors";`
`13`	`12`
`14`		`- #endregion`
`15`		`-`
`16`		`- #region constructor`
`17`		`-`
`18`		`- public ErrorsRouteLibrary()`
`19`		`- : base(RoutePrefix, RouteConstants.PluginModuleResourcePathPrefix)`
	`13`	`+ public ErrorsRouteLibrary(AdminSettings adminSetting)`
	`14`	`+ : base(adminSetting, RoutePrefix, RouteConstants.PluginModuleResourcePathPrefix)`
`20`	`15`	`{`
`21`	`16`	`}`
`22`	`17`
`23`		`- #endregion`
`24`		`-`
`25`		`- #region routes`
`26`		`-`
`27`	`18`	`public string List()`
`28`	`19`	`{`
`29`	`20`	`return AngularRoute();`
`@@ -33,7 +24,5 @@ public string Details(int id)`
`33`	`24`	`{`
`34`	`25`	`return AngularRoute(id.ToString());`
`35`	`26`	`}`
`36`		`-`
`37`		`- #endregion`
`38`	`27`	`}`
`39`	`28`	`}`