Add sustainability dashboard, rename App_Plugins folder

Author: Rick Butterfield

src/Umbraco.Community.Sustainability.TestSite.10.x/.gitignore

@@ -478,5 +478,6 @@ appsettings-schema.json
 /wwwroot/media/
 
 # Test Site App_Plugins packages folder (exclude here as in Umbraco.Community.Sustainability project)
+/App_Plugins/UmbracoCommunitySustainability/
 /App_Plugins/Umbraco.Community.Sustainability/
 /App_Plugins/Bergmania.OpenStreetMap/

src/Umbraco.Community.Sustainability.TestSite.13.x/Views/Home.cshtml

@@ -1,4 +1,4 @@
-
+
 @using Umbraco.Extensions
 @using Umbraco.Cms.Web.Common.PublishedModels;
 @inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage<Home>
@@ -42,4 +42,4 @@
         </div>
     </div>
 
-</section>
+</section>

src/Umbraco.Community.Sustainability/Constants.cs

@@ -0,0 +1,10 @@
+namespace Umbraco.Community.Sustainability
+{
+    public static partial class Constants
+    {
+        public static string Alias => "sustainability";
+        public static string Name => "Sustainability";
+        public static string SectionAlias => Alias;
+        public static string DashboardAlias => $"{Alias}Dashboard";
+    }
+}

src/Umbraco.Community.Sustainability/ContentApps/SustainabilityContentApp.cs

@@ -23,7 +23,7 @@ public class SustainabilityContentApp : IContentAppFactory
                 Alias = "sustainabilityCheck",
                 Name = "Sustainability",
                 Icon = "icon-eco",
-                View = "/App_Plugins/Umbraco.Community.Sustainability/views/sustainability-content-app.html",
+                View = "/App_Plugins/UmbracoCommunitySustainability/views/sustainability-content-app.html",
                 Weight = 0
             };
         }

src/Umbraco.Community.Sustainability/Controllers/SustainabilityController.cs

@@ -1,6 +1,7 @@
 using System.Text.Json;
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Models.PublishedContent;
 using Umbraco.Cms.Web.BackOffice.Controllers;
 using Umbraco.Community.Sustainability.Models;
@@ -26,6 +27,54 @@ public SustainabilityController(
             _sustainabilityService = sustainabilityService;
         }
 
