CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.13.3 - 2021-06-08

Added

• Support passing function names to logger configuration option

Changed

• Improved Relay integration and support
• Improved unsupported compression and serializer error messages
• Renamed more things to "Object Cache Pro"

Fixed

• Support url options without usernames
• Ensure wp_debug_backtrace_summary() is loaded to increase Batcache compatibility

Security

• Hide passwords in url from diagnostics

v1.13.2 - 2021-04-29

Added

• Added relay_listeners configuration option
• Added a BacktraceLogger logger for easy debugging
• Added wildcard support in non-prefetchable group names

Changed

• Split up setMutationOptions() methods

Fixed

• Fixed flushing clusters when using a TLS connection

v1.13.1 - 2021-04-14

Changed

• Disable prefetching for CLI and API requests
• Added userlogins and wc_session_id to non-prefetchable groups
• Prevent even more __PHP_Incomplete_Class errors when using prefetching

Fixed

• Fixed type error in PrefetchesKeys

v1.13.0 - 2021-04-12

Added

• Added support for Relay
• Added client configuration option
• Added tls_options configuration option
• Added ObjectCache::withoutMutations() helper
• Added PrefetchesKeys::deletePrefetches() helper
• Added info log lines to wp_cache_init()
• Added wildcard support in non-persistent group names
• Show command count and argument class names in Query Monitor

Changed

• Respect debug configuration option in wp_cache_init()
• Added Connector::boot(): void interface method
• Deprecated WP_REDIS_PHPREDIS_OPTIONS constant
• Renamed several internal exceptions
• Access fully qualified constants
• Expect PhpRedisConnection in PhpRedisObjectCache constructor
• Use high resolution time when available
• Increased command time decimals from 2 to 4
• Refactored license code to be more graceful
• Prevent __PHP_Incomplete_Class errors when using prefetching

Fixed

• Fixed flushing networks when using the site or global option
• Fixed preloading in multisite environments
• Fixed prefetches count discrepancies

v1.12.0 - 2020-12-23

Added

• Improved PHP 8 compatibility
• Added support for Batcache
• Support flagging groups as non-prefetchable
• Added ObjectCache::deleteFromMemory(string $key, string $group) method
• Added ObjectCache::flushMemory() in favor of ObjectCache::flushRuntimeCache()
• Added rediscache_validate_dropin filter
• Added rediscache_validate_dropin_version filter

Changed

• Support loading the object cache as early as advanced-cache.php
• Changed default value of cluster_failover to error to improve stability
• Refactored flushBlog(int $siteId, string $flush_network = null) method
• Check wp_is_file_mod_allowed('object_cache_dropin') before automatically updating drop-in
• Marked PHP 7.3 as outdated

Fixed

• Prevent another rare undefined variable notice in wp_cache_init()
• Resolve incompatibility with Query Monitor 3.6.5
• Updated some links to the documentation

v1.11.1 - 2020-11-12

Changed

• Only preload groups with at least two keys

Fixed

• Convert integer group names to strings

v1.11.0 - 2020-11-11

Added

• Added prefetching 🚀
• Added ObjectCache::flushRuntimeCache() method
• Added PhpRedisConnection::withoutMutations() method
• Added support for Query Monitor's new backtraces

Changed

• Improved memory usage display in widget
• Speed up command execution when using replication
• Improved parameter formatting in Query Monitor
• Attach backtrace as array along with backtrace summary to log messages
• Moved runtime cache helpers from to ObjectCache class

Fixed

• Fixed updating split alloptions hash options with equivalent values
• Send alloptions hash read commands to the master when using replication
• Prevent rare undefined variable notice in wp_cache_init()

v1.10.2 - 2020-09-28

Added

• Overload generic cache_hits and cache_misses properties

Changed

• Always return a Configuration from Configuration::safelyFrom()
• Use invalid configuration option name (not method name) in error log message

Fixed

• Use key caching in multisite environments
• Added suffix to MU and Drop-in stubs to avoid invalid plugin header error when activating

v1.10.1 - 2020-09-16

Fixed

• Fixed an issue with non-persistent, numeric keys in get_multiple()

v1.10.0 - 2020-09-15

Added

• Show connection class in Query Monitor
• Added Configuration::parseUrl() helper
• Added support for replicated connections
• Show configuration instantiation errors in widget and site health

