Merge pull request #14 from craftcms/feature/cld-369-add-static-cache…

…-clearing-utility Cache purge tag by host
craftcms · Nov 17, 2023 · c97cd71 · c97cd71
2 parents 69e0098 + 21e1408
commit c97cd71
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/src/HeaderEnum.php b/src/HeaderEnum.php
@@ -5,7 +5,6 @@
 enum HeaderEnum: string
 {
     case CACHE_TAG = 'Cache-Tag';
-    case CACHE_PURGE_TAG = 'Cache-Purge-Tag';
-    case CACHE_PURGE_HOST = 'Cache-Purge-Host';
+    case CACHE_PURGE = 'Cache-Purge';
     case CACHE_CONTROL = 'Cache-Control';
 }
diff --git a/src/StaticCaching.php b/src/StaticCaching.php
@@ -11,7 +11,6 @@
 use craft\web\UrlManager;
 use craft\web\View;
 use Illuminate\Support\Collection;
-use League\Uri\Uri;
 use samdark\log\PsrMessage;
 use yii\caching\TagDependency;
 
@@ -76,15 +75,24 @@ public function handleRegisterCacheOptions(RegisterCacheOptionsEvent $event): vo
 
     public function purgeAll(): void
     {
-        if (Craft::$app->getRequest()->isConsoleRequest) {
-            $url = Uri::new(UrlHelper::baseSiteUrl());
+        if (Craft::$app->getRequest()->getIsConsoleRequest()) {
+            // TODO: should this hit a ping/healthcheck controller instead?
+            $url = UrlHelper::baseSiteUrl();
+
+            if (str_starts_with($url, '@web')) {
+                $message = implode(PHP_EOL, [
+                    'Unable to clear static caches because the web host isn\'t known for console commands.',
+                    'Explicitly set the @web alias in config/general.php to avoid this error.',
+                    'See https://craftcms.com/docs/4.x/config/#aliases for more info.',
+                ]);
 
-            // TODO: warn about @web not being defined for CLI
+                throw new \yii\console\Exception($message);
+            }
 
             Craft::createGuzzleClient()
                 ->request('HEAD', (string) $url, [
                     'headers' => [
-                        HeaderEnum::CACHE_PURGE_HOST->value => '*',
+                        HeaderEnum::CACHE_PURGE->value => '*',
                     ],
                 ]);
 
@@ -93,7 +101,7 @@ public function purgeAll(): void
 
 
         Craft::$app->getResponse()->getHeaders()->set(
-            HeaderEnum::CACHE_PURGE_HOST->value, '*',
+            HeaderEnum::CACHE_PURGE->value, '*',
         );
     }
 
@@ -195,7 +203,7 @@ protected function addCachePurgeTagsToResponse(array $tags): void
         $headers = Craft::$app->getResponse()->getHeaders();
 
         $tagsForHeader->each(fn(string $tag) => $headers->add(
-            HeaderEnum::CACHE_PURGE_TAG->value,
+            HeaderEnum::CACHE_PURGE->value,
             $tag,
         ));
     }

diff --git a/src/web/ResponseBehavior.php b/src/web/ResponseBehavior.php
@@ -23,7 +23,7 @@ public function init(): void
     {
         $this->csvHeaders = [
             HeaderEnum::CACHE_TAG->value,
-            HeaderEnum::CACHE_PURGE_TAG->value,
+            HeaderEnum::CACHE_PURGE->value,
         ];
     }