feat: Add Support for App Router Invalidation by Tag in Drupal Module (#812)

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

@@ -0,0 +1,111 @@
+<?php
+
+namespace Drupal\next\Plugin\Next\Revalidator;
+
+use Drupal\Core\Entity\FieldableEntityInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Utility\Error;
+use Drupal\next\Event\EntityActionEvent;
+use Drupal\next\Plugin\ConfigurableRevalidatorBase;
+use Drupal\next\Plugin\RevalidatorInterface;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Provides a revalidator for revalidating Next Site references by cache tags.
+ *
+ * @Revalidator(
+ *  id = "cache_tag",
+ *  label = "Cache Tag",
+ *  description = "Cache tag based on-demand revalidation."
+ * )
+ */
+class CacheTag extends ConfigurableRevalidatorBase implements RevalidatorInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+    // No configuration form.
+  }
+
+  /**
+   * {@inheritdoc}
+   * @throws \Drupal\Core\Entity\EntityMalformedException
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  public function revalidate(EntityActionEvent $event): bool {
+    $revalidated = FALSE;
+    $entity = $event->getEntity();
+    $sites = $event->getSites();
+
+    if (!($entity instanceof FieldableEntityInterface)) {
+      return FALSE;
+    }
+
+    $tags = [];
+    $tags[] = $entity->getEntityTypeId() . ':' . $entity->id();
+    if ($entity->getEntityTypeId() == 'menu_link_content') {
+      $tags[] = $entity->getEntityTypeId() . ':' . $entity->getMenuName();
+    }
+    else {
+      $tags[] = $entity->getEntityTypeId() . '_list';
+      $tags[] = $entity->getEntityTypeId() . '_list:' . $entity->bundle();
+    }
+
+    /** @var \Drupal\next\Entity\NextSite $site */
+    foreach ($sites as $site) {
+      try {
+        $tags_string = implode(',', $tags);
+        $revalidate_url = $site->buildRevalidateUrl(['tags' => $tags_string]);
+
+        if (!$revalidate_url) {
+          throw new \Exception('No revalidate url set.');
+        }
+
+        if ($this->nextSettingsManager->isDebug()) {
+          $this->logger->notice('(@action): Revalidating tags %tags for the site %site. URL: %url', [
+            '@action' => $event->getAction(),
+            '%tags' => $tags_string,
+            '%site' => $site->label(),
+            '%url' => $revalidate_url->toString(),
+          ]);
+        }
+
+        $response = $this->httpClient->request('GET', $revalidate_url->toString());
+        if ($response && $response->getStatusCode() === Response::HTTP_OK) {
+          if ($this->nextSettingsManager->isDebug()) {
+            $this->logger->notice('(@action): Successfully revalidated tags %path for the site %site. URL: %url', [
+              '@action' => $event->getAction(),
+              '%tags' => $tags_string,
+              '%site' => $site->label(),
+              '%url' => $revalidate_url->toString(),
+            ]);
+          }
+
+          $revalidated = TRUE;
+        }
+      }
+      catch (\Exception $exception) {
+        Error::logException($this->logger, $exception);
+        $revalidated = FALSE;
+      }
+    }
+
+    return $revalidated;
+  }
+
+}

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());
   }
 
 }