Merge pull request #663 from keboola/odin-AJDA-2028-c

[internal-api-php-client] update lib standards

Author: odinuv

composer.json

@@ -44,12 +44,12 @@
     "require-dev": {
         "infection/infection": "^0.27",
         "keboola/coding-standard": ">=14.0",
-        "phpstan/phpstan": "^1.0",
-        "phpstan/phpstan-phpunit": "^1.3",
-        "phpstan/phpstan-symfony": "^1.4",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^9.5",
         "sempro/phpunit-pretty-print": "^1.4",
-        "symfony/dotenv": "^6.3"
+        "symfony/dotenv": "^6.3|^7.0"
     },
     "scripts": {
         "pre-autoload-dump": "Aws\\Script\\Composer\\Composer::removeUnusedServices",

provisioning/local/.terraform.lock.hcl

@@ -24,12 +24,19 @@ resource "azuread_application" "job_queue_internal_api_php_client" {
 }
 
 resource "azuread_service_principal" "job_queue_internal_api_php_client" {
-  application_id = azuread_application.job_queue_internal_api_php_client.application_id
+  client_id      = azuread_application.job_queue_internal_api_php_client.client_id
   owners         = [data.azuread_client_config.current.object_id]
 }
 
+resource "time_rotating" "job_queue_internal_api_php_client" {
+  rotation_days = 30
+}
+
 resource "azuread_service_principal_password" "job_queue_internal_api_php_client" {
   service_principal_id = azuread_service_principal.job_queue_internal_api_php_client.id
+  rotate_when_changed = {
+    rotation = time_rotating.job_queue_internal_api_php_client.id
+  }
 }
 
 // resource group
@@ -40,7 +47,7 @@ resource "azurerm_resource_group" "job_queue_internal_api_php_client" {
 
 resource "azurerm_role_assignment" "job_queue_daemon" {
   scope                = azurerm_resource_group.job_queue_internal_api_php_client.id
-  principal_id         = azuread_service_principal.job_queue_internal_api_php_client.id
+  principal_id         = azuread_service_principal.job_queue_internal_api_php_client.object_id
   role_definition_name = "Contributor"
 }
 
@@ -54,7 +61,7 @@ resource "azurerm_key_vault" "job_queue_internal_api_php_client" {
 
   access_policy {
     tenant_id = data.azurerm_client_config.current.tenant_id
-    object_id = azuread_service_principal.job_queue_internal_api_php_client.id
+    object_id = azuread_service_principal.job_queue_internal_api_php_client.object_id
 
     key_permissions = [
       "Decrypt",
@@ -78,7 +85,7 @@ output "azure_tenant_id" {
 }
 
 output "azure_application_id" {
-  value = azuread_application.job_queue_internal_api_php_client.application_id
+  value = azuread_application.job_queue_internal_api_php_client.client_id
 }
 
 output "azure_application_secret" {

provisioning/local/azure.tf

@@ -10,22 +10,22 @@ terraform {
   required_providers {
     aws = {
       source  = "hashicorp/aws"
-      version = "~> 5.9"
+      version = "~> 6.11"
     }
 
     azurerm = {
       source  = "hashicorp/azurerm"
-      version = "~> 4.17.0"
+      version = "~> 4.42"
     }
 
     azuread = {
       source  = "hashicorp/azuread"
-      version = "~> 2.40.0"
+      version = "~> 3.5"
     }
 
     google = {
       source  = "hashicorp/google"
-      version = "~> 4.81.0"
+      version = "~> 7.4"
     }
   }
 

provisioning/local/main.tf

@@ -63,7 +63,8 @@ public function __construct(
             $options,
         );
         if (!empty($options['backoffMaxTries'])) {
-            $options['backoffMaxTries'] = intval($options['backoffMaxTries']);
+            assert(is_scalar($options['backoffMaxTries']));
+            $options['backoffMaxTries'] = intval((string) $options['backoffMaxTries']);
         } else {
             $options['backoffMaxTries'] = self::DEFAULT_BACKOFF_RETRIES;
         }
@@ -125,6 +126,7 @@ private function validateConfiguration(
             $messages = '';
             /** @var ConstraintViolationInterface $error */
             foreach ($errors as $error) {
+                // @phpstan-ignore-next-line
                 $messages .= 'Value "' . $error->getInvalidValue() . '" is invalid: ' . $error->getMessage() . "\n";
             }
             throw new ClientException('Invalid parameters when creating client: ' . $messages);
@@ -162,7 +164,10 @@ public function createJobsBatch(array $jobs): array
         }
         $result = $this->sendRequest($request);
 
-        return array_map(fn(array $jobData) => $this->existingJobFactory->loadFromExistingJobData($jobData), $result);
+        return array_map(function ($jobData) {
+            assert(is_array($jobData));
+            return $this->existingJobFactory->loadFromExistingJobData($jobData);
+        }, $result);
     }
 
     /**
@@ -364,7 +369,9 @@ public function getJobsDurationSum(string $projectId): int
 
         $request = new Request('GET', 'stats/projects/' . $projectId);
         $response = $this->sendRequest($request);
-        return $response['stats']['durationSum'];
+        assert(isset($response['stats']) && is_array($response['stats']));
+        assert(is_scalar($response['stats']['durationSum']));
+        return (int) $response['stats']['durationSum'];
     }
 
     /**
@@ -503,18 +510,19 @@ function (array $group): array {
     /** @return TJob[] */
     private function mapJobsFromSearchResponse(array $responseBody): array
     {
-        return array_map(
-            fn(array $jobData) => $this->existingJobFactory->loadFromElasticJobData($jobData),
-            $responseBody,
-        );
+        return array_map(function ($jobData) {
+            assert(is_array($jobData));
+            return $this->existingJobFactory->loadFromElasticJobData($jobData);
+        }, $responseBody);
     }
 
     /**
      * @return array<TJob>
      */
     private function mapJobsFromResponse(array $responseBody): array
     {
-        $jobs = array_map(function (array $jobData) {
+        $jobs = array_map(function ($jobData) {
+            assert(is_array($jobData));
             try {
                 return $this->existingJobFactory->loadFromExistingJobData($jobData);
             } catch (Throwable $e) {
@@ -573,10 +581,12 @@ private function initClient(
             $handlerStack = HandlerStack::create();
         }
         // Set exponential backoff
+        assert(is_int($options['backoffMaxTries']));
         $handlerStack->push(Middleware::retry($this->createDefaultDecider($options['backoffMaxTries'])));
         // Set handler to set default headers
         $handlerStack->push(Middleware::mapRequest(
             function (RequestInterface $request) use ($internalToken, $storageToken, $applicationToken, $options) {
+                assert(is_string($options['userAgent']));
                 $request = $request->withHeader('User-Agent', $options['userAgent'])
                         ->withHeader('Content-type', 'application/json');
                 if ($internalToken !== null) {
@@ -641,7 +651,7 @@ private function decodeRequestBody(ResponseInterface $response): array
 
     private function throwExceptionByStringCode(array $body, Throwable $previous): void
     {
-        if (empty($body['context']['stringCode'])) {
+        if (!isset($body['context']) || !is_array($body['context']) || empty($body['context']['stringCode'])) {
             return;
         }
 

src/Client.php

@@ -25,14 +25,14 @@ public function __construct(
     public function loadFromExistingJobData(array $data): JobInterface
     {
         $data = $this->validateJobData($data, FullJobDefinition::class);
-
+        // @phpstan-ignore-next-line
         return new Job($this->objectEncryptor, $this->storageClientFactory, $data);
     }
 
     public function loadFromElasticJobData(array $data): JobInterface
     {
         $data = $this->validateJobData($data, ElasticJobDefinition::class);
-
+        assert(isset($data['id']) && isset($data['mode']) && isset($data['isFinished']));
         return new Job($this->objectEncryptor, $this->storageClientFactory, $data);
     }
 }

src/ExistingJobFactory.php

@@ -17,12 +17,14 @@ class ExistingPlainJobFactory extends JobFactory implements ExistingJobFactoryIn
     public function loadFromExistingJobData(array $data): PlainJobInterface
     {
         $data = $this->validateJobData($data, FullJobDefinition::class);
+        assert(isset($data['id']) && isset($data['mode']) && isset($data['isFinished']));
         return new PlainJob($data);
     }
 
     public function loadFromElasticJobData(array $data): PlainJobInterface
     {
         $data = $this->validateJobData($data, ElasticJobDefinition::class);
+        assert(isset($data['id']) && isset($data['mode']) && isset($data['isFinished']));
         return new PlainJob($data);
     }
 }