Merge branch 'release/1.2.0-beta.1' into support/1.2.0

Author: btry

CHANGELOG.md

@@ -35,5 +35,5 @@
         "license-headers": "vendor/bin/licence-headers-check --ansi --no-interaction",
         "build-schema": "tools/build-db-schema.php carbon | plantuml -p -tpng > docs/db-schema.png"
     },
-    "version": "1.0.0-beta.3"
-}
+    "version": "1.2.0-beta.1"
+}

composer.json

@@ -194,7 +194,7 @@ public function upgrade(string $from_version, array $args = []): bool
             }
         }
 
-        // Cherry pick install sub tasts to run
+        // Cherry pick sub tasts to run from fresh install workflow
         // Useful to rewrite missing data in DB
         $install_dir = __DIR__ . '/install/';
         $update_scripts = scandir($install_dir);

install/Install.php

@@ -2,7 +2,7 @@
     "name": "carbon",
     "description": "Measurement of carbon emissions of GLPI devices",
     "license": "GPL-3.0-or-later",
-    "version": "1.0.0-beta.3",
+    "version": "1.2.0-beta.1",
     "dependencies": {
         "apexcharts": "^3.49.0"
     },

package-lock.json

@@ -47,6 +47,7 @@
         __DIR__ . '/src',
         __DIR__ . '/tools',
     ])
