Refactor URL revalidator method in NextSite entity.

Author: minnur

modules/next/src/Entity/NextSite.php

@@ -265,22 +265,15 @@ public function getLiveUrlForEntity(EntityInterface $entity): ?Url {
   /**
    * {@inheritdoc}
    */
-  public function getRevalidateUrlForPath(string $path): ?Url {
+  public function buildRevalidateUrl(array $query = []): ?Url {
     $revalidate_url = $this->getRevalidateUrl();
-
     if (!$revalidate_url) {
       return NULL;
     }
-
-    $query = [
-      'path' => $path,
-    ];
-
     if ($secret = $this->getRevalidateSecret()) {
       $query['secret'] = $secret;
     }
-
-    return Url::fromUri($this->getRevalidateUrl(), [
+    return Url::fromUri($revalidate_url, [
       'query' => $query,
     ]);
   }

modules/next/src/Entity/NextSiteInterface.php

@@ -131,12 +131,12 @@ public function setRevalidateSecret(string $revalidate_secret): self;
   /**
    * Returns the revalidate url for given path.
    *
-   * @param string $path
-   *   The path.
+   * @param array $query
+   *   The revalidate URL query parameters.
    *
    * @return \Drupal\Core\Url|null
    *   The revalidate url.
    */
-  public function getRevalidateUrlForPath(string $path): ?Url;
+  public function buildRevalidateUrl(array $query = []): ?Url;
 
 }

modules/next/src/Plugin/Next/Revalidator/CacheTag.php

@@ -4,9 +4,7 @@
 
 use Drupal\Core\Entity\FieldableEntityInterface;
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Url;
 use Drupal\Core\Utility\Error;
-use Drupal\next\Entity\NextSite;
 use Drupal\next\Event\EntityActionEvent;
 use Drupal\next\Plugin\ConfigurableRevalidatorBase;
 use Drupal\next\Plugin\RevalidatorInterface;
@@ -72,7 +70,7 @@ public function revalidate(EntityActionEvent $event): bool {
     foreach ($sites as $site) {
       try {
         $tags_string = implode(',', $tags);
-        $revalidate_url = $this->getRevalidateUrlForTags($site, $tags_string);
+        $revalidate_url = $site->buildRevalidateUrl(['tags' => $tags_string]);
 
         if (!$revalidate_url) {
           throw new \Exception('No revalidate url set.');
@@ -110,30 +108,4 @@ public function revalidate(EntityActionEvent $event): bool {
     return $revalidated;
   }
 
-  /**
-   * Returns the revalidate url for given cache tags.
-   *
-   * @param NextSite $site
-   * @param string $cache_tags
-   *   The cache tags as string.
-   *
-   * @return \Drupal\Core\Url|null
-   *   The revalidate url.
-   */
-  protected function getRevalidateUrlForTags(NextSite $site, string $cache_tags): ?Url {
-    $revalidate_url = $site->getRevalidateUrl();
-    if (!$revalidate_url) {
-      return NULL;
-    }
-    $query = [
-      'tags' => $cache_tags,
-    ];
-    if ($secret = $site->getRevalidateSecret()) {
-      $query['secret'] = $secret;
-    }
-    return Url::fromUri($site->getRevalidateUrl(), [
-      'query' => $query,
-    ]);
-  }
-
 }

modules/next/src/Plugin/Next/Revalidator/Path.php

@@ -84,9 +84,10 @@ public function revalidate(EntityActionEvent $event): bool {
     }
 
     foreach ($paths as $path) {
+      /** @var \Drupal\next\Entity\NextSite $site */
       foreach ($sites as $site) {
         try {
-          $revalidate_url = $site->getRevalidateUrlForPath($path);
+          $revalidate_url = $site->buildRevalidateUrl(['path' => $path]);
 
           if (!$revalidate_url) {
             throw new \Exception('No revalidate url set.');

modules/next/tests/src/Kernel/Entity/NextSiteTest.php

@@ -117,7 +117,7 @@ public function test() {
   }
 
   /**
-   * @covers ::getRevalidateUrlForPath
+   * @covers ::buildRevalidateUrl
    */
   public function testGetRevalidateUrlForPath() {
     $marketing = NextSite::create([
@@ -129,13 +129,13 @@ public function testGetRevalidateUrlForPath() {
     ]);
     $marketing->save();
 
-    $this->assertNull($marketing->getRevalidateUrlForPath('/foo'));
+    $this->assertNull($marketing->buildRevalidateUrl(['path' => '/foo']));
 
     $marketing->setRevalidateUrl('http://example.com/api/revalidate');
-    $this->assertSame('http://example.com/api/revalidate?path=/foo', $marketing->getRevalidateUrlForPath('/foo')->toString());
+    $this->assertSame('http://example.com/api/revalidate?path=/foo', $marketing->buildRevalidateUrl(['path' => '/foo'])->toString());
 
     $marketing->setRevalidateSecret('12345');
-    $this->assertSame('http://example.com/api/revalidate?path=/foo&secret=12345', $marketing->getRevalidateUrlForPath('/foo')->toString());
+    $this->assertSame('http://example.com/api/revalidate?path=/foo&secret=12345', $marketing->buildRevalidateUrl(['path' => '/foo'])->toString());
   }
 
 }