Merge pull request #136 from City-of-Helsinki/UHF-9034

UHF-9034: Proper internal address support
City-of-Helsinki · Oct 5, 2023 · 8f39f1d · 8f39f1d
2 parents d304750 + 150ee01
commit 8f39f1d
Show file tree

Hide file tree

Showing 15 changed files with 663 additions and 170 deletions.
diff --git a/fixtures/environments.json b/fixtures/environments.json
diff --git a/helfi_api_base.services.yml b/helfi_api_base.services.yml
@@ -127,6 +127,7 @@ services:
     class: Drupal\helfi_api_base\EventSubscriber\CacheTagInvalidatorSubscriber
     arguments:
       - '@cache_tags.invalidator'
+      - '@helfi_api_base.environment_resolver'
     tags:
       - { name: event_subscriber }
 

diff --git a/phpunit.xml b/phpunit.xml
@@ -4,7 +4,7 @@
   colors="true"
   cacheResultFile=".phpunit.cache/test-results"
   executionOrder="depends,defects"
-  forceCoversAnnotation="true"
+  forceCoversAnnotation="false"
   beStrictAboutTestsThatDoNotTestAnything="true"
   beStrictAboutOutputDuringTests="true"
   beStrictAboutChangesToGlobalState="true"

diff --git a/src/Cache/CacheTagInvalidator.php b/src/Cache/CacheTagInvalidator.php
@@ -28,14 +28,17 @@ public function __construct(
    *
    * @param array $tags
    *   An array of cache tags.
+   * @param array $instances
+   *   The instances to flush caches from.
    *
    * @return $this
    *   The self.
    */
-  public function invalidateTags(array $tags) : self {
+  public function invalidateTags(array $tags, array $instances = []) : self {
     try {
       $this->pubSubManager->sendMessage([
         'tags' => $tags,
+        'instances' => $instances,
       ]);
     }
     catch (ConnectionException) {

diff --git a/src/Environment/Address.php b/src/Environment/Address.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\helfi_api_base\Environment;
+
+/**
+ * A value object to store address information.
+ */
+final class Address {
+
+  /**
+   * Constructs a new instance.
+   *
+   * @param string $domain
+   *   The domain.
+   * @param string $protocol
+   *   The protocol.
+   * @param int $port
+   *   The port.
+   */
+  public function __construct(
+    public readonly string $domain,
+    public readonly string $protocol = 'https',
+    public readonly int $port = 443,
+  ) {
+  }
+
+  /**
+   * Gets the address.
+   *
+   * @return string
+   *   The address.
+   */
+  public function getAddress() : string {
+    $port = '';
+    if (!in_array($this->port, [80, 443])) {
+      $port = sprintf(':%d', $this->port);
+    }
+    return sprintf('%s://%s%s', $this->protocol, $this->domain, $port);
+  }
+
+}
diff --git a/src/Environment/Environment.php b/src/Environment/Environment.php
@@ -12,12 +12,12 @@ final class Environment {
   /**
    * Constructs a new instance.
    *
-   * @param string $domain
-   *   The domain.
+   * @param \Drupal\helfi_api_base\Environment\Address $address
+   *   The address.
+   * @param \Drupal\helfi_api_base\Environment\Address $internalAddress
+   *   The internal address.
    * @param array $paths
    *   The paths.
-   * @param string $protocol
-   *   The protocol.
    * @param string $id
    *   Environment resolver identifier for the project.
    * @param \Drupal\helfi_api_base\Environment\EnvironmentEnum $environment
@@ -26,9 +26,9 @@ final class Environment {
    *   The environment specific metadata.
    */
   public function __construct(
-    private readonly string $domain,
+    private readonly Address $address,
+    private readonly Address $internalAddress,
     private readonly array $paths,
-    private readonly string $protocol,
     private readonly string $id,
     private readonly EnvironmentEnum $environment,
     private readonly ?EnvironmentMetadata $metadata,
@@ -45,42 +45,6 @@ public function getId() : string {
     return $this->id;
   }
 
-  /**
-   * Gets the domain.
-   *
-   * @return string
-   *   The domain.
-   */
-  public function getDomain() : string {
-    return $this->domain;
-  }
-
-  /**
-   * Gets the protocol.
-   *
-   * @return string
-   *   The protocol.
-   */
-  public function getProtocol() : string {
-    return $this->protocol;
-  }
-
-  /**
-   * Gets the original URL for given language.
-   *
-   * @param string $language
-   *   The language.
-   *
-   * @return string
-   *   The URL.
-   */
-  private function doGetUrl(string $language) : string {
-    return vsprintf('%s/%s', [
-      $this->getBaseUrl(),
-      ltrim($this->getPath($language), '/'),
-    ]);
-  }
-
   /**
    * Gets the full URL for given language.
    *
@@ -91,11 +55,7 @@ private function doGetUrl(string $language) : string {
    *   The URL.
    */
   public function getUrl(string $language) : string {
-    $url = $this->doGetUrl($language);
-    // Local uses an internal address by default to allow containers to
-    // communicate via API requests. Convert URL back to a proper link that
-    // works with browsers.
-    return str_replace(['http://', ':8080'], ['https://', ''], $url);
+    return sprintf('%s/%s', $this->address->getAddress(), ltrim($this->getPath($language), '/'));
   }
 
   /**
@@ -108,7 +68,7 @@ public function getUrl(string $language) : string {
    *   The canonical URL.
    */
   public function getInternalAddress(string $language) : string {
-    return $this->doGetUrl($language);
+    return sprintf('%s/%s', $this->internalAddress->getAddress(), ltrim($this->getPath($language), '/'));
   }
 
   /**
@@ -118,10 +78,17 @@ public function getInternalAddress(string $language) : string {
    *   The base url.
    */
   public function getBaseUrl() : string {
-    return vsprintf('%s://%s', [
-      $this->getProtocol(),
-      $this->getDomain(),
-    ]);
+    return $this->address->getAddress();
+  }
+
+  /**
+   * Gets the internal base url.
+   *
+   * @return string
+   *   The base url.
+   */
+  public function getInternalBaseUrl() : string {
+    return $this->internalAddress->getAddress();
   }
 
   /**

diff --git a/src/Environment/EnvironmentResolver.php b/src/Environment/EnvironmentResolver.php
@@ -89,13 +89,14 @@ private function populateEnvironments(string $pathOrJson) : void {
       $project = new Project($id, ProjectMetadata::createFromArray($meta));
 
       foreach ($environments as $environment => $settings) {
-        if (!isset($settings['domain'], $settings['path'])) {
-          throw new \InvalidArgumentException('Project missing domain or paths setting.');
+        if (!isset($settings['address'], $settings['internal_address'], $settings['path'])) {
+          throw new \InvalidArgumentException('Project missing "address", "internal_address" or "paths" setting.');
         }
+
         $project->addEnvironment($environment, new Environment(
-          $settings['domain'],
+          new Address(...$settings['address']),
+          new Address(...$settings['internal_address']),
           $settings['path'],
-          $settings['protocol'] ?? 'https',
           $id,
           EnvironmentEnum::tryFrom($environment),
           EnvironmentMetadata::createFromArray($settings['meta'] ?? [])

diff --git a/src/EventSubscriber/CacheTagInvalidatorSubscriber.php b/src/EventSubscriber/CacheTagInvalidatorSubscriber.php
@@ -6,6 +6,7 @@
 
 use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
 use Drupal\helfi_api_base\Azure\PubSub\PubSubMessage;
+use Drupal\helfi_api_base\Environment\EnvironmentResolverInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
@@ -18,12 +19,39 @@ final class CacheTagInvalidatorSubscriber implements EventSubscriberInterface {
    *
    * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cacheTagsInvalidator
    *   The cache tag invalidator subscriber.
+   * @param \Drupal\helfi_api_base\Environment\EnvironmentResolverInterface $environmentResolver
+   *   The environment resolver.
    */
   public function __construct(
     private readonly CacheTagsInvalidatorInterface $cacheTagsInvalidator,
+    private readonly EnvironmentResolverInterface $environmentResolver,
   ) {
   }
 
+  /**
+   * Checks if the given instance is valid.
+   *
+   * @param array $instances
+   *   The instances.
+   *
+   * @return bool
+   *   TRUE if valid instance.
+   */
+  private function isValidInstance(array $instances = []) : bool {
+    if (!$instances) {
+      return TRUE;
+    }
+
+    try {
+      $project = $this->environmentResolver->getActiveProject();
+
+      return in_array($project->getName(), $instances);
+    }
+    catch (\InvalidArgumentException) {
+    }
+    return TRUE;
+  }
+
   /**
    * Responds to PubSub message events.
    *
@@ -34,6 +62,11 @@ public function onReceive(PubSubMessage $message) : void {
     if (!isset($message->data['data']['tags'])) {
       return;
     }
+    $instances = $message->data['data']['instances'] ?? [];
+
+    if (!$this->isValidInstance($instances)) {
+      return;
+    }
     $this->cacheTagsInvalidator->invalidateTags($message->data['data']['tags']);
     // Cache invalidator service keeps already invalidated cache tags in a
     // static cache and prevents the invalidation of the same tag multiple

diff --git a/tests/fixtures/environments.json b/tests/fixtures/environments.json
@@ -11,16 +11,30 @@
           "sv": "/sv/boende",
           "en": "/en/housing"
         },
-        "protocol": "http",
-        "domain": "helfi-asuminen.docker.so:8080"
+        "address": {
+          "protocol": "https",
+          "domain": "helfi-asuminen.docker.so"
+        },
+        "internal_address": {
+          "protocol": "http",
+          "domain": "helfi-asuminen.docker.so",
+          "port": 8080
+        }
       },
       "prod": {
         "path": {
           "fi": "/fi/asuminen",
           "sv": "/sv/boende",
           "en": "/en/housing"
         },
-        "domain": "www.hel.fi",
+        "address": {
+          "protocol": "https",
+          "domain": "www.hel.fi"
+        },
+        "internal_address": {
+          "protocol": "https",
+          "domain": "nginx-asuminen-prod.apps.platta.hel.fi"
+        },
         "meta": {}
       },
       "stage": {
@@ -29,7 +43,14 @@
           "sv": "/sv/staging-boende",
           "en": "/en/staging-housing"
         },
-        "domain": "www.hel.fi",
+        "address": {
+          "protocol": "https",
+          "domain": "www.hel.fi"
+        },
+        "internal_address": {
+          "protocol": "https",
+          "domain": "nginx-asuminen-staging.apps.platta.hel.fi"
+        },
         "meta": {
           "openshift_console_link": "https://example.com"
         }
@@ -40,7 +61,14 @@
           "sv": "/sv/test-boende",
           "en": "/en/test-housing"
         },
-        "domain": "helfi-asuminen-test.docker.so",
+        "address": {
+          "protocol": "https",
+          "domain": "www.hel.fi"
+        },
+        "internal_address": {
+          "protocol": "https",
+          "domain": "nginx-asuminen-test.apps.arodevtest.hel.fi"
+        },
         "meta": {
           "openshift_console_link": "https://example.com"
         }