Switch from direct ClientDependency references to Suppliers (#25)

labkey-jeckels · web-flow · commit 8cf1c92d5835 · 2020-04-08T09:29:09.000-07:00
Issue 40118: Client dependencies are cached too aggressively
diff --git a/LDK/src/org/labkey/ldk/query/DefaultTableCustomizer.java b/LDK/src/org/labkey/ldk/query/DefaultTableCustomizer.java
@@ -49,6 +49,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
@@ -71,14 +72,15 @@ public class DefaultTableCustomizer implements TableCustomizer
 
     public DefaultTableCustomizer()
     {
-        this(new ArrayListValuedHashMap());
+        this(new ArrayListValuedHashMap<>());
     }
 
-    public DefaultTableCustomizer(MultiValuedMap props)
+    public DefaultTableCustomizer(MultiValuedMap<String, String> props)
     {
         _settings = new Settings(props);
     }
 
+    @Override
     public void customize(TableInfo table)
     {
         if (table instanceof SchemaTableInfo)
@@ -305,15 +307,12 @@ public static void customizeButtonBar(AbstractTableInfo ti, List<ButtonConfigFac
         String[] existingScripts = cfg.getScriptIncludes();
         if (existingScripts != null)
         {
-            for (String s : existingScripts)
-            {
-                scripts.add(s);
-            }
+            Collections.addAll(scripts, existingScripts);
         }
 
         boolean hasMoreActions = configureMoreActionsBtn(ti, buttons, cfg, scripts);
 
-        cfg.setScriptIncludes(scripts.toArray(new String[scripts.size()]));
+        cfg.setScriptIncludes(scripts.toArray(new String[0]));
         if (hasMoreActions)
             cfg.setAlwaysShowRecordSelectors(true);
 
@@ -400,12 +399,12 @@ private static boolean configureMoreActionsBtn(TableInfo ti, List<ButtonConfigFa
             cfg.setItems(existingBtns);
         }
 
-        List<NavTree> menuItems = new ArrayList<NavTree>();
+        List<NavTree> menuItems = new ArrayList<>();
         if (moreActionsBtn.getMenuItems() != null)
             menuItems.addAll(moreActionsBtn.getMenuItems());
 
         //create map of existing item names
-        Map<String, NavTree> btnNameMap = new HashMap<String, NavTree>();
+        Map<String, NavTree> btnNameMap = new HashMap<>();
         for (NavTree item : menuItems)
         {
             btnNameMap.put(item.getText(), item);
@@ -419,7 +418,7 @@ private static boolean configureMoreActionsBtn(TableInfo ti, List<ButtonConfigFa
                 btnNameMap.put(newButton.getText(), newButton);
                 menuItems.add(newButton);
 
-                for (ClientDependency cd : fact.getClientDependencies(ti.getUserSchema().getContainer(), ti.getUserSchema().getUser()))
+                for (ClientDependency cd : ClientDependency.getClientDependencySet(fact.getClientDependencies(ti.getUserSchema().getContainer(), ti.getUserSchema().getUser())))
                 {
                     scripts.add(cd.getScriptString());
                 }
diff --git a/laboratory/api-src/org/labkey/api/laboratory/button/ChangeAssayResultStatusBtn.java b/laboratory/api-src/org/labkey/api/laboratory/button/ChangeAssayResultStatusBtn.java
@@ -21,6 +21,8 @@
 import org.labkey.api.security.permissions.UpdatePermission;
 import org.labkey.api.view.template.ClientDependency;
 
+import java.util.Arrays;
+
 /**
  * User: bimber
  * Date: 9/8/13
@@ -36,7 +38,7 @@ public ChangeAssayResultStatusBtn(Module owner)
     public ChangeAssayResultStatusBtn(Module owner, String label)
     {
         super(owner, label, "Laboratory.window.ChangeAssayResultStatusWindow.buttonHandler(dataRegionName);");
-        setClientDependencies(ClientDependency.fromModuleName("laboratory"), ClientDependency.fromPath("laboratory/window/ChangeAssayResultStatusWindow.js"));
+        setClientDependencies(Arrays.asList(ClientDependency.supplierFromModuleName("laboratory"), ClientDependency.supplierFromPath("laboratory/window/ChangeAssayResultStatusWindow.js")));
     }
 
     public boolean isAvailable(TableInfo ti)
diff --git a/laboratory/src/org/labkey/laboratory/LaboratoryModule.java b/laboratory/src/org/labkey/laboratory/LaboratoryModule.java
@@ -53,9 +53,11 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
-import java.util.LinkedHashSet;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Supplier;
 
 /**
  * User: bimber
@@ -173,17 +175,17 @@ protected void doStartupAfterSpringConfig(ModuleContext moduleContext)
         LDKService.get().registerContainerScopedTable(SCHEMA_NAME, LaboratorySchema.TABLE_SUBJECTS, "subjectname");
 
         SimpleButtonConfigFactory btn1 = new SimpleButtonConfigFactory(this, "Mark Removed", "Laboratory.buttonHandlers.markSamplesRemoved(dataRegionName, arguments[0])");
-        btn1.setClientDependencies(ClientDependency.fromModuleName("laboratory"));
+        btn1.setClientDependencies(ClientDependency.supplierFromModuleName("laboratory"));
         btn1.setPermission(UpdatePermission.class);
         LDKService.get().registerQueryButton(btn1, LaboratoryModule.SCHEMA_NAME, LaboratorySchema.TABLE_SAMPLES);
 
         SimpleButtonConfigFactory btn2 = new SimpleButtonConfigFactory(this, "Duplicate/Derive Samples", "Laboratory.buttonHandlers.deriveSamples(dataRegionName, arguments[0])");
-        btn2.setClientDependencies(ClientDependency.fromModuleName("laboratory"));
+        btn2.setClientDependencies(ClientDependency.supplierFromModuleName("laboratory"));
         btn2.setPermission(UpdatePermission.class);
         LDKService.get().registerQueryButton(btn2, LaboratoryModule.SCHEMA_NAME, LaboratorySchema.TABLE_SAMPLES);
 
         SimpleButtonConfigFactory btn4 = new SimpleButtonConfigFactory(this, "Append Comment", "Laboratory.buttonHandlers.appendCommentToSamples(dataRegionName, arguments[0])");
-        btn4.setClientDependencies(ClientDependency.fromModuleName("laboratory"));
+        btn4.setClientDependencies(ClientDependency.supplierFromModuleName("laboratory"));
         btn4.setPermission(UpdatePermission.class);
         LDKService.get().registerQueryButton(btn4, LaboratoryModule.SCHEMA_NAME, LaboratorySchema.TABLE_SAMPLES);
 
@@ -212,11 +214,11 @@ public Set<String> getSchemaNames()
 
     @NotNull
     @Override
-    public LinkedHashSet<ClientDependency> getClientDependencies(Container c)
+    public List<Supplier<ClientDependency>> getClientDependencies(Container c)
     {
         // allow other modules to register with EHR service, and include their dependencies automatically
         // whenever laboratory context is requested
-        LinkedHashSet<ClientDependency> ret = new LinkedHashSet<>();
+        List<Supplier<ClientDependency>> ret = new LinkedList<>();
         ret.addAll(super.getClientDependencies(c));
         ret.addAll(LaboratoryService.get().getRegisteredClientDependencies(c));
 
diff --git a/laboratory/src/org/labkey/laboratory/LaboratoryServiceImpl.java b/laboratory/src/org/labkey/laboratory/LaboratoryServiceImpl.java

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@`
`49`	`49`	`import java.util.ArrayList;`
`50`	`50`	`import java.util.Arrays;`
`51`	`51`	`import java.util.Collection;`
	`52`	`+import java.util.Collections;`
`52`	`53`	`import java.util.HashMap;`
`53`	`54`	`import java.util.LinkedHashSet;`
`54`	`55`	`import java.util.List;`
`@@ -71,14 +72,15 @@ public class DefaultTableCustomizer implements TableCustomizer`
`71`	`72`
`72`	`73`	`public DefaultTableCustomizer()`
`73`	`74`	`{`
`74`		`- this(new ArrayListValuedHashMap());`
	`75`	`+ this(new ArrayListValuedHashMap<>());`
`75`	`76`	`}`
`76`	`77`
`77`		`- public DefaultTableCustomizer(MultiValuedMap props)`
	`78`	`+ public DefaultTableCustomizer(MultiValuedMap<String, String> props)`
`78`	`79`	`{`
`79`	`80`	`_settings = new Settings(props);`
`80`	`81`	`}`
`81`	`82`
	`83`	`+ @Override`
`82`	`84`	`public void customize(TableInfo table)`
`83`	`85`	`{`
`84`	`86`	`if (table instanceof SchemaTableInfo)`
`@@ -305,15 +307,12 @@ public static void customizeButtonBar(AbstractTableInfo ti, List<ButtonConfigFac`
`305`	`307`	`String[] existingScripts = cfg.getScriptIncludes();`
`306`	`308`	`if (existingScripts != null)`
`307`	`309`	`{`
`308`		`- for (String s : existingScripts)`
`309`		`- {`
`310`		`- scripts.add(s);`
`311`		`- }`
	`310`	`+ Collections.addAll(scripts, existingScripts);`
`312`	`311`	`}`
`313`	`312`
`314`	`313`	`boolean hasMoreActions = configureMoreActionsBtn(ti, buttons, cfg, scripts);`
`315`	`314`
`316`		`- cfg.setScriptIncludes(scripts.toArray(new String[scripts.size()]));`
	`315`	`+ cfg.setScriptIncludes(scripts.toArray(new String[0]));`
`317`	`316`	`if (hasMoreActions)`
`318`	`317`	`cfg.setAlwaysShowRecordSelectors(true);`
`319`	`318`
`@@ -400,12 +399,12 @@ private static boolean configureMoreActionsBtn(TableInfo ti, List<ButtonConfigFa`
`400`	`399`	`cfg.setItems(existingBtns);`
`401`	`400`	`}`
`402`	`401`
`403`		`- List<NavTree> menuItems = new ArrayList<NavTree>();`
	`402`	`+ List<NavTree> menuItems = new ArrayList<>();`
`404`	`403`	`if (moreActionsBtn.getMenuItems() != null)`
`405`	`404`	`menuItems.addAll(moreActionsBtn.getMenuItems());`
`406`	`405`
`407`	`406`	`//create map of existing item names`
`408`		`- Map<String, NavTree> btnNameMap = new HashMap<String, NavTree>();`
	`407`	`+ Map<String, NavTree> btnNameMap = new HashMap<>();`
`409`	`408`	`for (NavTree item : menuItems)`
`410`	`409`	`{`
`411`	`410`	`btnNameMap.put(item.getText(), item);`
`@@ -419,7 +418,7 @@ private static boolean configureMoreActionsBtn(TableInfo ti, List<ButtonConfigFa`
`419`	`418`	`btnNameMap.put(newButton.getText(), newButton);`
`420`	`419`	`menuItems.add(newButton);`
`421`	`420`
`422`		`- for (ClientDependency cd : fact.getClientDependencies(ti.getUserSchema().getContainer(), ti.getUserSchema().getUser()))`
	`421`	`+ for (ClientDependency cd : ClientDependency.getClientDependencySet(fact.getClientDependencies(ti.getUserSchema().getContainer(), ti.getUserSchema().getUser())))`
`423`	`422`	`{`
`424`	`423`	`scripts.add(cd.getScriptString());`
`425`	`424`	`}`