Changed

• Moved RedisCachePro\Config class to RedisCachePro\Configuration\Configuration
• Renamed slave_failover configuration option to cluster_failover ✊🏿
• Extracted cluster related configuration into RedisCachePro\Configuration\Concerns\Cluster
• Trim log messages to 400 characters in Debug Bar log
• Throw RedisConfigValueException for invalid configuration values instead of RedisConfigException

Fixed

• Create a proper configuration object when cache instantiation fails
• Escape command parameters in Query Monitor extension
• Moved Redis related information from ObjectCache::info() to PhpRedisObjectCache::info()
• Always strip unix:// from PhpRedis host parameter
• Ensure PhpRedisObjectCache::info()->status returns a boolean
• Prevent invalid configuration values from booting plugin

v1.9.2 - 2020-08-29

Added

• Look for object-cache-pro directory in must-use stub

Fixed

• Fixed host scheme in PhpRedis 5.0.2 and older

v1.9.1 - 2020-08-26

Added

• Added wp_cache_remember() and wp_cache_sear() functions

Changed

• Pointed all URLs to the new domain objectcache.pro
• Change log prefix from rediscache to objectcache
• Slightly sped up API loading in object cache drop-in

Fixed

• Only throw exception in mu-plugin and drop-in when WP_DEBUG is true

v1.9.0 - 2020-08-15

Added

• Added url configuration option
• Added scheme configuration option
• Added support for options parameter added in PhpRedis 5.3
• Added support for LZ4 compression (PhpRedis 5.3+)

Changed

• Support connecting to sockets and using TLS in wp redis cli
• Convert host configuration option to lowercase
• Set scheme when included in host configuration option

Fixed

• Fixed getting multiple numeric keys in ArrayObjectCache
• Fixed setting port, database, maxttl and retry_interval as numeric string

v1.8.2 - 2020-08-11

Changed

• Reverted eager plugin name change in v1.8.1
• Updated plugin URL to new domain to avoid redirects

Fixed

• Don't flag drop-in as invalid when it's just outdated

v1.8.1 - 2020-08-11

Changed

• Look for API in object-cache-pro directories

Fixed

• Fixed an issue with numeric keys and improved error handling in get_multiple()

v1.8.0 - 2020-07-23

Added

• Added username configuration option for Redis 6 ACL support
• Added cache configuration option to set a custom object cache class
• Added connector configuration option to set a custom connector class
• Added flush_network configuration option (defaults to all)
• Support flushing individual sites via Network Admin > Sites
• Added --skip-flush-notice option to wp redis enable command
• Added health check to ensure asynchronous flushing is supported
• Added health check to ensure drop-in can be managed
• Added intuitive alias for all WP CLI commands
• Added support for wp_cache_get_multiple() introduced in WP 5.5

Changed

• Renamed "Dropin" to "Drop-in" everywhere
• Support flushing individual sites using wp redis flush
• Hide Redis memory from dashboard widget in multisite environments
• Display notice when license token is not set or invalid, as well as when the license is unpaid or canceled

Fixed

• Explicitly set permissions of object-cache.php to FS_CHMOD_FILE

v1.7.3 - 2020-07-10

Fixed

• Support older versions of Query Monitor
• Ignore HTTP errors for license verification requests
• Prevent undefined index notice in ObjectCache::info()
• Prevent call to undefined function in Licensing::telemetry()

v1.7.2 - 2020-07-09

Added

• Use wp_opcache_invalidate() on drop-in
• Refactored Diagnostics to use Diagnostic objects

Changed

• Minor dashboard widget improvements
• Minor Query Monitor extension improvements
• Cleanup plugin options upon deactivation
• Disable free version when activating plugin to avoid confusion

Fixed

• Escape more HTML outputs
• Prevent unnecessary license verification requests

v1.7.1 - 2020-06-08

Fixed

• Always send setOption() values as string
• Fixed Query Monitor panels not showing up for some setups
• Fixed ArrayObjectCache fallback instantiation in wp_cache_init()
• Format all commands parameters using json_encode() in Query Monitor panel

v1.7.0 - 2020-05-30

Added

• Added support for Query Monitor
• Added context to license issues in the dashboard widget
• Show updates for must-use plugin and object cache drop-in

Changed

