feat(eventing-service): init

simonhir · simonhir · commit 4963ab3eb0ad · 2025-08-25T14:19:41.000+02:00
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/DbsTicketingEventingService.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/DbsTicketingEventingService.java
@@ -10,8 +10,8 @@
 @SpringBootApplication
 @ConfigurationPropertiesScan
 @SuppressWarnings("PMD.UseUtilityClass")
-public class MicroServiceApplication {
+public class DbsTicketingEventingService {
     public static void main(final String[] args) {
-        SpringApplication.run(MicroServiceApplication.class, args);
+        SpringApplication.run(DbsTicketingEventingService.class, args);
     }
 }
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/adapter/in/rest/EventMapper.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/adapter/in/rest/EventMapper.java
@@ -2,7 +2,9 @@
 
 import de.muenchen.oss.dbs.ticketing.eventing.service.domain.model.Event;
 import org.mapstruct.Mapper;
+import org.springframework.stereotype.Component;
 
+@Component
 @Mapper
 interface EventMapper {
     Event fromDto(String action, EventDTO dto);
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/adapter/in/rest/RestAdapter.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/adapter/in/rest/RestAdapter.java
@@ -3,6 +3,8 @@
 import de.muenchen.oss.dbs.ticketing.eventing.service.configuration.DbsEventingProperties;
 import de.muenchen.oss.dbs.ticketing.eventing.service.core.port.in.HandleEventInPort;
 import de.muenchen.oss.dbs.ticketing.eventing.service.domain.model.Event;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
@@ -13,31 +15,42 @@
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.server.ResponseStatusException;
 
+import static de.muenchen.oss.dbs.ticketing.eventing.service.configuration.OpenAPIDocumentationConfiguration.BASIC_SCHEME_NAME;
+
 @Service
-@RestController("/api/")
+@RestController
 @RequiredArgsConstructor
 @Slf4j
 public class RestAdapter {
-    private static final String TRIGGER_HEADER = "X-Zammad-Trigger";
-    private static final String ID_HEADER = "X-Zammad-Delivery";
+    private static final String HEADER_TRIGGER_NAME = "X-Zammad-Trigger";
+    private static final String HEADER_DELIVERY_ID = "X-Zammad-Delivery";
 
     private final DbsEventingProperties dbsEventingProperties;
     private final HandleEventInPort handleEventInPort;
     private final EventMapper eventMapper;
 
-    @PostMapping("event")
+    /**
+     * Endpoint for receiving Zammad webhook events.
+     *
+     * @param triggerName Name of the trigger of the event
+     * @param deliveryId Random unique identifier of event
+     * @param eventDto Event payload
+     */
+    @PostMapping("/api/event")
+    @SecurityRequirement(name = BASIC_SCHEME_NAME)
+    @ApiResponse(responseCode = "200", description = "Successfully processed event")
     public void event(
-            @RequestHeader(TRIGGER_HEADER) final String trigger,
-            @RequestHeader(ID_HEADER) final String deliveryId,
+            @RequestHeader(HEADER_TRIGGER_NAME) final String triggerName,
+            @RequestHeader(HEADER_DELIVERY_ID) final String deliveryId,
             @RequestBody final EventDTO eventDto) {
-        log.info("Received event {} from trigger {}: {}", deliveryId, trigger, eventDto);
-        final String action = dbsEventingProperties.getTriggerMapping().get(trigger);
+        log.info("Received event '{}' from trigger '{}': {}", deliveryId, triggerName, eventDto);
+        final String action = dbsEventingProperties.mapTriggerToAction(triggerName);
         if (action == null) {
-            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "No mapping for trigger %s".formatted(trigger));
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "No mapping for trigger '%s'".formatted(triggerName));
         }
         final Event event = eventMapper.fromDto(action, eventDto);
-        log.debug("Mapped trigger {} and payload to event {}", trigger, event);
+        log.debug("Mapped trigger '{}' and payload to event {}", triggerName, event);
         handleEventInPort.handleEvent(event);
-        log.debug("Handled event successfully");
+        log.debug("Handled event '{}' successfully", deliveryId);
     }
 }
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/DbsEventingProperties.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/DbsEventingProperties.java
@@ -1,16 +1,54 @@
 package de.muenchen.oss.dbs.ticketing.eventing.service.configuration;
 
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
-import java.util.Map;
+
+import java.util.List;
+
 import lombok.Getter;
 import lombok.Setter;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.validation.annotation.Validated;
 
 @Configuration
 @ConfigurationProperties("dbs.eventing")
 @Getter
 @Setter
