REgionMappings return null instead of throwing exception + fix logic in AverageCarbonIntensity

Signed-off-by: Julien Nioche <julien@digitalpebble.com>

Author: jnioche

src/main/java/com/digitalpebble/spruce/modules/electricitymaps/AverageCarbonIntensity.java

@@ -2,27 +2,32 @@
 
 package com.digitalpebble.spruce.modules.electricitymaps;
 
-import com.digitalpebble.spruce.*;
-
-import static com.digitalpebble.spruce.SpruceColumn.*;
-
+import com.digitalpebble.spruce.Column;
+import com.digitalpebble.spruce.EnrichmentModule;
+import com.digitalpebble.spruce.Provider;
+import com.digitalpebble.spruce.Utils;
 import com.digitalpebble.spruce.modules.realtimecloud.RegionMappings;
 import org.apache.spark.sql.Row;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+import static com.digitalpebble.spruce.SpruceColumn.*;
+
 /**
  * Populate the CARBON_INTENSITY field using ElecticityMaps' 2024 datasets
  * for rows where energy usage has been estimated.
  **/
 public class AverageCarbonIntensity implements EnrichmentModule {
 
-    private final Map<String, Double> average_intensities = new HashMap<>();
+    private static final Logger log = LoggerFactory.getLogger(AverageCarbonIntensity.class);
 
     private final static String DEFAULT_RESOURCE_LOCATION = "electricitymaps/averages_2024.csv";
+    private final Map<String, Double> average_intensities = new HashMap<>();
 
     public void init(Map<String, Object> params) {
         // load the averages for each EM IDs
@@ -53,11 +58,16 @@ public Column[] columnsNeeded() {
     }
 
     /**
-      Get the average intensity for the given region ID
-      in gCO2perKWH
+     * Get the average intensity for the given region ID
+     * in gCO2perKWH
+     * or null if the region does not exist
      */
     protected Double getAverageIntensity(Provider provider, String regionId) {
         String emRegionId = RegionMappings.getEMRegion(provider, regionId);
+        if (emRegionId == null) {
+            log.info("Region unknown {} for {}", regionId, provider);
+            return null;
+        }
         return average_intensities.get(emRegionId);
     }
 
@@ -79,16 +89,11 @@ public Row process(Row row) {
         }
 
         // get intensity for the location
-        try {
-            final double coeff = getAverageIntensity(Provider.AWS, locationCode);
-            if (coeff == 0.0d) {
-                // if the coefficient is 0 it means that the region is not supported
-                return row;
-            }
-            return EnrichmentModule.withUpdatedValue(row, CARBON_INTENSITY, coeff);
-        } catch (Exception exception) {
-            // if the region is not supported, we cannot compute the carbon intensity
+        Double coeff = getAverageIntensity(Provider.AWS, locationCode);
+        if (coeff == null) {
+            // if the coefficient is 0 it means that the region is not supported
             return row;
         }
+        return EnrichmentModule.withUpdatedValue(row, CARBON_INTENSITY, coeff);
     }
 }

src/main/java/com/digitalpebble/spruce/modules/realtimecloud/RegionMappings.java

@@ -46,18 +46,14 @@ public class RegionMappings {
      *
      * @param p      The cloud provider (e.g., AWS, GOOGLE, AZURE).
      * @param region The region name (e.g., "us-east-1").
-     * @return The corresponding ElectricityMaps region ID.
-     * @throws RuntimeException if the region is not supported.
+     * @return The corresponding ElectricityMaps region ID or null if the region or provider is not supported.
      */
     public static String getEMRegion(Provider p, String region) {
-
         java.util.Map<String, String> regionMap = mappings.get(p);
-
-        String regionKey = regionMap.get(region);
-        if (regionKey == null) {
-            throw new RuntimeException("Unsupported region for provider " + p + ": " + region);
+        if (regionMap == null) {
+            return null;
         }
-        return regionKey;
+        return regionMap.get(region);
     }
 
 }

src/test/java/com/digitalpebble/spruce/modules/electricitymaps/AverageCarbonIntensityTest.java

@@ -19,4 +19,13 @@ void testGetAverageIntensity() {
         Double result = aci.getAverageIntensity(Provider.AWS, regionId);
         assertEquals(400.33, result);
     }
+
+    @Test
+    void testUnknownRegion() {
+        AverageCarbonIntensity aci = new AverageCarbonIntensity();
+        aci.init(Map.of());
+        String regionId = "us-blablabla-1";
+        Double result = aci.getAverageIntensity(Provider.AWS, regionId);
+        assertNull(result);
+    }
 }

src/test/java/com/digitalpebble/spruce/modules/realtimecloud/RegionMappingsTest.java

@@ -19,11 +19,6 @@ void testGetEMRegion_ValidMapping() {
 
     @Test
     void testGetEMRegion_UnsupportedRegion() {
-        Exception exception = assertThrows(RuntimeException.class, () ->
-                RegionMappings.getEMRegion(Provider.AWS, "non-existent-region"));
-        assertTrue(exception.getMessage().contains("Unsupported region"));
+        assertNull(RegionMappings.getEMRegion(Provider.AWS, "non-existent-region"));
     }
-
-
-
 }