#112 Accounting for host when writing module timestamps file

Note that DefaultModulesLoader won't do use this support by default because it doesn't have a constructor that allows for manipulating the ModulesManager. Instead, a client will need to call setModulesManager.

Author: rjrudin

src/main/java/com/marklogic/client/ext/modulesloader/ModulesLoader.java

@@ -8,16 +8,21 @@
 /**
  * Interface for objects that can load a set of modules via the REST API, which is intended to include not just what the
  * REST API calls "assets" (regular modules), but also options, services, transforms, and namespaces.
+ *
+ * Note that in both of the methods in this interface, the DatabaseClient is used for loading REST extensions. This is
+ * to account for the fact that how search options are loaded (i.e. the URI they're written to) differs based on what
+ * REST server they're loaded from. But the implementation is not expected to use this DatabaseClient for loading
+ * non-REST modules - that is likely done via an instance of AssetFileLoader that uses the App-Services port by
+ * default for loading non-REST modules.
  */
 public interface ModulesLoader {
 
 	/**
-	 * Use the given DatabaseClient to load modules found in the given directory. Return a set containing any files that
-	 * were loaded.
+	 * Load modules from the given directory, and return the set of resources containing all modules written.
 	 *
 	 * @param directory
 	 * @param modulesFinder
-	 * @param client
+	 * @param client the DatabaseClient to use for loading REST extensions
 	 * @return
 	 */
 	Set<Resource> loadModules(String directory, ModulesFinder modulesFinder, DatabaseClient client);
@@ -28,7 +33,7 @@ public interface ModulesLoader {
 	 *
 	 * @param client
 	 * @param modulesFinder
-	 * @param paths
+	 * @param paths the DatabaseClient to use for loading REST extensions
 	 * @return
 	 */
 	Set<Resource> loadModules(DatabaseClient client, ModulesFinder modulesFinder, String... paths);

src/main/java/com/marklogic/client/ext/modulesloader/impl/PropertiesModuleManager.java

@@ -1,5 +1,6 @@
 package com.marklogic.client.ext.modulesloader.impl;
 
+import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.ext.helper.LoggingObject;
 import com.marklogic.client.ext.modulesloader.ModulesManager;
 
@@ -16,6 +17,7 @@ public class PropertiesModuleManager extends LoggingObject implements ModulesMan
     private Properties props;
     private String propertiesFilePath;
     private long minimumFileTimestampToLoad;
+    private String host;
 
     public PropertiesModuleManager() {
         this(DEFAULT_FILE_PATH);
@@ -26,6 +28,20 @@ public PropertiesModuleManager(String propertiesFilePath) {
         this.propertiesFilePath = propertiesFilePath;
     }
 
+	/**
+	 * Use this constructor so that the keys generated for the properties file account for the host associated with the
+	 * given DatabaseClient.
+	 *
+	 * @param propertiesFilePath
+	 * @param client
+	 */
+	public PropertiesModuleManager(String propertiesFilePath, DatabaseClient client) {
+    	this(propertiesFilePath);
+    	if (client != null) {
+    		host = client.getHost();
+	    }
+    }
+
     @Override
     public void initialize() {
     	this.props = new Properties();
@@ -64,7 +80,13 @@ public void deletePropertiesFile() {
         }
     }
 
-    public boolean hasFileBeenModifiedSinceLastLoaded(File file) {
+	/**
+	 *
+	 * @param file
+	 * @return
+	 */
+	@Override
+	public boolean hasFileBeenModifiedSinceLastLoaded(File file) {
     	if (minimumFileTimestampToLoad > 0 && file.lastModified() <= minimumFileTimestampToLoad) {
     		if (logger.isDebugEnabled()) {
     			logger.debug(String.format("lastModified for file '%s' is %d, which is before the minimumFileTimestampToLoad of %d",
@@ -83,7 +105,13 @@ public boolean hasFileBeenModifiedSinceLastLoaded(File file) {
         return true;
     }
 
-    public void saveLastLoadedTimestamp(File file, Date date) {
+	/**
+	 *
+	 * @param file
+	 * @param date
+	 */
+	@Override
+	public void saveLastLoadedTimestamp(File file, Date date) {
         String key = buildKey(file);
         props.setProperty(key, date.getTime() + "");
         FileWriter fw = null;
@@ -110,10 +138,23 @@ public void saveLastLoadedTimestamp(File file, Date date) {
      * @return
      */
     protected String buildKey(File file) {
-        return file.getAbsolutePath().toLowerCase();
+        String path = file.getAbsolutePath().toLowerCase();
+        final String key = host != null ? host + ":" + path : path;
+        if (logger.isDebugEnabled()) {
+        	logger.debug("Key for file " + file.getAbsolutePath() + ": " + key);
+        }
+        return key;
     }
 
 	public void setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad) {
 		this.minimumFileTimestampToLoad = minimumFileTimestampToLoad;
 	}
+
+	public String getHost() {
+		return host;
+	}
+
+	public void setHost(String host) {
+		this.host = host;
+	}
 }

src/test/java/com/marklogic/client/ext/modulesloader/impl/LoadModulesTest.java

@@ -13,6 +13,7 @@
 import org.springframework.core.io.Resource;
 import org.springframework.util.StringUtils;
 
+import java.io.File;
 import java.nio.file.Paths;
 import java.util.List;
 import java.util.Properties;
@@ -42,6 +43,11 @@ public void setup() {
 
 		modulesLoader = new DefaultModulesLoader(new AssetFileLoader(modulesClient));
 		modulesLoader.setModulesManager(null);
+
+		File file = new File(PropertiesModuleManager.DEFAULT_FILE_PATH);
+		if (file.exists()) {
+			file.delete();
+		}
 	}
 
 	@Test
@@ -195,6 +201,29 @@ private void verifyModuleCountWithPattern(String pattern, String message, int co
 		assertEquals(message, count, files.size());
 	}
 
+	@Test
+	public void loadModulesAndAccountForHost() {
+		PropertiesModuleManager moduleManager = new PropertiesModuleManager(PropertiesModuleManager.DEFAULT_FILE_PATH, modulesClient);
+		modulesLoader.setAssetFileLoader(new AssetFileLoader(modulesClient, moduleManager));
+		modulesLoader.setModulesManager(moduleManager);
+
+		String dir = Paths.get("src", "test", "resources", "sample-base-dir").toString();
+		Set<Resource> files = modulesLoader.loadModules(dir, new DefaultModulesFinder(), client);
+		assertEquals(26, files.size());
+
+		files = modulesLoader.loadModules(dir, new DefaultModulesFinder(), client);
+		assertEquals("No files should have been loaded since none were new or modified", 0, files.size());
+
+		// The host defaults to "localhost", so change it to a host that should still hit localhost on any OS, and
+		// verify all files were loaded because a different host was used
+		moduleManager.setHost("127.0.0.1");
+		files = modulesLoader.loadModules(dir, new DefaultModulesFinder(), client);
+		assertEquals(26, files.size());
+
+		files = modulesLoader.loadModules(dir, new DefaultModulesFinder(), client);
+		assertEquals("No files should have been loaded since none were new or modified", 0, files.size());
+	}
+
 	@Test
 	public void test() {
 		String dir = Paths.get("src", "test", "resources", "sample-base-dir").toString();