Download the PHP package iqual/authenticated_cache_warmer without Composer
On this page you can find all versions of the php package iqual/authenticated_cache_warmer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download iqual/authenticated_cache_warmer
More information about iqual/authenticated_cache_warmer
Files in iqual/authenticated_cache_warmer
Package authenticated_cache_warmer
Short Description A module to warm cache for endpoints that need authentication.
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 authenticated_cache_warmer
Authenticated cache warmer
This module allows to warm cache on routes that need authentication. It achieves this by impersonating a user in an EventSubscriber using the account_switcher service and a state key to authenticate the warming requests (see Security).
Usage
The module only provides the API to create your own cache warmer service. You need to implement your own drush command or cron job to actually run the cache warming.
To use the API, you need the following data:
- The route you want to call (e.g.
entity.node.canonical) - The entity ids to request
- The user ids to impersonate
- (Optional) Http options for the GuzzleHttpClient
You then create one or more CacheWarmUrl and provide them to the authenticated_cache_warmer.cache_warmer service. The service will call all the provided urls with the corresponding user account, limited to 10 parallel calls.
Example
The following snippet will warm both nodes 1 and 2 simulating users 2 and 3.
Tips on CacheWarmerUrl
- CacheWarmerUrl extends Drupal/Core/Url, so you can use all the
from*methods. You then need to set the user account usingsetAccountId(). - You can pass options to the GuzzleHttpClient used to do the call using
setHttpOptions()or via the fourth argument on the create method. SeeGuzzleHttp\ClientInterface::requestAsyncfor details.
Security
The requests are secured by generating and storing a random key on starting the warming, which is then passed along as a cookie value with the request. The EventSubscriber checks if the key is in Drupal's state and is active.
This means the calling client needs to run with the same Drupal environment/db.
