Changes report: fix failing tests after swagger-ui 4.9.1

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/Constants.java

@@ -117,11 +117,6 @@ public final class Constants {
 	 */
 	public static final String SPRINGDOC_SWAGGER_UI_ENABLED = "springdoc.swagger-ui.enabled";
 
-	/**
-	 * The constant SPRING_NATIVE_LISTENER.
-	 */
-	public static final String SPRING_NATIVE_LISTENER = "org.springframework.nativex.NativeListener";
-
 	/**
 	 * The constant NULL.
 	 */
@@ -193,6 +188,16 @@ public final class Constants {
 	 */
 	public static final String SWAGGER_UI_URL = SWAGGER_UI_PREFIX + INDEX_PAGE;
 
+	/**
+	 * The constant SWAGGER_INITIALIZER_JS.
+	 */
+	public static final String SWAGGER_INITIALIZER_JS = "swagger-initializer.js";
+
+	/**
+	 * The constant SWAGGER_INITIALIZER_URL.
+	 */
+	public static final String SWAGGER_INITIALIZER_URL = SWAGGER_UI_PREFIX + "/" + SWAGGER_INITIALIZER_JS;
+
 	/**
 	 * The constant SWAGGER_UI_OAUTH_REDIRECT_URL.
 	 */

springdoc-openapi-starter-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java

@@ -94,12 +94,12 @@ public AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties swaggerUiConfig
 	 * @throws JsonProcessingException the json processing exception
 	 */
 	protected String addInitOauth(String html) throws JsonProcessingException {
-		StringBuilder stringBuilder = new StringBuilder("window.ui = ui\n");
+		StringBuilder stringBuilder = new StringBuilder("  });\n");
 		stringBuilder.append("ui.initOAuth(\n");
 		String json = objectMapper.writeValueAsString(swaggerUiOAuthProperties.getConfigParameters());
 		stringBuilder.append(json);
 		stringBuilder.append(")");
-		return html.replace("window.ui = ui", stringBuilder.toString());
+		return html.replace("  });", stringBuilder.toString());
 	}
 
 	/**
@@ -197,9 +197,9 @@ protected String addParameters(String html) throws JsonProcessingException {
 	}
 
 	private String addParameter(String html, String key, String value) {
-		StringBuilder stringBuilder = new StringBuilder("const ui = SwaggerUIBundle({\n");
+		StringBuilder stringBuilder = new StringBuilder("window.ui = SwaggerUIBundle({\n");
 		stringBuilder.append(key + ": \"" + value + "\",");
-		return html.replace("const ui = SwaggerUIBundle({", stringBuilder.toString());
+		return html.replace("window.ui = SwaggerUIBundle({", stringBuilder.toString());
 	}
 
 	/**

springdoc-openapi-starter-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerIndexPageTransformer.java

@@ -35,6 +35,8 @@
 import org.springframework.web.reactive.resource.TransformedResource;
 import org.springframework.web.server.ServerWebExchange;
 
+import static org.springdoc.core.utils.Constants.SWAGGER_INITIALIZER_JS;
+
 /**
  * The type Swagger index transformer.
  * @author bnasslahsen
@@ -65,7 +67,7 @@ public Mono<Resource> transform(ServerWebExchange serverWebExchange, Resource re
 
 		final AntPathMatcher antPathMatcher = new AntPathMatcher();
 		try {
-			boolean isIndexFound = antPathMatcher.match("**/swagger-ui/**/index.html", resource.getURL().toString());
+			boolean isIndexFound = antPathMatcher.match("**/swagger-ui/**/" + SWAGGER_INITIALIZER_JS, resource.getURL().toString());
 			if (isIndexFound) {
 				String html = defaultTransformations(resource.getInputStream());
 				return Mono.just(new TransformedResource(resource, html.getBytes()));

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java

@@ -44,23 +44,23 @@ public abstract class AbstractSpringDocTest extends AbstractCommonTest {
 	@Autowired
 	protected WebTestClient webTestClient;
 
-	private static final String DEFAULT_SWAGGER_UI_URL= Constants.DEFAULT_WEB_JARS_PREFIX_URL  + Constants.SWAGGER_UI_URL;
+	private static final String DEFAULT_SWAGGER_INITIALIZER_URL= Constants.DEFAULT_WEB_JARS_PREFIX_URL  + Constants.SWAGGER_INITIALIZER_URL;
 
-	protected void checkHTML(String fileName, String uri) {
+	protected void checkJS(String fileName, String uri) {
 		EntityExchangeResult<byte[]> getResult = webTestClient.get().uri(uri)
 				.exchange()
 				.expectStatus().isOk()
 				.expectBody().returnResult();
-		checkHTMLResult(fileName, new String(getResult.getResponseBody()));
+		checkJSResult(fileName, new String(getResult.getResponseBody()));
 	}
 
-	protected void checkHTMLResult(String fileName, String result) {
-		assertTrue(result.contains("Swagger UI"));
+	protected void checkJSResult(String fileName, String result) {
+		assertTrue(result.contains("window.ui"));
 		String expected = getContent("results/" + fileName);
 		assertEquals(expected, result.replace("\r", ""));
 	}
 
-	protected void checkHTML(String fileName) {
-		checkHTML(fileName, DEFAULT_SWAGGER_UI_URL);
+	protected void checkJS(String fileName) {
+		checkJS(fileName, DEFAULT_SWAGGER_INITIALIZER_URL);
 	}
 }

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirecFilterTest.java

@@ -37,7 +37,7 @@ public void shouldRedirectWithConfigUrlIgnoringQueryParams() {
 				.expectStatus().isFound();
 		responseSpec.expectHeader()
 				.value("Location", Matchers.is("/webjars/swagger-ui/index.html"));
-		super.checkHTML("index1-filter");
+		super.checkJS("index1-filter");
 	}
 
 	@SpringBootApplication

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectConfigUrlTest.java

@@ -41,7 +41,7 @@ public void shouldRedirectWithConfigUrlIgnoringQueryParams() {
 		responseSpec.expectHeader()
 				.value("Location", Matchers.is("/webjars/swagger-ui/index.html"));
 
-		super.checkHTML("index1-configurl");
+		super.checkJS("index1-configurl");
 	}
 
 	@SpringBootApplication

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectDefaultTest.java

@@ -38,7 +38,7 @@ public void shouldRedirectWithDefaultQueryParams() {
 		webTestClient.get().uri("/v3/api-docs/swagger-config").exchange()
 				.expectStatus().isOk().expectBody().jsonPath("$.validatorUrl").isEqualTo("");
 
-		super.checkHTML("index1-default");
+		super.checkJS("index1-default");
 	}
 
 	@SpringBootApplication

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectLayoutTest.java

@@ -38,7 +38,7 @@ public void shouldRedirectWithConfigUrlIgnoringQueryParams() {
 		responseSpec.expectHeader()
 				.value("Location", Matchers.is("/webjars/swagger-ui/index.html"));
 
-		super.checkHTML("index1-layout");
+		super.checkJS("index1-layout");
 	}
 
 	@SpringBootApplication

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectWithConfigTest.java

@@ -43,7 +43,7 @@ public void shouldRedirectWithConfiguredParams() {
 		webTestClient.get().uri("/baf/batz/swagger-config").exchange()
 				.expectStatus().isOk().expectBody().jsonPath("$.validatorUrl").isEqualTo("/foo/validate");
 
-		super.checkHTML("index1");
+		super.checkJS("index1");
 	}
 
 	@SpringBootApplication

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app3/SpringDocApp3RedirectDefaultTest.java

@@ -20,6 +20,7 @@
 
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Test;
+import org.springdoc.core.utils.Constants;
 import test.org.springdoc.ui.AbstractSpringDocTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -45,7 +46,7 @@ public void shouldRedirectWithDefaultQueryParams() {
 				.jsonPath("$.validatorUrl").isEqualTo("")
 				.jsonPath("$.oauth2RedirectUrl").isEqualTo("/documentation/webjars/swagger-ui/oauth2-redirect.html");
 
-		super.checkHTML("index3", "/documentation/webjars/swagger-ui/index.html");
+		super.checkJS("index3", "/documentation/webjars"+ Constants.SWAGGER_INITIALIZER_URL);
 	}
 
 	@SpringBootApplication