Download the PHP package webandco/neos-asset-usage-cache without Composer
On this page you can find all versions of the php package webandco/neos-asset-usage-cache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download webandco/neos-asset-usage-cache
More information about webandco/neos-asset-usage-cache
Files in webandco/neos-asset-usage-cache
Package neos-asset-usage-cache
Short Description Improve asset usage query performance
License
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package neos-asset-usage-cache
Asset Usage Cache
The package provides a strategy to cache the asset usage results. Additionally, the database query to fetch the related nodes is simplified and can be cached by the database server too.
Installation
Install the package with composer. It is recommended to use the package only in development environments.
Features
This package provides various features to improve performance of querying the asset usage.
The alternative package https://github.com/punktDe/elastic-assetusageinnodes also solves the performance problem using an elasticsearch index. The main differences to the elasticsearch package are:
- This package,
webandco/neos-asset-usage-cache, only needs the database you use for NEOS. There is no need for elasticsearch. - We assume the cache to be more short-lived, whereas the elasticsearch package is basically an index of the nodes and updated accordingly.
- We also use a different method to inject our own
AssetUsageStrategy. Via the Settings.yaml you can then disable/enable Strategies as you like. Thus you are more maneuverable and create add/extend your ownAssetUsageStrategy- which is currently more complicated by default in NEOS. - You can disable the cache completely in
Settings.yamlif you want and just enable it on purpose, e.g. in a long running command controller of yours. - You can also disable the cache itself and just let the database cache the results. This basically means that the query to determine the asset usage is modified. This approach can be very fast and provides correct results all the time. The drawback is that you need to reconfigure your database to increase query caches which can cause decreased query performance because of internal DB locks. More details and links down below.
Configurable asset usage strategy
Currently the asset usage is generated by iterating over all classes
implementing the Neos\Media\Domain\Strategy\AssetUsageStrategyInterface
and sum up or merge the results from the implementations.
In a default setup, it is not possible to enable/disable strategies, making it
more complicated to replace the current default strategy Neos\Neos\Domain\Strategy\AssetUsageInNodePropertiesStrategy
This package uses an aspect for Neos\Media\Domain\Service\AssetService->getUsageStrategies()
and the configuration to disable or enable strategies. Thus one can easier add or remove
an AssetUsageStrategy.
Simplified database query
The default asset usage query in AssetUsageInNodePropertiesStrategy adds
multiple LIKE conditions for the properties column to query the nodeData table.
The more an asset is in use, the more image variants exist, the more LIKE conditions are added and this slows the query down.
In this package we implemented an alternative approach, by just querying all
rows which contain __identifier or asset: and then filter the results
using PHP's preg_match_all. So the workload is moved away from the database
and into PHP.
To make use of database query caching you likely need to increase query cache sizes, e.g.
Keep in mind, that by increasing the database cache sizes, the database can actually be slowed down, see https://dev.mysql.com/doc/refman/5.6/en/query-cache.html:
For futher details, see: https://haydenjames.io/mysql-query-cache-size-performance/
If you increase database query cache sizes, the query used in this package is cached, and there is no need for php caching.
Cached asset usage
The database result is managed via a cache, which is updated on signals for node changes and by default flushed every hour.
Performance
The database query used in this package, takes around 4 sec for for around 300.000 nodes in the nodeData table. The more nodes the slower this query becomes.
This database query is independent of any given asset or usage count and performs the same for every asset.
If the cache is populated, the methods provided by AssetUsageCacheStrategy
take around 6ms per asset nearly independent of the usage count.
Configuration
The default configuration, disables the AssetUsageInNodePropertiesStrategy
and enables the provided AssetUsageCacheStrategy.
Additionally the queryCache is enabled and realTimeUpdate is enabled.
Use cases
Database query cache only
To make use of the database query cache but not using the PHP cache, just disable the cache in the configuration
Enable cache on purpose
In case the cache should be not used in the media browser, but during a custom command line action, the cache needs to be disabled via configuration, see above.
In the command line action you can then enable the cache
Thus the cache is used during the run of the current command line action which can be handy if you need to iterate over all assets and check their usage count.
