refactor: Interfacing Boaviztapi engines with the data source

Author: btry

src/DataSource/Boaviztapi.php

@@ -114,6 +114,24 @@ public function createSource(): bool
         return true;
     }
 
+    /**
+     * Get version of Boaviztapi
+     *
+     * @return string
+     */
+    public function queryVersion(): string
+    {
+        $response = $this->get('utils/version');
+        if (!isset($response[0]) || !is_string($response[0])) {
+            trigger_error(sprintf(
+                'Invalid response from Boavizta API: %s',
+                json_encode($response[0] ?? '')
+            ), E_USER_WARNING);
+            return '';
+        }
+        return $response[0];
+    }
+
     /**
      * Get zones from Boaviztapi
      * countries or world regions woth a 3 letters code

src/Impact/Embodied/Boavizta/AbstractAsset.php

@@ -75,7 +75,7 @@ abstract protected function analyzeHardware(CommonDBTM $item);
     public function setClient(Boaviztapi $client)
     {
         $this->client = $client;
-        $this->engine_version = $this->getVersion();
+        // $this->engine_version = $this->getVersion();
     }
 
     protected function getVersion(): string

src/Impact/Embodied/Engine.php

@@ -57,10 +57,9 @@ public static function getAvailableBackends(): array
      * Returns null if no engine found
      *
      * @param string $itemtype itemtype of assets to analyze
-     * @param ?RestApiClientInterface $client
      * @return EmbodiedImpactInterface|null an instance if an embodied impact calculation object or null on error
      */
-    public static function getEngineFromItemtype(string $itemtype, ?RestApiClientInterface $client = null): ?EmbodiedImpactInterface
+    public static function getEngineFromItemtype(string $itemtype): ?EmbodiedImpactInterface
     {
         $embodied_impact_namespace = Config::getEmbodiedImpactEngine();
         $embodied_impact_class = $embodied_impact_namespace . '\\' . $itemtype;
@@ -72,7 +71,7 @@ public static function getEngineFromItemtype(string $itemtype, ?RestApiClientInt
         /** @var AbstractEmbodiedImpact $embodied_impact */
         $embodied_impact = new $embodied_impact_class();
         try {
-            return self::configureEngine($embodied_impact, $client);
+            return self::configureEngine($embodied_impact);
         } catch (\RuntimeException $e) {
             // If the engine cannot be configured, it is not usable
             return null;
@@ -100,20 +99,15 @@ public static function getInternalEngineFromItemtype(string $itemtype): ?Embodie
      * Configure the engine depending on its specificities
      *
      * @param EmbodiedImpactInterface $engine the engine to configure
-     * @param ?RestApiClientInterface $client
      * @return EmbodiedImpactInterface the configured engine
      */
-    protected static function configureEngine(EmbodiedImpactInterface $engine, ?RestApiClientInterface $client = null): EmbodiedImpactInterface
+    protected static function configureEngine(EmbodiedImpactInterface $engine): EmbodiedImpactInterface
     {
         $embodied_impact_namespace = explode('\\', get_class($engine));
         switch (array_slice($embodied_impact_namespace, -2, 1)[0]) {
             case 'Boavizta':
-                if ($client === null) {
-                    throw new \RuntimeException('A RestApiClientInterface instance is required to configure Boavizta embodied impact engine');
-                }
                 /** @var AbstractAsset $engine  */
-                $client = $client ?? new RestApiClient();
-                $engine->setClient(new Boaviztapi($client));
+                $engine->setClient(new Boaviztapi(new RestApiClient()));
         }
 
         return $engine;

src/Impact/Usage/Boavizta/AbstractAsset.php

@@ -93,7 +93,7 @@ abstract protected function getAveragePower(int $id): ?int;
     public function setClient(Boaviztapi $client)
     {
         $this->client = $client;
-        $this->engine_version = $this->getVersion();
+        // $this->engine_version = $this->getVersion();
     }
 
     protected function getVersion(): string

src/Impact/Usage/Engine.php

@@ -56,10 +56,9 @@ public static function getAvailableBackends(): array
      * Returns null if no engine found
      *
      * @param string $itemtype itemtype of assets to analyze
-     * @param ?RestApiClientInterface $client
      * @return AbstractUsageImpact|null an instance if an embodied impact calculation object or null on error
      */
-    public static function getEngineFromItemtype(string $itemtype, ?RestApiClientInterface $client = null): ?AbstractUsageImpact
+    public static function getEngineFromItemtype(string $itemtype): ?AbstractUsageImpact
     {
         $usage_impact_namespace = Config::getUsageImpactEngine();
         $usage_impact_class = $usage_impact_namespace . '\\' . $itemtype;
@@ -70,7 +69,7 @@ public static function getEngineFromItemtype(string $itemtype, ?RestApiClientInt
         /** @var AbstractUsageImpact $usage_impact */
         $usage_impact = new $usage_impact_class();
         try {
-            return self::configureEngine($usage_impact, $client);
+            return self::configureEngine($usage_impact);
         } catch (\RuntimeException $e) {
             return null;
         }
@@ -80,17 +79,15 @@ public static function getEngineFromItemtype(string $itemtype, ?RestApiClientInt
      * Configure the engine depending on its specificities
      *
      * @param AbstractUsageImpact $engine the engine to configure
-     * @param ?RestApiClientInterface $client
      * @return AbstractUsageImpact the configured engine
      */
-    protected static function configureEngine(AbstractUsageImpact $engine, ?RestApiClientInterface $client = null): AbstractUsageImpact
+    protected static function configureEngine(AbstractUsageImpact $engine): AbstractUsageImpact
     {
         $embodied_impact_namespace = explode('\\', get_class($engine));
         switch (array_slice($embodied_impact_namespace, -2, 1)[0]) {
             case 'Boavizta':
                 /** @var Boavizta\AbstractAsset $engine  */
-                $client = $client ?? new RestApiClient();
-                $engine->setClient(new Boaviztapi($client));
+                $engine->setClient(new Boaviztapi(new RestApiClient()));
         }
 
         return $engine;