• Improved formatting of config values in diagnostics
• Don't highlight noeviction policy when maxTTL is set

Fixed

• Prevent unnecessary plugin update requests

v1.6.0 - 2020-05-11

Added

• Support PHP 7.0 and PhpRedis 3.1.1
• Indicate missing license token in dashboard widget

Changed

• Switched to WP_CLI\Utils\proc_open_compat() for wp redis cli
• Ping Redis during object cache initialization to catch LOADING errors

Fixed

• Fixed potential TypeError during upgrader_process_complete action

v1.5.1 - 2020-04-29

Fixed

• Fixed global group cache keys

Security

• Prevent XSS injection using cache group names when using Debug Bar

v1.5.0 - 2020-04-22

Added

• Added Requires PHP and Network to plugin header fields
• Show supported compression formats in site health

Changed

• Initialize plugin after all plugins have been loaded
• Improved the plugin version and basename detection
• Improved muting the wp redis cli auth warning
• Don't require setting port when connecting to a unix socket
• Validate config connection information before connecting
• Always inline widget styles (1015 bytes)
• Always inject plugin details into update_plugins transient
• Improved obfuscation of sensitive values
• Hide health link from plugin actions in WP <5.2 and multisite networks
• Prevent widget color clashing with color scheme

Fixed

• Fixed detection of multisite networks
• Fixed setting global and non-persistent groups
• Fixed notices in Debug Bar extension
• Fixed INFO command when using cluster

Removed

• Removed wp_clear_scheduled_hook for rediscache_report

v1.4.0 - 2020-02-27

Added

• Added support for storing alloptions key as hash
• Added wp redis cli command to spawn redis-cli process with configuration
• Support WP_REDIS_DIR constant in mu-plugin.php stub

Changed

• Ensure object cache drop-in is valid before flushing via CLI
• Colorized wp redis flush errors

Fixed

• Fixed typo in RedisConfigMissingException
• Fixed logs missing from Debug Bar
• Fixed cloning logic in PhpRedisObjectCache::storeInMemory()
• Inline styles when plugin is symlinked or located outside of web root

v1.3.0 - 2020-02-06

Added

• Added support for asynchronous flushing
• Added support for data compression using LZF and Zstandard
• Added network admin dashboard widget
• Added wp redis flush command with support for --async flag
• Automatically update drop-in after plugin update
• Show used and max memory in widget, site health and Debug Bar

Changed

• Switched to using ErrorLogLogger by default
• The ArrayLogger now extends ErrorLogLogger and vice versa
• The log levels now default to ['emergency', 'alert', 'critical', 'error']
• Changed log level of ObjectCache::error() from critical to error
• Introduced PhpRedisMissingException and PhpRedisOutdatedException
• Attempt direct filesystem access when WP filesystem initialization fails
• Renamed internal cache methods in PhpRedisObjectCache to be more descriptive
• Capture more errors by using Throwable in some places
• Moved Debug Bar HTML into template files
• Support setting log_levels configuration option to null

Removed

• Support setting token and password to null
• Removed captured errors from site health information

v1.2.1 - 2020-01-20

Added

• Added health checks link to plugin actions

Changed

• Made initialization exceptions more helpful
• Escape HTML in Debug Bar log messages
• Improved pinging cluster nodes

Fixed

• Fixed duplicate prefix when using cluster
• Fixed undefined index notices in Licensing
• Fixed a issue when loading widget styles as must-use plugin
• Resolved minor spelling mistakes

v1.2.0 - 2019-11-29

Added

• Added dashboard widget
• Added support for automatic WordPress updates
• Added diagnostic tests and information to Tools > Site Health
• Added token configuration option to set license token

Changed

• Disable object cache when deactivating/uninstalling the plugin

Fixed

• Fixed DebugBar integration on case-sensitive filesystems

v1.1.0 - 2019-11-19

Added

• Added log levels
• Added WP_REDIS_DISABLED environment variable

Changed

• Use PhpRedisConnection for each master when flushing clusters
• Obfuscate all non-null passwords in diagnostics
• Allow password to be null for more convenient fallbacks

Fixed

• Prevent timeouts when flushing database
• Use inline styles to clear floats in Debug Bar panels

Security

• Obfuscate password in constants section of diagnostics

v1.0.0 - 2019-11-01

Added

• Initial stable release