Transform CoreConfigurationService to immutable SchedulerConfiguration class (#597)

Author: jbern0rd

CHANGELOG.md

@@ -6,19 +6,20 @@ All notable changes to this project will be documented in this file.
 
 ### New Features
 
-- Use `iexec-core-library` in `iexec-worker`. (#595)
+- Add `iexec-core-library` dependency and use it. (#595)
 - Create `ConfigServerClient` instance and use it instead of `BlockchainAdapterApiClient`. (#596)
 
 ### Bug fixes
 
 - Fix `LoginServiceTests#shouldLoginOnceOnSimultaneousCalls` test. (#587)
-- Alwyas use `WorkerpoolAuhorization` to retrieve JWT on Result Proxy. (#588)
+- Always use `WorkerpoolAuhorization` to retrieve JWT on Result Proxy. (#588)
 
 ### Quality
 
 - Configure Gradle JVM Test Suite Plugin. (#589)
 - Remove `ResponseEntity` wrapper in feign client. (#593)
 - Use constructor injection in `Application` class. (#594)
+- Transform `CoreConfigurationService` to immutable `SchedulerConfiguration` class. (#597)
 
 ### Dependency Upgrades
 

src/main/java/com/iexec/worker/PingService.java

@@ -17,7 +17,6 @@
 package com.iexec.worker;
 
 import com.iexec.core.api.SchedulerClient;
-import com.iexec.worker.config.CoreConfigurationService;
 import com.iexec.worker.feign.LoginService;
 import com.iexec.worker.utils.AsyncUtils;
 import com.iexec.worker.utils.ExecutorUtils;
@@ -38,19 +37,18 @@ public class PingService {
     private static final int PING_RATE_IN_SECONDS = 10;
 
     private final Executor executor;
-    private final SchedulerClient coreClient;
-    private final CoreConfigurationService coreConfigurationService;
+    private final SchedulerClient schedulerClient;
     private final LoginService loginService;
     private final WorkerService workerService;
 
-    public PingService(SchedulerClient coreClient,
-                       CoreConfigurationService coreConfigurationService,
+    private String coreSessionId;
+
+    public PingService(SchedulerClient schedulerClient,
                        LoginService loginService,
                        WorkerService workerService) {
         executor = ExecutorUtils
                 .newSingleThreadExecutorWithFixedSizeQueue(1, "ping-");
-        this.coreClient = coreClient;
-        this.coreConfigurationService = coreConfigurationService;
+        this.schedulerClient = schedulerClient;
         this.loginService = loginService;
         this.workerService = workerService;
     }
@@ -78,7 +76,7 @@ void pingScheduler() {
         log.debug("Sending ping to scheduler");
         final String sessionId;
         try {
-            sessionId = coreClient.ping(loginService.getToken());
+            sessionId = schedulerClient.ping(loginService.getToken());
         } catch (FeignException e) {
             log.warn("The worker cannot ping the core [status:{}]", e.status());
             if (e instanceof FeignException.Unauthorized) {
@@ -97,16 +95,15 @@ void pingScheduler() {
         if (now.getMinute() == 0 && now.getSecond() <= PING_RATE_IN_SECONDS) {
             log.info("Sent ping to scheduler [sessionId:{}]", sessionId);
         }
-        String currentSessionId = coreConfigurationService.getCoreSessionId();
-        if (StringUtils.isEmpty(currentSessionId)) {
+        if (StringUtils.isEmpty(coreSessionId)) {
             log.info("First ping from the worker, setting the sessionId [coreSessionId:{}]", sessionId);
-            coreConfigurationService.setCoreSessionId(sessionId);
+            coreSessionId = sessionId;
             return;
         }
-        if (!sessionId.equalsIgnoreCase(currentSessionId)) {
+        if (!sessionId.equalsIgnoreCase(coreSessionId)) {
             // need to reconnect to the core by restarting the worker
             log.warn("Scheduler seems to have restarted [currentSessionId:{}, coreSessionId:{}]",
-                    currentSessionId, sessionId);
+                    coreSessionId, sessionId);
             workerService.restartGracefully();
         }
     }

…ker/config/CoreConfigurationService.java …orker/config/SchedulerConfiguration.javasrc/main/java/com/iexec/worker/config/CoreConfigurationService.java renamed to src/main/java/com/iexec/worker/config/SchedulerConfiguration.java src/main/java/com/iexec/worker/config/CoreConfigurationService.java renamed to src/main/java/com/iexec/worker/config/SchedulerConfiguration.java

@@ -21,59 +21,29 @@
 import feign.Logger;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
-import org.springframework.stereotype.Service;
+import org.springframework.context.annotation.Configuration;
 
-import javax.annotation.PostConstruct;
-import java.net.MalformedURLException;
-import java.net.URL;
+@Configuration
+public class SchedulerConfiguration {
 
-@Service
-public class CoreConfigurationService {
+    private final String protocol;
+    private final String host;
+    private final String port;
 
-    @Value("${core.protocol}")
-    private String coreProtocol;
-
-    @Value("${core.host}")
-    private String coreHost;
-
-    @Value("${core.port}")
-    private String corePort;
-
-    private URL url;
-
-    private String coreSessionId;
-
-    @PostConstruct
-    public void run() throws MalformedURLException {
-        url = new URL(coreProtocol, coreHost, Integer.parseInt(corePort), "");
+    public SchedulerConfiguration(@Value("${core.protocol}") String protocol,
+                                  @Value("${core.host}") String host,
+                                  @Value("${core.port}") String port) {
+        this.protocol = protocol;
+        this.host = host;
+        this.port = port;
     }
 
     public String getUrl() {
-        return url.toString();
-    }
-
-    public String getProtocol() {
-        return url.getProtocol();
-    }
-
-    public String getHost() {
-        return url.getHost();
-    }
-
-    public int getPort() {
-        return url.getPort();
-    }
-
-    public String getCoreSessionId() {
-        return coreSessionId;
-    }
-
-    public void setCoreSessionId(String coreSessionId) {
-        this.coreSessionId = coreSessionId;
+        return String.format("%s://%s:%s", protocol, host, port);
     }
 
     @Bean
     SchedulerClient schedulerClient() {
-        return SchedulerClientBuilder.getInstance(Logger.Level.FULL, url.toString());
+        return SchedulerClientBuilder.getInstance(Logger.Level.FULL, getUrl());
     }
 }

src/main/java/com/iexec/worker/pubsub/StompClientService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 
 package com.iexec.worker.pubsub;
 
-import com.iexec.worker.config.CoreConfigurationService;
+import com.iexec.worker.config.SchedulerConfiguration;
 import com.iexec.worker.utils.AsyncUtils;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.ApplicationEventPublisher;
@@ -51,10 +51,10 @@ public class StompClientService {
     private StompSession stompSession;
 
     public StompClientService(ApplicationEventPublisher applicationEventPublisher,
-                              CoreConfigurationService coreConfigService,
+                              SchedulerConfiguration schedulerConfiguration,
                               WebSocketStompClient stompClient) {
         this.eventPublisher = applicationEventPublisher;
-        this.webSocketServerUrl = coreConfigService.getUrl() + "/connect";
+        this.webSocketServerUrl = schedulerConfiguration.getUrl() + "/connect";
         this.stompClient = stompClient;
     }
 

src/main/java/com/iexec/worker/worker/WorkerService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,8 @@
 
 import com.iexec.common.config.WorkerModel;
 import com.iexec.commons.poco.utils.WaitUtils;
-import com.iexec.worker.config.CoreConfigurationService;
 import com.iexec.worker.config.PublicConfigurationService;
+import com.iexec.worker.config.SchedulerConfiguration;
 import com.iexec.worker.config.WorkerConfigurationService;
 import com.iexec.worker.docker.DockerService;
 import com.iexec.worker.feign.CustomCoreFeignClient;
@@ -33,14 +33,13 @@
 
 import java.util.List;
 
-
 @Slf4j
 @Service
 public class WorkerService {
 
     private final String workerWalletAddress;
     private final WorkerConfigurationService workerConfigService;
-    private final CoreConfigurationService coreConfigService;
+    private final SchedulerConfiguration schedulerConfiguration;
     private final PublicConfigurationService publicConfigService;
     private final CustomCoreFeignClient customCoreFeignClient;
     private final BuildProperties buildProperties;
@@ -50,7 +49,7 @@ public class WorkerService {
 
     public WorkerService(
             WorkerConfigurationService workerConfigService,
-            CoreConfigurationService coreConfigService,
+            SchedulerConfiguration schedulerConfiguration,
             PublicConfigurationService publicConfigService,
             CustomCoreFeignClient customCoreFeignClient,
             BuildProperties buildProperties,
@@ -59,7 +58,7 @@ public WorkerService(
             DockerService dockerService,
             String workerWalletAddress) {
         this.workerConfigService = workerConfigService;
-        this.coreConfigService = coreConfigService;
+        this.schedulerConfiguration = schedulerConfiguration;
         this.publicConfigService = publicConfigService;
         this.customCoreFeignClient = customCoreFeignClient;
         this.buildProperties = buildProperties;
@@ -71,7 +70,7 @@ public WorkerService(
 
     public boolean registerWorker() {
         log.info("Number of CPUs [CPUs:{}]", workerConfigService.getCpuCount());
-        log.info("Core URL [url:{}]", coreConfigService.getUrl());
+        log.info("Core URL [url:{}]", schedulerConfiguration.getUrl());
         log.info("Core version [version:{}]", customCoreFeignClient.getCoreVersion());
         log.info("Getting public configuration from the core...");
         log.info("Got public configuration from the core [config:{}]", publicConfigService.getPublicConfiguration());