Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

fix(scheduler): honor target EventBridgeParameters DetailType/Source (#1489)

Saliou Gaye8590ffec34b6
diff --git a/src/main/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvoker.java b/src/main/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvoker.java
index fb854aae0d..0d37e54934 100644
--- a/src/main/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvoker.java
+++ b/src/main/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvoker.java
@@ -9,6 +9,7 @@ import io.github.hectorvent.floci.services.ecs.model.LaunchType;
import io.github.hectorvent.floci.services.eventbridge.EventBridgeService;
import io.github.hectorvent.floci.services.lambda.LambdaService;
import io.github.hectorvent.floci.services.lambda.model.InvocationType;
+import io.github.hectorvent.floci.services.scheduler.model.EventBridgeParameters;
import io.github.hectorvent.floci.services.scheduler.model.EcsParameters;
import io.github.hectorvent.floci.services.scheduler.model.Target;
import io.github.hectorvent.floci.services.sns.SnsService;
@@ -94,7 +95,7 @@ public class ScheduleInvoker {
deliverToEcsRunTask(target, targetRegion);
LOG.debugv("Scheduler delivered to ECS RunTask: {0}", arn);
} else if (isEventBridgePutEventsArn(arn)) {
- deliverToEventBridge(arn, payload, targetRegion);
+ deliverToEventBridge(target, payload, targetRegion);
LOG.debugv("Scheduler delivered to EventBridge: {0}", arn);
} else {
LOG.warnv("Scheduler: unsupported target ARN type: {0}", arn);
@@ -193,12 +194,23 @@ public class ScheduleInvoker {
return arn.contains(":events:") && arn.contains(":event-bus/");
}
- private void deliverToEventBridge(String busArn, String payload, String region) {
+ private void deliverToEventBridge(Target target, String payload, String region) {
+ String busArn = target.getArn();
String busName = busArn.substring(busArn.indexOf(":event-bus/") + ":event-bus/".length());
+
+ // AWS requires DetailType and Source on the target's EventBridgeParameters for
+ // event-bus targets; honor them. Keep the historical defaults as a fallback for
+ // schedules created without those parameters.
+ EventBridgeParameters ebp = target.getEventBridgeParameters();
+ String source = ebp != null && ebp.getSource() != null && !ebp.getSource().isBlank()
+ ? ebp.getSource() : "aws.scheduler";
+ String detailType = ebp != null && ebp.getDetailType() != null && !ebp.getDetailType().isBlank()
+ ? ebp.getDetailType() : "Scheduled Event";
+
Map<String, Object> entry = new HashMap<>();
entry.put("EventBusName", busName);
- entry.put("Source", "aws.scheduler");
- entry.put("DetailType", "Scheduled Event");
+ entry.put("Source", source);
+ entry.put("DetailType", detailType);
entry.put("Detail", asDetail(payload));
eventBridgeService.putEvents(List.of(entry), region);
}
diff --git a/src/main/java/io/github/hectorvent/floci/services/scheduler/SchedulerController.java b/src/main/java/io/github/hectorvent/floci/services/scheduler/SchedulerController.java
index 826195ea34..3febecc115 100644
--- a/src/main/java/io/github/hectorvent/floci/services/scheduler/SchedulerController.java
+++ b/src/main/java/io/github/hectorvent/floci/services/scheduler/SchedulerController.java
@@ -5,6 +5,7 @@ import io.github.hectorvent.floci.core.common.RegionResolver;
import io.github.hectorvent.floci.services.scheduler.model.AwsVpcConfiguration;
import io.github.hectorvent.floci.services.scheduler.model.DeadLetterConfig;
import io.github.hectorvent.floci.services.scheduler.model.EcsParameters;
+import io.github.hectorvent.floci.services.scheduler.model.EventBridgeParameters;
import io.github.hectorvent.floci.services.scheduler.model.FlexibleTimeWindow;
import io.github.hectorvent.floci.services.scheduler.model.NetworkConfiguration;
import io.github.hectorvent.floci.services.scheduler.model.RetryPolicy;
@@ -276,6 +277,19 @@ public class SchedulerController {
t.put("EcsParameters", ep);
}
}
+ if (s.getTarget().getEventBridgeParameters() != null) {
+ EventBridgeParameters ebp = s.getTarget().getEventBridgeParameters();
+ Map<String, Object> eb = new HashMap<>();
+ if (ebp.getDetailType() != null) {
+ eb.put("DetailType", ebp.getDetailType());
+ }
+ if (ebp.getSource() != null) {
+ eb.put("Source", ebp.getSource());
+ }
+ if (!eb.isEmpty()) {
+ t.put("EventBridgeParameters", eb);
+ }
+ }
r.put("Target", t);
}
if (s.getDescription() != null) {
@@ -414,6 +428,44 @@ public class SchedulerController {
if (node.has("EcsParameters") && !node.get("EcsParameters").isNull()) {
target.setEcsParameters(parseEcsParameters(node.get("EcsParameters")));
}
+ if (node.has("EventBridgeParameters") && !node.get("EventBridgeParameters").isNull()) {
+ JsonNode ebNode = node.get("EventBridgeParameters");
+ EventBridgeParameters ebp = new EventBridgeParameters();
+ if (
+ ebNode.has("DetailType") &&
+ !ebNode.get("DetailType").isNull() &&
+ !ebNode.get("DetailType").asText().isBlank()
+ ) {
+ ebp.setDetailType(ebNode.get("DetailType").asText());
+ }
+ if (
+ ebNode.has("Source") &&
+ !ebNode.get("Source").isNull() &&
+ !ebNode.get("Source").asText().isBlank()
+ ) {
+ ebp.setSource(ebNode.get("Source").asText());
+ }
+ if (ebp.getDetailType() == null || ebp.getSource() == null) {
+ throw new AwsException("ValidationException",
+ "EventBridgeParameters requires both DetailType and Source.", 400);
+ }
+
+ if(ebp.getDetailType().length() > 128) {
+ throw new AwsException("ValidationException",
+ "EventBridgeParameters DetailType must be less than or equal to 128 characters.", 400);
+ }
+ if(ebp.getSource().length() > 256) {
+ throw new AwsException("ValidationException",
+ "EventBridgeParameters Source must be less than or equal to 256 characters.", 400);
+ }
+
+ if(ebp.getSource().startsWith("aws.") || ebp.getSource().startsWith("aws:")) {
+ throw new AwsException("ValidationException",
+ "EventBridgeParameters Source cannot start with 'aws.' or 'aws:'.", 400);
+ }
+
+ target.setEventBridgeParameters(ebp);
+ }
return target;
}
diff --git a/src/main/java/io/github/hectorvent/floci/services/scheduler/model/EventBridgeParameters.java b/src/main/java/io/github/hectorvent/floci/services/scheduler/model/EventBridgeParameters.java
new file mode 100644
index 0000000000..8ca2b98031
--- /dev/null
+++ b/src/main/java/io/github/hectorvent/floci/services/scheduler/model/EventBridgeParameters.java
@@ -0,0 +1,28 @@
+package io.github.hectorvent.floci.services.scheduler.model;
+
+import io.quarkus.runtime.annotations.RegisterForReflection;
+
+/**
+ * EventBridge Scheduler {@code Target.EventBridgeParameters}. Carries the
+ * {@code DetailType} and {@code Source} used for the PutEvents entry when the
+ * target is an EventBridge event bus (both required by AWS in that case).
+ */
+@RegisterForReflection
+public class EventBridgeParameters {
+
+ private String detailType;
+ private String source;
+
+ public EventBridgeParameters() {}
+
+ public EventBridgeParameters(String detailType, String source) {
+ this.detailType = detailType;
+ this.source = source;
+ }
+
+ public String getDetailType() { return detailType; }
+ public void setDetailType(String detailType) { this.detailType = detailType; }
+
+ public String getSource() { return source; }
+ public void setSource(String source) { this.source = source; }
+}
diff --git a/src/main/java/io/github/hectorvent/floci/services/scheduler/model/Target.java b/src/main/java/io/github/hectorvent/floci/services/scheduler/model/Target.java
index 92b26ce9aa..32cea24ddb 100644
--- a/src/main/java/io/github/hectorvent/floci/services/scheduler/model/Target.java
+++ b/src/main/java/io/github/hectorvent/floci/services/scheduler/model/Target.java
@@ -12,6 +12,7 @@ public class Target {
private DeadLetterConfig deadLetterConfig;
private SqsParameters sqsParameters;
private EcsParameters ecsParameters;
+ private EventBridgeParameters eventBridgeParameters;
public Target() {}
@@ -42,4 +43,7 @@ public class Target {
public EcsParameters getEcsParameters() { return ecsParameters; }
public void setEcsParameters(EcsParameters ecsParameters) { this.ecsParameters = ecsParameters; }
+
+ public EventBridgeParameters getEventBridgeParameters() { return eventBridgeParameters; }
+ public void setEventBridgeParameters(EventBridgeParameters eventBridgeParameters) { this.eventBridgeParameters = eventBridgeParameters; }
}
diff --git a/src/test/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvokerTest.java b/src/test/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvokerTest.java
index db66a505be..0c8f100dce 100644
--- a/src/test/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvokerTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/scheduler/ScheduleInvokerTest.java
@@ -7,6 +7,7 @@ import io.github.hectorvent.floci.services.ecs.model.ContainerOverride;
import io.github.hectorvent.floci.services.ecs.model.LaunchType;
import io.github.hectorvent.floci.services.eventbridge.EventBridgeService;
import io.github.hectorvent.floci.services.lambda.LambdaService;
+import io.github.hectorvent.floci.services.scheduler.model.EventBridgeParameters;
import io.github.hectorvent.floci.services.scheduler.model.AwsVpcConfiguration;
import io.github.hectorvent.floci.services.scheduler.model.EcsParameters;
import io.github.hectorvent.floci.services.scheduler.model.NetworkConfiguration;
@@ -19,7 +20,9 @@ import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import java.util.List;
+import java.util.Map;
+import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyString;
@@ -110,6 +113,41 @@ class ScheduleInvokerTest {
eq("Scheduler"), eq("us-east-1"));
}
+ @Test
+ @SuppressWarnings("unchecked")
+ void eventBusTargetUsesDeclaredDetailTypeAndSource() {
+ Target target = new Target();
+ target.setArn("arn:aws:events:us-east-1:000000000000:event-bus/my-bus");
+ target.setInput("{\"hello\":\"world\"}");
+ target.setEventBridgeParameters(new EventBridgeParameters("Order Placed", "my.app"));
+
+ invoker.invoke(target, "us-east-1");
+
+ ArgumentCaptor<List<Map<String, Object>>> captor = ArgumentCaptor.forClass(List.class);
+ verify(eventBridgeService).putEvents(captor.capture(), eq("us-east-1"));
+ Map<String, Object> entry = captor.getValue().get(0);
+ assertEquals("my-bus", entry.get("EventBusName"));
+ assertEquals("my.app", entry.get("Source"));
+ assertEquals("Order Placed", entry.get("DetailType"));
+ assertEquals("{\"hello\":\"world\"}", entry.get("Detail"));
+ }
+
+ @Test
+ @SuppressWarnings("unchecked")
+ void eventBusTargetWithoutParametersFallsBackToDefaults() {
+ Target target = new Target();
+ target.setArn("arn:aws:events:us-east-1:000000000000:event-bus/my-bus");
+ target.setInput("{\"hello\":\"world\"}");
+
+ invoker.invoke(target, "us-east-1");
+
+ ArgumentCaptor<List<Map<String, Object>>> captor = ArgumentCaptor.forClass(List.class);
+ verify(eventBridgeService).putEvents(captor.capture(), eq("us-east-1"));
+ Map<String, Object> entry = captor.getValue().get(0);
+ assertEquals("aws.scheduler", entry.get("Source"));
+ assertEquals("Scheduled Event", entry.get("DetailType"));
+ }
+
@Test
void ecsSchedulerTargetRunsTaskWithNetworkConfiguration() {
Target target = new Target();
diff --git a/src/test/java/io/github/hectorvent/floci/services/scheduler/SchedulerIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/scheduler/SchedulerIntegrationTest.java
index 7e45a38068..6ba184449a 100644
--- a/src/test/java/io/github/hectorvent/floci/services/scheduler/SchedulerIntegrationTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/scheduler/SchedulerIntegrationTest.java
@@ -405,6 +405,145 @@ class SchedulerIntegrationTest {
.body("Target.SqsParameters.MessageGroupId", equalTo("group-1"));
}
+ @Test
+ @Order(39)
+ void createScheduleWithEventBridgeParametersRoundTrips() {
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"DetailType": "schedule.completed", "Source": "my.app"}
+ }
+ }
+ """)
+ .when()
+ .post("/schedules/eb-schedule")
+ .then()
+ .statusCode(200);
+
+ given()
+ .when()
+ .get("/schedules/eb-schedule")
+ .then()
+ .statusCode(200)
+ .body("Target.EventBridgeParameters.DetailType", equalTo("schedule.completed"))
+ .body("Target.EventBridgeParameters.Source", equalTo("my.app"));
+ }
+
+ @Test
+ @Order(40)
+ void createScheduleWithOnlyDetailTypeOrSourceReturns400() {
+ // AWS spec: EventBridgeParameters requires BOTH DetailType and Source.
+ // Providing only one must surface as ValidationException.
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"DetailType": "schedule.completed"}
+ }
+ }
+ """)
+ .when()
+ .post("/schedules/eb-only-detailtype")
+ .then()
+ .statusCode(400);
+
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"Source": "my.app"}
+ }
+ }
+ """)
+ .when()
+ .post("/schedules/eb-only-source")
+ .then()
+ .statusCode(400);
+ }
+
+ @Test
+ @Order(41)
+ void createScheduleWithOversizedDetailTypeOrSourceReturns400() {
+ // AWS spec: DetailType max 128 chars, Source max 256 chars.
+ String longDetailType = "d".repeat(129);
+ String longSource = "s".repeat(257);
+
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"DetailType": "%s", "Source": "my.app"}
+ }
+ }
+ """.formatted(longDetailType))
+ .when()
+ .post("/schedules/eb-long-detailtype")
+ .then()
+ .statusCode(400);
+
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"DetailType": "schedule.completed", "Source": "%s"}
+ }
+ }
+ """.formatted(longSource))
+ .when()
+ .post("/schedules/eb-long-source")
+ .then()
+ .statusCode(400);
+ }
+
+ @Test
+ @Order(42)
+ void createScheduleWithReservedSourcePrefixReturns400() {
+ // AWS spec: Source cannot start with the reserved "aws." or "aws:" prefix.
+ given()
+ .contentType("application/json")
+ .body("""
+ {
+ "ScheduleExpression": "rate(1 hour)",
+ "FlexibleTimeWindow": {"Mode": "OFF"},
+ "Target": {
+ "Arn": "arn:aws:events:us-east-1:000000000000:event-bus/my-bus",
+ "RoleArn": "arn:aws:iam::000000000000:role/scheduler-role",
+ "EventBridgeParameters": {"DetailType": "schedule.completed", "Source": "aws.myservice"}
+ }
+ }
+ """)
+ .when()
+ .post("/schedules/eb-reserved-source")
+ .then()
+ .statusCode(400);
+ }
+
@Test
@Order(21)
void createScheduleWithEcsParametersRoundTrips() {