Merge pull request #2 from keboola/odin-PS-1306

feat: add client factory

Author: odinuv

README.md

@@ -33,6 +33,15 @@ $client->postEvent(
 );
 ```
 
+or use a factory to create the client
+
+```php
+use Keboola\NotificationClient\ClientFactory;
+
+$clientFactory = new ClientFactory('https://connection.keboola.com');
+$clientFactory->getEventsClient('xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+```
+
 ## Development
 - Create an Azure service principal to download the required images and login:
 
@@ -58,7 +67,7 @@ $client->postEvent(
     ```
 
 - Set the following environment variables in `set-env.sh` file (use `set-env.template.sh` as sample):
-    - `STORAGE_API_URL` - Keboola Connection URL.
+    - `STORAGE_API_URL` - Keboola Connection URL to arbitrary stack where the notification service is registered.
     - `TEST_STORAGE_API_TOKEN` - Token to a test project.
     - `TEST_MANAGE_API_APPLICATION_TOKEN` - Application token with scope `notifications:push-event`.
 

azure-pipelines.yml

@@ -70,6 +70,8 @@ stages:
               TEST_STORAGE_API_TOKEN: $(TEST_STORAGE_API_TOKEN)
               TEST_MANAGE_API_APPLICATION_TOKEN: $(TEST_MANAGE_API_APPLICATION_TOKEN)
               TEST_NOTIFICATION_API_URL: http://$(NOTIFICATION_API_IP):8181
+              STORAGE_API_URL: $(STORAGE_API_URL)
+              TEST_STORAGE_API_PROJECT_ID: $(TEST_STORAGE_API_PROJECT_ID)
 
           - task: PublishTestResults@2
             displayName: 'Publish Test results'

docker-compose.yml

@@ -10,6 +10,8 @@ services:
       TEST_NOTIFICATION_API_URL:
       TEST_STORAGE_API_TOKEN:
       TEST_MANAGE_API_APPLICATION_TOKEN:
+      STORAGE_API_URL:
+      TEST_STORAGE_API_PROJECT_ID:
     command: ['composer', 'ci']
 
   tests-local:

provisioning/environments.yaml.template

@@ -23,11 +23,15 @@ metadata:
   name: dev-notification-environments
   namespace: dev-notification-client
 data:
+  appEnv: 'dev'
+  keboolaStack: 'local'
   awsAccessKeyId: '$TEST_AWS_ACCESS_KEY_ID'
   awsLogsS3Bucket: '$AWS_LOGS_S3_BUCKET'
   awsRegion: '$AWS_REGION'
   azureLogsAbsContainer: '$AZURE_LOGS_ABS_CONTAINER'
   azureClientId: '$TEST_AZURE_CLIENT_ID'
   azureTenantId: '$TEST_AZURE_TENANT_ID'
   storageApiUrl: '$STORAGE_API_URL'
-  mailerUrl: 'null://null'
+  databaseSslVerifyEnabled: '0'
+  messengerTransportDsn: 'doctrine://default'
+  mailerDsn: 'null://null'

provisioning/notification.yaml

@@ -72,13 +72,24 @@ spec:
               cpu: "250m"
               memory: "256Mi"
           ports:
-            - containerPort: 80
+            - containerPort: 8080
           command:
             - "/bin/sh"
           args:
             - "-c"
             - 'php bin/console doctrine:migrations:migrate --no-interaction && apache2-foreground'
           env:
+            - name: APP_ENV
+              valueFrom:
+                configMapKeyRef:
+                  name: dev-notification-environments
+                  key: appEnv
+            - name: KEBOOLA_STACK
+              valueFrom:
+                configMapKeyRef:
+                  name: dev-notification-environments
+                  key: keboolaStack
+
             - name: AWS_LOGS_S3_BUCKET
               valueFrom:
                 configMapKeyRef:
@@ -137,34 +148,37 @@ spec:
                 secretKeyRef:
                   name: dev-notification-environments
                   key: databaseUrl
+            - name: DATABASE_SSL_VERIFY_ENABLED
+              valueFrom:
+                configMapKeyRef:
+                  name: dev-notification-environments
+                  key: databaseSslVerifyEnabled
+            - name: MESSENGER_TRANSPORT_DSN
+              valueFrom:
+                configMapKeyRef:
+                  name: dev-notification-environments
+                  key: messengerTransportDsn
             - name: MAILER_DSN
               valueFrom:
                 configMapKeyRef:
                   name: dev-notification-environments
-                  key: mailerUrl
+                  key: mailerDsn
+
 
           readinessProbe:
-            httpGet:
-              path: /health-check
-              port: 80
-              httpHeaders:
-                - name: Host
-                  value: KubernetesReadinessProbe
-            initialDelaySeconds: 60
-            periodSeconds: 30
-            successThreshold: 1
-            failureThreshold: 3
-          livenessProbe:
-            httpGet:
-              port: 80
-              path: /health-check
-              httpHeaders:
-                - name: Host
-                  value: KubernetesLivelinessProbe
-            initialDelaySeconds: 60
-            periodSeconds: 100
-            successThreshold: 1
-            failureThreshold:
+            tcpSocket:
+              port: 8080
+            initialDelaySeconds: 15
+            periodSeconds: 20
+            # until https://keboola.atlassian.net/browse/PS-2344 is fixed
+#            httpGet:
+#              path: /health-check
+#              port: 8080
+#              httpHeaders:
+#                - name: Host
+#                  value: KubernetesReadinessProbe
+#            initialDelaySeconds: 60
+#            periodSeconds: 30
 ---
 kind: Service
 apiVersion: v1
@@ -177,7 +191,7 @@ spec:
     app: dev-notification-api
   ports:
     - port: 8181
-      targetPort: 80
+      targetPort: 8080
       protocol: TCP
       name: http
 ---

src/Client.php

@@ -17,7 +17,6 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Constraints\Range;
 use Symfony\Component\Validator\Constraints\Url;
 use Symfony\Component\Validator\ConstraintViolationInterface;
@@ -32,15 +31,12 @@ abstract class Client
     protected GuzzleClient $guzzle;
 
     public function __construct(
-        string $notificationApiUrl,
-        string $token,
+        string $baseUrl,
+        ?string $token,
         array $options = []
     ) {
         $validator = Validation::createValidator();
-        $errors = $validator->validate($notificationApiUrl, [new Url()]);
-        $errors->addAll(
-            $validator->validate($token, [new NotBlank()])
-        );
+        $errors = $validator->validate($baseUrl, [new Url()]);
         if (!empty($options['backoffMaxTries'])) {
             $errors->addAll($validator->validate($options['backoffMaxTries'], [new Range(['min' => 0, 'max' => 100])]));
             $options['backoffMaxTries'] = intval($options['backoffMaxTries']);
@@ -58,7 +54,7 @@ public function __construct(
             }
             throw new NotificationClientException('Invalid parameters when creating client: ' . $messages);
         }
-        $this->guzzle = $this->initClient($notificationApiUrl, $token, $options);
+        $this->guzzle = $this->initClient($baseUrl, $token, $options);
     }
 
     private function createDefaultDecider(int $maxRetries): Closure
@@ -79,9 +75,9 @@ private function createDefaultDecider(int $maxRetries): Closure
         };
     }
 
-    abstract protected function getTokenHeaderName(): string;
+    abstract protected function getTokenHeaderName(): ?string;
 
-    private function initClient(string $url, string $token, array $options = []): GuzzleClient
+    private function initClient(string $url, ?string $token, array $options = []): GuzzleClient
     {
         // Initialize handlers (start with those supplied in constructor)
         $handlerStack = HandlerStack::create($options['handler'] ?? null);
@@ -90,10 +86,13 @@ private function initClient(string $url, string $token, array $options = []): Gu
         // Set handler to set default headers
         $handlerStack->push(Middleware::mapRequest(
             function (RequestInterface $request) use ($token, $options) {
-                return $request
+                $request = $request
                     ->withHeader('User-Agent', $options['userAgent'])
-                    ->withHeader($this->getTokenHeaderName(), $token)
                     ->withHeader('Content-type', 'application/json');
+                if ($this->getTokenHeaderName()) {
+                    $request = $request->withHeader((string) $this->getTokenHeaderName(), (string) $token);
+                }
+                return $request;
             }
         ));
         // Set client logger

src/ClientFactory.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient;
+
+use Keboola\NotificationClient\Requests\PostEvent\FailedJobEventData;
+
+class ClientFactory
+{
+    private const NOTIFICATION_SERVICE_NAME = 'notification';
+    private ?string $notificationUrl;
+    private string $connectionUrl;
+    private array $connectionClientOptions;
+
+    public function __construct(string $connectionUrl, array $connectionClientOptions = [])
+    {
+        $this->connectionUrl = $connectionUrl;
+        $this->connectionClientOptions = $connectionClientOptions;
+        $this->notificationUrl = null;
+    }
+
+    private function getNotificationUrl(): string
+    {
+        if ($this->notificationUrl === null) {
+            $storageApiIndexClient = new StorageApiIndexClient($this->connectionUrl, $this->connectionClientOptions);
+            $this->notificationUrl = $storageApiIndexClient->getServiceUrl(self::NOTIFICATION_SERVICE_NAME);
+        }
+        return (string) $this->notificationUrl;
+    }
+
+    public function getEventsClient(string $applicationToken, array $options = []): EventsClient
+    {
+        return new EventsClient($this->getNotificationUrl(), $applicationToken, $options);
+    }
+
+    public function getSubscriptionClient(string $storageApiToken, array $options = []): SubscriptionClient
+    {
+        return new SubscriptionClient($this->getNotificationUrl(), $storageApiToken, $options);
+    }
+}

src/EventsClient.php

@@ -8,7 +8,6 @@
 use JsonException;
 use Keboola\NotificationClient\Exception\ClientException;
 use Keboola\NotificationClient\Requests\Event;
-use Psr\Log\LoggerInterface;
 
 class EventsClient extends Client
 {
@@ -22,6 +21,12 @@ public function __construct(
         string $applicationToken,
         array $options = []
     ) {
+        if (empty($applicationToken)) {
+            throw new ClientException(sprintf(
+                'Application token must be non-empty, %s provided.',
+                json_encode($applicationToken)
+            ));
+        }
         parent::__construct($notificationApiUrl, $applicationToken, $options);
     }
 

src/Requests/Event.php

@@ -11,9 +11,9 @@ class Event implements JsonSerializable
     private JsonSerializable $eventData;
     private string $eventType;
 
-    public function __construct(string $eventType, JsonSerializable $eventData)
+    public function __construct(EventDataInterface $eventData)
     {
-        $this->eventType = $eventType;
+        $this->eventType = $eventData::getEventTypeName();
         $this->eventData = $eventData;
     }
 

src/Requests/EventDataInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient\Requests;
+
+use JsonSerializable;
+
+interface EventDataInterface extends JsonSerializable
+{
+    public static function getEventTypeName(): string;
+}