+        [HttpGet]
+        public async Task<IActionResult> GetOverviewData(int pageNumber = 1, int pageSize = 10, string orderBy = nameof(PageMetric.CarbonRating), Direction direction = Direction.Ascending)
+        {
+            var overviewMetrics = await _pageMetricService.GetOverviewMetrics();
+            int total = overviewMetrics.Count();
+
+            var filteredMetrics = overviewMetrics;
+
+            Func<PageMetric, object?>? filter = null;
+            switch (orderBy)
+            {
+                case nameof(PageMetric.CarbonRating):
+                    filter = x => x.CarbonRating;
+                    break;
+                case nameof(PageMetric.RequestDate):
+                    filter = x => x.RequestDate;
+                    break;
+                case nameof(PageMetric.TotalSize):
+                    filter = x => x.TotalSize;
+                    break;
+                case nameof(PageMetric.TotalEmissions):
+                    filter = x => x.TotalEmissions;
+                    break;
+            }
+
+            if (filter != null)
+            {
+                filteredMetrics = direction == Direction.Ascending ?
+                    filteredMetrics.OrderBy(filter) : filteredMetrics.OrderByDescending(filter);
+            }
+
+            filteredMetrics = filteredMetrics.Skip((pageNumber - 1) * pageSize).Take(pageSize);
+
+            PagedResult<PageMetric> pagedMetrics = new PagedResult<PageMetric>(total, pageNumber, pageSize)
+            {
+                Items = filteredMetrics
+            };
+
+            return Ok(pagedMetrics);
+        }
+
+        public async Task<IActionResult> GetAverageData()
+        {
+            var averageMetrics = await _pageMetricService.GetAverageMetrics();
+
+            return Ok(averageMetrics);
+        }
+
         [HttpGet]
         public async Task<IActionResult> GetPageData([FromQuery] int pageId)
         {

src/Umbraco.Community.Sustainability/Models/AveragePageMetrics.cs

@@ -0,0 +1,11 @@
+namespace Umbraco.Community.Sustainability.Models
+{
+    public class AveragePageMetrics
+    {
+        public AveragePageMetrics() { }
+
+        public string? CarbonRating { get; set; }
+        public decimal? PageSize { get; set; }
+        public decimal? Emissions { get; set; }
+    }
+}

src/Umbraco.Community.Sustainability/Schemas/PageMetricSchema.cs

@@ -17,6 +17,9 @@ public class PageMetric
         [Column("NodeId")]
         public int NodeId { get; set; }
 
+        [Ignore]
+        public string? NodeName { get; set; }
+
         [Column("RequestedBy")]
         [NullSetting(NullSetting = NullSettings.Null)]
         public string? RequestedBy { get; set; }

src/Umbraco.Community.Sustainability/Sections/SustainabilitySection.cs

@@ -0,0 +1,10 @@
+using Umbraco.Cms.Core.Sections;
+
+namespace Umbraco.Community.Sustainability.Sections
+{
+    public class SustainabilitySection : ISection
+    {
+        public string Alias => Constants.SectionAlias;
+        public string Name => Constants.Name;
+    }
+}

src/Umbraco.Community.Sustainability/Services/PageMetricService.cs

@@ -1,21 +1,59 @@
+using Umbraco.Cms.Core;
 using Umbraco.Cms.Infrastructure.Scoping;
+using Umbraco.Community.Sustainability.Models;
 using Umbraco.Community.Sustainability.Schemas;
 
 namespace Umbraco.Community.Sustainability.Services
 {
     public interface IPageMetricService
     {
+        Task<IEnumerable<PageMetric>> GetOverviewMetrics();
+        Task<AveragePageMetrics> GetAverageMetrics();
         Task<IEnumerable<PageMetric>> GetPageMetrics(int pageId);
         Task AddPageMetric(PageMetric pageMetric);
     }
 
     public class PageMetricService : IPageMetricService
     {
         private readonly IScopeProvider _scopeProvider;
+        private readonly IPublishedContentQuery _contentQuery;
 
-        public PageMetricService(IScopeProvider scopeProvider)
+        public PageMetricService(
+            IScopeProvider scopeProvider,
+            IPublishedContentQuery contentQuery)
         {
             _scopeProvider = scopeProvider;
+            _contentQuery = contentQuery;
+        }
+
+        public async Task<IEnumerable<PageMetric>> GetOverviewMetrics()
+        {
+            using var scope = _scopeProvider.CreateScope();
+            var queryResults = await scope.Database.FetchAsync<PageMetric>();
+
+            queryResults = queryResults.OrderByDescending(x => x.RequestDate).ToList();
+            queryResults = queryResults.DistinctBy(x => x.NodeId).ToList();
+
+            foreach (var result in queryResults)
+            {
+                var node = _contentQuery.Content(result.NodeId);
+                result.NodeName = node?.Name;
+            }
+
+            scope.Complete();
+
+            return queryResults;
+        }
+
+        public async Task<AveragePageMetrics> GetAverageMetrics()
+        {
+            var overviewMetrics = await GetOverviewMetrics();
+
+            return new AveragePageMetrics()
+            {
+                PageSize = overviewMetrics.Sum(x => x.TotalSize) / overviewMetrics.Count(),
+                Emissions = overviewMetrics.Sum(x => x.TotalEmissions) / overviewMetrics.Count(),
+            };
         }
 
         public async Task<IEnumerable<PageMetric>> GetPageMetrics(int pageId)

src/Umbraco.Community.Sustainability/Services/SustainabilityService.cs

@@ -25,7 +25,7 @@ public async Task<SustainabilityResponse> GetSustainabilityData(string url)
             // Add our script to report data
             await page.AddScriptTagAsync(new PageAddScriptTagOptions()
             {
-                Url = "/App_Plugins/Umbraco.Community.Sustainability/js/resource-checker.js",
+                Url = "/App_Plugins/UmbracoCommunitySustainability/js/resource-checker.js",
                 Type = "module"
             });