Aggies Sprint 9

README.md

@@ -24,7 +24,7 @@ The [Workflow Documentation](docs/README.md) describes additional information on
 
 ```
 docker build -t folio/mod-workflow .
-docker run -d -p 9001:9001 folio/mod-workflow
+docker run -d -p 9001:8081 folio/mod-workflow
 ```
 
 ### Publish docker image
@@ -35,6 +35,47 @@ docker build -t [docker repo]/folio/mod-workflow:[version] .
 docker push [docker repo]/folio/mod-workflow:[version]
 ```
 
+### Environment variables:
+
+| Name                           |       Default value       | Description                                                                                                                                                |
+|:-------------------------------|:-------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| JAVA_OPTIONS                   | -XX:MaxRAMPercentage=75.0 | Java options                                                                                                                                               |
+| DB_HOST                        |         postgres          | Postgres hostname                                                                                                                                          |
+| DB_PORT                        |           5432            | Postgres port                                                                                                                                              |
+| DB_USERNAME                    |        folio_admin        | Postgres username                                                                                                                                          |
+| DB_PASSWORD                    |             -             | Postgres username password                                                                                                                                 |
+| DB_DATABASE                    |       okapi_modules       | Postgres database name                                                                                                                                     |
+| DB_QUERYTIMEOUT                |           60000           | Database query timeout.                                                                                                                                    |
+| DB_CHARSET                     |           UTF-8           | Database charset.                                                                                                                                          |
+| DB_MAXPOOLSIZE                 |             5             | Database max pool size.                                                                                                                                    |
+| KAFKA_HOST                     |           kafka           | Kafka broker hostname                                                                                                                                      |
+| KAFKA_PORT                     |           9092            | Kafka broker port                                                                                                                                          |
+| KAFKA_SECURITY_PROTOCOL        |         PLAINTEXT         | Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT)                                                                                |
+| KAFKA_SSL_KEYSTORE_LOCATION    |             -             | The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client.                               |
+| KAFKA_SSL_KEYSTORE_PASSWORD    |             -             | The store password for the Kafka key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured.                     |
+| KAFKA_SSL_TRUSTSTORE_LOCATION  |             -             | The location of the Kafka trust store file.                                                                                                                |
+| KAFKA_SSL_TRUSTSTORE_PASSWORD  |             -             | The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. |
+| OKAPI_URL                      |     http://okapi:9130     | OKAPI URL used to login system user, required                                                                                                              |
+| SERVER_PORT                    |           8081            | The port to listen on that must match the PortBindings.                                                                                                              |
+| SERVER_SERVLET_CONTEXTPATH     |             /             | The context path, or base path, to host at.                                                                                                              |
+| SPRING_FLYWAY_ENABLED          |           false           | Database migration support via Spring Flyway.                                                                                                              |
+| SPRING_JPA_HIBERNATE_DDLAUTO   |           update          | Auto-configure database on startup.                                                                                                              |
+| TENANT_DEFAULTTENANT           |           diku            | The name of the default tenant to use.                                                                                                              |
+| TENANT_FORCETENANT             |           false           | Forcibly add or overwrite the tenant name using the default tenant.                                                                                                              |
+| TENANT_INITIALIZEDEFAULTTENANT |           true            | Perform initial auto-creation of tenant in the DB (schema, tables, etc..).                                                                                                              |
+| TENANT_RECREATEDEFAULTTENANT   |           false           | When TENANT_INITIALIZEDEFAULTTENANT is true and the DB already exists, then drop and re-create.                                                                                                              |
+
+
+### Required Permissions
+Institutional users should be granted the following permissions in order to use this workflow API:
+- `workflow.actions.all`
+- `workflow.events.all`
+- `workflow.nodes.all`
+- `workflow.nodes.item.post`
+- `workflow.triggers.all`
+- `workflow.tasks.all`
+- `workflow.workflows.all`
+
 ### Issue tracker
 
 See project [FOLIO](https://issues.folio.org/browse/FOLIO)

service/descriptors/ModuleDescriptor-template.json

@@ -29,6 +29,37 @@
         }
       ]
     },
+    {
+      "id": "workflow-nodes",
+      "version": "1.0",
+      "handlers": [
+        {
+          "methods": ["GET"],
+          "pathPattern": "/nodes",
+          "permissionsRequired": ["workflow.nodes.collection.get"]
+        },
+        {
+          "methods": ["POST"],
+          "pathPattern": "/nodes",
+          "permissionsRequired": ["workflow.nodes.item.post"]
+        },
+        {
+          "methods": ["DELETE"],
+          "pathPattern": "/nodes/{id}",
+          "permissionsRequired": ["workflow.nodes.item.delete"]
+        },
+        {
+          "methods": ["GET"],
+          "pathPattern": "/nodes/{id}",
+          "permissionsRequired": ["workflow.nodes.item.get"]
+        },
+        {
+          "methods": ["PUT"],
+          "pathPattern": "/nodes/{id}",
+          "permissionsRequired": ["workflow.nodes.item.put"]
+        }
+      ]
+    },
     {
       "id": "workflow-triggers",
       "version": "1.0",
@@ -251,6 +282,44 @@
       ],
       "visible": false
     },
+    {
+      "permissionName": "workflow.nodes.collection.get",
+      "displayName": "Workflow - node - get node collection",
+      "description": "Get node collection"
+    },
+    {
+      "permissionName": "workflow.nodes.item.delete",
+      "displayName": "Workflow - node - delete node item",
+      "description": "Delete node item"
+    },
+    {
+      "permissionName": "workflow.nodes.item.get",
+      "displayName": "Workflow - node - get node item",
+      "description": "Get node item"
+    },
+    {
+      "permissionName": "workflow.nodes.item.post",
+      "displayName": "Workflow - node - post node item",
+      "description": "Create node item"
+    },
+    {
+      "permissionName": "workflow.nodes.item.put",
+      "displayName": "Workflow - node - put node item",
+      "description": "Update node item"
+    },
+    {
+      "permissionName": "workflow.nodes.all",
+      "displayName": "Workflow - node - all permissions",
+      "description": "Entire set of permissions needed to use the workflow triggers",
+      "subPermissions": [
+        "workflow.nodes.collection.get",
+        "workflow.nodes.item.delete",
+        "workflow.nodes.item.get",
+        "workflow.nodes.item.post",
+        "workflow.nodes.item.put"
+      ],
+      "visible": false
+    },
     {
       "permissionName": "workflow.triggers.collection.get",
       "displayName": "Workflow - trigger - get trigger collection",
@@ -404,32 +473,30 @@
       "HostConfig": {
         "Memory": 402653184,
         "PortBindings": {
-          "8081/tcp": [ { "HostPort": "%p" } ],
-          "61616/tcp": [ { "HostPort": "61616" } ]
+          "8081/tcp": [ { "HostPort": "%p" } ]
         }
       }
     },
     "env": [
-      {
-        "name": "JAVA_OPTIONS",
-        "value": "-XX:MaxRAMPercentage=66.0"
-      },
-      { "name": "DB_HOST", "value": "postgres" },
-      { "name": "DB_PORT", "value": "5432" },
-      { "name": "DB_USERNAME", "value": "folio_admin" },
-      { "name": "DB_PASSWORD", "value": "folio_admin" },
-      { "name": "DB_DATABASE", "value": "okapi_modules" },
-      { "name": "DB_QUERYTIMEOUT", "value": "60000" },
-      { "name": "DB_CHARSET", "value": "UTF-8" },
-      { "name": "DB_MAXPOOLSIZE", "value": "16" },
-      { "name": "EVENT_UPLOADS_PATH", "value": "events", "description": "The ActiveMQ event uploads path." },
-      { "name": "EVENT_QUEUE_NAME", "value": "event.queue", "description": "The ActiveMQ event queue name." },
-      { "name": "OKAPI_CAMUNDA_BASEPATH", "value": "/", "description": "The context path, or base path of Mod-Camunda." },
-      { "name": "OKAPI_CAMUNDA_RESTPATH", "value": "/rest", "description": "The path Mod-Camunda uses for REST requests." },
+      { "name": "JAVA_OPTIONS", "value": "-XX:MaxRAMPercentage=66.0", "description": "Java options" },
+      { "name": "DB_HOST", "value": "postgres", "description": "Postgres hostname" },
+      { "name": "DB_PORT", "value": "5432", "description": "Postgres port" },
+      { "name": "DB_USERNAME", "value": "folio_admin", "description": "Postgres username" },
+      { "name": "DB_PASSWORD", "value": "folio_admin", "description": "Postgres username password" },
+      { "name": "DB_DATABASE", "value": "okapi_modules", "description": "Postgres database name" },
+      { "name": "DB_QUERYTIMEOUT", "value": "60000", "description": "Database query timeout." },
+      { "name": "DB_CHARSET", "value": "UTF-8", "description": "Database charset." },
+      { "name": "DB_MAXPOOLSIZE", "value": "16", "description": "Database max pool size." },
+      { "name": "KAFKA_HOST", "value": "kafka", "description": "Kafka broker hostname" },
+      { "name": "KAFKA_PORT", "value": "9092", "description": "Kafka broker port" },
+      { "name": "KAFKA_SECURITY_PROTOCOL", "value": "PLAINTEXT", "description": "Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT)" },
+      { "name": "KAFKA_SSL_KEYSTORE_LOCATION", "value": "", "description": "The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client." },
+      { "name": "KAFKA_SSL_KEYSTORE_PASSWORD", "value": "", "description": "The store password for the Kafka key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured." },
+      { "name": "KAFKA_SSL_TRUSTSTORE_LOCATION", "value": "", "description": "The location of the Kafka trust store file." },
+      { "name": "KAFKA_SSL_TRUSTSTORE_PASSWORD", "value": "", "description": "The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled." },
       { "name": "OKAPI_URL", "value": "http://10.0.2.15:9130", "description": "The URL to the OKAPI service." },
       { "name": "SERVER_PORT", "value": "8081", "description": "The port to listen on that must match the PortBindings." },
       { "name": "SERVER_SERVLET_CONTEXTPATH", "value": "/", "description": "The context path, or base path, to host at." },
-      { "name": "SPRING_ACTIVEMQ_BROKERURL", "value": "tcp://localhost:61616", "description": "The URL to the ActiveMQ server." },
       { "name": "SPRING_FLYWAY_ENABLED", "value": "false", "description": "Database migration support via Spring Flyway." },
       { "name": "SPRING_JPA_HIBERNATE_DDLAUTO", "value": "update", "description": "Auto-configure database on startup." },
       { "name": "TENANT_DEFAULTTENANT", "value": "diku", "description": "The name of the default tenant to use." },

service/src/main/java/org/folio/rest/workflow/config/KafkaProducerConfig.java

@@ -0,0 +1,40 @@
+package org.folio.rest.workflow.config;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.kafka.clients.producer.ProducerConfig;
+import org.apache.kafka.common.serialization.StringSerializer;
+import org.folio.spring.messaging.model.Event;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+import org.springframework.kafka.core.DefaultKafkaProducerFactory;
+import org.springframework.kafka.core.KafkaTemplate;
+import org.springframework.kafka.core.ProducerFactory;
+import org.springframework.kafka.support.serializer.JsonSerializer;
+
+@Configuration
+@Profile({ "messaging", "!test" })
+public class KafkaProducerConfig {
+
+  @Value(value = "${spring.kafka.bootstrap-servers}")
+  private String bootstrapAddress;
+
+  @Bean
+  public ProducerFactory<String, Event> eventProducerFactory() {
+    Map<String, Object> configProps = new HashMap<>();
+    configProps.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, bootstrapAddress);
+    configProps.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
+    configProps.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, JsonSerializer.class);
+
+    return new DefaultKafkaProducerFactory<>(configProps);
+  }
+
+  @Bean
+  public KafkaTemplate<String, Event> eventKafkaTemplate() {
+    return new KafkaTemplate<>(eventProducerFactory());
+  }
+
+}

service/src/main/java/org/folio/rest/workflow/controller/EventController.java

@@ -3,7 +3,6 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import jakarta.jms.JMSException;
 import jakarta.servlet.http.HttpServletRequest;
 import java.io.File;
 import java.io.IOException;
@@ -20,7 +19,7 @@
 import org.folio.rest.workflow.dto.TriggerDto;
 import org.folio.rest.workflow.enums.HttpMethod;
 import org.folio.rest.workflow.exception.EventPublishException;
-import org.folio.rest.workflow.jms.EventProducer;
+import org.folio.rest.workflow.kafka.EventProducer;
 import org.folio.rest.workflow.model.repo.TriggerRepo;
 import org.folio.spring.messaging.model.Event;
 import org.folio.spring.tenant.annotation.TenantHeader;
@@ -173,7 +172,7 @@ private void processEvent(TriggerDto trigger, Event event) throws EventPublishEx
     logger.debug("Publishing event: {}: {}", trigger.getName(), trigger.getDescription());
     try {
       eventProducer.send(event);
-    } catch (JMSException | IOException e) {
+    } catch (Exception e) {
       throw new EventPublishException("Unable to publish event!", e);
     }
   }

service/src/main/java/org/folio/rest/workflow/kafka/EventProducer.java

@@ -0,0 +1,31 @@
+package org.folio.rest.workflow.kafka;
+
+import org.folio.spring.messaging.model.Event;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.kafka.core.KafkaTemplate;
+import org.springframework.stereotype.Service;
+
+@Service
+public class EventProducer {
+
+  private static final Logger logger = LoggerFactory.getLogger(EventProducer.class);
+
+  @Value("${application.kafka.producer.events.topic}")
+  private String topic;
+
+  private KafkaTemplate<String, Event> eventTemplate;
+
+  @Autowired
+  public EventProducer(KafkaTemplate<String, Event> eventTemplate) {
+    this.eventTemplate = eventTemplate;
+  }
+
+  public void send(Event event) {
+    logger.debug("Send []: {}, {}", event.getMethod(), event.getPath());
+    this.eventTemplate.send(topic, event);
+  }
+
+}

service/src/main/java/org/folio/rest/workflow/service/OkapiDiscoveryService.java

@@ -40,9 +40,6 @@ public class OkapiDiscoveryService {
   @Value("${okapi.url}")
   private String okapiUrl;
 
-  @Value("${okapi.camunda.base-path}")
-  private String basePath;
-
   private HttpService httpService;
 
   private ObjectMapper objectMapper;
@@ -94,7 +91,7 @@ public Map<String, List<Handler>> getHandlers(String tenant, String id) throws I
   }
 
   public JsonNode getModules(String tenant) {
-    String url = okapiUrl + basePath + PROXY_TENANT_BASE_PATH + tenant + MODULES_SUB_PATH;
+    String url = okapiUrl + PROXY_TENANT_BASE_PATH + tenant + MODULES_SUB_PATH;
     ResponseEntity<JsonNode> response = request(url, tenant);
     if (logger.isDebugEnabled()) {
       logger.debug("Response status code {}", response.getStatusCode());
@@ -104,7 +101,7 @@ public JsonNode getModules(String tenant) {
   }
 
   public JsonNode getModuleDescriptor(String tenant, String id) {
-    String url = okapiUrl + basePath + PROXY_MODULE_BASE_PATH + id;
+    String url = okapiUrl + PROXY_MODULE_BASE_PATH + id;
     ResponseEntity<JsonNode> response = request(url, tenant);
     if (logger.isDebugEnabled()) {
       logger.debug("Response status code {}", response.getStatusCode());