Discover when the Cloud Request Engine is built, and retry on first use only after a failure that can pass

device-detection/device-detection.cloud/src/main/java/fiftyone/devicedetection/cloud/flowelements/DeviceDetectionCloudEngine.java

@@ -55,9 +55,10 @@
  */
 public class DeviceDetectionCloudEngine
     extends CloudAspectEngineBase<DeviceDataCloud> {
-    List<AspectPropertyMetaData> aspectProperties;
+    volatile List<AspectPropertyMetaData> aspectProperties;
     private String dataSourceTier;
     CloudRequestEngine cloudRequestEngine;
+    private final Object metadataLock = new Object();
 
     /**
      * Construct a new instance of the {@link DeviceDetectionCloudEngine}.
@@ -72,9 +73,37 @@ public DeviceDetectionCloudEngine(
         this.cloudRequestEngine = null;
     }
 
+    /**
+     * The property metadata, from the products the Cloud Request Engine
+     * reports. Until they are known, after a failure at build that can
+     * pass, this is empty and is read again on the next call.
+     * @return the property metadata
+     */
     @Override
     public List<AspectPropertyMetaData> getProperties() {
-        return aspectProperties;
+        List<AspectPropertyMetaData> loaded = aspectProperties;
+        if (loaded == null && cloudRequestEngine != null) {
+            synchronized (metadataLock) {
+                if (aspectProperties == null) {
+                    loadAspectProperties(cloudRequestEngine);
+                }
+                loaded = aspectProperties;
+            }
+        }
+        return loaded == null ?
+            new ArrayList<AspectPropertyMetaData>() :
+            loaded;
+    }
+
+    /**
+     * Whether the property metadata is loaded, which reads it if the Cloud
+     * Request Engine now knows the accessible properties.
+     * @return true once the property metadata is loaded
+     */
+    @Override
+    public boolean hasLoadedProperties() {
+        getProperties();
+        return aspectProperties != null;
     }
 
     @Override
@@ -188,9 +217,10 @@ public void addPipeline(Pipeline pipeline) {
         if (cloudRequestEngine == null) {
             cloudRequestEngine = pipeline.getElement(CloudRequestEngine.class);
             if (cloudRequestEngine != null) {
-                if (loadAspectProperties(cloudRequestEngine) == false) {
-                    logger.error("Failed to load aspect properties");
-                }
+                // The products are not known after a failure at build that
+                // can pass, which the Cloud Request Engine has logged.
+                // getProperties reads them once they are.
+                loadAspectProperties(cloudRequestEngine);
             }
 
         }
@@ -209,7 +239,7 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
             findProduct(engine.getPublicProperties());
 
         if (product != null) {
-            aspectProperties = new ArrayList<>();
+            List<AspectPropertyMetaData> properties = new ArrayList<>();
             dataSourceTier = product.dataTier;
 
             for (AccessiblePropertyMetaData.PropertyMetaData item :
@@ -221,13 +251,12 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
                     item.getPropertyType(),
                     new ArrayList<String>(),
                     true);
-                aspectProperties.add(property);
+                properties.add(property);
             }
+            aspectProperties = properties;
             return true;
         }
         else {
-            logger.error("Aspect properties could not be loaded for" +
-                " the Device Detection cloud engine", this);
             return false;
         }
     }

device-detection/device-detection.cloud/src/test/java/fiftyone/devicedetection/cloud/flowelements/ProductMissingTests.java

@@ -134,6 +134,39 @@ public void ProductMissing_PropertyIsMissing() throws Exception {
         }
     }
 
