Merge branch 'release/3.5.1' into v3

CHANGELOG.md

@@ -1,5 +1,13 @@
 # SEOmatic Changelog
 
+## 3.5.1 - 2024.07.19
+### Changed
+* Renamed the **Regenerate Sitemaps Automatically** setting to **Invalidate Sitemap Caches Automatically** for clarity
+
+### Fixed
+* Fixed an issue where getting the sitemaps via GraphQL and meta container endpoint only retrieved the first page since the switch to paginated sitemaps ([#1492](https://github.com/nystudio107/craft-seomatic/issues/1492))
+* Fixed an issue where saving an entry could be slow, because SEOmatic was pointlessly trying to regenerate the sitemap cache (which is no longer a thing with paginated sitemaps) ([#1494](https://github.com/nystudio107/craft-seomatic/issues/1494))
+
 ## 3.5.0 - 2024.07.12
 ### Added
 * Remove queue generated sitemaps, switch to paginated sitemaps to allow them to be rendered at web response time, but still be managable in size

composer.json

@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-seomatic",
   "description": "SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 3. It is a turnkey SEO system that is comprehensive, powerful, and flexible.",
   "type": "craft-plugin",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "keywords": [
     "craft",
     "cms",

docs/docs/configuring/content-seo.md

@@ -52,7 +52,7 @@ Search engines no longer accept [sitemap pings](https://developers.google.com/se
 
 SEOmatic generates sitemaps on demmand when requested on the frontend, and then caches the sitemap for future requests so they are fast.
 
-Normally SEOmatic will invalidate the cache for a sitemap for a Section, Category Group, or Product any time you save an element. However,  if you prefer to regenerate the sitemap manually you can disable the **Regenerate Sitemaps Automatically** option in SEOmatic’s Plugin Settings.
+Normally SEOmatic will invalidate the cache for a sitemap for a Section, Category Group, or Product any time you save an element. However,  if you prefer to invalidate the sitemap caches manually you can disable the **Invalidate Sitemap Caches Automatically** option in SEOmatic’s Plugin Settings.
 
 ![Screenshot of a console running the following command to generate a blog sitemap: `./craft seomatic/sitemap/generate --siteId=1 --handle=blog`](../resources/screenshots/seomatic-sitemap-console-command.png)
 
@@ -81,7 +81,7 @@ You can also limit it to a specific Section, Category Group, or Product handle:
 ```
 
 ::: tip Manually Updating Sitemaps
-If you disable **Regenerate Sitemaps Automatically**, sitemaps can _only_ be updated via CLI command, or by clearing SEOmatic’s sitemap caches via **Utilities** → **Clear Caches**.
+If you disable **Invalidate Sitemap Caches Automatically**, sitemaps can _only_ be updated via CLI command, or by clearing SEOmatic’s sitemap caches via **Utilities** → **Clear Caches**.
 :::
 
 ### Additional Sitemaps

docs/docs/configuring/plugin-settings.md

@@ -9,7 +9,7 @@ Plugin Settings let you control various SEOmatic settings across all sites/langu
 * **Plugin name** – The name used for the plugin throughout the control panel.
 * **Automatic Render Enabled** – Controls whether SEOmatic automatically renders metadata on your pages. If you turn this off, you will need to manually render the metadata via `seomatic.tag.render()`, `seomatic.link.render()`, etc. Selectively disable rendering via Twig with `{% do seomatic.config.renderEnabled(false) %}`.
 * **Sitemaps Enabled** – Controls whether SEOmatic will automatically render front-end sitemaps for your site.
-* **Regenerate Sitemaps Automatically** – Controls whether sitemaps will automatically be regenerated when entries are saved.
+* **Invalidate Sitemap Caches Automatically** – Controls whether sitemap caches will automatically be invalidated when entries are saved.
 * **Include Homepage in Breadcrumbs** – Should the homepage be included in the generated Breadcrumbs JSON-LD?
 * **Manually Set SEOmatic Environment** – If off, SEOmatic will automatically attempt to determine the current environment. Turn this on to manually set the environment.
 * **Environment** – The server environment, either `live`, `staging`, or `local`. If `devMode` is on, SEOmatic will override this setting to local Development. This setting controls whether certain things render; for instance only in the `live` production environment will Google Analytics and other tracking tags send analytics data. SEOmatic also automatically sets the `robots` tag to `none` for everything but the `live` production environment.

src/gql/resolvers/SitemapResolver.php

@@ -15,9 +15,11 @@
 use GraphQL\Type\Definition\ResolveInfo;
 use nystudio107\seomatic\helpers\Gql as GqlHelper;
 use nystudio107\seomatic\helpers\PluginTemplate;
+use nystudio107\seomatic\helpers\Sitemap;
 use nystudio107\seomatic\models\SitemapCustomTemplate;
 use nystudio107\seomatic\models\SitemapIndexTemplate;
 use nystudio107\seomatic\models\SitemapTemplate;
+use nystudio107\seomatic\Seomatic;
 use yii\web\NotFoundHttpException;
 
 /**
@@ -55,15 +57,18 @@ public static function getSitemaps($source, array $arguments, $context, ResolveI
             return [];
         }
 
+        $sitemapList = [];
         // If either of the source bundle arguments are present, get the sitemap
         if (!empty($arguments['sourceBundleType']) || !empty($arguments['sourceBundleHandle'])) {
-            $filename = self::createFilenameFromComponents($site->groupId, $arguments['sourceBundleType'] ?? '', $arguments['sourceBundleHandle'] ?? '', $siteId);
+            $filenames = self::createSitemapFilenamesFromComponents($site->groupId, $arguments['sourceBundleType'] ?? '', $arguments['sourceBundleHandle'] ?? '', $siteId);
 
-            return [
-                self::getSitemapItemByFilename($filename),
-            ];
+            foreach ($filenames as $filename) {
+                $sitemapList[] = self::getSitemapItemByFilename($filename);
+            }
+
+            return $sitemapList;
         }
-        $sitemapList = [];
+
         $sitemapIndexItems = [self::getSitemapIndexListEntry($siteId, $site->groupId)];
 
         // Scrape each index for individual entries
@@ -151,7 +156,7 @@ protected static function getSitemapIndexListEntry($siteId, $groupId): array
      */
     protected static function getSitemapItemByFilename($filename)
     {
-        if (!preg_match('/sitemaps-(?P<groupId>\d+)-(?P<type>[\w\.*]+)-(?P<handle>[\w\.*]+)-(?P<siteId>\d+)/i', $filename, $matches)) {
+        if (!preg_match('/sitemaps-(?P<groupId>\d+)-(?P<type>[\w\.*]+)-(?P<handle>[\w\.*]+)-(?P<siteId>\d+)-sitemap(-p(?P<page>\d+))?/i', $filename, $matches)) {
             return null;
         }
 
@@ -171,10 +176,31 @@ protected static function getSitemapItemByFilename($filename)
      * @param string $bundleType
      * @param string $bundleHandle
      * @param int $siteId
-     * @return string
+     * @return array
      */
-    protected static function createFilenameFromComponents(int $groupId, string $bundleType, string $bundleHandle, int $siteId): string
+    protected static function createSitemapFilenamesFromComponents(int $groupId, string $bundleType, string $bundleHandle, int $siteId): array
     {
-        return "sitemaps-$groupId-$bundleType-$bundleHandle-$siteId-sitemap.xml";
+        $metaBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceHandle($bundleType, $bundleHandle, $siteId);
+        if (!$metaBundle) {
+            return [];
+        }
+
+        $pageSize = $metaBundle->metaSitemapVars->sitemapPageSize ?? null;
+        if (!$pageSize) {
+            return ["sitemaps-$groupId-$bundleType-$bundleHandle-$siteId-sitemap.xml"];
+        }
+
+        $sitemapFilenames = [];
+        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
+        if ($seoElement) {
+            $totalElements = Sitemap::getTotalElementsInSitemap($seoElement, $metaBundle);
+            $pageCount = $pageSize > 0 ? ceil($totalElements / $pageSize) : 1;
+
+            for ($page = 1; $page <= $pageCount; $page++) {
+                $sitemapFilenames[] = sprintf('sitemaps-%d-%s-%s-%d-sitemap-p%d.xml', $groupId, $bundleType, $bundleHandle, $siteId, $page);
+            }
+        }
+
+        return $sitemapFilenames;
     }
 }

src/helpers/Sitemap.php

@@ -443,6 +443,23 @@ public static function generateSitemap(array $params): ?string
         return implode('', $lines);
     }
 
+    /**
+     * Return the total number of elements in a sitemap, respecting metabundle settings.
+     *
+     * @param class-string<SeoElementInterface> $seoElementClass
+     * @param MetaBundle $metaBundle
+     * @return int|null
+     */
+    public static function getTotalElementsInSitemap(string $seoElementClass, MetaBundle $metaBundle)
+    {
+        $totalElements = $seoElementClass::sitemapElementsQuery($metaBundle)->count();
+
+        if ($metaBundle->metaSitemapVars->sitemapLimit && ($totalElements > $metaBundle->metaSitemapVars->sitemapLimit)) {
+            $totalElements = $metaBundle->metaSitemapVars->sitemapLimit;
+        }
+
+        return $totalElements;
+    }
 
     /**
      * Combine any per-entry type field settings from $element with the passed in
@@ -616,8 +633,4 @@ protected static function assetFilesSitemapLink(Asset $asset, MetaBundle $metaBu
             }
         }
     }
-
-    protected static function getElementListSitemap(array $elements)
-    {
-    }
 }

src/models/SitemapIndexTemplate.php

@@ -19,6 +19,7 @@
 use nystudio107\seomatic\events\RegisterSitemapsEvent;
 use nystudio107\seomatic\events\RegisterSitemapUrlsEvent;
 use nystudio107\seomatic\helpers\MetaValue as MetaValueHelper;
+use nystudio107\seomatic\helpers\Sitemap;
 use nystudio107\seomatic\Seomatic;
 use yii\base\Event;
 use yii\caching\TagDependency;
@@ -189,11 +190,7 @@ public function render(array $params = []): string
                             $metaBundle->metaSitemapVars->sitemapLimit = null;
                         }
 
-                        $totalElements = $seoElement::sitemapElementsQuery($metaBundle)->count();
-
-                        if ($metaBundle->metaSitemapVars->sitemapLimit && ($totalElements > $metaBundle->metaSitemapVars->sitemapLimit)) {
-                            $totalElements = $metaBundle->metaSitemapVars->sitemapLimit;
-                        }
+                        $totalElements = Sitemap::getTotalElementsInSitemap($seoElement, $metaBundle);
 
                         $pageSize = $metaBundle->metaSitemapVars->sitemapPageSize;
                         $pageCount = (!empty($pageSize) && $pageSize > 0) ? ceil($totalElements / $pageSize) : 1;

src/models/SitemapTemplate.php

@@ -171,6 +171,7 @@ public function render(array $params = []): string
                 $dependency = new TagDependency([
                     'tags' => [
                         self::GLOBAL_SITEMAP_CACHE_TAG,
+                        self::SITEMAP_CACHE_TAG . $handle . $siteId,
                         self::SITEMAP_CACHE_TAG . $handle . $siteId . $pageCacheSuffix,
                     ],
                 ]);

src/seoelements/SeoCampaign.php

@@ -448,7 +448,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/seoelements/SeoCategory.php

@@ -437,7 +437,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/seoelements/SeoDigitalProduct.php

@@ -445,7 +445,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/seoelements/SeoEntry.php

@@ -453,7 +453,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/seoelements/SeoEvent.php

@@ -212,7 +212,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/seoelements/SeoProduct.php

@@ -445,7 +445,6 @@ public static function createContentMetaBundle(Model $sourceModel)
         /** @var Site $site */
         foreach ($sites as $site) {
             $seoElement = self::class;
-            /** @var SeoElementInterface $seoElement */
             Seomatic::$plugin->metaBundles->createMetaBundleFromSeoElement($seoElement, $sourceModel, $site->id);
         }
     }

src/services/MetaBundles.php

@@ -336,7 +336,7 @@ public function updateMetaBundle(MetaBundle $metaBundle, int $siteId)
     }
 
     /**
-     * @param SeoElementInterface $seoElement
+     * @param class-string<SeoElementInterface> $seoElement
      * @param Model $sourceModel
      * @param int $sourceSiteId
      * @param MetaBundle|null $baseConfig

src/services/SeoElements.php

@@ -79,14 +79,13 @@ class SeoElements extends Component
     /**
      * @param null|string $metaBundleType
      *
-     * @return SeoElementInterface|null
+     * @return class-string<SeoElementInterface>|null
      */
     public function getSeoElementByMetaBundleType($metaBundleType)
     {
         if ($metaBundleType === null) {
             return null;
         }
-        /** @var SeoElementInterface[] $seoElements */
         $seoElements = $this->getAllSeoElementTypes();
 
         return $seoElements[$metaBundleType] ?? null;
@@ -95,7 +94,7 @@ public function getSeoElementByMetaBundleType($metaBundleType)
     /**
      * Returns all available field type classes.
      *
-     * @return string[] The available field type classes
+     * @return class-string<SeoElementInterface>[] The available field type classes
      */
     public function getAllSeoElementTypes(bool $useCache = true): array
     {

src/services/Sitemaps.php

@@ -522,30 +522,12 @@ public function invalidateCaches()
      */
     public function invalidateSitemapCache(string $handle, ?int $siteId, string $type, bool $invalidateCache = true)
     {
-        // Since we want a stale-while-revalidate pattern, only invalidate the cache if we're asked to
-        if ($invalidateCache) {
-            $cache = Craft::$app->getCache();
-            TagDependency::invalidate($cache, SitemapTemplate::SITEMAP_CACHE_TAG . $handle . $siteId);
-            Craft::info(
-                'Sitemap cache cleared: ' . $handle,
-                __METHOD__
-            );
-        }
-        $sites = Craft::$app->getSites();
-        if ($siteId === null) {
-            $siteId = $sites->currentSite->id ?? 1;
-        }
-        $site = $sites->getSiteById($siteId);
-        $groupId = $site->groupId;
-        $sitemapTemplate = SitemapTemplate::create();
-        $xml = $sitemapTemplate->render(
-            [
-                'groupId' => $groupId,
-                'type' => $type,
-                'handle' => $handle,
-                'siteId' => $siteId,
-                'throwException' => false,
-            ]
+        // Always just invalidate the sitemap cache now, since we're doing paginated sitemaps
+        $cache = Craft::$app->getCache();
+        TagDependency::invalidate($cache, SitemapTemplate::SITEMAP_CACHE_TAG . $handle . $siteId);
+        Craft::info(
+            'Sitemap cache cleared: ' . $handle,
+            __METHOD__
         );
     }
 

src/templates/settings/plugin/_includes/sitemaps.twig

@@ -15,8 +15,8 @@
         }) }}
 
         {{ forms.lightswitchField({
-            label: "Regenerate Sitemaps Automatically"|t("seomatic"),
-            instructions: "Controls whether sitemaps will automatically be regenerated when entries are saved."|t("seomatic"),
+            label: "Invalidate Sitemap Caches Automatically"|t("seomatic"),
+            instructions: "Controls whether sitemap caches will automatically be invalidated when entries are saved."|t("seomatic"),
             id: "regenerateSitemapsAutomatically",
             name: "regenerateSitemapsAutomatically",
             on: settings.regenerateSitemapsAutomatically,