fix(authority-source-files): Fix persisting createdBy and updatedBy user id for shadow copies in ECS (#363)

* fix(authority-source-files): Fix persisting user's id when creating and updating shadow copies for member tenants in ECS

Closes: MODELINKS-244

Author: mukhiddin-yusuf

NEWS.md

@@ -15,6 +15,7 @@
 ### Bug fixes
 * Fix context mix-up on data propagation ([MODELINKS-273](https://folio-org.atlassian.net/browse/MODELINKS-273))
 * Close input stream on s3 file read ([MODELINKS-278](https://folio-org.atlassian.net/browse/MODELINKS-278))
+* Fix persisting createdBy and updatedBy user id for shadow copies in ECS ([MODELINKS-244](https://folio-org.atlassian.net/browse/MODELINKS-244))
 
 ### Tech Dept
 * Add missing interface `source-storage-batch` dependency in module descriptor ([MODELINKS-275](https://folio-org.atlassian.net/browse/MODELINKS-275))

pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>3.3.5</version>
+    <version>3.4.0</version>
     <relativePath /> <!-- lookup parent from repository -->
   </parent>
 

src/main/java/org/folio/entlinks/controller/delegate/AuthoritySourceFileServiceDelegate.java

@@ -33,6 +33,7 @@
 import org.folio.spring.service.SystemUserScopedExecutionService;
 import org.folio.tenant.domain.dto.Parameter;
 import org.jetbrains.annotations.NotNull;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Service;
 
 @Log4j2
@@ -44,7 +45,7 @@ public class AuthoritySourceFileServiceDelegate {
   private static final String AUTHORITY_TABLE_NAME = "authority";
   private static final String AUTHORITY_ARCHIVE_TABLE_NAME = "authority_archive";
 
-  private final AuthoritySourceFileService service;
+  private final @Qualifier("authoritySourceFileService") AuthoritySourceFileService service;
   private final AuthoritySourceFileMapper mapper;
   private final UserTenantsService tenantsService;
   private final AuthoritySourceFileDomainEventPublisher eventPublisher;
@@ -72,7 +73,7 @@ public AuthoritySourceFileDto createAuthoritySourceFile(AuthoritySourceFilePostD
 
     service.createSequence(created.getSequenceName(), created.getHridStartNumber());
 
-    propagationService.propagate(getPropagationData(entity, null), CREATE, context.getTenantId());
+    propagationService.propagate(getPropagationData(created, null), CREATE, context.getTenantId());
     return mapper.toDto(created);
   }
 

src/main/java/org/folio/entlinks/domain/repository/AuthoritySourceFileJdbcRepository.java

@@ -0,0 +1,98 @@
+package org.folio.entlinks.domain.repository;
+
+import static org.apache.commons.collections4.CollectionUtils.isNotEmpty;
+import static org.folio.entlinks.utils.JdbcUtils.getFullPath;
+import static org.folio.entlinks.utils.JdbcUtils.getParamPlaceholder;
+import static org.folio.entlinks.utils.JdbcUtils.getSchemaName;
+
+import java.util.UUID;
+import org.folio.entlinks.domain.entity.AuthoritySourceFile;
+import org.folio.spring.FolioExecutionContext;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.stereotype.Repository;
+
+
+@Repository
+public class AuthoritySourceFileJdbcRepository {
+
+  private static final String AUTHORITY_SOURCE_FILE_CODE_TABLE = "authority_source_file_code";
+  private static final String AUTHORITY_SOURCE_FILE_TABLE = "authority_source_file";
+
+  private final JdbcTemplate jdbcTemplate;
+  private final FolioExecutionContext folioExecutionContext;
+
+  public AuthoritySourceFileJdbcRepository(JdbcTemplate jdbcTemplate, FolioExecutionContext folioExecutionContext) {
+    this.jdbcTemplate = jdbcTemplate;
+    this.folioExecutionContext = folioExecutionContext;
+  }
+
+  public void insert(AuthoritySourceFile entity) {
+    var sourceType = getFullPath(folioExecutionContext, "authority_source_file_source");
+    var sqlValues = "%s::%s,%s".formatted(getParamPlaceholder(3), sourceType, getParamPlaceholder(9));
+
+    var sql = """
+                INSERT INTO %s (id, name, source, type, base_url_protocol, base_url, hrid_start_number, _version,
+                created_date, updated_date, created_by_user_id, updated_by_user_id)
+                VALUES (%s);
+        """;
+    jdbcTemplate.update(sql.formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_TABLE), sqlValues),
+        entity.getId(), entity.getName(),
+        entity.getSource().name(), entity.getType(), entity.getBaseUrlProtocol(), entity.getBaseUrl(),
+        entity.getHridStartNumber(), 0, entity.getCreatedDate(), entity.getUpdatedDate(), entity.getCreatedByUserId(),
+        entity.getUpdatedByUserId());
+
+    if (isNotEmpty(entity.getAuthoritySourceFileCodes())) {
+      var sourceFileCode = entity.getAuthoritySourceFileCodes().iterator().next();
+      sql = "INSERT INTO %s (authority_source_file_id, code) VALUES (?, ?);";
+      jdbcTemplate.update(sql.formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_CODE_TABLE)),
+          sourceFileCode.getAuthoritySourceFile().getId(), sourceFileCode.getCode());
+    }
+  }
+
+  public void update(AuthoritySourceFile entity, int version) {
+    var sourceType = getFullPath(folioExecutionContext, "authority_source_file_source");
+    var sql = """
+                UPDATE %s
+                SET name=?, source=?::%s, type=?, base_url_protocol=?, base_url=?, hrid_start_number=?,
+                created_date=?, updated_date=?, created_by_user_id=?, updated_by_user_id=?, _version=?
+                WHERE id = ? and _version = ?;
+        """;
+
+    var id = entity.getId();
+    jdbcTemplate.update(sql.formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_TABLE), sourceType),
+        entity.getName(), entity.getSource().name(), entity.getType(),
+        entity.getBaseUrlProtocol(), entity.getBaseUrl(), entity.getHridStartNumber(),
+        entity.getCreatedDate(), entity.getUpdatedDate(), entity.getCreatedByUserId(),
+        entity.getUpdatedByUserId(), entity.getVersion(), id, version);
+
+    if (isNotEmpty(entity.getAuthoritySourceFileCodes())) {
+      var sourceFileCode = entity.getAuthoritySourceFileCodes().iterator().next().getCode();
+
+      jdbcTemplate.execute("DELETE FROM %s WHERE authority_source_file_id = '%s';"
+          .formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_CODE_TABLE), id));
+
+      jdbcTemplate.update("INSERT INTO %s (authority_source_file_id, code) VALUES (?, ?);"
+              .formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_CODE_TABLE)), id, sourceFileCode);
+    }
+  }
+
+  public void delete(UUID id) {
+    jdbcTemplate.execute("DELETE FROM %s WHERE authority_source_file_id = '%s'"
+        .formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_CODE_TABLE), id));
+    jdbcTemplate.execute("DELETE FROM %s WHERE id = '%s'"
+        .formatted(getFullPath(folioExecutionContext, AUTHORITY_SOURCE_FILE_TABLE), id));
+  }
+
+  public void createSequence(String sequenceName, int startNumber) {
+    var command = String.format("""
+            CREATE SEQUENCE %s MINVALUE %d INCREMENT BY 1 OWNED BY %s.authority_source_file.sequence_name;
+            """,
+        sequenceName, startNumber, getSchemaName(folioExecutionContext));
+    jdbcTemplate.execute(command);
+  }
+
+  public void dropSequence(String sequenceName) {
+    var command = String.format("DROP SEQUENCE IF EXISTS %s.%s;", getSchemaName(folioExecutionContext), sequenceName);
+    jdbcTemplate.execute(command);
+  }
+}