+    /**
+     * After a failure at build that can pass, the Cloud Request Engine does
+     * not know the accessible products yet. The engine builds without
+     * logging anything, and reads its metadata once the products are known
+     * rather than keeping none.
+     */
+    @Test
+    public void DiscoveryNotComplete_LoadsTheMetadataLater() throws Exception {
+        ProductMetaData product = new ProductMetaData();
+        product.dataTier = "test";
+        product.properties = Arrays.asList(
+            new PropertyMetaData("hardwarevendor", "String", "cat", null));
+        Map<String, ProductMetaData> products = new HashMap<>();
+        products.put("device", product);
+        CloudRequestEngine requestEngine = mock(CloudRequestEngine.class);
+        when(requestEngine.getPublicProperties())
+            .thenReturn(null)
+            .thenReturn(products);
+        Pipeline pipeline = mock(Pipeline.class);
+        when(pipeline.getElement(CloudRequestEngine.class))
+            .thenReturn(requestEngine);
+
+        try (DeviceDetectionCloudEngine engine =
+            new DeviceDetectionCloudEngineBuilder(loggerFactory).build()) {
+            engine.addPipeline(pipeline);
+            List<String> logged = warningsAndErrors();
+            assertEquals(logged.toString(), 0, logged.size());
+
+            assertEquals(1, engine.getProperties().size());
+            assertEquals("hardwarevendor", engine.getProperties().get(0).getName());
+        }
+    }
+
     /**
      * An engine whose Cloud Request Engine reports one product, holding
      * one string property.

ip-intelligence/ip-intelligence.cloud/src/main/java/fiftyone/ipintelligence/cloud/flowelements/IPIntelligenceCloudEngine.java

@@ -63,8 +63,9 @@
  */
 public class IPIntelligenceCloudEngine
     extends CloudAspectEngineBase<IPIntelligenceDataCloud> {
-    List<AspectPropertyMetaData> aspectProperties;
+    volatile List<AspectPropertyMetaData> aspectProperties;
     private String dataSourceTier;
+    private final Object metadataLock = new Object();
     // Lower-cased names of properties the cloud returns as weighted lists
     // (cloud type "Weighted..."), so processEngine can read their value/weight
     // pairs rather than treating them as a plain list.
@@ -84,9 +85,37 @@ public IPIntelligenceCloudEngine(
         this.cloudRequestEngine = null;
     }
 
+    /**
+     * The property metadata, from the products the Cloud Request Engine
+     * reports. Until they are known, after a failure at build that can
+     * pass, this is empty and is read again on the next call.
+     * @return the property metadata
+     */
     @Override
     public List<AspectPropertyMetaData> getProperties() {
-        return aspectProperties;
+        List<AspectPropertyMetaData> loaded = aspectProperties;
+        if (loaded == null && cloudRequestEngine != null) {
+            synchronized (metadataLock) {
+                if (aspectProperties == null) {
+                    loadAspectProperties(cloudRequestEngine);
+                }
+                loaded = aspectProperties;
+            }
+        }
+        return loaded == null ?
+            new ArrayList<AspectPropertyMetaData>() :
+            loaded;
+    }
+
+    /**
+     * Whether the property metadata is loaded, which reads it if the Cloud
+     * Request Engine now knows the accessible properties.
+     * @return true once the property metadata is loaded
+     */
+    @Override
+    public boolean hasLoadedProperties() {
+        getProperties();
+        return aspectProperties != null;
     }
 
     @Override
@@ -222,9 +251,10 @@ public void addPipeline(Pipeline pipeline) {
         if (cloudRequestEngine == null) {
             cloudRequestEngine = pipeline.getElement(CloudRequestEngine.class);
             if (cloudRequestEngine != null) {
-                if (loadAspectProperties(cloudRequestEngine) == false) {
-                    logger.error("Failed to load aspect properties");
-                }
+                // The products are not known after a failure at build that
+                // can pass, which the Cloud Request Engine has logged.
+                // getProperties reads them once they are.
+                loadAspectProperties(cloudRequestEngine);
             }
 
         }
@@ -243,7 +273,7 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
             findProduct(engine.getPublicProperties());
 
         if (product != null) {
-            aspectProperties = new ArrayList<>();
+            List<AspectPropertyMetaData> properties = new ArrayList<>();
             weightedPropertyNames.clear();
             dataSourceTier = product.dataTier;
 
@@ -259,13 +289,12 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
                     resolvePropertyType(item),
                     new ArrayList<String>(),
                     true);
-                aspectProperties.add(property);
+                properties.add(property);
             }
+            aspectProperties = properties;
             return true;
         }
         else {
-            logger.error("Aspect properties could not be loaded for" +
-                " the IP Intelligence cloud engine", this);
             return false;
         }
     }

ip-intelligence/ip-intelligence.cloud/src/test/java/fiftyone/ipintelligence/cloud/flowelements/ProductMissingTests.java

@@ -134,6 +134,39 @@ public void ProductMissing_PropertyIsMissing() throws Exception {
         }
     }
 
