Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 2.1 KB

2023-01-16-atomic-theme-compilation.md

File metadata and controls

29 lines (23 loc) · 2.1 KB
title issue
Atomic theme compilation
NEXT-24662

Storefront

  • Added generateNewPath() and saveSeed() methods in \Shopware\Storefront\Theme\AbstractThemePathBuilder, to allow atomic theme compilations.
  • Added \Shopware\Storefront\Theme\SeedingThemePathBuilder as new default implementation for \Shopware\Storefront\Theme\AbstractThemePathBuilder.
  • Added \Shopware\Storefront\Theme\Message\DeleteThemeFilesMessage and \Shopware\Storefront\Theme\Message\DeleteThemeFilesHandler to asynchronously delete compiled theme files.

Upgrade Information

Atomic theme compilation

To allow atomic theme compilations, a seeding mechanism for AbstractThemePathBuilder was added. Whenever a theme is compiled, a new seed is generated and passed to the generateNewPath() method, to generate a new theme path with that seed. After the theme was compiled successfully the saveSeed() method is called to that seed, after that subsequent calls to the assemblePath() method, must use the newly saved seed for the path generation.

Additionally, the default implementation for \Shopware\Storefront\Theme\AbstractThemePathBuilder was changed from \Shopware\Storefront\Theme\MD5ThemePathBuilder to \Shopware\Storefront\Theme\SeedingThemePathBuilder.

Obsolete compiled theme files are now deleted with a delay, whenever a new theme compilation created new files. The delay time can be configured in the shopware.yaml file with the new storefront.theme.file_delete_delay option, by default it is set to 900 seconds (15 min), if the old theme files should be deleted immediately you can set the value to 0.

For more details refer to the corresponding ADR.

Next Major Version Changes

Seeding mechanism for AbstractThemePathBuilder

The generateNewPath() and saveSeed() methods in \Shopware\Storefront\Theme\AbstractThemePathBuilder are now abstract, this means you should implement those methods to allow atomic theme compilations.

For more details refer to the corresponding ADR.