src/main/java/org/folio/entlinks/service/authority/AuthorityService.java

@@ -17,7 +17,9 @@
 import org.folio.entlinks.domain.entity.Authority;
 import org.folio.entlinks.domain.entity.AuthoritySourceFile;
 import org.folio.entlinks.domain.repository.AuthorityRepository;
+import org.folio.entlinks.domain.repository.AuthoritySourceFileRepository;
 import org.folio.entlinks.exception.AuthorityNotFoundException;
+import org.folio.entlinks.exception.AuthoritySourceFileNotFoundException;
 import org.folio.entlinks.exception.OptimisticLockingException;
 import org.folio.spring.data.OffsetRequest;
 import org.springframework.context.annotation.Primary;
@@ -32,6 +34,7 @@
 public class AuthorityService implements AuthorityServiceI<Authority> {
 
   private final AuthorityRepository repository;
+  private final AuthoritySourceFileRepository sourceFileRepository;
 
   @Override
   public Page<Authority> getAll(Integer offset, Integer limit, String cql) {
@@ -138,10 +141,9 @@ protected Authority createInner(Authority entity) {
 
   protected AuthorityUpdateResult updateInner(Authority modified, boolean forced) {
     log.debug("update:: Attempting to update Authority [authority: {}]", modified);
-    var id = modified.getId();
-    var existing = repository.findByIdAndDeletedFalse(id).orElseThrow(() -> new AuthorityNotFoundException(id));
+
+    var existing = validateOnUpdateAndGetExisting(modified.getId(), modified);
     var detachedExisting = new Authority(existing);
-    olCheck(modified, existing, id);
 
     copyModifiableFields(existing, modified);
 
@@ -159,6 +161,20 @@ protected Authority deleteByIdInner(UUID id, boolean forced) {
     return repository.save(existed);
   }
 
+  private Authority validateOnUpdateAndGetExisting(UUID id, Authority modified) {
+    var existing = repository.findByIdAndDeletedFalse(id).orElseThrow(() -> new AuthorityNotFoundException(id));
+
+    var sourceFileId = Optional.ofNullable(modified.getAuthoritySourceFile())
+        .map(AuthoritySourceFile::getId)
+        .orElse(null);
+    if (sourceFileId != null && !sourceFileRepository.existsById(sourceFileId)) {
+      throw new AuthoritySourceFileNotFoundException(sourceFileId);
+    }
+
+    olCheck(modified, existing, id);
+    return existing;
+  }
+
   private static void olCheck(Authority modified, Authority existing, UUID id) {
     if (modified.getVersion() < existing.getVersion()) {
       throw OptimisticLockingException.optimisticLockingOnUpdate(id, existing.getVersion(), modified.getVersion());

src/main/java/org/folio/entlinks/service/authority/AuthoritySourceFileService.java

@@ -15,15 +15,16 @@
 import org.folio.entlinks.domain.entity.AuthoritySourceFile;
 import org.folio.entlinks.domain.entity.AuthoritySourceFileCode;
 import org.folio.entlinks.domain.repository.AuthorityRepository;
+import org.folio.entlinks.domain.repository.AuthoritySourceFileJdbcRepository;
 import org.folio.entlinks.domain.repository.AuthoritySourceFileRepository;
 import org.folio.entlinks.exception.AuthoritySourceFileHridException;
 import org.folio.entlinks.exception.AuthoritySourceFileNotFoundException;
 import org.folio.entlinks.exception.OptimisticLockingException;
 import org.folio.entlinks.exception.RequestBodyValidationException;
 import org.folio.spring.FolioExecutionContext;
-import org.folio.spring.FolioModuleMetadata;
 import org.folio.spring.data.OffsetRequest;
 import org.folio.tenant.domain.dto.Parameter;
+import org.springframework.context.annotation.Primary;
 import org.springframework.dao.DataAccessException;
 import org.springframework.data.domain.Page;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -33,19 +34,21 @@
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
 
-@Service
+@Primary
+@Service("authoritySourceFileService")
 @AllArgsConstructor
 @Log4j2
-public class AuthoritySourceFileService {
+public class AuthoritySourceFileService implements AuthoritySourceFileServiceI {
 
   private static final String AUTHORITY_SEQUENCE_NAME_TEMPLATE = "hrid_authority_local_file_%s_seq";
   private final AuthoritySourceFileRepository repository;
+  private final AuthoritySourceFileJdbcRepository jdbcRepository;
   private final AuthorityRepository authorityRepository;
   private final AuthoritySourceFileMapper mapper;
   private final JdbcTemplate jdbcTemplate;
-  private final FolioModuleMetadata moduleMetadata;
   private final FolioExecutionContext folioExecutionContext;
 
+  @Override
   public Page<AuthoritySourceFile> getAll(Integer offset, Integer limit, String cql) {
     log.debug("getAll:: Attempts to find all AuthoritySourceFile by [offset: {}, limit: {}, cql: {}]", offset, limit,
       cql);
@@ -57,27 +60,14 @@ public Page<AuthoritySourceFile> getAll(Integer offset, Integer limit, String cq
     return repository.findByCql(cql, new OffsetRequest(offset, limit));
   }
 
-  /**
-   * Retrieves {@link AuthoritySourceFile} by the given id.
-   *
-   * @param id {@link UUID} ID of the authority source file being retrieved
-   * @return retrieved {@link AuthoritySourceFile}
-   *
-   *   Note: This method assumes the authority source file exists for the given ID and thus throws exception in case
-   *   no authority source file is found
-   */
+  @Override
   public AuthoritySourceFile getById(UUID id) {
     log.debug("getById:: Loading AuthoritySourceFile by ID [id: {}]", id);
 
     return repository.findById(id).orElseThrow(() -> new AuthoritySourceFileNotFoundException(id));
   }
 
-  /**
-   * Searches for the Authority Source File for the given ID.
-   *
-   * @param id {@link UUID} ID of the authority source file being searched
-   * @return found {@link AuthoritySourceFile} instance or null if it is not found
-   */
+  @Override
   public AuthoritySourceFile findById(UUID id) {
     log.debug("findById:: Querying for AuthoritySourceFile by ID [id: {}]", id);
 
@@ -88,12 +78,7 @@ public AuthoritySourceFile findById(UUID id) {
     return repository.findById(id).orElse(null);
   }
 
-  /**
-   * Searches for the Authority Source File for the given name.
-   *
-   * @param name Name of the authority source file being searched
-   * @return found {@link AuthoritySourceFile} instance or null if it is not found
-   */
+  @Override
   public AuthoritySourceFile findByName(String name) {
     log.debug("findById:: Querying for AuthoritySourceFile by name [name: {}]", name);
 
@@ -104,6 +89,7 @@ public AuthoritySourceFile findByName(String name) {
     return repository.findByName(name).orElse(null);
   }
 
+  @Override
   @Transactional
   public AuthoritySourceFile create(AuthoritySourceFile entity) {
     log.debug("create:: Attempting to create AuthoritySourceFile [entity: {}]", entity);
@@ -115,6 +101,7 @@ public AuthoritySourceFile create(AuthoritySourceFile entity) {
     return repository.save(entity);
   }
 
+  @Override
   @Transactional(propagation = Propagation.REQUIRES_NEW)
   @Retryable(
     retryFor = OptimisticLockingException.class,
@@ -124,6 +111,7 @@ public AuthoritySourceFile update(UUID id, AuthoritySourceFile modified) {
     return updateInner(id, modified, null);
   }
 
+  @Override
   @Transactional(propagation = Propagation.REQUIRES_NEW)
   @Retryable(
     retryFor = OptimisticLockingException.class,
@@ -134,18 +122,14 @@ public AuthoritySourceFile update(UUID id, AuthoritySourceFile modified,
     return updateInner(id, modified, publishConsumer);
   }
 
+  @Override
   public void deleteById(UUID id) {
     log.debug("deleteById:: Attempt to delete AuthoritySourceFile by [id: {}]", id);
-    var authoritySourceFile = repository.findById(id)
-      .orElseThrow(() -> new AuthoritySourceFileNotFoundException(id));
-    if (!FOLIO.equals(authoritySourceFile.getSource())) {
-      repository.deleteById(id);
-    } else {
-      throw new RequestBodyValidationException("Cannot delete Authority source file with source 'folio'",
-        List.of(new Parameter("source").value(authoritySourceFile.getSource().name())));
-    }
+    validateOnDelete(id);
+    repository.deleteById(id);
   }
 
+  @Override
   public String nextHrid(UUID id) {
     log.debug("nextHrid:: Attempting to get next AuthoritySourceFile HRID [id: {}]", id);
     var sourceFile = getById(id);
@@ -162,17 +146,19 @@ public String nextHrid(UUID id) {
     }
   }
 
+  @Override
   public boolean authoritiesExistForSourceFile(UUID sourceFileId) {
     return authorityRepository.existsAuthorityByAuthoritySourceFileId(sourceFileId);
   }
 
+  @Override
   public boolean authoritiesExistForSourceFile(UUID sourceFileId, String tenantId, String tableName) {
     if (sourceFileId == null || tenantId == null) {
       return false;
     }
 
     var command = String.format("select exists (select true from %s.%s a where a.source_file_id='%s' limit 1)",
-        moduleMetadata.getDBSchemaName(tenantId), tableName, sourceFileId);
+        folioExecutionContext.getFolioModuleMetadata().getDBSchemaName(tenantId), tableName, sourceFileId);
     return Boolean.TRUE.equals(jdbcTemplate.queryForObject(command, Boolean.class));
   }
 
@@ -268,21 +254,17 @@ private void copyModifiableFields(AuthoritySourceFile existingEntity, AuthorityS
     }
   }
 
+  @Override
   public void createSequence(String sequenceName, int startNumber) {
-    var command = String.format("""
-            CREATE SEQUENCE %s MINVALUE %d INCREMENT BY 1 OWNED BY %s.authority_source_file.sequence_name;
-            """,
-        sequenceName, startNumber, moduleMetadata.getDBSchemaName(folioExecutionContext.getTenantId()));
-    jdbcTemplate.execute(command);
+    jdbcRepository.createSequence(sequenceName, startNumber);
   }
 
+  @Override
   public void deleteSequence(String sequenceName) {
-    var command = String.format("DROP SEQUENCE IF EXISTS %s.%s;",
-        moduleMetadata.getDBSchemaName(folioExecutionContext.getTenantId()), sequenceName);
-    jdbcTemplate.execute(command);
+    jdbcRepository.dropSequence(sequenceName);
   }
 
-  private void updateSequenceStartNumber(AuthoritySourceFile existing, AuthoritySourceFile modified) {
+  protected void updateSequenceStartNumber(AuthoritySourceFile existing, AuthoritySourceFile modified) {
     if (!Objects.equals(existing.getHridStartNumber(), modified.getHridStartNumber())
         && existing.getHridStartNumber() != null && modified.getHridStartNumber() != null) {
       var sequenceName = existing.getSequenceName();
@@ -291,4 +273,12 @@ private void updateSequenceStartNumber(AuthoritySourceFile existing, AuthoritySo
       createSequence(sequenceName, modifiedStartNumber);
     }
   }
+
+  protected void validateOnDelete(UUID id) {
+    var sourceFile = repository.findById(id).orElseThrow(() -> new AuthoritySourceFileNotFoundException(id));
+    if (FOLIO.equals(sourceFile.getSource())) {
+      throw new RequestBodyValidationException("Cannot delete Authority source file with source 'folio'",
+        List.of(new Parameter("source").value(sourceFile.getSource().name())));
+    }
+  }
 }