[#464] added soft delete feature and refactored local startup

Author: david-monichi

README.md

@@ -26,6 +26,16 @@ There is currently one database implementations available.
 > **Note:** When switching between implementation it's a good practise to first execute a maven clean to remove
 > old dependencies from the target directory in the app module.
 
+## Development
+
+Run application with local postgresql database in development mode:
+```bash
+  docker run --rm -d --name compas-db -p 5432:5432 -e POSTGRES_USER=compas \
+      -e POSTGRES_PASSWORD=compas -e POSTGRES_DB=compas postgres:14 -d
+
+  mvn -DskipTests=true -Dquarkus.profile=dev-postgresql,local package io.quarkus:quarkus-maven-plugin::dev
+```
+
 ## Common Environment variables
 
 Below environment variable(s) can be used to configure which claims and information are used to fill the UserInfo
@@ -86,4 +96,3 @@ configured as needed.
 - STD_DELETE
 - STD_READ
 - STD_UPDATE
-

app/src/main/resources/application-dev-postgresql.properties

@@ -19,8 +19,8 @@ quarkus.datasource.devservices.enabled = false
 quarkus.datasource.db-kind             = postgresql
 quarkus.datasource.jdbc.url            = jdbc:postgresql://${POSTGRESQL_HOST:localhost}:${POSTGRESQL_PORT:5432}/${POSTGRESQL_DB:compas}
 quarkus.datasource.jdbc.max-size       = 16
-quarkus.datasource.username            = ${POSTGRESQL_USERNAME:postgres}
-quarkus.datasource.password            = ${POSTGRESQL_PASSWORD:postgres}
+quarkus.datasource.username            = ${POSTGRESQL_USERNAME:compas}
+quarkus.datasource.password            = ${POSTGRESQL_PASSWORD:compas}
 
 # Flyway configuration for PostgreSQL
 quarkus.flyway.migrate-at-start = true

app/src/main/resources/application-local.properties

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025 BearingPoint GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
+quarkus.http.auth.permission.deny-default.paths=/*
+quarkus.http.auth.permission.deny-default.policy=permit

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgresql/CompasSclDataPostgreSQLRepository.java

@@ -10,8 +10,6 @@
 import org.lfenergy.compas.scl.data.repository.CompasSclDataRepository;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
 
-import jakarta.enterprise.context.ApplicationScoped;
-import jakarta.inject.Inject;
 import javax.sql.DataSource;
 import jakarta.transaction.Transactional;
 import java.sql.Array;
@@ -27,7 +25,6 @@
 import static jakarta.transaction.Transactional.TxType.SUPPORTS;
 import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.*;
 
-@ApplicationScoped
 public class CompasSclDataPostgreSQLRepository implements CompasSclDataRepository {
     private static final String ID_FIELD = "id";
     private static final String MAJOR_VERSION_FIELD = "major_version";
@@ -39,9 +36,8 @@ public class CompasSclDataPostgreSQLRepository implements CompasSclDataRepositor
     private static final String HITEM_WHEN_FIELD = "hitem_when";
     private static final String HITEM_WHAT_FIELD = "hitem_what";
 
-    private final DataSource dataSource;
+    protected final DataSource dataSource;
 
-    @Inject
     public CompasSclDataPostgreSQLRepository(DataSource dataSource) {
         this.dataSource = dataSource;
     }
@@ -56,6 +52,7 @@ public List<IItem> list(SclFileType type) {
                   from (select distinct on (scl_file.id) *
                           from scl_file
                          where scl_file.type = ?
+                         AND scl_file.is_deleted = false
                          order by scl_file.id
                                 , scl_file.major_version desc
                                 , scl_file.minor_version desc
@@ -115,6 +112,7 @@ left outer join (
                        and scl_data.patch_version = scl_file.patch_version
                  where scl_file.id   = ?
                  and   scl_file.type = ?
+                 and   scl_file.is_deleted = false
                  order by scl_file.major_version
                         , scl_file.minor_version
                         , scl_file.patch_version
@@ -162,6 +160,7 @@ public String findByUUID(SclFileType type, UUID id, Version version) {
                  and   scl_file.major_version = ?
                  and   scl_file.minor_version = ?
                  and   scl_file.patch_version = ?
+                 and   scl_file.is_deleted = false
                 """;
 
         try (var connection = dataSource.getConnection();
@@ -191,6 +190,7 @@ public boolean hasDuplicateSclName(SclFileType type, String name) {
                 select distinct on (scl_file.id) scl_file.name
                   from scl_file
                  where scl_file.type = ?
+                 and scl_file.is_deleted = false
                  order by scl_file.id
                         , scl_file.major_version desc
                         , scl_file.minor_version desc
@@ -221,6 +221,7 @@ public IAbstractItem findMetaInfoByUUID(SclFileType type, UUID id) {
                   from scl_file
                  where scl_file.id   = ?
                  and   scl_file.type = ?
+                 and   scl_file.is_deleted = false
                  order by scl_file.major_version desc, scl_file.minor_version desc, scl_file.patch_version desc
                 """;
 

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgresql/CompasSclDataPostgreSQLRepositoryConfiguration.java

@@ -0,0 +1,30 @@
+// SPDX-FileCopyrightText: 2025 BearingPoint GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.scl.data.repository.postgresql;
+
+import io.quarkus.arc.DefaultBean;
+import io.quarkus.arc.lookup.LookupIfProperty;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.enterprise.inject.Produces;
+import org.lfenergy.compas.scl.data.repository.CompasSclDataRepository;
+
+import javax.sql.DataSource;
+
+public class CompasSclDataPostgreSQLRepositoryConfiguration {
+
+    @Produces
+    @ApplicationScoped
+    @LookupIfProperty(name = "compas.scl-data-service.features.soft-delete-enabled", stringValue = "true")
+    CompasSclDataRepository softDeleteCompasSclDataPostgreSQLRepository(DataSource dataSource) {
+        return new SoftDeleteCompasSclDataPostgreSQLRepository(dataSource);
+    }
+
+    @Produces
+    @ApplicationScoped
+    @DefaultBean
+    CompasSclDataRepository defaultCompasSclDataPostgreSQLRepository(DataSource dataSource) {
+        return new CompasSclDataPostgreSQLRepository(dataSource);
+    }
+}

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgresql/SoftDeleteCompasSclDataPostgreSQLRepository.java

@@ -0,0 +1,70 @@
+// SPDX-FileCopyrightText: 2025 BearingPoint GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.scl.data.repository.postgresql;
+
+import jakarta.transaction.Transactional;
+import org.lfenergy.compas.scl.data.exception.CompasSclDataServiceException;
+import org.lfenergy.compas.scl.data.model.*;
+import org.lfenergy.compas.scl.extensions.model.SclFileType;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+import java.util.UUID;
+
+import static jakarta.transaction.Transactional.TxType.REQUIRED;
+import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.*;
+
+public class SoftDeleteCompasSclDataPostgreSQLRepository extends CompasSclDataPostgreSQLRepository {
+
+    public SoftDeleteCompasSclDataPostgreSQLRepository(DataSource dataSource) {
+        super(dataSource);
+    }
+
+    @Override
+    @Transactional(REQUIRED)
+    public void delete(SclFileType type, UUID id) {
+        var sql = """
+                UPDATE scl_file
+                 SET scl_file.is_deleted = true
+                 where scl_file.id   = ?
+                 and   scl_file.type = ?
+                """;
+
+        try (var connection = dataSource.getConnection();
+             var stmt = connection.prepareStatement(sql)) {
+            stmt.setObject(1, id);
+            stmt.setString(2, type.name());
+            stmt.executeUpdate();
+        } catch (SQLException exp) {
+            throw new CompasSclDataServiceException(POSTGRES_DELETE_ERROR_CODE, "Error removing SCL from database!", exp);
+        }
+    }
+
+    @Override
+    @Transactional(REQUIRED)
+    public void delete(SclFileType type, UUID id, Version version) {
+        var sql = """
+                UPDATE scl_file
+                 SET scl_file.is_deleted = true
+                 where scl_file.id   = ?
+                 and   scl_file.type = ?
+                 and   scl_file.major_version = ?
+                 and   scl_file.minor_version = ?
+                 and   scl_file.patch_version = ?
+                """;
+
+        try (var connection = dataSource.getConnection();
+             var stmt = connection.prepareStatement(sql)) {
+            stmt.setObject(1, id);
+            stmt.setString(2, type.name());
+            stmt.setInt(3, version.getMajorVersion());
+            stmt.setInt(4, version.getMinorVersion());
+            stmt.setInt(5, version.getPatchVersion());
+            stmt.executeUpdate();
+        } catch (SQLException exp) {
+            throw new CompasSclDataServiceException(POSTGRES_DELETE_ERROR_CODE, "Error removing SCL (version) from database!", exp);
+        }
+    }
+}

repository-postgresql/src/main/resources/org/lfenergy/compas/scl/data/repository/postgresql/db/migration/V1_5__add_soft_delete_flag.sql

@@ -0,0 +1,14 @@
+/**
+ * SPDX-FileCopyrightText: 2025 BearingPoint GmbH
+ *
+ * SPDX-License-Identifier: Apache-2.0
+*/
+
+--
+-- Update SCL File Table to add soft deletion
+--
+
+ALTER TABLE scl_file 
+ADD COLUMN is_deleted BOOLEAN DEFAULT false;
+
+comment on column scl_file.is_deleted is 'Flag is the SCL File is deleted.';

repository/pom.xml

@@ -24,6 +24,10 @@ SPDX-License-Identifier: Apache-2.0
             <groupId>org.lfenergy.compas.core</groupId>
             <artifactId>scl-extension</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-arc</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>jakarta.xml.bind</groupId>