Migration

This page lists all notable changes and required migrations when upgrading to a new major version of this extension.

Version 3.0.0

Upgrade of eliashaeussler/cache-warmup library

  • Custom crawlers must be rewritten to match the updated codebase.
  • Read more in the library's release notes.

StreamResponseHandler is now result-aware

  • \EliasHaeussler\Typo3Warming\Http\Message\Handler\StreamResponseHandler now depends on a given \EliasHaeussler\CacheWarmup\Result\CacheWarmupResult.
  • The result object is generated and updated by the \EliasHaeussler\CacheWarmup\Http\Message\Handler\ResultCollectorHandler.
  • Make sure to use both handlers together when using the stream response handler.
  • Pass the result object from result collection handler when instantiating the stream response handler.
  • See \EliasHaeussler\Typo3Warming\Crawler\ConcurrentUserAgentCrawler for a dedicated example.

Version 2.0.0

Integration of EXT:sitemap_locator

  • Sitemaps cache was extracted to EXT:sitemap_locator. Use \EliasHaeussler\Typo3SitemapLocator\Cache\SitemapsCache instead of \EliasHaeussler\Typo3Warming\Cache\SitemapsCache.
  • Sitemap providers were extracted to EXT:sitemap_locator. Use \EliasHaeussler\Typo3SitemapLocator\Sitemap\Provider\Provider instead of \EliasHaeussler\Typo3Warming\Sitemap\Provider\Provider for custom provider implementations.
  • Sitemap locator was extracted to EXT:sitemap_locator. Use \EliasHaeussler\Typo3SitemapLocator\Sitemap\SitemapLocator instead of \EliasHaeussler\Typo3Warming\Sitemap\SitemapLocator.

Relocated sitemap model

  • The default \EliasHaeussler\Typo3Warming\Sitemap\SiteAwareSitemap model was moved to \EliasHaeussler\Typo3Warming\Domain\Model\SiteAwareSitemap. Update references to this class in your code.

Version 1.0.0

Default crawlers

  • Default crawlers are now final. Custom crawlers can no longer extend default crawlers. Implement \EliasHaeussler\CacheWarmup\Crawler\Crawler or \EliasHaeussler\CacheWarmup\Crawler\VerboseCrawler instead.
  • CrawlerFactory from eliashaeussler/cache-warmup library is now used to instantiate crawlers. Dependency injection is no longer possible.
  • \EliasHaeussler\Typo3Warming\Crawler\ConfigurableClientTrait was removed. Use \EliasHaeussler\Typo3Warming\Http\Client\ClientFactory::get instead.
  • \EliasHaeussler\Typo3Warming\Crawler\RequestAwareInterface and \EliasHaeussler\Typo3Warming\Crawler\RequestAwareTrait were removed. Use \EliasHaeussler\Typo3Warming\Crawler\StreamableCrawler in combination with \EliasHaeussler\Typo3Warming\Http\Message\Handler\StreamResponseHandler instead.
  • \EliasHaeussler\Typo3Warming\Crawler\UserAgentTrait was removed. Provide an own implementation that calls \EliasHaeussler\Typo3Warming\Configuration\Configuration::getUserAgent instead.

Warmup request handling

  • \EliasHaeussler\Typo3Warming\ValueObject\Request\WarmupRequest is now final.
  • \EliasHaeussler\Typo3Warming\ValueObject\Request\WarmupRequest::$updateCallback was removed. Streamed warmup requests must now be handled by using \EliasHaeussler\Typo3Warming\Http\Message\Handler\StreamResponseHandler in a custom crawler instead.
  • Crawling result handling within \EliasHaeussler\Typo3Warming\ValueObject\Request\WarmupRequest was removed. Use the returned \EliasHaeussler\Typo3Warming\Result\CacheWarmupResult from \EliasHaeussler\Typo3Warming\Service\CacheWarmupService::warmup instead.
  • \EliasHaeussler\Typo3Warming\Service\CacheWarmupService::warmupPages and \EliasHaeussler\Typo3Warming\Service\CacheWarmupService::warmupSites were combined to a new method \EliasHaeussler\Typo3Warming\Service\CacheWarmupService::warmup. Use this method with dedicated instances of \EliasHaeussler\Typo3Warming\ValueObject\Request\SiteWarmupRequest and \EliasHaeussler\Typo3Warming\ValueObject\Request\PageWarmupRequest.

Sitemap providers

  • \EliasHaeussler\Typo3Warming\Sitemap\Provider\ProviderInterface was renamed to \EliasHaeussler\Typo3Warming\Sitemap\Provider\Provider.
  • \EliasHaeussler\Typo3Warming\Sitemap\Provider\AbstractProvider was removed. Custom sitemap providers must now implement \EliasHaeussler\Typo3Warming\Sitemap\Provider\Provider directly. The previously available trait method is now available within \EliasHaeussler\Typo3Warming\Utility\HttpUtility::getSiteUrlWithPath.
  • \EliasHaeussler\Typo3Warming\Sitemap\Provider\Provider::get now returns an array of \EliasHaeussler\Typo3Warming\Sitemap\SiteAwareSitemap instances.
  • A new sitemap provider \EliasHaeussler\Typo3Warming\Sitemap\Provider\PageTypeProvider was added. It is configured with highest priority. Read more at Sitemap providers.

Language handling

  • \EliasHaeussler\Typo3Warming\Sitemap\SiteAwareSitemap now requires a site language to be set.
  • Page uri generation now respects configured language overlays and is moved to \EliasHaeussler\Typo3Warming\Utility\HttpUtility::generateUri.

Extension configuration

  • Extension configuration exclude was added. Read more at exclude.
  • Extension configuration strategy was added. Read more at strategy.

Command options

Template paths

  • Template paths were rewritten:

    • CacheWarmupToolbarItem.html was rewritten to Toolbar/CacheWarmupToolbarItem.html
    • CacheWarmupToolbarItemActions.html was rewritten to Modal/SitesModal.html

  • Partial paths were rewritten:

    • ToolbarItem.html was inlined to template Toolbar/CacheWarmupToolbarItem.html
    • ToolbarItemAction.html was split into Modal/Sites/SiteGroup.html and Modal/Sites/SiteGroupItem.html
    • ToolbarItemMissing.html was rewritten to Modal/Alert/NoSites.html
    • ToolbarItemPlaceholder.html was removed
    • ToolbarItemUserAgent.html was removed