Feature/55184 update school audit trigger (#2339)

* Update assets version

* Update trigger

* Update ms-sql version

Attempt to fix the issue that triggers cannot be ALTERed without error.

* Update migrations - scope

* Make azure-sql-edge the default for local dev

* Drop FK constraint from schoolAudit table

* Handle DELETE ops in school audit trigger

* Fix: remove FK from pupilAudit

* Update pupil audit trigger  - now handles deletes

admin/package.json

@@ -30,7 +30,7 @@
     "watch:integration": "yarn jest --watch --coverage=no --config ./tests-integration/jest.integration.config.js"
   },
   "mtc": {
-    "assets-version": "35403e1d6d0f5f675c028f29d5629ce0"
+    "assets-version": "e3cf7309a51a6a6af117a4d5f04dedec"
   },
   "engines": {
     "node": ">= 14"

db/migrations/schema-objects/20221122163818.do.fix-school-audit-trigger.sql

@@ -0,0 +1,84 @@
+CREATE OR ALTER TRIGGER  [mtc_admin].[schoolInsertUpdateAuditTrigger] ON [mtc_admin].[school]
+AFTER INSERT, UPDATE, DELETE
+AS
+BEGIN
+    DECLARE @auditOperationTypeLookupId int;
+    DECLARE @newDataJson NVARCHAR(MAX);
+    DECLARE @updatedTimestamp DATETIMEOFFSET(3) = GETUTCDATE();
+    DECLARE @schoolId INT;
+    -- infer audit type, populate var
+    IF EXISTS (SELECT 1 FROM inserted)
+        BEGIN
+            IF EXISTS (SELECT 1 FROM deleted)
+                BEGIN
+                    -- I am an update
+                    SELECT @auditOperationTypeLookupId=2
+                    SELECT @schoolId = id FROM inserted
+                    -- incorporate updatedAt trigger logic, to avoid duplicate audit entries
+                    UPDATE [mtc_admin].[school] SET updatedAt = @updatedTimestamp
+                    WHERE id = @schoolId
+                END
+            ELSE
+                BEGIN
+                    -- I am an insert
+                    SELECT @auditOperationTypeLookupId=1
+                END
+        END
+    ELSE
+        BEGIN
+            -- Delete operation
+            SELECT @auditOperationTypeLookupId=3
+        END
+
+    DECLARE @lastModifiedBy_userId int
+    DECLARE db_cursor CURSOR FOR
+        SELECT i.id, i.lastModifiedBy_userId
+        FROM inserted i;
+    DECLARE db_deleted_cursor CURSOR FOR
+        SELECT d.id, d.lastModifiedBy_userId
+        FROM deleted d;
+
+    IF @auditOperationTypeLookupId IN (1,2)
+      BEGIN
+        OPEN db_cursor
+        FETCH NEXT FROM db_cursor INTO @schoolId, @lastModifiedBy_userId
+        WHILE @@FETCH_STATUS = 0
+          BEGIN
+          SELECT @newDataJson = (SELECT TOP 1 * FROM inserted i WHERE i.id = @schoolId FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER);
+            -- incorporate updatedAt trigger logic, to avoid duplicate audit entries
+            IF @auditOperationTypeLookupId = 2
+              BEGIN
+                UPDATE [mtc_admin].[school] SET updatedAt = @updatedTimestamp WHERE id = @schoolId;
+                SET @newDataJson = JSON_MODIFY(@newDataJson, '$.updatedAt', CAST(@updatedTimestamp AS NVARCHAR));
+              END
+            -- do insert into school audit
+            INSERT INTO [mtc_admin].[schoolAudit]
+              (auditOperationTypeLookup_id, newData, school_id, operationBy_userId, sqlUserIdentifier)
+            VALUES (@auditOperationTypeLookupId, @newDataJson, @schoolId, @lastModifiedBy_userId, SUSER_SNAME());
+
+            FETCH NEXT FROM db_cursor INTO @schoolId, @lastModifiedBy_userId
+          END
+
+        CLOSE db_cursor
+        DEALLOCATE db_cursor
+      END
+
+      IF @auditOperationTypeLookupId = 3
+      BEGIN
+        OPEN db_deleted_cursor
+        FETCH NEXT FROM db_deleted_cursor INTO @schoolId, @lastModifiedBy_userId
+        WHILE @@FETCH_STATUS = 0
+          BEGIN
+            SELECT @newDataJson = (SELECT TOP 1 * FROM deleted d WHERE d.id = @schoolId FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER);
+            -- do insert into school audit
+            INSERT INTO [mtc_admin].[schoolAudit]
+              (auditOperationTypeLookup_id, newData, school_id, operationBy_userId, sqlUserIdentifier)
+            VALUES (@auditOperationTypeLookupId, @newDataJson, @schoolId, @lastModifiedBy_userId, SUSER_SNAME());
+
+            FETCH NEXT FROM db_deleted_cursor INTO @schoolId, @lastModifiedBy_userId
+          END
+
+        CLOSE db_deleted_cursor
+        DEALLOCATE db_deleted_cursor
+      END
+END

db/migrations/schema-objects/20221122163818.undo.fix-school-audit-trigger.sql

@@ -0,0 +1,43 @@
+CREATE OR ALTER TRIGGER [mtc_admin].[schoolInsertUpdateAuditTrigger] ON [mtc_admin].[school]
+AFTER INSERT, UPDATE
+AS
+BEGIN
+    DECLARE @auditOperationTypeLookupId int
+    DECLARE @newDataJson NVARCHAR(MAX)
+    DECLARE @updatedTimestamp DATETIMEOFFSET(3) = GETUTCDATE()
+    -- infer audit type, populate var
+    IF EXISTS (SELECT 1 FROM inserted)
+        BEGIN
+            IF EXISTS (SELECT 1 FROM deleted)
+                BEGIN
+                    -- I am an update
+                    SELECT @auditOperationTypeLookupId=2
+                    DECLARE @schoolId INT
+                    SELECT @schoolId = id FROM inserted
+                    -- incorporate updatedAt trigger logic, to avoid duplicate audit entries
+                    UPDATE [mtc_admin].[school] SET updatedAt = @updatedTimestamp
+                    WHERE id = @schoolId
+                END
+            ELSE
+                BEGIN
+                    -- I am an insert
+                    SELECT @auditOperationTypeLookupId=1
+                END
+        END
+    ELSE
+        BEGIN
+            -- I am a delete (not currently supported)
+            SELECT @auditOperationTypeLookupId=3
+        END
+    -- grab incoming data as JSON
+    SELECT @newDataJson = (SELECT * FROM inserted FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER)
+
+    SET @newDataJson = JSON_MODIFY(@newDataJson, '$.updatedAt', CAST(@updatedTimestamp AS NVARCHAR))
+
+    INSERT INTO [mtc_admin].[schoolAudit]
+    (auditOperationTypeLookup_id, newData, school_id, operationBy_userId, sqlUserIdentifier)
+
+    SELECT @auditOperationTypeLookupId, @newDataJson, i.id, i.lastModifiedBy_userId, SUSER_SNAME()
+    FROM mtc_admin.school s
+    INNER JOIN inserted i ON s.id = i.id
+END

db/migrations/schema-objects/20221123132323.do.remove-fk-from-school-audit.sql

@@ -0,0 +1,2 @@
+ ALTER TABLE [mtc_admin].[schoolAudit]
+    DROP CONSTRAINT IF EXISTS [FK_school_id];

db/migrations/schema-objects/20221123132323.undo.remove-fk-from-school-audit.sql

@@ -0,0 +1,11 @@
+IF NOT EXISTS(SELECT *
+                FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE
+               WHERE CONSTRAINT_COLUMN_USAGE.TABLE_SCHEMA = 'mtc_admin'
+                 AND CONSTRAINT_COLUMN_USAGE.TABLE_NAME = 'schoolAudit'
+                 AND CONSTRAINT_COLUMN_USAGE.COLUMN_NAME = 'school_id'
+                 AND CONSTRAINT_NAME = 'FK_school_id')
+    BEGIN
+        ALTER TABLE [mtc_admin].[schoolAudit]
+            ADD CONSTRAINT [FK_school_id]
+                FOREIGN KEY (school_id) REFERENCES [mtc_admin].[school] (id);
+    END

db/migrations/schema-objects/20221125103800.do.alter-pupil-audit-remove-fk.sql

@@ -0,0 +1,2 @@
+ ALTER TABLE [mtc_admin].[pupilAudit]
+    DROP CONSTRAINT IF EXISTS [FK_pupilAudit_pupil_id];

db/migrations/schema-objects/20221125103800.undo.alter-pupil-audit-remove-fk.sql

@@ -0,0 +1,11 @@
+IF NOT EXISTS(SELECT *
+                FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE
+               WHERE CONSTRAINT_COLUMN_USAGE.TABLE_SCHEMA = 'mtc_admin'
+                 AND CONSTRAINT_COLUMN_USAGE.TABLE_NAME = 'pupilAudit'
+                 AND CONSTRAINT_COLUMN_USAGE.COLUMN_NAME = 'pupil_id'
+                 AND CONSTRAINT_NAME = 'FK_pupilAudit_pupil_id')
+    BEGIN
+        ALTER TABLE [mtc_admin].[pupilAudit]
+            ADD CONSTRAINT [FK_pupilAudit_pupil_id]
+                FOREIGN KEY (pupil_id) REFERENCES [mtc_admin].[pupil] (id);
+    END

db/migrations/schema-objects/20221125104853.do.alter-pupil-audit-trigger.sql

@@ -0,0 +1,82 @@
+CREATE OR ALTER TRIGGER [mtc_admin].[pupilInsertUpdateAuditTrigger] ON [mtc_admin].[pupil]
+AFTER INSERT, UPDATE, DELETE
+AS
+BEGIN
+    DECLARE @auditOperationTypeLookupId int
+    DECLARE @newDataJson NVARCHAR(MAX)
+    DECLARE @updatedTimestamp DATETIMEOFFSET(3) = GETUTCDATE()
+    -- infer audit type, populate var
+    IF EXISTS (SELECT 1 FROM inserted)
+        BEGIN
+            IF EXISTS (SELECT 1 FROM deleted)
+                BEGIN
+                    -- I am an update
+                    SELECT @auditOperationTypeLookupId=2
+                END
+            ELSE
+                BEGIN
+                    -- I am an insert
+                    SELECT @auditOperationTypeLookupId=1
+                END
+        END
+    ELSE
+        BEGIN
+            -- i am a delete
+            SELECT @auditOperationTypeLookupId=3
+        END
+
+    DECLARE @pupilId int
+    DECLARE @lastModifiedBy_userId int
+    DECLARE db_cursor CURSOR FOR
+      SELECT i.id, i.lastModifiedBy_userId
+      FROM inserted i;
+    DECLARE db_deleted_cursor CURSOR FOR
+        SELECT d.id, d.lastModifiedBy_userId
+        FROM deleted d;
+
+	IF @auditOperationTypeLookupId IN (1,2)
+      BEGIN
+	      OPEN db_cursor
+	        FETCH NEXT FROM db_cursor INTO @pupilId, @lastModifiedBy_userId
+	        WHILE @@FETCH_STATUS = 0
+	        BEGIN
+	          -- grab the inserted/updated data
+	          SELECT @newDataJson = (SELECT TOP 1 * FROM inserted i WHERE i.id = @pupilId FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER)
+	          -- incorporate updatedAt trigger logic, to avoid duplicate audit entries
+	          IF @auditOperationTypeLookupId = 2
+	            BEGIN
+	              UPDATE [mtc_admin].[pupil] SET updatedAt = @updatedTimestamp WHERE id = @pupilId
+	              SET @newDataJson = JSON_MODIFY(@newDataJson, '$.updatedAt', CAST(@updatedTimestamp AS NVARCHAR))
+	            END
+
+	          -- do insert into pupil audit
+	          INSERT INTO [mtc_admin].[pupilAudit]
+	            (auditOperationTypeLookup_id, newData, pupil_id, operationBy_userId, sqlUserIdentifier)
+	          VALUES (@auditOperationTypeLookupId, @newDataJson, @pupilId, @lastModifiedBy_userId, SUSER_SNAME())
+
+	          FETCH NEXT FROM db_cursor INTO @pupilId, @lastModifiedBy_userId
+	        END
+
+	      CLOSE db_cursor
+	    DEALLOCATE db_cursor
+	END
+
+	IF @auditOperationTypeLookupId = 3
+    BEGIN
+      OPEN db_deleted_cursor
+      FETCH NEXT FROM db_deleted_cursor INTO @pupilId, @lastModifiedBy_userId
+      WHILE @@FETCH_STATUS = 0
+        BEGIN
+          SELECT @newDataJson = (SELECT TOP 1 * FROM deleted d WHERE d.id = @pupilId FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER);
+          -- do insert into pupil audit
+          INSERT INTO [mtc_admin].[pupilAudit]
+           (auditOperationTypeLookup_id, newData, pupil_id, operationBy_userId, sqlUserIdentifier)
+           VALUES (@auditOperationTypeLookupId, @newDataJson, @pupilId, @lastModifiedBy_userId, SUSER_SNAME());
+
+          FETCH NEXT FROM db_deleted_cursor INTO @pupilId, @lastModifiedBy_userId
+        END
+
+          CLOSE db_deleted_cursor
+          DEALLOCATE db_deleted_cursor
+      END
+END

db/migrations/schema-objects/20221125104853.undo.alter-pupil-audit-trigger.sql

@@ -0,0 +1,55 @@
+CREATE OR ALTER TRIGGER [mtc_admin].[pupilInsertUpdateAuditTrigger] ON [mtc_admin].[pupil]
+AFTER INSERT, UPDATE
+AS
+BEGIN
+    DECLARE @auditOperationTypeLookupId int
+    DECLARE @newDataJson NVARCHAR(MAX)
+    DECLARE @updatedTimestamp DATETIMEOFFSET(3) = GETUTCDATE()
+    -- infer audit type, populate var
+    IF EXISTS (SELECT 1 FROM inserted)
+        BEGIN
+            IF EXISTS (SELECT 1 FROM deleted)
+                BEGIN
+                    -- I am an update
+                    SELECT @auditOperationTypeLookupId=2
+                END
+            ELSE
+                BEGIN
+                    -- I am an insert
+                    SELECT @auditOperationTypeLookupId=1
+                END
+        END
+    ELSE
+        BEGIN
+            -- i am a delete
+            SELECT @auditOperationTypeLookupId=3
+        END
+
+    DECLARE @pupilId int
+    DECLARE @lastModifiedBy_userId int
+    DECLARE db_cursor CURSOR FOR
+      SELECT i.id, i.lastModifiedBy_userId
+      FROM inserted i
+
+      OPEN db_cursor
+        FETCH NEXT FROM db_cursor INTO @pupilId, @lastModifiedBy_userId
+        WHILE @@FETCH_STATUS = 0
+        BEGIN
+          -- incorporate updatedAt trigger logic, to avoid duplicate audit entries
+          IF @auditOperationTypeLookupId = 2
+            BEGIN
+              UPDATE [mtc_admin].[pupil] SET updatedAt = @updatedTimestamp WHERE id = @pupilId
+            END
+          SELECT @newDataJson = (SELECT TOP 1 * FROM inserted i WHERE i.id = @pupilId FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER)
+          SET @newDataJson = JSON_MODIFY(@newDataJson, '$.updatedAt', CAST(@updatedTimestamp AS NVARCHAR))
+          -- do insert into pupil audit
+          INSERT INTO [mtc_admin].[pupilAudit]
+            (auditOperationTypeLookup_id, newData, pupil_id, operationBy_userId, sqlUserIdentifier)
+          VALUES (@auditOperationTypeLookupId, @newDataJson, @pupilId, @lastModifiedBy_userId, SUSER_SNAME())
+
+          FETCH NEXT FROM db_cursor INTO @pupilId, @lastModifiedBy_userId
+        END
+
+      CLOSE db_cursor
+    DEALLOCATE db_cursor
+END

docker-compose.yml

@@ -1,8 +1,8 @@
 version: '3'
 services:
   sqldb:
-    image: "mcr.microsoft.com/mssql/server:2019-CU16-GDR1-ubuntu-20.04"
-    #image: "mcr.microsoft.com/azure-sql-edge"
+    #image: "mcr.microsoft.com/mssql/server:2022-latest"
+    image: "mcr.microsoft.com/azure-sql-edge"
     container_name: mtc_mssql
     ports:
       - "1433:1433"