Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
@tillkruss
tillkruss committed Apr 22, 2024
2 parents e580c96 + 29c805c commit 14d740b
Show file tree
Hide file tree
Showing 10 changed files with 279 additions and 215 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## 2.5.2

- Respect `WP_REDIS_FLUSH_TIMEOUT` in Lua flush scripts
- Improve `DISALLOW_FILE_MODS` support
- Reverted behavioral change to `sanitize_key_part()`
- Fixed rare fatal error in `show_error_and_die()` (again)

## 2.5.1

- Added timeouts to diagnostics
Expand Down
87 changes: 35 additions & 52 deletions FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,35 @@

When in doubt try flushing the cache, you'd be surprised how often this resolves issues. Welcome to WordPress ✌️

<details>
<summary>HELP! My site is down!1!!11!!11</summary>
- [HELP! My site is down!1!!11!!11](#help-my-site-is-down11111)
- [Plugin is incompatible with OtherPlugin](#plugin-is-incompatible-with-otherplugin)
- [Status: <code>Not connected</code>](#status-not-connected)
- [<code>connection timed out</code> and <code>read error on connection</code>](#connection-timed-out-and-read-error-on-connection)
- [How can I exclude a page from the cache?](#how-can-i-exclude-a-page-from-the-cache)
- [My site is getting redirected another domain](#my-site-is-getting-redirected-another-domain)
- [Are transients stored in Redis?](#are-transients-stored-in-redis)
- [I'm getting <code>404</code> errors](#im-getting-404-errors)
- [WordPress is slower with Redis Object Cache enabled](#wordpress-is-slower-with-redis-object-cache-enabled)
- [<code>NOAUTH Authentication required</code>](#noauth-authentication-required)
- [<code>Allowed memory size of 1337 bytes exhausted</code>](#allowed-memory-size-of-1337-bytes-exhausted)
- [<code>OOM command not allowed</code>](#oom-command-not-allowed)
- [<code>Flushing the cache causes timeout</code>](#flushing-the-cache-causes-timeout)
- [Unable to flush the cache](#unable-to-flush-the-cache)
- [Cache is flushed constantly](#cache-is-flushed-constantly)
- [Flushing the cache regularly](#flushing-the-cache-regularly)
- [How can I uninstall the cache?](#how-can-i-uninstall-the-cache)

## HELP! My site is down!1!!11!!11

The easiest way to to disable Redis on your site is deleting the `wp-content/object-cache.php` drop-in file. Alternatively, you can set the `WP_REDIS_DISABLED` constant to `true` to bypass loading it.
</details>

<details>
<summary>Plugin is incompatible with OtherPlugin</summary>
## Plugin is incompatible with OtherPlugin

Unfortunately many plugin authors don't bother testing their plugins with a persistent object cache. If you’re experiencing a compatibility issue with another plugin in combination with Redis Object Cache, please contact the support team of the **other plugin** regarding the issue.

This plugin is **not the issue**, it's just providing WordPress with `wp_cache_*()` functions for persistent caching.
</details>

<details>
<summary>Status: <code>Not connected</code></summary>
## Status: <code>Not connected</code>

This means that either [Redis Server](https://redis.io) is not installed and running, or the plugin is not configured correctly.

Expand All @@ -40,23 +53,17 @@ require_once(ABSPATH . 'wp-settings.php');
```

If you moved all constants above those lines and the plugin still shows `Not Connected`, double check your [connection options](https://github.com/rhubarbgroup/redis-cache#connections), or ask your hosting provider for assistance.
</details>

<details>
<summary><code>connection timed out</code> and <code>read error on connection</code></summary>
## <code>connection timed out</code> and <code>read error on connection</code>
If the error occurs rarely, ignore it, Redis Server is having a hiccup. If it persists, read the answer to "Status: <code>Not connected</code>".
</details>

<details>
<summary>How can I exclude a page from the cache?</summary>
## How can I exclude a page from the cache?

Object caching caches only **objects**, not **pages**. You cannot exclude a page from using the object cache, because object caching is not URL-centric. You also cannot exclude the WordPress admin dashboard from using object caching, because then you risk the cache going stale and even loosing data.

If you’re experiencing a compatibility issue with another plugin in combination with Redis Object Cache, please contact the support team of the plugin regarding the issue and ask them to ensure it's compatible with persistent object cache backends, like Redis.
</details>

<details>
<summary>My site is getting redirected another domain</summary>
## My site is getting redirected another domain

That happens when the same `WP_REDIS_DATABASE` index is used for multiple WordPress installations. You **MUST** set a separate `WP_REDIS_DATABASE` and `WP_REDIS_PREFIX` for each domain to avoid data collision.

Expand All @@ -65,10 +72,8 @@ Once your site is being redirected, you **MUST** flush the entire Redis Server u
```bash
redis-cli -h 127.0.01 -p 6379 FLUSHALL
```
</details>

<details>
<summary>Are transients stored in Redis?</summary>
## Are transients stored in Redis?

Yes. The WordPress [Transients API](https://developer.wordpress.org/apis/transients/) will use Redis to store transients and not the `options` table.

Expand All @@ -83,10 +88,8 @@ DELETE FROM `wp_options`
WHERE `option_name` LIKE '_transient_%'
OR `option_name` LIKE '_site_transient_%';
```
</details>

<details>
<summary>I'm getting <code>404</code> errors</summary>
## I'm getting <code>404</code> errors

This may be an issue with WordPress 6.1's [query caching](https://make.wordpress.org/core/2022/10/07/improvements-to-wp_query-performance-in-6-1/) feature, which you can disable by creating your own [Must Use Plugin](https://wordpress.org/documentation/article/must-use-plugins/) containing this snippet:

Expand All @@ -96,58 +99,45 @@ add_action( 'parse_query', function ( $wp_query ) {
} );
```

</details>

<details>
<summary>WordPress is slower with Redis Object Cache enabled</summary>
## WordPress is slower with Redis Object Cache enabled

This should never always means **something is broken**.

1. Does the plugin show "Connected"?
2. Is Redis Server responding too slowly? Run `redis-cli --latency-history` to find out.
3. Is Redis Server maxing out it's RAM or CPU?
</details>

<details>
<summary><code>NOAUTH Authentication required</code></summary>
## <code>NOAUTH Authentication required</code>

You either need to add the `WP_REDIS_PASSWORD` constant to your `wp-config.php` file, or move the constant above higher up in your `wp-config.php` file, above these lines:

```php
/* That's all, stop editing! Happy publishing. */
require_once(ABSPATH . 'wp-settings.php');
```
</details>

<details>
<summary><code>Allowed memory size of 1337 bytes exhausted</code></summary>
## <code>Allowed memory size of 1337 bytes exhausted</code>

This can happen when using a persistent object cache. Increase PHP's memory limit.

- <https://wordpress.org/documentation/article/common-wordpress-errors/#allowed-memory-size-exhausted>
- <https://woocommerce.com/document/increasing-the-wordpress-memory-limit/>
</details>

<details>
<summary><code>OOM command not allowed</code></summary>
## <code>OOM command not allowed</code>

This can happen when Redis Server runs out of memory and no `maxmemory-policy` was set in the `redis.conf`.

- <https://aws.amazon.com/premiumsupport/knowledge-center/oom-command-not-allowed-redis/>

Alternatively, you can set the `WP_REDIS_MAXTTL` constant to something relatively low (like `3600` seconds) and flush the cache.
</details>

<details>
<summary><code>Flushing the cache causes timeout</code></summary>
## <code>Flushing the cache causes timeout</code>

This can happen when the dataset in Redis Server is quite large. Consider increasing `WP_REDIS_READ_TIMEOUT` and `WP_REDIS_FLUSH_TIMEOUT` to 5-10 seconds.

Alternatively, starting with Redis 6.2, setting the `lazyfree-lazy-user-flush` in the `redis.conf` configuration directive to `yes` changes the default flush mode to be asynchronous.
</details>

<details>
<summary>Unable to flush the cache</summary>
## Unable to flush the cache

If your site is unreachable, you can flush the cache without access to the WordPress dashboard.

Expand All @@ -158,10 +148,8 @@ redis-cli -h 127.0.01 -p 6379 FLUSHALL
```

Alternatively, you can use a desktop client like [Medis](https://getmedis.com) or [RedisInsight](https://redis.com/redis-enterprise/redis-insight/) to connect to your Redis Server and flush it by executing `FLUSHALL`.
</details>

<details>
<summary>Cache is flushed constantly</summary>
## Cache is flushed constantly

If you don't see metrics building up, or your site is not getting faster, you might have an active plugin that flushes the object cache frequently. To diagnose this issue you can use the following snippet to find the source of the cache flush:

Expand All @@ -176,10 +164,8 @@ add_action( 'redis_object_cache_flush', function( $results ) {
```

Once you found the plugin responsible by checking `redis-cache-flush.log`, you can contact the plugin author(s) and reporting the issue.
</details>

<details>
<summary>Flushing the cache regularly</summary>
## Flushing the cache regularly

It's considered a bad practise to flush the frequently, but sometimes 3rd party plugins and themes just don't play nice with persistent object caches. When the plugin/theme authors refuse to fix their code you can use [WP Cron](https://developer.wordpress.org/plugins/cron/) to flush the Redis object cache frequently.

Expand All @@ -190,12 +176,9 @@ if ( ! wp_next_scheduled( 'flush_redis_cache' ) ) {

add_action( 'flush_redis_cache', 'wp_cache_flush' );
```
</details>

<details>
<summary>How can I uninstall the cache?</summary>
## How can I uninstall the cache?

Before [uninstalling the plugin](https://wordpress.org/documentation/article/manage-plugins/#uninstalling-plugins-1), be sure to disable the cache via `WordPress -> Settings -> Redis`.

If you already removed the plugin before doing so, you can delete the `object-cache.php` file in your `/wp-content/` directly.
</details>
15 changes: 5 additions & 10 deletions includes/class-plugin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,7 @@ public function add_plugin_row_meta( array $plugin_meta, $plugin_file ) {
* @param bool $as_html
* @return string
*/
public function link_to_ocp($medium, $as_html = true)
{
public function link_to_ocp($medium, $as_html = true){
$ref = 'oss';

if ( self::acceleratewp_install( true ) ) {
Expand Down Expand Up @@ -822,8 +821,7 @@ public function render_admin_bar( $wp_admin_bar ) {
*
* @return string
*/
protected function admin_bar_style()
{
protected function admin_bar_style() {
return <<<HTML
<style>
#wpadminbar ul li.redis-cache-error {
Expand All @@ -843,8 +841,7 @@ protected function admin_bar_style()
*
* @return string
*/
protected function admin_bar_script()
{
protected function admin_bar_script() {
$nonce = wp_create_nonce();
$ajaxurl = esc_url( admin_url( 'admin-ajax.php' ) );
$flushMessage = __( 'Flushing cache...', 'redis-cache' );
Expand Down Expand Up @@ -1274,8 +1271,7 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes",
*
* @return bool
*/
protected function incompatible_content_type()
{
protected function incompatible_content_type() {
$jsonContentType = static function ($headers) {
foreach ($headers as $header => $value) {
if (stripos((string) $header, 'content-type') === false) {
Expand Down Expand Up @@ -1586,8 +1582,7 @@ public function current_user_can_manage_redis() {
*
* @return void
*/
public function litespeed_disable_objectcache()
{
public function litespeed_disable_objectcache() {
if ( isset( $_POST['LSCWP_CTRL'], $_POST['LSCWP_NONCE'], $_POST['object'] ) ) {
$_POST['object'] = '0';
}
Expand Down
Loading

0 comments on commit 14d740b

Please sign in to comment.