Merge pull request #1 from rickbutterfield/feature/db-table

Add page metrics table

Author: rickbutterfield

src/Umbraco.Community.Sustainability/Composers/PageMetricsComposer.cs

@@ -0,0 +1,15 @@
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Cms.Core.DependencyInjection;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Community.Sustainability.Notifications;
+
+namespace Umbraco.Community.Sustainability.Composers
+{
+    public class PageMetricsComposer : IComposer
+    {
+        public void Compose(IUmbracoBuilder builder)
+        {
+            builder.AddNotificationHandler<UmbracoApplicationStartingNotification, PageMetricsNotificationHandler>();
+        }
+    }
+}

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

@@ -0,0 +1,54 @@
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Infrastructure.Scoping;
+using Umbraco.Cms.Web.Common.Controllers;
+using Umbraco.Community.Sustainability.Models;
+using Umbraco.Community.Sustainability.Schemas;
+
+namespace Umbraco.Community.Sustainability.Controllers
+{
+    public class PageMetricsController : UmbracoApiController
+    {
+        private readonly IScopeProvider _scopeProvider;
+
+        public PageMetricsController(IScopeProvider scopeProvider)
+        {
+            _scopeProvider = scopeProvider;
+        }
+
+        [HttpGet]
+        public IEnumerable<PageMetric> GetPageMetrics(int pageId)
+        {
+            using var scope = _scopeProvider.CreateScope();
+            var queryResults = scope.Database.Fetch<PageMetric>($"SELECT * FROM {PageMetric.TableName} WHERE NodeId = @0", pageId);
+            scope.Complete();
+
+            return queryResults;
+        }
+
+        [HttpGet]
+        public void TestData()
+        {
+            var rand = new Random();
+            var pageMetric = new PageMetric()
+            {
+                NodeId = 1,
+                RequestedBy = "Thomas",
+                RequestDate = DateTime.Now,
+                PageWeight = new decimal(rand.NextDouble()),
+                PageData = "example data"
+            };
+
+            using var scope = _scopeProvider.CreateScope();
+            scope.Database.Insert(pageMetric);
+            scope.Complete();
+        }
+
+        [HttpPost]
+        public void AddPageMetric(PageMetric pageMetric)
+        {
+            using var scope = _scopeProvider.CreateScope();
+            scope.Database.Insert(pageMetric);
+            scope.Complete();
+        }
+    }
+}

src/Umbraco.Community.Sustainability/Migrations/AddPageMetricsTable.cs

@@ -0,0 +1,27 @@
+using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Infrastructure.Migrations;
+using Umbraco.Community.Sustainability.Schemas;
+
+namespace Umbraco.Community.Sustainability.Migrations
+{
+    public class AddPageMetricsTable : MigrationBase
+    {
+        public AddPageMetricsTable(IMigrationContext context) : base(context)
+        {
+        }
+
+        protected override void Migrate()
+        {
+            Logger.LogDebug("Running migration {MigrationStep}", "AddPageMetricsTable");
+
+            if (TableExists(PageMetric.TableName) == false)
+            {
+                Create.Table<PageMetric>().Do();
+            }
+            else
+            {
+                Logger.LogDebug("The database table {DbTable} already exists, skipping", PageMetric.TableName);
+            }
+        }
+    }
+}

src/Umbraco.Community.Sustainability/Notifications/PageMetricsNotificationHandler.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Cms.Core.Events;
+using Umbraco.Cms.Core.Migrations;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Cms.Core.Scoping;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Infrastructure.Migrations.Upgrade;
+using Umbraco.Cms.Infrastructure.Migrations;
+using Umbraco.Community.Sustainability.Migrations;
+using Umbraco.Community.Sustainability.Schemas;
+
+namespace Umbraco.Community.Sustainability.Notifications
+{
+    public class PageMetricsNotificationHandler : INotificationHandler<UmbracoApplicationStartingNotification>
+    {
+        private readonly IMigrationPlanExecutor _migrationPlanExecutor;
+        private readonly ICoreScopeProvider _coreScopeProvider;
+        private readonly IKeyValueService _keyValueService;
+        private readonly IRuntimeState _runtimeState;
+
+        public PageMetricsNotificationHandler(
+            ICoreScopeProvider coreScopeProvider,
+            IMigrationPlanExecutor migrationPlanExecutor,
+            IKeyValueService keyValueService,
+            IRuntimeState runtimeState)
+        {
+            _migrationPlanExecutor = migrationPlanExecutor;
+            _coreScopeProvider = coreScopeProvider;
+            _keyValueService = keyValueService;
+            _runtimeState = runtimeState;
+        }
+
+        public void Handle(UmbracoApplicationStartingNotification notification)
+        {
+            if (_runtimeState.Level < RuntimeLevel.Run)
+            {
+                return;
+            }
+
+            // Create a migration plan for a specific project/feature
+            // We can then track that latest migration state/step for this project/feature
+            var migrationPlan = new MigrationPlan(PageMetric.TableName);
+
+            // This is the steps we need to take
+            // Each step in the migration adds a unique value
+            migrationPlan.From(string.Empty)
+                .To<AddPageMetricsTable>("pagemetrics-init");
+
+            // Go and upgrade our site (Will check if it needs to do the work or not)
+            // Based on the current/latest step
+            var upgrader = new Upgrader(migrationPlan);
+            upgrader.Execute(
+                _migrationPlanExecutor,
+                _coreScopeProvider,
+                _keyValueService);
+        }
+    }
+}

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

@@ -0,0 +1,33 @@
+using NPoco;
+using Umbraco.Cms.Infrastructure.Persistence.DatabaseAnnotations;
+
+namespace Umbraco.Community.Sustainability.Schemas
+{
+    [TableName(TableName)]
+    [PrimaryKey("Id", AutoIncrement = true)]
+    [ExplicitColumns]
+    public class PageMetric
+    {
+        public const string TableName = "umbPageMetrics";
+
+        [PrimaryKeyColumn(AutoIncrement = true, IdentitySeed = 1)]
+        [Column("Id")]
+        public int Id { get; set; }
+
+        [Column("NodeId")]
+        public int NodeId { get; set; }
+
+        [Column("RequestedBy")]
+        public string RequestedBy { get; set; }
+
+        [Column("RequestDate")]
+        public DateTime RequestDate { get; set; }
+
+        [Column("PageWeight")]
+        public decimal PageWeight { get; set; }
+
+        [SpecialDbType(SpecialDbTypes.NVARCHARMAX)]
+        [NullSetting(NullSetting = NullSettings.Null)]
+        public string? PageData { get; set; }
+    }
+}