#256 Using servers endpoint to check for REST server existence

Instead of /v1/rest-apis

Author: rjrudin

src/main/java/com/marklogic/appdeployer/command/appservers/UpdateRestApiServersCommand.java

@@ -5,9 +5,6 @@
 import com.marklogic.appdeployer.command.AbstractCommand;
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.SortOrderConstants;
-import com.marklogic.mgmt.PayloadParser;
-import com.marklogic.mgmt.SaveReceipt;
-import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.appservers.ServerManager;
 
 import java.io.File;
@@ -51,22 +48,6 @@ public void execute(CommandContext context) {
 		}
 	}
 
-	@Override
-	protected String adjustPayloadBeforeSavingResource(ResourceManager mgr, CommandContext context, File f, String payload) {
-		payload = super.adjustPayloadBeforeSavingResource(mgr, context, f, payload);
-		if (payload != null) {
-			String urlRewriter = new PayloadParser().getPayloadFieldValue(payload, "url-rewriter", false);
-			if (urlRewriter != null && !urlRewriter.contains("rest-api")) {
-				logger.warn("The REST server is being updated with a url-rewriter that does not contain the string 'rest-api' in its URI. " +
-					"This may result in a 'Port is in use' exception if the command for creating a REST server is run. " +
-					"This is because the command to create a REST server first sends a GET to /v1/rest-apis, and that endpoint " +
-					"only returns servers that have the string 'rest-api' in the URI of the url-rewriter. It is recommended to " +
-					"include the string 'rest-api' in the URI of a url-rewriter for a REST server to avoid this problem.");
-			}
-		}
-		return payload;
-	}
-
 	protected File findRestApiConfigFile(CommandContext context) {
 		if (restApiFilename != null) {
 			File f = null;

src/main/java/com/marklogic/mgmt/resource/restapis/RestApiManager.java

@@ -6,10 +6,8 @@
 import com.marklogic.mgmt.PayloadParser;
 import com.marklogic.mgmt.resource.appservers.ServerManager;
 import com.marklogic.mgmt.resource.databases.DatabaseManager;
-import com.marklogic.rest.util.Fragment;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.client.HttpClientErrorException;
 
 /**
  * For /v1/rest-apis. Currently only supports JSON files.
@@ -34,25 +32,9 @@ public ResponseEntity<String> createRestApi(String name, String json) {
 			return null;
 		} else {
 			logger.info("Creating REST API: " + json);
-			try {
-				ResponseEntity<String> re = client.postJson("/v1/rest-apis", json);
-				logger.info("Created REST API");
-				return re;
-			} catch (HttpClientErrorException ex) {
-				logWarningIfErrorIsDueToPortInUse(ex);
-				throw ex;
-			}
-		}
-	}
-
-	protected void logWarningIfErrorIsDueToPortInUse(HttpClientErrorException ex) {
-		String body = ex.getResponseBodyAsString();
-		if (body != null && body.contains("Invalid parameter") && body.contains("is in use")) {
-			logger.warn("Caught exception due to a port being in use; this may because the REST server already exists " +
-				"but is using a rewriter that the /v1/rest-apis endpoint does not recognize as a REST rewriter, and thus " +
-				"the /v1/rest-apis endpoint does not think that the REST server has been created yet. The error is then " +
-				"because an attempt is made to create the REST server but it fails because the port is already in use. " +
-				"To fix this, try modifying the URI of the rewriter module so it contains the string 'rest-api'.");
+			ResponseEntity<String> re = client.postJson("/v1/rest-apis", json);
+			logger.info("Created REST API");
+			return re;
 		}
 	}
 
@@ -61,9 +43,20 @@ public String extractNameFromJson(String json) {
 		return node.get("rest-api").get("name").textValue();
 	}
 
+	/**
+	 * Prior to ML 9.0-4, the /v1/rest-apis endpoint required that a server's url-rewriter have the string "rest-api"
+	 * somewhere in it. With 9.0-4, the url-rewriter must match the pattern:
+	 * <p>
+	 * ^/MarkLogic/rest-api/(8000-rewriter|rewriter|rewriter-noxdbc)\.xml$
+	 * <p>
+	 * It's not likely that a user's custom rewriter will fit that pattern, so this method no longer uses /v1/rest-apis,
+	 * opting to use ServerManager instead.
+	 *
+	 * @param name
+	 * @return
+	 */
 	public boolean restApiServerExists(String name) {
-		Fragment f = client.getXml("/v1/rest-apis?format=xml", "rapi", "http://marklogic.com/rest-api");
-		return f.elementExists(String.format("/rapi:rest-apis/rapi:rest-api[rapi:name = '%s']", name));
+		return new ServerManager(client).exists(name);
 	}
 
 	/**

src/test/java/com/marklogic/appdeployer/AbstractAppDeployerTest.java

@@ -3,7 +3,6 @@
 import com.marklogic.appdeployer.command.Command;
 import com.marklogic.appdeployer.command.modules.DefaultModulesLoaderFactory;
 import com.marklogic.appdeployer.command.modules.LoadModulesCommand;
-import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
 import com.marklogic.appdeployer.impl.SimpleAppDeployer;
 import com.marklogic.client.ext.modulesloader.impl.DefaultModulesLoader;
 import com.marklogic.mgmt.AbstractMgmtTest;
@@ -45,10 +44,6 @@ protected void initializeAppConfig() {
         appConfig.setRestAdminPassword(manageConfig.getPassword());
     }
 
-    protected void initializeAppDeployer() {
-        initializeAppDeployer(new DeployRestApiServersCommand());
-    }
-
     /**
      * Initialize an AppDeployer with the given set of commands. Avoids having to create a Spring configuration.
      *

src/test/java/com/marklogic/appdeployer/command/ReplaceTokensTest.java

@@ -32,7 +32,7 @@ public void test() {
 		loadModulesCommand.initializeDefaultModulesLoader(new CommandContext(appConfig, manageClient, adminManager));
 		((DefaultModulesLoader) loadModulesCommand.getModulesLoader()).setModulesManager(null);
 
-		initializeAppDeployer(new DeployRestApiServersCommand(), loadModulesCommand);
+		initializeAppDeployer(new DeployRestApiServersCommand(true), loadModulesCommand);
 		deploySampleApp();
 
 		// We know xdbcEnabled was replaced, otherwise the deployment of the REST API server would have failed

src/test/java/com/marklogic/appdeployer/command/restapis/CreateRestApiWithCustomRewriterTest.java

@@ -3,9 +3,9 @@
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.appdeployer.ConfigDir;
 import com.marklogic.appdeployer.command.appservers.UpdateRestApiServersCommand;
+import com.marklogic.mgmt.api.API;
 import org.junit.After;
 import org.junit.Test;
-import org.springframework.web.client.HttpClientErrorException;
 
 import java.io.File;
 
@@ -17,18 +17,20 @@ public void teardown() {
 	}
 
 	/**
-	 * This test is used to manually inspect the log statements that are written.
+	 * This was created for #242, but is being modified for #256 as this library is now using ServerManager instead
+	 * of /v1/rest-apis to see if a REST server exists already.
 	 */
 	@Test
 	public void test() {
 		appConfig.setConfigDir(new ConfigDir(new File("src/test/resources/sample-app/rest-api-different-rewriter")));
 
-		initializeAppDeployer(new DeployRestApiServersCommand(), new UpdateRestApiServersCommand());
+		initializeAppDeployer(new DeployRestApiServersCommand(true), new UpdateRestApiServersCommand());
 
-		try {
-			deploySampleApp();
-		} catch (HttpClientErrorException ex) {
-			logger.info("Caught expected exception because the REST server has a url-rewriter without 'rest-api' in it: " + ex.getMessage());
-		}
+		deploySampleApp();
+		assertEquals("/my/custom/rewriter.xml", new API(manageClient).server("sample-app").getUrlRewriter());
+
+		// This shouldn't throw an error, because it's no longer using /v1/rest-apis to see if the REST server exists
+		deploySampleApp();
+		assertEquals("/my/custom/rewriter.xml", new API(manageClient).server("sample-app").getUrlRewriter());
 	}
 }

src/test/java/com/marklogic/appdeployer/command/restapis/DeleteRestApiTest.java

@@ -24,7 +24,7 @@ public void createAndDelete() {
         RestApiManager mgr = new RestApiManager(manageClient);
         ServerManager serverMgr = new ServerManager(manageClient, appConfig.getGroupName());
 
-        initializeAppDeployer(new DeployRestApiServersCommand());
+        initializeAppDeployer(new DeployRestApiServersCommand(true));
         appDeployer.deploy(appConfig);
 
         assertTrue("The REST API server should exist", mgr.restApiServerExists(SAMPLE_APP_NAME));

src/test/java/com/marklogic/appdeployer/command/servers/UpdateRestApiServersTest.java

@@ -19,7 +19,8 @@ public void teardown() {
     @Test
     public void updateMainAndRestRestApiServers() {
         // Deploy a REST API server and a test one too
-        initializeAppDeployer();
+	    initializeAppDeployer(new DeployRestApiServersCommand(true));
+
         appConfig.setTestRestPort(SAMPLE_APP_TEST_REST_PORT);
         appDeployer.deploy(appConfig);
 

src/test/resources/sample-app/rest-api-different-rewriter/servers/rest-api-server.json

@@ -1,4 +1,4 @@
 {
   "server-name": "%%NAME%%",
-  "url-rewriter": "/should/log/a-warning.xml"
+  "url-rewriter": "/my/custom/rewriter.xml"
 }