Migration

This page lists breaking changes between major versions which may require manual actions during upgrade.

TIP

You can find all pull requests with breaking changes on GitHub.

3.x → 4.x

New XML parser component (#422)

A new interface Xml\Parser is introduced as base component for parsing XML sitemaps. The default XML parser is renamed from Xml\Parser to Xml\SitemapXmlParser and implements the new Xml\Parser interface.

• Migrate all existing class name references from Xml\Parser to Xml\SitemapXmlParser.

• When using a custom client within CacheWarmer, create the parser on your own and include your client implementation, then pass it to CacheWarmer:

  use EliasHaeussler\CacheWarmup;
  use GuzzleHttp\Client;
  
  $client = new Client($clientConfig);
  $parser = new CacheWarmup\Xml\SitemapXmlParser(client: $client);
  $cacheWarmer = new CacheWarmup\CacheWarmer(parser: $parser);

Changed crawling response body handling (#424)

Default crawlers using Crawler\ConcurrentCrawlerTrait no longer attach crawling response body to response objects. A new crawler option write_response_body is introduced to control this behavior.

• Set write_response_body to true if you rely on the crawling response body. Note that this may significantly increase memory consumption and CPU load.

Removal of client_config crawler option (#442)

The client_config crawler option, which was previously respected by both default crawlers, is dropped. A new Http\Client\ClientFactory acts as drop-in replacement for globally shared client configuration.

• Migrate client_config crawler option to the new clientOptions configuration option. Note that this configuration option will be respected by the default parser as well.

Changed User-Agent header (#447)

The default HTTP request header User-Agent changes like follows (<version> references the current library's version):

-EliasHaeussler-CacheWarmup/<version> (https://github.com/eliashaeussler/cache-warmup)
+EliasHaeussler-CacheWarmup/<version> (https://cache-warmup.dev)

• Change usages and references of the User-Agent header, for example when excluding cache warmup requests from website analytics.

Moved namespace of events (#450)

Class namespaces of events are changed to follow a clear categorization of specific events.

• Modify namespaces of referenced events. A list of available events is available on the Events page.