Add option to configure selectable languages in the UI

closes #1417

Co-authored-by: Dušan Markovič <[email protected]>

Author: bratwurzt

spring-boot-admin-docs/src/main/asciidoc/customizing.adoc

@@ -140,3 +140,8 @@ It is possible to use a custom favicon, which is also used for desktop notificat
 2. Configure the icons to use using the following properties:
   - `spring.boot.admin.ui.favicon`: Used as default icon. (e.g `assets/img/custom-favicon.png`
   - `spring.boot.admin.ui.favicon-danger`: Used when one or more service is down. (e.g `assets/img/custom-favicon-danger.png`)
+
+=== Customizing Available Languages ===
+To filter languages to a subset of all supported languages:
+
+- **spring.boot.admin.ui.available-languages**: Used as a filter of existing languages. (e.g `en,de` out of existing `de,en,fr,ko,pt-BR,ru,zh`)

spring-boot-admin-server-ui/src/main/frontend/sba-config.js

@@ -25,6 +25,7 @@ const DEFAULT_CONFIG = {
     faviconDanger: 'assets/img/favicon-danger.png',
     notificationFilterEnabled: false,
     routes: [],
+    availableLanguages: []
   },
   user: null,
   extensions: [],

spring-boot-admin-server-ui/src/main/frontend/shell/navbar.vue

@@ -83,6 +83,7 @@
   import {compareBy} from '@/utils/collections';
   import {AVAILABLE_LANGUAGES} from '@/i18n';
   import moment from 'moment';
+  import isEmpty from 'lodash/isEmpty';
 
   const readCookie = (name) => {
     const match = document.cookie.match(new RegExp('(^|;\\s*)(' + name + ')=([^;]*)'));
@@ -132,7 +133,9 @@
       this.userName = sbaConfig.user ? sbaConfig.user.name : null;
       this.csrfToken = readCookie('XSRF-TOKEN');
       this.csrfParameterName = sbaConfig.csrf.parameterName;
-      this.availableLanguages = AVAILABLE_LANGUAGES;
+      this.availableLanguages = (isEmpty(sbaConfig.uiSettings.availableLanguages)) ?
+        AVAILABLE_LANGUAGES :
+        sbaConfig.uiSettings.availableLanguages.filter(language => AVAILABLE_LANGUAGES.includes(language))
       this.currentLanguage = this.$i18n.locale;
     },
     mounted() {

spring-boot-admin-server-ui/src/main/java/de/codecentric/boot/admin/server/ui/config/AdminServerUiAutoConfiguration.java

@@ -90,7 +90,8 @@ public UiController homeUiController(UiExtensions uiExtensions) throws IOExcepti
 				.notificationFilterEnabled(
 						!this.applicationContext.getBeansOfType(NotificationFilterController.class).isEmpty())
 				.routes(routes).rememberMeEnabled(this.adminUi.isRememberMeEnabled())
-				.externalViews(this.adminUi.getExternalViews()).build();
+				.availableLanguages(this.adminUi.getAvailableLanguages()).externalViews(this.adminUi.getExternalViews())
+				.build();
 
 		String publicUrl = (this.adminUi.getPublicUrl() != null) ? this.adminUi.getPublicUrl()
 				: this.adminServer.getContextPath();

spring-boot-admin-server-ui/src/main/java/de/codecentric/boot/admin/server/ui/config/AdminServerUiProperties.java

@@ -107,6 +107,12 @@ public class AdminServerUiProperties {
 	 */
 	private boolean rememberMeEnabled = true;
 
+	/**
+	 * Limit languages to this list. Intersection of all supported languages and this list
+	 * will be used.
+	 */
+	private List<String> availableLanguages = new ArrayList<>();
+
 	@lombok.Data
 	public static class Cache {
 

spring-boot-admin-server-ui/src/main/java/de/codecentric/boot/admin/server/ui/web/UiController.java

@@ -128,6 +128,8 @@ public static class Settings {
 
 		private final boolean rememberMeEnabled;
 
+		private final List<String> availableLanguages;
+
 		private final List<String> routes;
 
 		private final List<ExternalView> externalViews;

spring-boot-admin-server-ui/src/test/java/de/codecentric/boot/admin/server/ui/AbstractAdminUiApplicationTest.java

@@ -119,6 +119,20 @@ public void should_return_correct_content_type_for_css_extensions() {
 		//@formatter:on
 	}
 
+	@Test
+	public void should_contain_only_one_language() {
+		//@formatter:off
+		this.webClient.get()
+					.uri("/sba-settings.js")
+					.accept(MediaType.ALL)
+					.exchange()
+					.expectStatus().isOk()
+					.expectHeader().contentTypeCompatibleWith("application/javascript")
+					.expectBody(String.class)
+					.value((body) -> assertThat(body).contains("\"availableLanguages\":[\"de\"]"));
+		//@formatter:on
+	}
+
 	protected WebTestClient createWebClient(int port) {
 		return WebTestClient.bindToServer().baseUrl("http://localhost:" + port).build();
 	}

spring-boot-admin-server-ui/src/test/java/de/codecentric/boot/admin/server/ui/AdminUiReactiveApplicationTest.java

@@ -37,7 +37,8 @@ public class AdminUiReactiveApplicationTest extends AbstractAdminUiApplicationTe
 	public void setUp() {
 		this.instance = new SpringApplicationBuilder().sources(TestAdminApplication.class)
 				.web(WebApplicationType.REACTIVE).run("--server.port=0",
-						"--spring.boot.admin.ui.extension-resource-locations=classpath:/META-INF/test-extensions/");
+						"--spring.boot.admin.ui.extension-resource-locations=classpath:/META-INF/test-extensions/",
+						"--spring.boot.admin.ui.available-languages=de");
 
 		super.setUp(this.instance.getEnvironment().getProperty("local.server.port", Integer.class, 0));
 	}

spring-boot-admin-server-ui/src/test/java/de/codecentric/boot/admin/server/ui/AdminUiServletApplicationTest.java

@@ -37,7 +37,8 @@ public class AdminUiServletApplicationTest extends AbstractAdminUiApplicationTes
 	public void setUp() {
 		this.instance = new SpringApplicationBuilder().sources(TestAdminApplication.class)
 				.web(WebApplicationType.SERVLET).run("--server.port=0",
-						"--spring.boot.admin.ui.extension-resource-locations=classpath:/META-INF/test-extensions/");
+						"--spring.boot.admin.ui.extension-resource-locations=classpath:/META-INF/test-extensions/",
+						"--spring.boot.admin.ui.available-languages=de");
 
 		super.setUp(this.instance.getEnvironment().getProperty("local.server.port", Integer.class, 0));
 	}