Skip to content

Log broker availability events as String messages #36856

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

Open
kodacme wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −2
Open

Log broker availability events as String messages #36856

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
4 changes: 2 additions & 2 deletions ...src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ protected void publishBrokerAvailableEvent() {
boolean shouldPublish = this.brokerAvailable.compareAndSet(false, true);
if (this.eventPublisher != null && shouldPublish) {
if (logger.isInfoEnabled()) {
logger.info(this.availableEvent);
logger.info(this.availableEvent.toString());
}
this.eventPublisher.publishEvent(this.availableEvent);
}
Expand All @@ -344,7 +344,7 @@ protected void publishBrokerUnavailableEvent() {
boolean shouldPublish = this.brokerAvailable.compareAndSet(true, false);
if (this.eventPublisher != null && shouldPublish) {
if (logger.isInfoEnabled()) {
logger.info(this.notAvailableEvent);
logger.info(this.notAvailableEvent.toString());
}
this.eventPublisher.publishEvent(this.notAvailableEvent);
}
Expand Down
30 changes: 30 additions & 0 deletions ...ng/src/test/java/org/springframework/messaging/simp/broker/BrokerMessageHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@

package org.springframework.messaging.simp.broker;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.apache.commons.logging.Log;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;

import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationEventPublisher;
Expand All @@ -30,9 +33,13 @@
import org.springframework.messaging.simp.SimpMessageType;
import org.springframework.messaging.support.GenericMessage;
import org.springframework.messaging.support.MessageBuilder;
import org.springframework.util.ReflectionUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
* Tests for {@link org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler}.
Expand Down Expand Up @@ -112,6 +119,22 @@ void publishBrokerUnavailableEventWhenAlreadyUnavailable() {
assertThat(this.handler.availabilityEvents).isEqualTo(Arrays.asList(true, false));
}

@Test
void publishBrokerAvailabilityEventsLogStringMessages() {
Log logger = mock();
when(logger.isInfoEnabled()).thenReturn(true);
this.handler.setLogger(logger);

this.handler.publishBrokerAvailableEvent();
this.handler.publishBrokerUnavailableEvent();

ArgumentCaptor<Object> messageCaptor = ArgumentCaptor.forClass(Object.class);
verify(logger, times(2)).info(messageCaptor.capture());
assertThat(messageCaptor.getAllValues()).containsExactly(
"BrokerAvailabilityEvent[available=true, " + this.handler + "]",
"BrokerAvailabilityEvent[available=false, " + this.handler + "]");
}

@Test
void checkDestination() {
TestBrokerMessageHandler theHandler = new TestBrokerMessageHandler("/topic");
Expand Down Expand Up @@ -168,6 +191,13 @@ private static class TestBrokerMessageHandler extends AbstractBrokerMessageHandl
setApplicationEventPublisher(this);
}

void setLogger(Log logger) {
Field field = ReflectionUtils.findField(AbstractBrokerMessageHandler.class, "logger");
assertThat(field).isNotNull();
ReflectionUtils.makeAccessible(field);
ReflectionUtils.setField(field, this, logger);
}

@Override
protected void handleMessageInternal(Message<?> message) {
String destination = (String) message.getHeaders().get(SimpMessageHeaderAccessor.DESTINATION_HEADER);
Expand Down