+@Validated
 public class DbsEventingProperties {
-    @NotNull private Map<String, String> triggerMapping;
+    /**
+     * Map for transforming trigger name into action.
+     * Decouples trigger name from event action.
+     */
+    @NestedConfigurationProperty @Valid
+    @NotNull private List<TriggerMatching> triggerMapping;
+
+    /**
+     * Maps a trigger name to the according action.
+     * See {@link #triggerMapping}
+     *
+     * @param triggerName Name of the trigger
+     * @return According action
+     */
+    public String mapTriggerToAction(final String triggerName) {
+        return triggerMapping.stream()
+                // TODO case insensitive?
+                .filter(i -> i.triggerName.equals(triggerName))
+                .findFirst()
+                .map(TriggerMatching::action).orElse(null);
+    }
+
+    /**
+     * Mapping from trigger name to action.
+     *
+     * @param triggerName The name of the trigger.
+     * @param action The action to map to.
+     */
+    public record TriggerMatching(
+            @NotBlank String triggerName,
+            @NotBlank String action
+    ) {}
 }
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/OpenAPIDocumentationConfiguration.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/OpenAPIDocumentationConfiguration.java
@@ -1,7 +1,10 @@
 package de.muenchen.oss.dbs.ticketing.eventing.service.configuration;
 
+import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -10,11 +13,23 @@
 @RequiredArgsConstructor
 public class OpenAPIDocumentationConfiguration {
 
+    public static final String BASIC_SCHEME_NAME = "basicScheme";
+    private static final String BASIC_SCHEME = "basic";
+
     private final OpenAPIProperties openAPIProperties;
 
     @Bean
     public OpenAPI customOpenAPI() {
         return new OpenAPI()
-                .info(new Info().title(openAPIProperties.getName()).description(openAPIProperties.getDescription()).version(openAPIProperties.getVersion()));
+                .info(new Info()
+                        .title(openAPIProperties.getName())
+                        .description(openAPIProperties.getDescription())
+                        .version(openAPIProperties.getVersion()))
+                .components(new Components()
+                        .addSecuritySchemes(BASIC_SCHEME_NAME,
+                                new SecurityScheme()
+                                        .type(SecurityScheme.Type.HTTP)
+                                        .scheme(BASIC_SCHEME)))
+                .addSecurityItem(new SecurityRequirement().addList(BASIC_SCHEME));
     }
 }
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/security/SecurityConfiguration.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/configuration/security/SecurityConfiguration.java
@@ -12,6 +12,7 @@
 import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
 import org.springframework.security.web.SecurityFilterChain;
 import org.springframework.security.web.servlet.util.matcher.PathPatternRequestMatcher;
 
@@ -58,6 +59,8 @@ public SecurityFilterChain filterChain(final HttpSecurity http) throws Exception
                 .authorizeHttpRequests((requests) -> requests
                         .anyRequest()
                         .authenticated())
+                // disable CSRF as server only api without preflight requests
+                .csrf(AbstractHttpConfigurer::disable)
                 .httpBasic(Customizer.withDefaults());
 
         return http.build();
diff --git a/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/domain/model/Event.java b/ticketing-eventing/eventing-service/src/main/java/de/muenchen/oss/dbs/ticketing/eventing/service/domain/model/Event.java
@@ -1,8 +1,10 @@
 package de.muenchen.oss.dbs.ticketing.eventing.service.domain.model;
 
+import jakarta.validation.constraints.NotBlank;
+
 public record Event(
-        String action,
-        String ticket,
+        @NotBlank String action,
+        @NotBlank String ticket,
         String status,
         String status_id,
         String anliegenart,
diff --git a/ticketing-eventing/eventing-service/src/main/resources/application-local.yml b/ticketing-eventing/eventing-service/src/main/resources/application-local.yml
@@ -31,5 +31,11 @@ logging:
   level:
     root: INFO
     de.muenchen.oss.dbs.ticketing.eventing: DEBUG
-    org.springframework.cache: TRACE
     org.springframework.web: DEBUG
+    org.springframework.security: DEBUG
+
+dbs:
+  eventing:
+    trigger-mapping:
+      - trigger-name: "Trigger Name"
+        action: "ticket_create"
diff --git a/ticketing-eventing/eventing-service/src/main/resources/application.yml b/ticketing-eventing/eventing-service/src/main/resources/application.yml
@@ -25,6 +25,7 @@ server:
   error:
     whitelabel:
       enabled: false
+    include-message: always
 
 # Config for spring actuator endpoints
 management:
@@ -61,7 +62,6 @@ management:
       enabled: true
 
 springdoc:
-  show-actuator: true
   # Disable swagger-ui as default
   swagger-ui:
     enabled: false
@@ -72,6 +72,7 @@ springdoc:
 logging:
   level:
     root: info
+    org.apache.kafka: warn
   structured:
     format:
       console: logstash

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,8 @@`
`10`	`10`	`@SpringBootApplication`
`11`	`11`	`@ConfigurationPropertiesScan`
`12`	`12`	`@SuppressWarnings("PMD.UseUtilityClass")`
`13`		`-public class MicroServiceApplication {`
	`13`	`+public class DbsTicketingEventingService {`
`14`	`14`	`public static void main(final String[] args) {`
`15`		`- SpringApplication.run(MicroServiceApplication.class, args);`
	`15`	`+ SpringApplication.run(DbsTicketingEventingService.class, args);`
`16`	`16`	`}`
`17`	`17`	`}`