feat: add clear_all_on_post_update option to CDN page caching subscriber

Author: carlalexander

src/Configuration/EventManagementConfiguration.php

@@ -46,7 +46,7 @@ public function modify(Container $container)
                 // Ymir subscribers
                 new Subscriber\AdminSubscriber(),
                 new Subscriber\AssetsSubscriber($container['content_directory_name'], $container['site_url'], $container['assets_url'], $container['ymir_project_type'], $container['uploads_baseurl']),
-                new Subscriber\ContentDeliveryNetworkPageCachingSubscriber($container['cloudfront_client'], $container['rest_url'], $container['is_page_caching_disabled']),
+                new Subscriber\ContentDeliveryNetworkPageCachingSubscriber($container['cloudfront_client'], $container['rest_url'], $container['page_caching_options']),
                 new Subscriber\DisallowIndexingSubscriber($container['ymir_using_vanity_domain']),
                 new Subscriber\EmailSubscriber($container['email_client'], $container['ymir_is_email_sending_enabled'], $container['ymir_using_vanity_domain']),
                 new Subscriber\ImageEditorSubscriber($container['console_client'], $container['file_manager']),

src/Configuration/PageCacheConfiguration.php

@@ -30,7 +30,7 @@ public function modify(Container $container)
         $container['cloudfront_client'] = $container->service(function (Container $container) {
             return new CloudFrontClient($container['ymir_http_client'], getenv('YMIR_DISTRIBUTION_ID'), $container['cloud_provider_key'], $container['cloud_provider_secret']);
         });
-        $container['is_page_caching_disabled'] = $container->service(function (Container $container) {
+        $container['page_caching_invalidation_disabled'] = $container->service(function (Container $container) {
             if (false !== getenv('YMIR_DISABLE_PAGE_CACHING')) {
                 return (bool) getenv('YMIR_DISABLE_PAGE_CACHING');
             } elseif (defined('YMIR_DISABLE_PAGE_CACHING')) {
@@ -39,5 +39,20 @@ public function modify(Container $container)
 
             return parse_url($container['upload_url'], PHP_URL_HOST) !== parse_url(WP_HOME, PHP_URL_HOST);
         });
+        $container['page_caching_clear_all_on_post_update'] = $container->service(function () {
+            if (false !== getenv('YMIR_CLEAR_ALL_ON_POST_UPDATE')) {
+                return (bool) getenv('YMIR_CLEAR_ALL_ON_POST_UPDATE');
+            } elseif (defined('YMIR_CLEAR_ALL_ON_POST_UPDATE')) {
+                return (bool) YMIR_CLEAR_ALL_ON_POST_UPDATE;
+            }
+
+            return false;
+        });
+        $container['page_caching_options'] = $container->service(function (Container $container) {
+            return [
+                'invalidation_enabled' => !$container['page_caching_invalidation_disabled'],
+                'clear_all_on_post_update' => $container['page_caching_clear_all_on_post_update'],
+            ];
+        });
     }
 }

src/Subscriber/ContentDeliveryNetworkPageCachingSubscriber.php

@@ -32,9 +32,9 @@ class ContentDeliveryNetworkPageCachingSubscriber extends AbstractEventManagerAw
     /**
      * Flag whether page caching is disabled or not.
      *
-     * @var bool
+     * @var array
      */
-    private $pageCachingDisabled;
+    private $pageCachingOptions;
 
     /**
      * Base URL for the WordPress REST API endpoints.
@@ -46,10 +46,10 @@ class ContentDeliveryNetworkPageCachingSubscriber extends AbstractEventManagerAw
     /**
      * Constructor.
      */
-    public function __construct(ContentDeliveryNetworkPageCacheClientInterface $pageCacheClient, string $restUrl, bool $pageCachingDisabled = false)
+    public function __construct(ContentDeliveryNetworkPageCacheClientInterface $pageCacheClient, string $restUrl, array $pageCachingOptions = [])
     {
         $this->pageCacheClient = $pageCacheClient;
-        $this->pageCachingDisabled = $pageCachingDisabled;
+        $this->pageCachingOptions = $pageCachingOptions;
         $this->restBaseUrl = rtrim($restUrl, '/').'/wp/v2';
     }
 
@@ -87,28 +87,64 @@ public function clearCache()
      */
     public function clearPost($postId)
     {
-        if ($this->pageCachingDisabled) {
+        if (empty($this->pageCachingOptions['invalidation_enabled'])) {
+            return;
+        } elseif (!empty($this->pageCachingOptions['clear_all_on_post_update'])) {
+            $this->clearCache();
+
+            return;
+        }
+
+        $urlsToClear = $this->eventManager->filter('ymir_page_caching_urls_to_clear', $this->getUrlsToClear($postId), $postId);
+
+        if (is_array($urlsToClear) || is_string($urlsToClear)) {
+            $urlsToClear = new Collection($urlsToClear);
+        } elseif (!$urlsToClear instanceof Collection) {
             return;
         }
 
+        $urlsToClear->filter(function ($url) {
+            return is_string($url) && !empty($url);
+        })->each(function (string $url) {
+            $this->pageCacheClient->clearUrl($url);
+        });
+    }
+
+    /**
+     * Send request to content delivery network to clear all requested URLs from its cache.
+     */
+    public function sendClearRequest()
+    {
+        $this->eventManager->execute('ymir_page_caching_send_clear_request');
+
+        $this->pageCacheClient->sendClearRequest();
+    }
+
+    /**
+     * Get all the URLs to clear for the given post ID.
+     */
+    private function getUrlsToClear($postId): Collection
+    {
         $permalink = get_permalink($postId);
         $post = get_post($postId);
+        $urlsToClear = new Collection();
 
         if (!$post instanceof \WP_Post
             || !is_string($permalink)
             || !in_array($post->post_status, ['publish', 'private', 'trash', 'pending', 'draft'], true)
             || in_array($post->post_type, ['nav_menu_item', 'revision'], true)
         ) {
-            return;
+            return $urlsToClear;
         }
 
         if ('trash' === $post->post_status) {
             $permalink = str_replace('__trashed', '', $permalink);
         }
 
-        $permalink = rtrim($permalink, '/').'/';
         $postType = get_post_type_object($postId);
-        $urlsToClear = new Collection([$permalink, rtrim(home_url(), '/').'/']);
+
+        $urlsToClear[] = rtrim($permalink, '/').'/';
+        $urlsToClear[] = rtrim(home_url(), '/').'/';
 
         // Custom post archive
         if ('page' === get_site_option('show_on_front') && !empty(get_site_option('page_for_posts'))) {
@@ -189,28 +225,6 @@ public function clearPost($postId)
             $urlsToClear[] = get_post_type_archive_feed_link($post->post_type);
         }
 
-        $urlsToClear = $this->eventManager->filter('ymir_page_caching_urls_to_clear', $urlsToClear);
-
-        if (is_array($urlsToClear) || is_string($urlsToClear)) {
-            $urlsToClear = new Collection($urlsToClear);
-        } elseif (!$urlsToClear instanceof Collection) {
-            return;
-        }
-
-        $urlsToClear->filter(function ($url) {
-            return is_string($url) && !empty($url);
-        })->each(function (string $url) {
-            $this->pageCacheClient->clearUrl($url);
-        });
-    }
-
-    /**
-     * Send request to content delivery network to clear all requested URLs from its cache.
-     */
-    public function sendClearRequest()
-    {
-        $this->eventManager->execute('ymir_page_caching_send_clear_request');
-
-        $this->pageCacheClient->sendClearRequest();
+        return $urlsToClear;
     }
 }