Skip to content

fix event/list #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanjbaxter merged 1 commit into from
Aug 21, 2026
+25 −15
Merged

fix event/list #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ul-binder/src/main/java/org/springframework/cloud/consul/binder/ConsulSendingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ protected void handleMessageInternal(Message<?> message) {

// TODO: support headers
// TODO: support consul event filters: NodeFilter, ServiceFilter, TagFilter
ResponseEntity<Event> event = this.consul.eventFire(this.eventName, (String) payload);
ResponseEntity<Event> event = this.consul.eventFire(this.eventName, (String) payload, null);
// TODO: return event?
}

Expand Down
7 changes: 4 additions & 3 deletions ...oud-consul-binder/src/main/java/org/springframework/cloud/consul/binder/EventService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ private void setLastIndex(ResponseEntity<?> response) {
}

public Event fire(String name, String payload) {
ResponseEntity<Event> response = this.consul.eventFire(name, payload);
ResponseEntity<Event> response = this.consul.eventFire(name, payload, null);
return response.getBody();
}

public ResponseEntity<List<Event>> getEventsResponse() {
return this.consul.eventList();
return this.consul.eventList(null, null, null, null, null);
}

public List<Event> getEvents() {
Expand All @@ -98,7 +98,8 @@ public List<Event> watch(Long lastIndex) {
if (this.properties != null) {
eventTimeout = this.properties.getEventTimeout();
}
ResponseEntity<List<Event>> watch = this.consul.eventList((long) eventTimeout, index);
ResponseEntity<List<Event>> watch = this.consul.eventList((long) eventTimeout, index, null, null, null, null,
null);
return filterEvents(readEvents(watch), lastIndex);
}

Expand Down
19 changes: 14 additions & 5 deletions spring-cloud-consul-core/src/main/java/org/springframework/cloud/consul/ConsulClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,24 @@ ResponseEntity<List<GetValue>> getKVValues(@PathVariable String context,
@PutExchange(url = "/v1/kv/{context}", contentType = MediaType.TEXT_PLAIN_VALUE)
ResponseEntity<Boolean> setKVValue(@PathVariable String context, @RequestBody String value);

@GetExchange("/v1/events")
ResponseEntity<List<Event>> eventList();
@GetExchange("/v1/event/list")
ResponseEntity<List<Event>> eventList(@RequestParam(name = "name", required = false) String name,
@RequestParam(name = "node", required = false) String node,
@RequestParam(name = "service", required = false) String service,
@RequestParam(name = "tag", required = false) String tag,
@RequestHeader(name = ACL_TOKEN_HEADER, required = false) String aclToken);

@GetExchange("/v1/events")
@GetExchange("/v1/event/list")
ResponseEntity<List<Event>> eventList(@RequestParam("wait") @WaitTimeFormat Long eventTimeout,
@RequestParam("index") long index);
@RequestParam("index") long index, @RequestParam(name = "name", required = false) String name,
@RequestParam(name = "node", required = false) String node,
@RequestParam(name = "service", required = false) String service,
@RequestParam(name = "tag", required = false) String tag,
@RequestHeader(name = ACL_TOKEN_HEADER, required = false) String aclToken);

@PostExchange("/v1/event/fire/{name}")
ResponseEntity<Event> eventFire(@PathVariable String name, @RequestBody String payload);
ResponseEntity<Event> eventFire(@PathVariable String name, @RequestBody String payload,
@RequestHeader(name = ACL_TOKEN_HEADER, required = false) String aclToken);

class QueryParams {

Expand Down
12 changes: 6 additions & 6 deletions ...sul-core/src/test/java/org/springframework/cloud/consul/ConsulClientIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ void getKVValues_WithWaitTimeAndIndexAndAclToken() {
@Test
void eventListWithWaitTimeAndIndex() {

mockServerClient.when(request().withMethod("GET").withPath("/v1/events"))
mockServerClient.when(request().withMethod("GET").withPath("/v1/event/list"))
.respond(response().withStatusCode(200)
.withHeaders(new Header("Content-Type", "application/json"))
.withBody(json("[\n" + " {\n" + " \"ID\": \"5548d61d-9e97-8e0e-e2b3-1f5f0af5b1a2\",\n"
Expand All @@ -163,12 +163,12 @@ void eventListWithWaitTimeAndIndex() {
+ " \"TagFilter\": \"\",\n" + " \"Version\": 1,\n" + " \"LTime\": 19\n" + " }\n"
+ "]\n")));

ResponseEntity<List<Event>> response = client.eventList(5L, 2);
ResponseEntity<List<Event>> response = client.eventList(5L, 2, "deploy", null, null, null, null);

mockServerClient.verify(
request().withMethod("GET")
.withPath("/v1/events")
.withQueryStringParameters(Parameter.param("wait", "5s"), Parameter.param("index", "2")),
mockServerClient.verify(request().withMethod("GET")
.withPath("/v1/event/list")
.withQueryStringParameters(Parameter.param("name", "deploy"), Parameter.param("wait", "5s"),
Parameter.param("index", "2")),
VerificationTimes.exactly(1));

assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
Expand Down
Loading