Feature/58454 logon events and MI views (#2487)

* views to surface json data and sum distinct school logins

* remove unused output

* docs

* surface more data from dfe signin

* views

---------

Co-authored-by: Mohsen Qureshi <[email protected]>

admin/services/dfe-signin.service.js

@@ -15,6 +15,7 @@ const service = {
   /**
    * @description maps an authenticated dfe sign-in user to an MTC user, school and role
    * @param {object} dfeUser all decrypted user information sent in the request payload
+   * @param {object} tokenset identification data associated with login provider
    */
   initialiseUser: async (dfeUser, tokenset) => {
     if (!dfeUser) {
@@ -101,6 +102,9 @@ const service = {
 
     if (schoolRecord) {
       logonEvent.school_id = schoolRecord.id
+      logonEvent.urn = dfeUser.organisation.urn
+      logonEvent.mtcRole = dfeUser.role
+      logonEvent.dfeRole = dfeRole
     }
 
     await adminLogonEventDataService.sqlCreate(logonEvent)

db/migrations/schema-objects/20230404110400.do.admin-logon-event-urn-column.sql

@@ -0,0 +1,9 @@
+IF NOT EXISTS(
+                SELECT *
+                FROM sys.columns
+               WHERE object_ID = object_id('mtc_admin.adminLogonEvent')
+                 AND col_name(object_ID, column_Id) = 'urn')
+    BEGIN
+        ALTER TABLE [mtc_admin].[adminLogonEvent]
+            ADD [urn] int NULL;
+    END

db/migrations/schema-objects/20230404110400.undo.admin-logon-event-urn-column.sql

@@ -0,0 +1 @@
+ALTER TABLE [mtc_admin].[adminLogonEvent] DROP COLUMN IF EXISTS [urn];

db/migrations/schema-objects/20230404110716.do.admin-logon-event-mtcrole-column.sql

@@ -0,0 +1,9 @@
+IF NOT EXISTS(
+                SELECT *
+                FROM sys.columns
+               WHERE object_ID = object_id('mtc_admin.adminLogonEvent')
+                 AND col_name(object_ID, column_Id) = 'mtcRole')
+    BEGIN
+        ALTER TABLE [mtc_admin].[adminLogonEvent]
+            ADD [mtcRole] nvarchar(50) NULL;
+    END

db/migrations/schema-objects/20230404110716.undo.admin-logon-event-mtcrole-column.sql

@@ -0,0 +1 @@
+ALTER TABLE [mtc_admin].[adminLogonEvent] DROP COLUMN IF EXISTS [mtcRole];

db/migrations/schema-objects/20230404111132.do.admin-logon-event-dferole-column.sql

@@ -0,0 +1,9 @@
+IF NOT EXISTS(
+                SELECT *
+                FROM sys.columns
+               WHERE object_ID = object_id('mtc_admin.adminLogonEvent')
+                 AND col_name(object_ID, column_Id) = 'dfeRole')
+    BEGIN
+        ALTER TABLE [mtc_admin].[adminLogonEvent]
+            ADD [dfeRole] nvarchar(max) NULL;
+    END

db/migrations/schema-objects/20230404111132.undo.admin-logon-event-dferole-column.sql

@@ -0,0 +1 @@
+ALTER TABLE [mtc_admin].[adminLogonEvent] DROP COLUMN IF EXISTS [dfeRole];

db/migrations/schema-objects/20230404112801.do.vew-mi-checks-with-errors.sql

@@ -0,0 +1,4 @@
+CREATE OR ALTER VIEW mtc_admin.[vewMiChecksWithErrors] AS
+  SELECT COUNT(chk.id) as [numberOfChecksWithErrors]
+    FROM [mtc_admin].[check] chk
+    WHERE chk.processingFailed = 1

db/migrations/schema-objects/20230404112801.undo.vew-mi-checks-with-errors.sql

@@ -0,0 +1 @@
+DROP VIEW IF EXISTS mtc_admin.[vewMiChecksWithErrors];

db/migrations/schema-objects/20230404113200.do.vew-mi-checks-not-started.sql

@@ -0,0 +1,4 @@
+CREATE OR ALTER VIEW mtc_admin.[vewMiChecksNotStarted] AS
+  SELECT COUNT(chk.id) as [numberOfChecksNotStarted]
+    FROM [mtc_admin].[check] chk
+    WHERE chk.startedAt IS NULL AND chk.isLiveCheck = 1

db/migrations/schema-objects/20230404113200.undo.vew-mi-checks-not-started.sql

@@ -0,0 +1 @@
+DROP VIEW IF EXISTS mtc_admin.[vewMiChecksNotStarted];

db/migrations/schema-objects/20230404115415.do.vew-mi-schools-logged-on-at-least-once.sql

@@ -0,0 +1,4 @@
+CREATE OR ALTER VIEW mtc_admin.[vewMiSchoolsLoggedOnAtLeastOnce] AS
+  SELECT COUNT(DISTINCT ale.urn) as [numberOfSchoolsAccessedService]
+    FROM [mtc_admin].[adminLogonEvent] ale
+    WHERE ale.mtcRole = 'TEACHER'

db/migrations/schema-objects/20230404115415.undo.vew-mi-schools-logged-on-at-least-once.sql

@@ -0,0 +1 @@
+DROP VIEW IF EXISTS mtc_admin.[vewMiSchoolsLoggedOnAtLeastOnce];