+    ->withSkipPath(__DIR__ . '/vendor')
     ->withPhpVersion(PhpVersion::PHP_82)
     ->withCache(
         sys_get_temp_dir() . '/rector',

package.json

@@ -46,13 +46,15 @@
 use Location as GlpiLocation;
 use Profile as GlpiProfile;
 
-define('PLUGIN_CARBON_VERSION', '1.2.0-dev');
+// Version of the plugin (major.minor.bugfix)
+define('PLUGIN_CARBON_VERSION', '1.2.0-beta.1');
+// Schema version of this version (major.minor.bugfix)
 define('PLUGIN_CARBON_SCHEMA_VERSION', '1.2.0');
 
 // Minimal GLPI version, inclusive
-define("PLUGIN_CARBON_MIN_GLPI_VERSION", "11.0.0-beta");
+define("PLUGIN_CARBON_MIN_GLPI_VERSION", '11.0.0');
 // Maximum GLPI version, exclusive
-define("PLUGIN_CARBON_MAX_GLPI_VERSION", "12.0.0");
+define("PLUGIN_CARBON_MAX_GLPI_VERSION", '12.0.0');
 
 define('PLUGIN_CARBON_DECIMALS', 3);
 

rector.php

@@ -50,6 +50,27 @@ abstract class AbstractCronTask extends DatasourceAbstractCronTask implements Cr
 
     protected static string $downloadMethod;
 
+    /**
+     * Filter out the gaps to remove fales gaps caused by DST switch
+     * Needed after a call to Toolbox::findTemporalGapsInTable()
+     * TODO: replace its inner implementation with this method on each call, when necessary
+     * In the SQL function DATE_ADD() we may do the following process
+     * DATE_ADD('2022-03-27 01:00:00', INTERVAL 1 HOUR) and '2022-03-27 01:00:00' + INTERVAL 1 HOUR
+     * while we use Europe/Paris timezone (or any timezone usinf DST)
+     * Both expressions return '2022-03-27 02:00:00' and it matches the exact time where we switch to summer time
+     * '2022-03-27 02:00:00' should be actually '2022-03-27 03:00:00', but this is not what happens with MySQL 8.0
+     * Therefore when the date '2022-03-27 02:00:00' is converted into a DateTime object in PHP with Europe/Paris timezone
+     * it is converted into '2022-03-27 03:00:00'.
+     * When the start of a gap and the end of a gap, both converted into a DateTime object, are equal
+     * then this means that we are switching to summer time and the gap is irrelevant
+     * The code below tracks such intervals and filters them out
+     *
+     * @param array $gaps
+     * @param Source_Zone $source_zone
+     * @return array
+     */
+    abstract protected function dstFilter(array $gaps, Source_Zone $source_zone): array;
+
     public function showForCronTask(CommonDBTM $item)
     {
         switch ($item->fields['name']) {
@@ -85,6 +106,7 @@ public function showGapsReport()
                 $source_zone,
                 $oldest_asset_date
             );
+            $entries = $this->dstFilter($entries, $source_zone);
             $total = count($entries);
             $zone = Zone::getById($zone_id);
 

setup.php

@@ -285,7 +285,7 @@ public function fetchRange(DateTimeImmutable $start, DateTimeImmutable $stop, So
         // If cached file exists, use it
         if (file_exists($cache_file)) {
             $full_response = json_decode(file_get_contents($cache_file), true);
-            return $full_response;
+            return $full_response['data'];
         } else {
             $cache_dir = dirname($cache_file);
             if (!is_dir($cache_dir)) {
@@ -382,19 +382,14 @@ protected function formatOutput(array $response, int $step): array
         // This is needed to detect later the switching to winter time
         $response = $this->shiftToLocalTimezone($response);
         $intensities = [];
-        foreach ($response['data'] as $record) {
-            $datetime = $record['datetime'];
-            if (!$datetime instanceof DateTimeInterface) {
-                var_dump(DateTime::getLastErrors());
-                continue;
-            }
+        array_walk($response, function ($record) use (&$intensities) {
             $data_quality = $this->getDataQuality($record);
             $intensities[] = [
-                'datetime'     => $datetime->format(DateTime::ATOM),
+                'datetime'     => $record['datetime']->format('Y-m-d\TH:00:00'),
                 'intensity'    => $record['carbonIntensity'],
                 'data_quality' => $data_quality,
             ];
-        }
+        });
 
         return $intensities;
     }
@@ -403,7 +398,7 @@ protected function formatOutput(array $response, int $step): array
      * convert dates to the timezone of GLPI
      *
      * @param array $response
-     * @return array array of records: ['date_heure' => string, 'taux_co2' => number, 'datetime' => DateTime]
+     * @return array array of records: ['datetime' => DateTime, 'carbonintensity' => number]
      */
     protected function shiftToLocalTimezone(array $response): array
     {
@@ -412,7 +407,7 @@ protected function shiftToLocalTimezone(array $response): array
 
         $shifted_response = [];
         $local_timezone = new DateTimeZone($DB->guessTimezone());
-        array_walk($response['data'], function ($item, $key) use (&$shifted_response, $local_timezone) {
+        array_walk($response, function ($item, $key) use (&$shifted_response, $local_timezone) {
             $shifted_date_object = DateTime::createFromFormat('Y-m-d\TH:i:s.vp', $item['datetime'])
                 ->setTimezone($local_timezone);
             $shifted_date_string = $shifted_date_object->format('Y-m-d H:i:sP');
@@ -423,7 +418,7 @@ protected function shiftToLocalTimezone(array $response): array
             $shifted_response[$shifted_date_string] = $item;
         });
 
-        return ['zone' => $response['zone'], 'data' => $shifted_response];
+        return $shifted_response;
     }
 
     /**

src/DataSource/CarbonIntensity/AbstractCronTask.php

@@ -36,6 +36,7 @@
 use CronTask as GlpiCronTask;
 use GlpiPlugin\Carbon\DataSource\CarbonIntensity\AbstractCronTask;
 use GlpiPlugin\Carbon\DataSource\CronTaskInterface;
+use GlpiPlugin\Carbon\Source_Zone;
 
 class CronTask extends AbstractCronTask implements CronTaskInterface
 {
@@ -89,4 +90,12 @@ public static function cronInfo(string $name): array
         }
         return [];
     }
+
+    protected function dstFilter(array $gaps, Source_Zone $source_zone): array
+    {
+        // TODO: find a way to handle electricitymaps territory codes
+        // They don't match any norm (US-CAL, US-CAR)
+        // The codes with a 3rd name (US-CAL-CISO) seems to mention an energy distribution or production entity
+        return $gaps;
+    }
 }