From 2e09fd99877c5cb16ac9819407d8cbd7a9bec4e5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stephan=20K=C3=B6ninger?= <stephan.koeninger@codecentric.de>
Date: Mon, 23 Dec 2024 16:15:28 +0100
Subject: [PATCH] feat(#1939): implement UI button to retrigger service
 detection (#3938)

---
 .../discovery/InstanceDiscoveryListener.java  |  8 +++++-
 .../frontend/views/applications/i18n.de.json  |  1 +
 .../frontend/views/applications/i18n.en.json  |  1 +
 .../frontend/views/applications/index.vue     | 14 +++++++++-
 .../config/AdminServerWebConfiguration.java   |  8 +++---
 .../server/web/ApplicationsController.java    | 15 +++++++++--
 .../web/client/RefreshInstancesEvent.java     | 27 +++++++++++++++++++
 7 files changed, 67 insertions(+), 7 deletions(-)
 create mode 100644 spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/RefreshInstancesEvent.java

diff --git a/spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/InstanceDiscoveryListener.java b/spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/InstanceDiscoveryListener.java
index 1cda69fa7f1..fd4a2c5d8ab 100644
--- a/spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/InstanceDiscoveryListener.java
+++ b/spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/InstanceDiscoveryListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,6 +42,7 @@
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 import de.codecentric.boot.admin.server.domain.values.Registration;
 import de.codecentric.boot.admin.server.services.InstanceRegistry;
+import de.codecentric.boot.admin.server.web.client.RefreshInstancesEvent;
 
 /**
  * Listener for Heartbeats events to publish all services to the instance registry.
@@ -105,6 +106,11 @@ public void onInstanceRegistered(InstanceRegisteredEvent<?> event) {
 		discover();
 	}
 
+	@EventListener
+	public void onRefreshInstances(RefreshInstancesEvent event) {
+		discover();
+	}
+
 	@EventListener
 	public void onParentHeartbeat(ParentHeartbeatEvent event) {
 		discoverIfNeeded(event.getValue());
diff --git a/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.de.json b/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.de.json
index 98dad65be8a..c24b046e14a 100644
--- a/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.de.json
+++ b/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.de.json
@@ -28,6 +28,7 @@
     "status": "Status",
     "label": "Anwendungen",
     "shutdown": "Möchten Sie die Anwendung <code>{name}</code> herunterfahren?",
+    "refreshed": "Anwendungen wurden aktualisiert.",
     "restart": "Möchten Sie Anwendung <code>{name}</code> neu starten?",
     "restarted": "Die Anwendung wurde neu gestartet.",
     "unregister": "Möchten Sie die Anwendung <code>{name}</code> deregistrieren?",
diff --git a/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.en.json b/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.en.json
index bb795a3e599..8a0ae213ca4 100644
--- a/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.en.json
+++ b/spring-boot-admin-server-ui/src/main/frontend/views/applications/i18n.en.json
@@ -32,6 +32,7 @@
     "offline": "offline",
     "shutdown": "Shutdown application <code>{name}</code>?",
     "shutdown_successful": "Successfully shutdown application {name}.",
+    "refreshed": "Applications refreshed.",
     "restart": "Restart application <code>{name}</code>?",
     "restarted": "Successfully restarted application <code>{name}</code>.",
     "unregister": "Deregister application <code>{name}</code>?",
diff --git a/spring-boot-admin-server-ui/src/main/frontend/views/applications/index.vue b/spring-boot-admin-server-ui/src/main/frontend/views/applications/index.vue
index ec8f0057b31..71728ef925b 100644
--- a/spring-boot-admin-server-ui/src/main/frontend/views/applications/index.vue
+++ b/spring-boot-admin-server-ui/src/main/frontend/views/applications/index.vue
@@ -1,5 +1,5 @@
 <!--
-  - Copyright 2014-2019 the original author or authors.
+  - Copyright 2014-2024 the original author or authors.
   -
   - Licensed under the Apache License, Version 2.0 (the "License");
   - you may not use this file except in compliance with the License.
@@ -21,6 +21,9 @@
       <sba-sticky-subnav>
         <div class="container mx-auto flex">
           <ApplicationStats />
+          <sba-confirm-button class="mr-1" @click="refreshContext">
+            <font-awesome-icon :icon="'rotate-left'" />
+          </sba-confirm-button>
           <ApplicationNotificationCenter
             v-if="hasNotificationFiltersSupport"
             :notification-filters="notificationFilters"
@@ -196,6 +199,9 @@ import ApplicationStats from '@/views/applications/ApplicationStats.vue';
 import ApplicationStatusHero from '@/views/applications/ApplicationStatusHero.vue';
 import InstancesList from '@/views/applications/InstancesList.vue';
 import NotificationFilterSettings from '@/views/applications/NotificationFilterSettings.vue';
+import SbaButton from '@/components/sba-button.vue';
+import SbaConfirmButton from '@/components/sba-confirm-button.vue';
+import axios from '@/utils/axios';
 
 const props = defineProps({
   error: {
@@ -320,6 +326,12 @@ const grouped = computed(() => {
   return sortBy(list, [(item) => getApplicationStatus(item)]);
 });
 
+const refreshContext = () => {
+  axios.post('/applications').then(() => {
+    notificationCenter.success(t('applications.refreshed'));
+  });
+};
+
 function getApplicationStatus(item: InstancesListType): string {
   return applicationStore.findApplicationByInstanceId(item.instances[0].id)
     ?.status;
diff --git a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerWebConfiguration.java b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerWebConfiguration.java
index f4b7ee4357f..3a8918647f9 100644
--- a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerWebConfiguration.java
+++ b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerWebConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.accept.ContentNegotiationManager;
@@ -56,8 +57,9 @@ public InstancesController instancesController(InstanceRegistry instanceRegistry
 
 	@Bean
 	@ConditionalOnMissingBean
-	public ApplicationsController applicationsController(ApplicationRegistry applicationRegistry) {
-		return new ApplicationsController(applicationRegistry);
+	public ApplicationsController applicationsController(ApplicationRegistry applicationRegistry,
+			ApplicationEventPublisher applicationEventPublisher) {
+		return new ApplicationsController(applicationRegistry, applicationEventPublisher);
 	}
 
 	@Configuration(proxyBeanMethods = false)
diff --git a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/ApplicationsController.java b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/ApplicationsController.java
index b2570aa3117..5dfbc22bd20 100644
--- a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/ApplicationsController.java
+++ b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/ApplicationsController.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,18 +20,21 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.codec.ServerSentEvent;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import de.codecentric.boot.admin.server.domain.entities.Application;
 import de.codecentric.boot.admin.server.services.ApplicationRegistry;
+import de.codecentric.boot.admin.server.web.client.RefreshInstancesEvent;
 
 /**
  * REST controller for controlling registration of managed instances.
@@ -49,8 +52,11 @@ public class ApplicationsController {
 
 	private final ApplicationRegistry registry;
 
-	public ApplicationsController(ApplicationRegistry registry) {
+	private final ApplicationEventPublisher publisher;
+
+	public ApplicationsController(ApplicationRegistry registry, ApplicationEventPublisher publisher) {
 		this.registry = registry;
+		this.publisher = publisher;
 	}
 
 	@GetMapping(path = "/applications", produces = MediaType.APPLICATION_JSON_VALUE)
@@ -58,6 +64,11 @@ public Flux<Application> applications() {
 		return registry.getApplications();
 	}
 
+	@PostMapping(path = "/applications", produces = MediaType.APPLICATION_JSON_VALUE)
+	public void refreshApplications() {
+		publisher.publishEvent(new RefreshInstancesEvent(this));
+	}
+
 	@GetMapping(path = "/applications/{name}", produces = MediaType.APPLICATION_JSON_VALUE)
 	public Mono<ResponseEntity<Application>> application(@PathVariable("name") String name) {
 		return registry.getApplication(name).map(ResponseEntity::ok).defaultIfEmpty(ResponseEntity.notFound().build());
diff --git a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/RefreshInstancesEvent.java b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/RefreshInstancesEvent.java
new file mode 100644
index 00000000000..514e8552a6f
--- /dev/null
+++ b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/RefreshInstancesEvent.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2014-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package de.codecentric.boot.admin.server.web.client;
+
+import org.springframework.context.ApplicationEvent;
+
+public class RefreshInstancesEvent extends ApplicationEvent {
+
+	public RefreshInstancesEvent(Object source) {
+		super(source);
+	}
+
+}