feat(specification-rule): add auditing for specification rules (#199)

psmagin · web-flow · commit 7019f0c3bed2 · 2026-02-20T10:48:53.000+02:00
Closes: MRSPECS-200
diff --git a/NEWS.md b/NEWS.md
@@ -9,6 +9,7 @@
 ### Features
 * Refactor specification sync from URL to local copy ([MRSPECS-87](https://folio-org.atlassian.net/browse/MRSPECS-87))
 * Default specification data updates to disable undefined rules ([MRSPECS-102](https://folio-org.atlassian.net/browse/MRSPECS-102))
+* Add auditing for specification rules ([MRSPECS-200](https://folio-org.atlassian.net/browse/MRSPECS-200))
 
 ### Bug fixes
 * Fix non-obsolete subfield choosing logic ([MRSPECS-95](https://folio-org.atlassian.net/browse/MRSPECS-95))
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/Rule.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/Rule.java
@@ -3,16 +3,19 @@
 import jakarta.persistence.Column;
 import jakarta.persistence.Embedded;
 import jakarta.persistence.Entity;
+import jakarta.persistence.EntityListeners;
 import jakarta.persistence.Table;
 import lombok.Getter;
 import lombok.Setter;
 import org.folio.rspec.domain.entity.support.Metadata;
 import org.folio.rspec.domain.entity.support.UuidPersistable;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 @Getter
 @Setter
 @Entity
 @Table(name = "rule")
+@EntityListeners(AuditingEntityListener.class)
 public class Rule extends UuidPersistable {
 
   public static final String NAME_COLUMN = "name";
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/Specification.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/Specification.java
@@ -3,6 +3,7 @@
 import jakarta.persistence.Column;
 import jakarta.persistence.Embedded;
 import jakarta.persistence.Entity;
+import jakarta.persistence.EntityListeners;
 import jakarta.persistence.EnumType;
 import jakarta.persistence.Enumerated;
 import jakarta.persistence.OneToMany;
@@ -21,6 +22,7 @@
 import org.folio.rspec.domain.entity.support.UuidPersistable;
 import org.hibernate.annotations.JdbcTypeCode;
 import org.hibernate.type.SqlTypes;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 @Getter
 @Setter
@@ -29,6 +31,7 @@
   @UniqueConstraint(name = "uc_specification_family_profile",
                     columnNames = {Specification.FAMILY_COLUMN, Specification.PROFILE_COLUMN})
 })
+@EntityListeners(AuditingEntityListener.class)
 public class Specification extends UuidPersistable {
 
   public static final String TITLE_COLUMN = "title";
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/SpecificationRule.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/entity/SpecificationRule.java
@@ -1,20 +1,25 @@
 package org.folio.rspec.domain.entity;
 
 import jakarta.persistence.Column;
+import jakarta.persistence.Embedded;
 import jakarta.persistence.EmbeddedId;
 import jakarta.persistence.Entity;
+import jakarta.persistence.EntityListeners;
 import jakarta.persistence.ManyToOne;
 import jakarta.persistence.MapsId;
 import jakarta.persistence.Table;
 import java.util.Objects;
 import lombok.Getter;
 import lombok.Setter;
+import org.folio.rspec.domain.entity.support.Metadata;
 import org.hibernate.Hibernate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 @Getter
 @Setter
 @Entity
 @Table(name = "specification_rule")
+@EntityListeners(AuditingEntityListener.class)
 public class SpecificationRule {
 
   @EmbeddedId
@@ -31,6 +36,9 @@ public class SpecificationRule {
   @Column(name = "enabled", nullable = false)
   private boolean enabled = true;
 
+  @Embedded
+  private Metadata metadata;
+
   @Override
   public final int hashCode() {
     return Objects.hash(specificationRuleId);
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/repository/SpecificationRuleRepository.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/domain/repository/SpecificationRuleRepository.java
@@ -5,9 +5,7 @@
 import org.folio.rspec.domain.entity.SpecificationRule;
 import org.folio.rspec.domain.entity.SpecificationRuleId;
 import org.springframework.data.jpa.repository.JpaRepository;
-import org.springframework.data.jpa.repository.Modifying;
 import org.springframework.data.jpa.repository.Query;
-import org.springframework.transaction.annotation.Transactional;
 
 public interface SpecificationRuleRepository extends JpaRepository<SpecificationRule, SpecificationRuleId> {
 
@@ -17,9 +15,4 @@ public interface SpecificationRuleRepository extends JpaRepository<Specification
     where s.specificationRuleId.specificationId = ?1
     """)
   List<SpecificationRule> findBySpecificationId(UUID specificationId);
-
-  @Transactional
-  @Modifying
-  @Query("update SpecificationRule s set s.enabled = ?1 where s.specificationRuleId = ?2")
-  int updateEnabledBySpecificationRuleId(boolean enabled, SpecificationRuleId specificationRuleId);
 }
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/service/SpecificationRuleService.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/service/SpecificationRuleService.java
@@ -32,9 +32,9 @@ public SpecificationRuleDtoCollection findSpecificationRules(UUID specificationI
 
   public void toggleSpecificationRule(SpecificationRuleId specificationRuleId, boolean enabled) {
     log.info("toggleSpecificationRule::specificationRuleId={}, enabled={}", specificationRuleId, enabled);
-    int updated = specificationRuleRepository.updateEnabledBySpecificationRuleId(enabled, specificationRuleId);
-    if (updated == 0) {
-      throw ResourceNotFoundException.forSpecificationRule(specificationRuleId);
-    }
+    var specificationRule = specificationRuleRepository.findById(specificationRuleId)
+      .orElseThrow(() -> ResourceNotFoundException.forSpecificationRule(specificationRuleId));
+    specificationRule.setEnabled(enabled);
+    specificationRuleRepository.save(specificationRule);
   }
 }
diff --git a/mod-record-specifications-server/src/main/java/org/folio/rspec/service/mapper/SpecificationRuleMapper.java b/mod-record-specifications-server/src/main/java/org/folio/rspec/service/mapper/SpecificationRuleMapper.java
@@ -17,7 +17,7 @@ public interface SpecificationRuleMapper {
   @Mapping(target = "name", source = "rule.name")
   @Mapping(target = "specificationId", source = "specification.id")
   @Mapping(target = "description", source = "rule.description")
-  @Mapping(target = "metadata", source = "rule.metadata")
+  @Mapping(target = "metadata", source = "metadata")
   SpecificationRuleDto toDto(SpecificationRule specificationRule);
 
   @Mapping(target = "specificationId", ignore = true)
diff --git a/mod-record-specifications-server/src/main/resources/db/changelog/changelog-master.xml b/mod-record-specifications-server/src/main/resources/db/changelog/changelog-master.xml
@@ -6,5 +6,6 @@
 
   <include file="changes/changelog-v1.0.xml" relativeToChangelogFile="true"/>
   <include file="changes/changelog-v2.1.xml" relativeToChangelogFile="true"/>
+  <include file="changes/changelog-v3.0.xml" relativeToChangelogFile="true"/>
 
 </databaseChangeLog>
diff --git a/mod-record-specifications-server/src/main/resources/db/changelog/changes/changelog-v3.0.xml b/mod-record-specifications-server/src/main/resources/db/changelog/changes/changelog-v3.0.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                   https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+
+  <include file="v3.0/move-rule-metadata.xml" relativeToChangelogFile="true"/>
+
+</databaseChangeLog>
diff --git a/mod-record-specifications-server/src/main/resources/db/changelog/changes/v3.0/move-rule-metadata.xml b/mod-record-specifications-server/src/main/resources/db/changelog/changes/v3.0/move-rule-metadata.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                   https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+
+
+  <changeSet id="MRSPECS-200@@update-table:specification_rule:add-metadata-fields" author="pavlo_smahin">
+    <preConditions>
+      <tableExists tableName="specification_rule"/>
+    </preConditions>
+
+    <comment>Add metadata fields to specification_rule table</comment>
+
+    <addColumn tableName="specification_rule">
+      <column name="created_by_user_id" type="UUID"/>
+      <column name="created_date" type="DATETIME"/>
+      <column name="updated_by_user_id" type="UUID"/>
+      <column name="updated_date" type="DATETIME"/>
+    </addColumn>
+  </changeSet>
+
+  <changeSet id="MRSPECS-200@@migrate:rule-to-specification-rule:metadata-fields" author="pavlo_smahin">
+    <preConditions>
+      <and>
+        <tableExists tableName="specification_rule"/>
+        <tableExists tableName="rule"/>
+      </and>
+    </preConditions>
+
+    <comment>Migrate metadata from rule table to specification_rule table</comment>
+
+    <sql>
+      UPDATE specification_rule sr
+      SET created_by_user_id = r.created_by_user_id,
+          created_date = r.created_date,
+          updated_by_user_id = r.updated_by_user_id,
+          updated_date = r.updated_date
+      FROM rule r
+      WHERE sr.rule_id = r.id
+    </sql>
+  </changeSet>
+
+  <changeSet id="MRSPECS-200@@update-table:specification_rule:add-not-null-constraints" author="pavlo_smahin">
+    <preConditions>
+      <tableExists tableName="specification_rule"/>
+    </preConditions>
+
+    <comment>Add NOT NULL constraints to metadata fields</comment>
+
+    <addNotNullConstraint tableName="specification_rule" columnName="created_by_user_id" columnDataType="UUID"/>
+    <addNotNullConstraint tableName="specification_rule" columnName="created_date" columnDataType="DATETIME"/>
+    <addNotNullConstraint tableName="specification_rule" columnName="updated_by_user_id" columnDataType="UUID"/>
+    <addNotNullConstraint tableName="specification_rule" columnName="updated_date" columnDataType="DATETIME"/>
+  </changeSet>
+
+</databaseChangeLog>
diff --git a/mod-record-specifications-server/src/test/java/org/folio/api/SpecificationStorageApiIT.java b/mod-record-specifications-server/src/test/java/org/folio/api/SpecificationStorageApiIT.java
@@ -251,7 +251,10 @@ void toggleSpecificationRule_shouldReturn204AndToggleSpecificationRule() {
 
     toggleDto = toggleDto.enabled(stateBeforeToggle);
     doPatch(specificationRulePath(BIBLIOGRAPHIC_SPECIFICATION_ID, ruleId), toggleDto);
-    assertSpecificationRuleEnabled(BIBLIOGRAPHIC_SPECIFICATION_ID, TRUE.equals(stateBeforeToggle), ruleId);
+    var actual = assertSpecificationRuleEnabled(BIBLIOGRAPHIC_SPECIFICATION_ID, TRUE.equals(stateBeforeToggle), ruleId);
+    assertThat(actual.getMetadata()).isNotNull();
+    assertThat(actual.getMetadata().getUpdatedByUserId()).isEqualTo(UUID.fromString(USER_ID));
+    assertThat(actual.getMetadata().getUpdatedDate()).isNotEqualTo(actual.getMetadata().getCreatedDate());
 
     assertSpecificationUpdatedEvents(2);
   }
@@ -403,19 +406,21 @@ private SpecificationRuleDtoCollection getSpecificationRules(ResultActions resul
     );
   }
 
-  private void assertSpecificationRuleEnabled(UUID specificationId, boolean expected, UUID ruleId) {
+  private SpecificationRuleDto assertSpecificationRuleEnabled(UUID specificationId, boolean expected, UUID ruleId) {
     var specificationRulesAfterUpdate = getSpecificationRules(doGet(specificationRulesPath(specificationId)));
-    assertSpecificationRulesEnabled(expected, true, specificationRulesAfterUpdate, ruleId);
+    return assertSpecificationRulesEnabled(expected, true, specificationRulesAfterUpdate, ruleId);
   }
 
-  private void assertSpecificationRulesEnabled(boolean expected, boolean including,
+  private SpecificationRuleDto assertSpecificationRulesEnabled(boolean expected, boolean including,
                                                SpecificationRuleDtoCollection collection,
                                                UUID... ruleIds) {
     for (SpecificationRuleDto rule : collection.getRules()) {
       assertNotNull(rule.getId());
       if (including ? Arrays.asList(ruleIds).contains(rule.getId()) : !Arrays.asList(ruleIds).contains(rule.getId())) {
         assertThat(rule.getEnabled()).isEqualTo(expected);
+        return rule;
       }
     }
+    return null;
   }
 }
diff --git a/mod-record-specifications-server/src/test/java/org/folio/rspec/domain/repository/SpecificationRuleRepositoryIT.java b/mod-record-specifications-server/src/test/java/org/folio/rspec/domain/repository/SpecificationRuleRepositoryIT.java
@@ -2,10 +2,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.folio.support.TestConstants.BIBLIOGRAPHIC_SPECIFICATION_ID;
-import static org.folio.support.TestConstants.MISSING_FIELD_RULE_ID;
-import static org.junit.jupiter.api.Assertions.assertFalse;
 
-import org.folio.rspec.domain.entity.SpecificationRuleId;
 import org.folio.spring.testing.extension.EnablePostgres;
 import org.folio.spring.testing.type.IntegrationTest;
 import org.junit.jupiter.api.Test;
@@ -30,17 +27,4 @@ void findBySpecificationId() {
       .isNotEmpty()
       .hasSize(15);
   }
-
-  @Test
-  void updateEnabledBySpecificationRuleId() {
-    var specificationRuleId = new SpecificationRuleId(BIBLIOGRAPHIC_SPECIFICATION_ID, MISSING_FIELD_RULE_ID);
-    var updated = specificationRuleRepository.updateEnabledBySpecificationRuleId(false, specificationRuleId);
-
-    assertThat(updated).isEqualTo(1);
-
-    var updatedEntity = specificationRuleRepository.findById(specificationRuleId);
-    assertThat(updatedEntity)
-      .isNotEmpty()
-      .hasValueSatisfying(specificationRule -> assertFalse(specificationRule.isEnabled()));
-  }
 }

Original file line number	Diff line number	Diff line change
`@@ -32,9 +32,9 @@ public SpecificationRuleDtoCollection findSpecificationRules(UUID specificationI`
`32`	`32`
`33`	`33`	`public void toggleSpecificationRule(SpecificationRuleId specificationRuleId, boolean enabled) {`
`34`	`34`	`log.info("toggleSpecificationRule::specificationRuleId={}, enabled={}", specificationRuleId, enabled);`
`35`		`- int updated = specificationRuleRepository.updateEnabledBySpecificationRuleId(enabled, specificationRuleId);`
`36`		`- if (updated == 0) {`
`37`		`- throw ResourceNotFoundException.forSpecificationRule(specificationRuleId);`
`38`		`- }`
	`35`	`+ var specificationRule = specificationRuleRepository.findById(specificationRuleId)`
	`36`	`+ .orElseThrow(() -> ResourceNotFoundException.forSpecificationRule(specificationRuleId));`
	`37`	`+ specificationRule.setEnabled(enabled);`
	`38`	`+ specificationRuleRepository.save(specificationRule);`
`39`	`39`	`}`
`40`	`40`	`}`