fix: Add Did Document Self Service De Registration Config (#2519)

* fix: Add Did Document Self Service De Registration Config

* fix: Cast replica count as int

* fix: add quote to TX_EDC_DID_SERVICE_SELF_DEREGISTRATION_ENABLED var

* fix: Trigger PR Build via empty commit

Author: pratapipatelbcone

charts/tractusx-connector-memory/templates/deployment-runtime.yaml

@@ -258,10 +258,10 @@ spec:
             {{- end }}
             - name: "TX_EDC_DID_SERVICE_SELF_REGISTRATION_ENABLED"
               value: {{ .Values.iatp.didService.selfRegistration.enabled | quote}}
-            {{- if .Values.iatp.didService.selfRegistration.enabled }}
+            - name: "TX_EDC_DID_SERVICE_SELF_DEREGISTRATION_ENABLED"
+              value: "false"
             - name: "TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID"
-              value: {{ .Values.iatp.didService.selfRegistration.id | required ".Values.iatp.didService.selfRegistration.id is required" | quote }}
-            {{- end }}
+              value: {{ .Values.iatp.didService.selfRegistration.id | quote }}
             - name: "TX_EDC_DCP_CACHE_ENABLED"
               value: {{ .Values.iatp.cache.enabled | quote }}
             - name: "TX_EDC_DCP_CACHE_VALIDITY_SECONDS"

charts/tractusx-connector/templates/deployment-controlplane.yaml

@@ -256,10 +256,10 @@ spec:
             {{- end }}
             - name: "TX_EDC_DID_SERVICE_SELF_REGISTRATION_ENABLED"
               value: {{ .Values.iatp.didService.selfRegistration.enabled | quote}}
-            {{- if .Values.iatp.didService.selfRegistration.enabled }}
+            - name: "TX_EDC_DID_SERVICE_SELF_DEREGISTRATION_ENABLED"
+              value: {{ and (eq (int .Values.controlplane.replicaCount) 1) (not .Values.controlplane.autoscaling.enabled) | quote }}
             - name: "TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID"
-              value: {{ .Values.iatp.didService.selfRegistration.id | required ".Values.iatp.didService.selfRegistration.id is required" | quote }}
-            {{- end }}
+              value: {{ .Values.iatp.didService.selfRegistration.id | quote }}
             - name: "TX_EDC_DCP_CACHE_ENABLED"
               value: {{ .Values.iatp.cache.enabled | quote }}
             - name: "TX_EDC_DCP_CACHE_VALIDITY_SECONDS"

edc-extensions/did-document/did-document-service-self-registration/src/main/java/org/eclipse/tractusx/edc/did/document/service/self/registration/DidDocumentServiceSelfRegistrationExtension.java

@@ -36,6 +36,7 @@
 public class DidDocumentServiceSelfRegistrationExtension implements ServiceExtension {
 
     public static final String TX_EDC_DID_SERVICE_SELF_REGISTRATION_ENABLED = "tx.edc.did.service.self.registration.enabled";
+    public static final String TX_EDC_DID_SERVICE_SELF_DEREGISTRATION_ENABLED = "tx.edc.did.service.self.deregistration.enabled";
     public static final String TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID = "tx.edc.did.service.self.registration.id";
 
     public static final String DATA_SERVICE_TYPE = "DataService";
@@ -54,6 +55,9 @@ public class DidDocumentServiceSelfRegistrationExtension implements ServiceExten
     @Setting(key = TX_EDC_DID_SERVICE_SELF_REGISTRATION_ENABLED, defaultValue = "false", description = "Enable self-registration of the DID Document Service")
     private boolean selfRegistrationEnabled;
 
+    @Setting(key = TX_EDC_DID_SERVICE_SELF_DEREGISTRATION_ENABLED, defaultValue = "false", description = "Enable self-deregistration of the DID Document Service")
+    private boolean selfDeregistrationEnabled;
+
     @Setting(key = TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID, required = false, description = "The Id to use for service self-registration (should be valid URI)")
     private String serviceId;
 
@@ -68,7 +72,7 @@ public void start() {
     @Override
     public void shutdown() {
         Optional.ofNullable(didDocumentServiceClient)
-                .filter(client -> selfRegistrationEnabled)
+                .filter(client -> selfDeregistrationEnabled)
                 .ifPresent(this::selfUnregisterDidDocumentService);
     }
 
@@ -100,7 +104,7 @@ private void selfUnregisterDidDocumentService(@NotNull DidDocumentServiceClient
     private Result<String> validatedServiceId(String serviceId) {
 
         if (serviceId == null || serviceId.isBlank()) {
-            return Result.failure("Service ID for DID Document Service self-registration configured via Property '%s' is missing or blank but self-registration is enabled.".formatted(TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID));
+            return Result.failure("Service ID for DID Document Service configured via Property '%s' is missing or blank but self-registration / de-registration is enabled.".formatted(TX_EDC_DID_SERVICE_SELF_REGISTRATION_ID));
         }
         try {
             new URI(serviceId);

edc-extensions/did-document/did-document-service-self-registration/src/test/java/org/eclipse/tractusx/edc/did/document/service/self/registration/DidDocumentServiceSelfRegistrationExtensionTest.java

@@ -68,6 +68,7 @@ void setup(ServiceExtensionContext context) {
     void start_shouldSelfRegister_whenEnabledAndClientPresent(ServiceExtensionContext context, ObjectFactory objectFactory) {
 
         var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true",
+                "tx.edc.did.service.self.deregistration.enabled", "true",
                 "tx.edc.did.service.self.registration.id", SERVICE_ID);
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);
@@ -93,6 +94,7 @@ void start_shouldSelfRegister_whenEnabledAndClientPresent(ServiceExtensionContex
     void start_selfRegister_whenEnabledAndClientReturnsFailure(ServiceExtensionContext context, ObjectFactory objectFactory) {
 
         var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true",
+                "tx.edc.did.service.self.deregistration.enabled", "true",
                 "tx.edc.did.service.self.registration.id", SERVICE_ID);
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);
@@ -130,7 +132,7 @@ void start_shouldNotSelfRegister_whenClientNotPresent(ObjectFactory objectFactor
     @Test
     void start_shouldNotSelfRegister_whenDisabledAndClientPresent(ServiceExtensionContext context, ObjectFactory objectFactory) {
 
-        var settings = Map.of("tx.edc.did.service.self.registration.enabled", "false");
+        var settings = Map.of("tx.edc.did.service.self.registration.enabled", "false", "tx.edc.did.service.self.deregistration.enabled", "false");
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);
 
@@ -147,15 +149,15 @@ void start_shouldNotSelfRegister_whenDisabledAndClientPresent(ServiceExtensionCo
     @Test
     void start_shouldNotSelfRegister_whenEnabledAndServiceIdMissing(ServiceExtensionContext context, ObjectFactory objectFactory) {
 
-        var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true");
+        var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true", "tx.edc.did.service.self.deregistration.enabled", "true");
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);
 
         var extension = objectFactory.constructInstance(DidDocumentServiceSelfRegistrationExtension.class);
         extension.start();
 
         verify(didDocumentServiceClient, never()).update(any(Service.class));
-        verify(monitor).severe(contains("is missing or blank but self-registration is enabled"));
+        verify(monitor).severe(contains("is missing or blank but self-registration / de-registration is enabled"));
 
         extension.shutdown();
         verify(didDocumentServiceClient, never()).deleteById(anyString());
@@ -167,6 +169,7 @@ void start_shouldNotSelfRegister_whenEnabledAndServiceIdMissing(ServiceExtension
     void start_shouldNotSelfRegister_whenEnabledAndServiceIdEmptyOrBlank(String serviceId, ServiceExtensionContext context, ObjectFactory objectFactory) {
 
         var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true",
+                "tx.edc.did.service.self.dregistration.enabled", "true",
                 "tx.edc.did.service.self.registration.id", serviceId);
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);
@@ -175,7 +178,7 @@ void start_shouldNotSelfRegister_whenEnabledAndServiceIdEmptyOrBlank(String serv
         extension.start();
 
         verify(didDocumentServiceClient, never()).update(any(Service.class));
-        verify(monitor).severe(contains("is missing or blank but self-registration is enabled"));
+        verify(monitor).severe(contains("is missing or blank but self-registration / de-registration is enabled"));
 
         extension.shutdown();
         verify(didDocumentServiceClient, never()).deleteById(anyString());
@@ -185,6 +188,7 @@ void start_shouldNotSelfRegister_whenEnabledAndServiceIdEmptyOrBlank(String serv
     void start_shouldNotSelfRegister_whenEnabledAndServiceIdInvalid(ServiceExtensionContext context, ObjectFactory objectFactory) {
 
         var settings = Map.of("tx.edc.did.service.self.registration.enabled", "true",
+                "tx.edc.did.service.self.deregistration.enabled", "true",
                 "tx.edc.did.service.self.registration.id", "invalid uri");
         when(context.getConfig()).thenReturn(ConfigFactory.fromMap(settings));
         context.registerService(DidDocumentServiceClient.class, didDocumentServiceClient);