Skip to content

Commit 52a4d5a

Browse files
authored
fix: typo in RemindingNotifier interval setter (#5397)
Signed-off-by: Vinod Kumar <codingkiddo@gmail.com>
1 parent 5ac6a56 commit 52a4d5a

7 files changed

Lines changed: 52 additions & 11 deletions

File tree

spring-boot-admin-docs/src/site/docs/02-server/notifications/90-custom-notifiers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ public class NotifierConfig {
357357
RemindingNotifier notifier = new RemindingNotifier(
358358
filteringNotifier, repository);
359359
notifier.setReminderPeriod(Duration.ofMinutes(10));
360-
notifier.setCheckReminderInverval(Duration.ofSeconds(10));
360+
notifier.setCheckReminderInterval(Duration.ofSeconds(10));
361361
return notifier;
362362
}
363363

spring-boot-admin-docs/src/site/docs/02-server/notifications/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public class NotifierConfiguration {
6969
public RemindingNotifier remindingNotifier() {
7070
RemindingNotifier notifier = new RemindingNotifier(notifier, repository);
7171
notifier.setReminderPeriod(Duration.ofMinutes(10)); // (1)
72-
notifier.setCheckReminderInverval(Duration.ofSeconds(10)); //(2)
72+
notifier.setCheckReminderInterval(Duration.ofSeconds(10)); //(2)
7373
return notifier;
7474
}
7575
}
@@ -123,7 +123,7 @@ public class NotifierConfig {
123123
public RemindingNotifier remindingNotifier() { // (2)
124124
RemindingNotifier notifier = new RemindingNotifier(filteringNotifier(), this.repository);
125125
notifier.setReminderPeriod(Duration.ofMinutes(10));
126-
notifier.setCheckReminderInverval(Duration.ofSeconds(10));
126+
notifier.setCheckReminderInterval(Duration.ofSeconds(10));
127127
return notifier;
128128
}
129129

spring-boot-admin-docs/src/site/docs/09-samples/10-sample-servlet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ public class NotifierConfig {
362362
filteringNotifier(), repository
363363
);
364364
notifier.setReminderPeriod(Duration.ofMinutes(10));
365-
notifier.setCheckReminderInverval(Duration.ofSeconds(10));
365+
notifier.setCheckReminderInterval(Duration.ofSeconds(10));
366366
return notifier;
367367
}
368368
}

spring-boot-admin-docs/src/site/docs/10-reference/10-event-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ public RemindingNotifier remindingNotifier(Notifier delegate,
593593
InstanceRepository repository) {
594594
RemindingNotifier notifier = new RemindingNotifier(delegate, repository);
595595
notifier.setReminderPeriod(Duration.ofMinutes(10));
596-
notifier.setCheckReminderInverval(Duration.ofSeconds(60));
596+
notifier.setCheckReminderInterval(Duration.ofSeconds(60));
597597
return notifier;
598598
}
599599
```

spring-boot-admin-samples/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/sample/NotifierConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public FilteringNotifier filteringNotifier() { // <1>
5555
public RemindingNotifier remindingNotifier() { // <2>
5656
RemindingNotifier notifier = new RemindingNotifier(filteringNotifier(), this.repository);
5757
notifier.setReminderPeriod(Duration.ofMinutes(10));
58-
notifier.setCheckReminderInverval(Duration.ofSeconds(10));
58+
notifier.setCheckReminderInterval(Duration.ofSeconds(10));
5959
return notifier;
6060
}
6161

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/RemindingNotifier.java

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public class RemindingNotifier extends AbstractEventNotifier {
5353

5454
private final Notifier delegate;
5555

56-
private Duration checkReminderInverval = Duration.ofSeconds(10);
56+
private Duration checkReminderInterval = Duration.ofSeconds(10);
5757

5858
private Duration reminderPeriod = Duration.ofMinutes(10);
5959

@@ -83,7 +83,7 @@ else if (shouldStartReminder(event)) {
8383

8484
public void start() {
8585
this.reminderScheduler = Schedulers.newSingle("reminders");
86-
this.subscription = Flux.interval(this.checkReminderInverval, this.reminderScheduler)
86+
this.subscription = Flux.interval(this.checkReminderInterval, this.reminderScheduler)
8787
.log(log.getName(), Level.FINEST)
8888
.doOnSubscribe((s) -> log.debug("Started reminders"))
8989
.flatMap((i) -> this.sendReminders())
@@ -141,8 +141,22 @@ public void setReminderStatuses(String[] reminderStatuses) {
141141
this.reminderStatuses = copy;
142142
}
143143

144-
public void setCheckReminderInverval(Duration checkReminderInverval) {
145-
this.checkReminderInverval = checkReminderInverval;
144+
/**
145+
* Set the interval used to check for reminders.
146+
* @param checkReminderInterval the interval used to check for reminders
147+
*/
148+
public void setCheckReminderInterval(Duration checkReminderInterval) {
149+
this.checkReminderInterval = checkReminderInterval;
150+
}
151+
152+
/**
153+
* Set the interval used to check for reminders.
154+
* @param checkReminderInterval the interval used to check for reminders
155+
* @deprecated use {@link #setCheckReminderInterval(Duration)} instead.
156+
*/
157+
@Deprecated
158+
public void setCheckReminderInverval(Duration checkReminderInterval) {
159+
setCheckReminderInterval(checkReminderInterval);
146160
}
147161

148162
protected static final class Reminder {

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/notify/RemindingNotifierTest.java

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ void should_resubscribe_after_error() {
159159

160160
RemindingNotifier reminder = new RemindingNotifier(notifier, this.repository);
161161
eventPublisher.flux().flatMap(reminder::notify).subscribe();
162-
reminder.setCheckReminderInverval(Duration.ofMillis(10));
162+
reminder.setCheckReminderInterval(Duration.ofMillis(10));
163163
reminder.setReminderPeriod(Duration.ofMillis(10));
164164
reminder.start();
165165
});
@@ -175,4 +175,31 @@ void should_resubscribe_after_error() {
175175
.verify();
176176
}
177177

178+
@SuppressWarnings("deprecation")
179+
@Test
180+
void should_support_deprecated_check_reminder_inverval_setter() {
181+
TestPublisher<InstanceEvent> eventPublisher = TestPublisher.create();
182+
183+
Flux<InstanceEvent> emittedNotifications = Flux.create((emitter) -> {
184+
Notifier notifier = (event) -> {
185+
emitter.next(event);
186+
return Mono.empty();
187+
};
188+
189+
RemindingNotifier reminder = new RemindingNotifier(notifier, this.repository);
190+
eventPublisher.flux().flatMap(reminder::notify).subscribe();
191+
192+
reminder.setCheckReminderInverval(Duration.ofMillis(10));
193+
reminder.setReminderPeriod(Duration.ofMillis(10));
194+
reminder.start();
195+
});
196+
197+
StepVerifier.create(emittedNotifications)
198+
.expectSubscription()
199+
.then(() -> eventPublisher.next(appDown))
200+
.expectNext(appDown, appDown)
201+
.thenCancel()
202+
.verify();
203+
}
204+
178205
}

0 commit comments

Comments
 (0)