+    /**
+     * After a failure at build that can pass, the Cloud Request Engine does
+     * not know the accessible products yet. The engine builds without
+     * logging anything, and reads its metadata once the products are known
+     * rather than keeping none.
+     */
+    @Test
+    public void DiscoveryNotComplete_LoadsTheMetadataLater() throws Exception {
+        ProductMetaData product = new ProductMetaData();
+        product.dataTier = "test";
+        product.properties = Arrays.asList(
+            new PropertyMetaData("registeredname", "String", "cat", null));
+        Map<String, ProductMetaData> products = new HashMap<>();
+        products.put("ip", product);
+        CloudRequestEngine requestEngine = mock(CloudRequestEngine.class);
+        when(requestEngine.getPublicProperties())
+            .thenReturn(null)
+            .thenReturn(products);
+        Pipeline pipeline = mock(Pipeline.class);
+        when(pipeline.getElement(CloudRequestEngine.class))
+            .thenReturn(requestEngine);
+
+        try (IPIntelligenceCloudEngine engine =
+            new IPIntelligenceCloudEngineBuilder(loggerFactory).build()) {
+            engine.addPipeline(pipeline);
+            List<String> logged = warningsAndErrors();
+            assertEquals(logged.toString(), 0, logged.size());
+
+            assertEquals(1, engine.getProperties().size());
+            assertEquals("registeredname", engine.getProperties().get(0).getName());
+        }
+    }
+
     /**
      * An engine whose Cloud Request Engine reports one product, holding
      * one string property.

location/geo-location.cloud/src/main/java/fiftyone/geolocation/flowelements/GeoLocationCloudEngine.java

@@ -47,15 +47,44 @@
 public class GeoLocationCloudEngine extends CloudAspectEngineBase<CloudGeoData> {
 
     private CloudRequestEngine cloudRequestEngine = null;
-    private List<AspectPropertyMetaData> properties;
+    private volatile List<AspectPropertyMetaData> properties;
+    private final Object metadataLock = new Object();
     private String dataSourceTier;
     private String elementDataKey;
     private EvidenceKeyFilter evidenceKeyFilter = new EvidenceKeyFilterWhitelist(Collections.emptyList());
     private String dataProviderPrefix;
 
+    /**
+     * The property metadata, from the products the Cloud Request Engine
+     * reports. Until they are known, after a failure at build that can
+     * pass, this is empty and is read again on the next call.
+     * @return the property metadata
+     */
     @Override
     public List<AspectPropertyMetaData> getProperties() {
-        return properties;
+        List<AspectPropertyMetaData> loaded = properties;
+        if (loaded == null && cloudRequestEngine != null) {
+            synchronized (metadataLock) {
+                if (properties == null) {
+                    loadAspectProperties(cloudRequestEngine);
+                }
+                loaded = properties;
+            }
+        }
+        return loaded == null ?
+            new ArrayList<AspectPropertyMetaData>() :
+            loaded;
+    }
+
+    /**
+     * Whether the property metadata is loaded, which reads it if the Cloud
+     * Request Engine now knows the accessible properties.
+     * @return true once the property metadata is loaded
+     */
+    @Override
+    public boolean hasLoadedProperties() {
+        getProperties();
+        return properties != null;
     }
 
     @Override
@@ -167,9 +196,10 @@ public void addPipeline(Pipeline pipeline) {
         if (cloudRequestEngine == null) {
             cloudRequestEngine = pipeline.getElement(CloudRequestEngine.class);
             if (cloudRequestEngine != null) {
-                if (loadAspectProperties(cloudRequestEngine) == false) {
-                    logger.error("Failed to load aspect properties");
-                }
+                // The products are not known after a failure at build that
+                // can pass, which the Cloud Request Engine has logged.
+                // getProperties reads them once they are.
+                loadAspectProperties(cloudRequestEngine);
             }
 
         }
@@ -181,7 +211,7 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
             findProduct(engine.getPublicProperties());
 
         if (product != null) {
-            properties = new ArrayList<>();
+            List<AspectPropertyMetaData> loaded = new ArrayList<>();
             dataSourceTier = product.dataTier;
 
             for (AccessiblePropertyMetaData.PropertyMetaData item : product.properties)
@@ -197,13 +227,12 @@ private boolean loadAspectProperties(CloudRequestEngine engine) {
                     item.delayExecution,
                     item.evidenceProperties);
 
-                properties.add(property);
+                loaded.add(property);
             }
+            properties = loaded;
             return true;
         }
         else {
-            logger.error("Aspect properties could not be loaded for" +
-                " the Location cloud engine", this);
             return false;
         }
     }

location/geo-location.cloud/src/test/java/fiftyone/geolocation/flowelements/GeoLocationCloudEngineTests.java

@@ -136,6 +136,40 @@ public void ProductMissing_PropertyIsMissing() throws Exception {
         }
     }
 
+    /**
+     * After a failure at build that can pass, the Cloud Request Engine does
+     * not know the accessible products yet. The engine builds without
+     * logging anything, and reads its metadata once the products are known
+     * rather than keeping none.
+     */
+    @Test
+    public void DiscoveryNotComplete_LoadsTheMetadataLater() throws Exception {
+        ProductMetaData product = new ProductMetaData();
+        product.dataTier = "test";
+        product.properties = Arrays.asList(
+            new PropertyMetaData("town", "String", "cat", null));
+        Map<String, ProductMetaData> products = new HashMap<>();
+        products.put("location", product);
+        CloudRequestEngine requestEngine = mock(CloudRequestEngine.class);
+        when(requestEngine.getPublicProperties())
+            .thenReturn(null)
+            .thenReturn(products);
+        Pipeline pipeline = mock(Pipeline.class);
+        when(pipeline.getElement(CloudRequestEngine.class))
+            .thenReturn(requestEngine);
+
+        try (GeoLocationCloudEngine engine =
+            new GeoLocationCloudEngineBuilder(loggerFactory)
+                .build(Enums.GeoLocationProvider.FiftyOneDegrees)) {
+            engine.addPipeline(pipeline);
+            List<String> logged = warningsAndErrors();
+            assertEquals(logged.toString(), 0, logged.size());
+
+            assertEquals(1, engine.getProperties().size());
+            assertEquals("town", engine.getProperties().get(0).getName());
+        }
+    }
+
     /**
      * An engine whose Cloud Request Engine reports one product, holding
      * one string property.