fixes #39 handle multiple schemas to support multiple specs in light-rest-4j (#41)

stevehu · web-flow · commit 536a733446bb · 2022-09-12T09:37:34.000-04:00
diff --git a/src/main/java/com/networknt/openapi/ApiNormalisedPath.java b/src/main/java/com/networknt/openapi/ApiNormalisedPath.java
@@ -35,15 +35,6 @@ public class ApiNormalisedPath implements NormalisedPath {
     private final String original;
     private final String normalised;
 
-    @Deprecated
-    public ApiNormalisedPath(final String path) {
-        if (logger.isDebugEnabled()) logger.debug("path =" + path);
-        this.original = requireNonNull(path, "A path is required");
-        this.normalised = normalise(path, null);
-        if (logger.isDebugEnabled()) logger.debug("normalised = " + this.normalised);
-        this.pathParts = List.of(normalised.split("/"));
-    }
-
     /**
      * Construct normalized path
      * @param path original path
@@ -98,9 +89,6 @@ public String normalised() {
     // case basePath == null, use OpenApiHelper.basePath
     // case basePath != null, remove the basePath
     private String normalise(String requestPath, String basePath) {
-        if (basePath == null) {
-            basePath = OpenApiHelper.openApi3 == null ? "" : OpenApiHelper.basePath;
-        }
         requestPath = requestPath.replaceFirst(basePath, "");
 
         if (!requestPath.startsWith("/")) {
diff --git a/src/main/java/com/networknt/openapi/OpenApiHelper.java b/src/main/java/com/networknt/openapi/OpenApiHelper.java
@@ -38,17 +38,22 @@
  * This handler supports openapi.yml, openapi.yaml and openapi.json and above
  * is the loading sequence.
  *
+ * Due to the high demand, we have changed this class from singleton to normal
+ * class to support multiple instances of specifications in light-rest-4j.
+ *
+ * Some of our users want to use one light-gateway to support multiple backend
+ * services to reduce the resource utilization.
+ *
  * @author Steve Hu
  */
 public class OpenApiHelper {
     static final Logger logger = LoggerFactory.getLogger(OpenApiHelper.class);
 
-    public static OpenApi3 openApi3;
-    public static List<String> oauth2Names;
-    public static String basePath;
-    private static OpenApiHelper INSTANCE = null;
+    public OpenApi3 openApi3;
+    public List<String> oauth2Names;
+    public String basePath;
 
-    private OpenApiHelper(String spec) {
+    public OpenApiHelper(String spec) {
         try {
             openApi3 = (OpenApi3) new OpenApiParser().parse(spec, new URL("https://oas.lightapi.net/"));
         } catch (MalformedURLException e) {
@@ -64,25 +69,6 @@ private OpenApiHelper(String spec) {
 
     }
 
-    public static OpenApiHelper getInstance() {
-        if(INSTANCE == null) {
-            return null;
-        }
-        return INSTANCE;
-    }
-
-    public synchronized static OpenApiHelper init(String spec) {
-        if(INSTANCE != null) {
-            return INSTANCE;
-        }
-        INSTANCE = new OpenApiHelper(spec);
-        return INSTANCE;
-    }
-
-    public synchronized static OpenApiHelper reset(String spec) {
-        INSTANCE = new OpenApiHelper(spec);
-        return INSTANCE;
-    }
 
     /**
      * merge inject map to openapi map
@@ -117,10 +103,10 @@ public Object apply(Object o, Object i) {
     }
 
     public Optional<NormalisedPath> findMatchingApiPath(final NormalisedPath requestPath) {
-        if(OpenApiHelper.openApi3 != null) {
-            return OpenApiHelper.openApi3.getPaths().keySet()
+        if(openApi3 != null) {
+            return openApi3.getPaths().keySet()
                     .stream()
-                    .map(p -> (NormalisedPath) new ApiNormalisedPath(p))
+                    .map(p -> (NormalisedPath) new ApiNormalisedPath(p, basePath))
                     .filter(p -> pathMatches(requestPath, p))
                     .findFirst();
         } else {
@@ -165,6 +151,17 @@ private String getBasePath() {
         return basePath;
     }
 
+    /**
+     * This method should only be called in the multiple specification use case to set the base path
+     * based on the OpenApiHandler config with the pathSpecMapping. For single specification use case,
+     * this method should be called to overwrite the basePath from the handler.yml configuration in
+     * case the openapi.yaml cannot derive the basePath from the server section.
+     * @param basePath string
+     */
+    public void setBasePath(String basePath) {
+        this.basePath = basePath;
+    }
+
     private boolean pathMatches(final NormalisedPath requestPath, final NormalisedPath apiPath) {
         if (requestPath.parts().size() != apiPath.parts().size()) {
             return false;
diff --git a/src/test/java/com/networknt/openapi/BasePathRewriteTest.java b/src/test/java/com/networknt/openapi/BasePathRewriteTest.java
@@ -11,23 +11,22 @@
 import java.util.Scanner;
 
 public class BasePathRewriteTest {
+    OpenApiHelper helper = null;
     @Before
     public void testOAuth2Name() throws Exception {
         URL url = Resources.getResource("models/openapi-server-url-rewrite.yaml");
         String spec = new Scanner(url.openStream(), "UTF-8").useDelimiter("\\A").next();
-        OpenApiHelper.init(spec);
+        helper = new OpenApiHelper(spec);
     }
 
     @After
     public void tearDown() throws NoSuchFieldException, IllegalAccessException {
-        Field instance = OpenApiHelper.class.getDeclaredField("INSTANCE");
-        instance.setAccessible(true);
-        instance.set(null, null);
+        helper = null;
     }
 
     @Test
     public void testBasePath() {
-        Assert.assertEquals("/namespace/application/v1", OpenApiHelper.basePath);
+        Assert.assertEquals("/namespace/application/v1", helper.basePath);
     }
 
     @Test
diff --git a/src/test/java/com/networknt/openapi/EndpointTest.java b/src/test/java/com/networknt/openapi/EndpointTest.java
@@ -14,11 +14,11 @@ public class EndpointTest {
     public void testJson() throws Exception {
         URL url = Resources.getResource("models/petstore.json");
         String spec = new Scanner(url.openStream(), "UTF-8").useDelimiter("\\A").next();
-        OpenApiHelper.init(spec);
+        OpenApiHelper helper = new OpenApiHelper(spec);
 
-        String basePath = OpenApiHelper.basePath;
+        String basePath = helper.basePath;
         Map<String, Object> endpoints = new HashMap<>();
-        Map<String, Path> paths = OpenApiHelper.openApi3.getPaths();
+        Map<String, Path> paths = helper.openApi3.getPaths();
         for (Map.Entry<String, Path> pathPair : paths.entrySet()) {
             String path = pathPair.getKey();
             for (Map.Entry<String, Operation> entries : pathPair.getValue().getOperations().entrySet()) {
@@ -30,7 +30,7 @@ public void testJson() throws Exception {
                 if(securityRequirements != null) {
                     for(SecurityRequirement requirement: securityRequirements) {
                         SecurityParameter securityParameter = null;
-                        for(String oauth2Name: OpenApiHelper.oauth2Names) {
+                        for(String oauth2Name: helper.oauth2Names) {
                             securityParameter = requirement.getRequirement(oauth2Name);
                             if(securityParameter != null) break;
                         }
@@ -52,11 +52,11 @@ public void testJson() throws Exception {
     public void testYaml() throws Exception {
         URL url = Resources.getResource("models/petstore.yaml");
         String spec = new Scanner(url.openStream(), "UTF-8").useDelimiter("\\A").next();
-        OpenApiHelper.init(spec);
+        OpenApiHelper helper = new OpenApiHelper(spec);
 
-        String basePath = OpenApiHelper.basePath;
+        String basePath = helper.basePath;
         Map<String, Object> endpoints = new HashMap<>();
-        Map<String, Path> paths = OpenApiHelper.openApi3.getPaths();
+        Map<String, Path> paths = helper.openApi3.getPaths();
         for (Map.Entry<String, Path> pathPair : paths.entrySet()) {
             String path = pathPair.getKey();
             for (Map.Entry<String, Operation> entries : pathPair.getValue().getOperations().entrySet()) {
@@ -68,7 +68,7 @@ public void testYaml() throws Exception {
                 if(securityRequirements != null) {
                     for(SecurityRequirement requirement: securityRequirements) {
                         SecurityParameter securityParameter = null;
-                        for(String oauth2Name: OpenApiHelper.oauth2Names) {
+                        for(String oauth2Name: helper.oauth2Names) {
                             securityParameter = requirement.getRequirement(oauth2Name);
                             if(securityParameter != null) break;
                         }
diff --git a/src/test/java/com/networknt/openapi/OpenApiHelperTest.java b/src/test/java/com/networknt/openapi/OpenApiHelperTest.java
@@ -32,25 +32,24 @@
  * Created by steve on 23/09/16.
  */
 public class OpenApiHelperTest {
+    OpenApiHelper helper = null;
     @Before
     public void testOAuth2Name() throws Exception {
         URL url = Resources.getResource("models/petstore.yaml");
         String spec = new Scanner(url.openStream(), "UTF-8").useDelimiter("\\A").next();
-        OpenApiHelper.init(spec);
-        Assert.assertEquals(1, OpenApiHelper.oauth2Names.size());
-        Assert.assertEquals("petstore_auth", OpenApiHelper.oauth2Names.get(0));
+        helper = new OpenApiHelper(spec);
+        Assert.assertEquals(1, helper.oauth2Names.size());
+        Assert.assertEquals("petstore_auth", helper.oauth2Names.get(0));
     }
 
     @After
     public void tearDown() throws NoSuchFieldException, IllegalAccessException {
-        Field instance = OpenApiHelper.class.getDeclaredField("INSTANCE");
-        instance.setAccessible(true);
-        instance.set(null, null);
+        helper = null;
     }
 
     @Test
     public void testBasePath() {
-        Assert.assertEquals("/v1", OpenApiHelper.basePath);
+        Assert.assertEquals("/v1", helper.basePath);
     }
 
     @Test
diff --git a/src/test/java/com/networknt/openapi/RelativeBasePathTest.java b/src/test/java/com/networknt/openapi/RelativeBasePathTest.java
@@ -11,28 +11,27 @@
 import java.util.Scanner;
 
 public class RelativeBasePathTest {
+    OpenApiHelper helper = null;
     @Before
     public void testOAuth2Name() throws Exception {
         URL url = Resources.getResource("models/openapi-relative-server-url.yaml");
         String spec = new Scanner(url.openStream(), "UTF-8").useDelimiter("\\A").next();
-        OpenApiHelper.init(spec);
+        helper = new OpenApiHelper(spec);
     }
 
     @After
     public void tearDown() throws NoSuchFieldException, IllegalAccessException {
-        Field instance = OpenApiHelper.class.getDeclaredField("INSTANCE");
-        instance.setAccessible(true);
-        instance.set(null, null);
+        helper = null;
     }
 
     @Test
     public void testBasePath() {
-        Assert.assertEquals("/v1", OpenApiHelper.basePath);
+        Assert.assertEquals("/v1", helper.basePath);
     }
 
     @Test
     public void testApiNormalized() {
-        ApiNormalisedPath normalisedPath = new ApiNormalisedPath("/v1/pets/26", null);
+        ApiNormalisedPath normalisedPath = new ApiNormalisedPath("/v1/pets/26", helper.basePath);
         Assert.assertEquals("/pets/26", normalisedPath.normalised());
     }
 }
