Fix/36265 pa fsm

SESSION_0_FSM_REVIEW.md

@@ -0,0 +1,8 @@
+
+## Discussions for later
+- We need to take care of modifications of the configuration file (Global lock)
+
+## Tasks
+- the state machine to functions within transitions (fully unit tested)
+- (?) Add a testing protocol adapter for testing (let's see if we need it, mockito might be)
+- new PR Epic!! -> 

hivemq-edge/src/main/java/com/hivemq/HiveMQEdgeMain.java

@@ -21,35 +21,32 @@
 import com.hivemq.bootstrap.LoggingBootstrap;
 import com.hivemq.bootstrap.ioc.Injector;
 import com.hivemq.bootstrap.ioc.Persistences;
-import com.hivemq.bootstrap.services.AfterHiveMQStartBootstrapService;
 import com.hivemq.bootstrap.services.AfterHiveMQStartBootstrapServiceImpl;
 import com.hivemq.common.shutdown.ShutdownHooks;
 import com.hivemq.configuration.info.SystemInformation;
 import com.hivemq.configuration.info.SystemInformationImpl;
-import com.hivemq.configuration.service.ApiConfigurationService;
 import com.hivemq.configuration.service.ConfigurationService;
 import com.hivemq.edge.modules.ModuleLoader;
 import com.hivemq.embedded.EmbeddedExtension;
 import com.hivemq.exceptions.HiveMQEdgeStartupException;
+import com.hivemq.http.JaxrsHttpServer;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import com.hivemq.http.JaxrsHttpServer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
+import static java.util.Objects.requireNonNull;
+
 public class HiveMQEdgeMain {
-    private static final Logger log = LoggerFactory.getLogger(HiveMQEdgeMain.class);
+    private static final @NotNull Logger log = LoggerFactory.getLogger(HiveMQEdgeMain.class);
 
-    private @Nullable ConfigurationService configService;
     private final @NotNull ModuleLoader moduleLoader;
     private final @NotNull MetricRegistry metricRegistry;
     private final @NotNull SystemInformation systemInformation;
-
+    private @Nullable ConfigurationService configService;
     private @Nullable JaxrsHttpServer jaxrsServer;
-
     private @Nullable Injector injector;
     private @Nullable Thread shutdownThread;
 
@@ -64,22 +61,30 @@ public HiveMQEdgeMain(
         this.moduleLoader = moduleLoader;
     }
 
-    public void bootstrap() throws HiveMQEdgeStartupException {
-        // Already bootstrapped.
-        if (injector != null) {
-            return;
+    public static void main(final String @NotNull [] args) throws Exception {
+        log.info("Starting HiveMQ Edge...");
+        final long startTime = System.nanoTime();
+        final SystemInformationImpl systemInformation = new SystemInformationImpl(true);
+        final ModuleLoader moduleLoader = new ModuleLoader(systemInformation);
+        final HiveMQEdgeMain server = new HiveMQEdgeMain(systemInformation, new MetricRegistry(), null, moduleLoader);
+        try {
+            server.start(null);
+            log.info("Started HiveMQ Edge in {}ms", TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime));
+        } catch (final HiveMQEdgeStartupException e) {
+            log.error("HiveMQ Edge start was aborted with error.", e);
         }
-        final HiveMQEdgeBootstrap bootstrap =
-                new HiveMQEdgeBootstrap(metricRegistry, systemInformation, moduleLoader, configService);
-
+    }
 
-        injector = bootstrap.bootstrap();
-        if (configService == null) {
-            configService = injector.configurationService();
+    public void bootstrap() throws HiveMQEdgeStartupException {
+        if (injector == null) {
+            injector =
+                    new HiveMQEdgeBootstrap(metricRegistry, systemInformation, moduleLoader, configService).bootstrap();
+            if (configService == null) {
+                configService = injector.configurationService();
+            }
         }
     }
 
-
     protected void startGateway(final @Nullable EmbeddedExtension embeddedExtension) throws HiveMQEdgeStartupException {
         if (injector == null) {
             throw new HiveMQEdgeStartupException("invalid startup state");
@@ -90,9 +95,7 @@ protected void startGateway(final @Nullable EmbeddedExtension embeddedExtension)
             throw new HiveMQEdgeStartupException("User aborted.");
         }
 
-        final HiveMQEdgeGateway instance = injector.edgeGateway();
-        instance.start(embeddedExtension);
-
+        injector.edgeGateway().start(embeddedExtension);
         initializeApiServer(injector);
         startApiServer();
     }
@@ -102,25 +105,21 @@ protected void stopGateway() {
             return;
         }
         final ShutdownHooks shutdownHooks = injector.shutdownHooks();
-        // Already shutdown.
         if (shutdownHooks.isShuttingDown()) {
             return;
         }
-
         shutdownHooks.runShutdownHooks();
 
         //clear metrics
         metricRegistry.removeMatching(MetricFilter.ALL);
 
         //Stop the API Webserver
         stopApiServer();
-
         LoggingBootstrap.resetLogging();
     }
 
     protected void initializeApiServer(final @NotNull Injector injector) {
-        final ApiConfigurationService config = Objects.requireNonNull(configService).apiConfiguration();
-        if (jaxrsServer == null && config.isEnabled()) {
+        if (jaxrsServer == null && requireNonNull(configService).apiConfiguration().isEnabled()) {
             jaxrsServer = injector.apiServer();
         } else {
             log.info("API is DISABLED by configuration");
@@ -142,21 +141,18 @@ protected void stopApiServer() {
 
     protected void afterStart() {
         afterHiveMQStartBootstrap();
-        //hook method
     }
 
     private void afterHiveMQStartBootstrap() {
         Preconditions.checkNotNull(injector);
         final Persistences persistences = injector.persistences();
         Preconditions.checkNotNull(persistences);
         Preconditions.checkNotNull(configService);
-
         try {
-            final AfterHiveMQStartBootstrapService afterHiveMQStartBootstrapService =
-                    AfterHiveMQStartBootstrapServiceImpl.decorate(injector.completeBootstrapService(),
+            injector.commercialModuleLoaderDiscovery()
+                    .afterHiveMQStart(AfterHiveMQStartBootstrapServiceImpl.decorate(injector.completeBootstrapService(),
                             injector.protocolAdapterManager(),
-                            injector.services().modulesAndExtensionsService());
-            injector.commercialModuleLoaderDiscovery().afterHiveMQStart(afterHiveMQStartBootstrapService);
+                            injector.services().modulesAndExtensionsService()));
         } catch (final Exception e) {
             log.warn("Error on bootstrapping modules:", e);
             throw new HiveMQEdgeStartupException(e);
@@ -174,31 +170,16 @@ public void start(final @Nullable EmbeddedExtension embeddedExtension)
 
     public void stop() {
         stopGateway();
-        try {
-            Runtime.getRuntime().removeShutdownHook(shutdownThread);
-        } catch (final IllegalStateException ignored) {
-            //ignore
-        }
-    }
-
-    public static void main(final String @NotNull [] args) throws Exception {
-        log.info("Starting HiveMQ Edge...");
-        final long startTime = System.nanoTime();
-        final SystemInformationImpl systemInformation = new SystemInformationImpl(true);
-        final ModuleLoader moduleLoader = new ModuleLoader(systemInformation);
-        final HiveMQEdgeMain server =
-                new HiveMQEdgeMain(systemInformation, new MetricRegistry(), null, moduleLoader);
-        try {
-            server.start(null);
-            log.info("Started HiveMQ Edge in {}ms", TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime));
-        } catch (final HiveMQEdgeStartupException e) {
-            log.error("HiveMQ Edge start was aborted with error.", e);
+        if (shutdownThread != null) {
+            try {
+                Runtime.getRuntime().removeShutdownHook(shutdownThread);
+            } catch (final IllegalStateException ignored) {
+                //ignore
+            }
         }
     }
 
     public @Nullable Injector getInjector() {
         return injector;
     }
-
-
 }

hivemq-edge/src/main/java/com/hivemq/api/model/adapters/ProtocolAdapter.java

@@ -42,28 +42,28 @@ public class ProtocolAdapter {
     private final @NotNull String name;
     @JsonProperty("description")
     @Schema(description = "The description")
-    private final @NotNull String description;
+    private final @Nullable String description;
     @JsonProperty("url")
     @Schema(description = "The url of the adapter")
-    private final @NotNull String url;
+    private final @Nullable String url;
     @JsonProperty("version")
     @Schema(description = "The installed version of the adapter")
     private final @NotNull String version;
     @JsonProperty("logoUrl")
     @Schema(description = "The logo of the adapter")
-    private final @NotNull String logoUrl;
+    private final @Nullable String logoUrl;
     @JsonProperty("provisioningUrl")
     @Schema(description = "The provisioning url of the adapter")
-    private final @NotNull String provisioningUrl;
+    private final @Nullable String provisioningUrl;
     @JsonProperty("author")
     @Schema(description = "The author of the adapter")
     private final @NotNull String author;
     @JsonProperty("installed")
     @Schema(description = "Is the adapter installed?")
-    private final @NotNull Boolean installed;
+    private final @Nullable Boolean installed;
     @JsonProperty("category")
     @Schema(description = "The category of the adapter")
-    private final @NotNull ProtocolAdapterCategory category;
+    private final @Nullable ProtocolAdapterCategory category;
     @JsonProperty("tags")
     @Schema(description = "The search tags associated with this adapter")
     private final @NotNull List<String> tags;
@@ -72,27 +72,27 @@ public class ProtocolAdapter {
     private final @NotNull Set<Capability> capabilities;
     @JsonProperty("configSchema")
     @Schema(description = "JSONSchema in the 'https://json-schema.org/draft/2020-12/schema' format, which describes the configuration requirements for the adapter.")
-    private final @NotNull JsonNode configSchema;
+    private final @Nullable JsonNode configSchema;
     @JsonProperty("uiSchema")
     @Schema(description = "UISchema (see https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/), which describes the UI rendering of the configuration for the adapter.")
-    private final @NotNull JsonNode uiSchema;
+    private final @Nullable JsonNode uiSchema;
 
     public ProtocolAdapter(
             @JsonProperty("id") final @NotNull String id,
             @JsonProperty("protocol") final @NotNull String protocol,
             @JsonProperty("name") final @NotNull String name,
-            @JsonProperty("description") final @NotNull String description,
-            @JsonProperty("url") final @NotNull String url,
+            @JsonProperty("description") final @Nullable String description,
+            @JsonProperty("url") final @Nullable String url,
             @JsonProperty("version") final @NotNull String version,
-            @JsonProperty("logoUrl") final @NotNull String logoUrl,
+            @JsonProperty("logoUrl") final @Nullable String logoUrl,
             @JsonProperty("provisioningUrl") final @Nullable String provisioningUrl,
             @JsonProperty("author") final @NotNull String author,
             @JsonProperty("installed") final @Nullable Boolean installed,
             @JsonProperty("capabilities") final @NotNull Set<Capability> capabilities,
             @JsonProperty("category") final @Nullable ProtocolAdapterCategory category,
-            @JsonProperty("tags") final @Nullable List<String> tags,
-            @JsonProperty("configSchema") final @NotNull JsonNode configSchema,
-            @JsonProperty("uiSchema") final @NotNull JsonNode uiSchema) {
+            @JsonProperty("tags") final @NotNull List<String> tags,
+            @JsonProperty("configSchema") final @Nullable JsonNode configSchema,
+            @JsonProperty("uiSchema") final @Nullable JsonNode uiSchema) {
         this.id = id;
         this.protocol = protocol;
         this.name = name;
@@ -122,19 +122,19 @@ public ProtocolAdapter(
         return name;
     }
 
-    public @NotNull String getDescription() {
+    public @Nullable String getDescription() {
         return description;
     }
 
-    public @NotNull String getUrl() {
+    public @Nullable String getUrl() {
         return url;
     }
 
     public @NotNull String getVersion() {
         return version;
     }
 
-    public @NotNull String getLogoUrl() {
+    public @Nullable String getLogoUrl() {
         return logoUrl;
     }
 
@@ -146,7 +146,7 @@ public ProtocolAdapter(
         return author;
     }
 
-    public @NotNull JsonNode getConfigSchema() {
+    public @Nullable JsonNode getConfigSchema() {
         return configSchema;
     }
 
@@ -158,7 +158,7 @@ public ProtocolAdapter(
         return installed;
     }
 
-    public @Nullable List<String> getTags() {
+    public @NotNull List<String> getTags() {
         return tags;
     }
 
@@ -172,7 +172,7 @@ public ProtocolAdapter(
 
     @Override
     public boolean equals(final @Nullable Object o) {
-        return this == o || o instanceof final ProtocolAdapter that && Objects.equals(id, that.id);
+        return this == o || (o instanceof final ProtocolAdapter that && Objects.equals(id, that.id));
     }
 
     @Override

hivemq-edge/src/main/java/com/hivemq/api/model/adapters/ProtocolAdapterCategory.java

@@ -17,15 +17,13 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.hivemq.edge.HiveMQEdgeConstants;
+import io.swagger.v3.oas.annotations.media.Schema;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import io.swagger.v3.oas.annotations.media.Schema;
 
 /**
  * A category is a unique entity and represents a curated grouping of a protocol adapter. A protocol adapter
  * maybe in 1 category.
- *
- * @author Simon L Johnson
  */
 public class ProtocolAdapterCategory {
 
@@ -34,7 +32,7 @@ public class ProtocolAdapterCategory {
             description = "The unique name of the category to be used in API communication.",
             format = "string",
             minLength = 1,
-            required = true,
+            requiredMode = Schema.RequiredMode.REQUIRED,
             maxLength = HiveMQEdgeConstants.MAX_NAME_LEN,
             pattern = HiveMQEdgeConstants.NAME_REGEX)
     private final @NotNull String name;
@@ -44,20 +42,16 @@ public class ProtocolAdapterCategory {
             description = "The display name of the category to be used in HCIs.",
             format = "string",
             minLength = 1,
-            required = true)
+            requiredMode = Schema.RequiredMode.REQUIRED)
     private final @NotNull String displayName;
 
     @JsonProperty("description")
-    @Schema(name = "description",
-            description = "The description associated with the category.",
-            format = "string")
-    private final @NotNull String description;
+    @Schema(name = "description", description = "The description associated with the category.", format = "string")
+    private final @Nullable String description;
 
     @JsonProperty("image")
-    @Schema(name = "image",
-            description = "The image associated with the category.",
-            format = "string")
-    private final @NotNull String image;
+    @Schema(name = "image", description = "The image associated with the category.", format = "string")
+    private final @Nullable String image;
 
     public ProtocolAdapterCategory(
             @JsonProperty("name") final @NotNull String name,
@@ -70,19 +64,19 @@ public ProtocolAdapterCategory(
         this.image = image;
     }
 
-    public String getName() {
+    public @NotNull String getName() {
         return name;
     }
 
-    public String getDisplayName() {
+    public @NotNull String getDisplayName() {
         return displayName;
     }
 
-    public String getDescription() {
+    public @Nullable String getDescription() {
         return description;
     }
 
-    public String getImage() {
+    public @Nullable String getImage() {
         return image;
     }
 }