Introduce envvar support for info

src/Controller/HealthController.php

@@ -30,14 +30,9 @@
  */
 class HealthController extends AbstractController
 {
-    /**
-     * @var HealthCheckChain
-     */
-    private $healthChecker;
-
-    public function __construct(HealthCheckChain $healthChecker)
-    {
-        $this->healthChecker = $healthChecker;
+    public function __construct(
+        private readonly HealthCheckChain $healthChecker
+    ) {
     }
 
     public function __invoke(): JsonResponse

src/Controller/InfoController.php

@@ -18,6 +18,7 @@
 
 namespace OpenConext\MonitorBundle\Controller;
 
+use OpenConext\MonitorBundle\Value\BuildInformationFactory;
 use OpenConext\MonitorBundle\Value\BuildPathFactory;
 use OpenConext\MonitorBundle\Value\Information;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -41,34 +42,16 @@
  */
 class InfoController extends AbstractController
 {
-    /**
-     * @var string
-     */
-    private $buildPath;
-
-    /**
-     * @var string
-     */
-    private $environment;
-
-    /**
-     * @var bool
-     */
-    private $debuggerEnabled;
-
-    /**
-     * @var array
-     */
-    private $systemInfo = [];
+    private array $systemInfo = [];
 
     public function __construct(
-        $buildPath,
-        $environment,
-        $debuggerEnabled
+        private readonly string $buildPath,
+        private readonly string $environment,
+        private readonly bool $debuggerEnabled,
+        private readonly ?string $version,
+        private readonly ?string $revision,
+        private readonly ?string $commitDate,
     ) {
-        $this->buildPath = $buildPath;
-        $this->environment = $environment;
-        $this->debuggerEnabled = $debuggerEnabled;
 
         if (function_exists('opcache_get_status')) {
             $this->systemInfo['opcache'] = opcache_get_status(false);
@@ -77,8 +60,14 @@ public function __construct(
 
     public function __invoke(): JsonResponse
     {
+        $buildInformation = BuildInformationFactory::build(
+            $this->version,
+            $this->revision,
+            $this->commitDate,
+            $this->buildPath
+        );
         $info = Information::buildFrom(
-            BuildPathFactory::buildFrom($this->buildPath),
+            $buildInformation,
             $this->environment,
             $this->debuggerEnabled,
             $this->systemInfo

src/DependencyInjection/Compiler/HealthCheckPass.php

@@ -38,7 +38,7 @@ public function process(ContainerBuilder $container)
 
         $definition = $container->findDefinition('openconext.monitor.health_check_chain');
 
-        // find all service IDs with the app.mail_transport tag
+        // find all service IDs with the openconext.monitor.health_check tag
         $taggedServices = $container->findTaggedServiceIds('openconext.monitor.health_check');
 
         foreach ($taggedServices as $id => $tags) {

src/Resources/config/services.yml

@@ -5,15 +5,17 @@ services:
             - '~'
             - '%kernel.environment%'
             - '%kernel.debug%'
-        public: true
+            - '%env(default::string:OPENCONEXT_APP_VERSION)%'
+            - '%env(default::string:OPENCONEXT_GIT_SHA)%'
+            - '%env(default::string:OPENCONEXT_COMMIT_DATE)%'
+
         autowire: true
         tags: ['controller.service_arguments', 'container.service_subscriber']
 
     openconext.monitor.controller.health:
         class: OpenConext\MonitorBundle\Controller\HealthController
         arguments:
             - '@openconext.monitor.health_check_chain'
-        public: true
         autowire: true
         tags: ['controller.service_arguments', 'container.service_subscriber']
 
@@ -30,4 +32,4 @@ services:
         calls:
             - [ setEntityManager, ['@?doctrine.orm.entity_manager']]
         tags:
-            - { name: openconext.monitor.health_check }
+            - { name: openconext.monitor.health_check }

src/Value/BuildEnvVars.php

@@ -0,0 +1,89 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Value;
+
+/**
+ * Representation of the env vars that describe the build details
+ *
+ * By default, the following env vars are evaluated:
+ *
+ * OPENCONEXT_APP_VERSION maps to $version
+ * OPENCONEXT_GIT_SHA     maps to $revision
+ * OPENCONEXT_COMMIT_DATE maps to $commitDate
+ *
+ * This VO is created by its factory who actually reads the env-vars
+ */
+class BuildEnvVars implements BuildInformation
+{
+    public function __construct(
+        private readonly string $version,
+        private readonly string $revision,
+        private readonly string $commitDate,
+    ) {
+    }
+
+    public function getVersion(): string
+    {
+        return $this->version;
+    }
+
+    public function getRevision(): string
+    {
+        return $this->revision;
+    }
+
+    public function getCommitDate(): string
+    {
+        return $this->commitDate;
+    }
+
+    public function hasRevision(): bool
+    {
+        return true;
+    }
+
+    public function getPath(): string
+    {
+        return '';
+    }
+
+    public function hasVersion(): bool
+    {
+        return true;
+    }
+
+    public function hasPath(): bool
+    {
+        return false;
+    }
+
+    public function hasCommitDate(): bool
+    {
+        return true;
+    }
+
+    public function jsonSerialize(): mixed
+    {
+        return [
+            'version' => $this->version,
+            'revision' => $this->revision,
+            'commitDate' => $this->commitDate,
+        ];
+    }
+}

src/Value/BuildEnvVarsFactory.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Value;
+
+/**
+ * Build instance of BuildEnvVars
+ */
+class BuildEnvVarsFactory
+{
+    public static function buildFrom(string $version, string $revision, string $commitDate): BuildEnvVars
+    {
+        return new BuildEnvVars(
+            $version,
+            $revision,
+            $commitDate
+        );
+    }
+}

src/Value/BuildInformation.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Value;
+
+use JsonSerializable;
+
+interface BuildInformation extends JsonSerializable
+{
+    public function getVersion(): string;
+
+    public function jsonSerialize(): mixed;
+
+    public function getRevision(): string;
+
+    public function hasRevision(): bool;
+
+    public function getPath(): string;
+
+    public function getCommitDate(): string;
+
+    public function hasVersion(): bool;
+
+    public function hasPath(): bool;
+
+    public function hasCommitDate(): bool;
+
+}

src/Value/BuildInformationFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Value;
+
+use function is_string;
+
+class BuildInformationFactory
+{
+    public static function build(
+        ?string $version,
+        ?string $revision,
+        ?string $commitDate,
+        string $buildPath,
+    ): BuildInformation
+    {
+        if (is_string($revision) && is_string($version) && is_string($commitDate)) {
+            return BuildEnvVarsFactory::buildFrom($version, $revision, $commitDate);
+        }
+        return BuildPathFactory::buildFrom($buildPath);
+    }
+}