From 162a8cd550a620693c4ac61208aa7c22a11b4502 Mon Sep 17 00:00:00 2001
From: Jeff Stieler <jeff.m.stieler@gmail.com>
Date: Tue, 17 Dec 2019 16:21:44 -0500
Subject: [PATCH] Allow report caching layer to be filtered off.
 (https://github.com/woocommerce/woocommerce-admin/pull/3434)

* Add filter to conditionally disable report caching.

* Disable caching for Orders Stats unit tests.

Fixes the display of the last query when tests fail.
---
 .../src/API/Reports/DataStore.php             | 29 +++++++++++++++++--
 .../class-wc-tests-reports-orders-stats.php   | 13 +++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/plugins/woocommerce-admin/src/API/Reports/DataStore.php b/plugins/woocommerce-admin/src/API/Reports/DataStore.php
index b8e42d58c86..922855b98e8 100644
--- a/plugins/woocommerce-admin/src/API/Reports/DataStore.php
+++ b/plugins/woocommerce-admin/src/API/Reports/DataStore.php
@@ -119,6 +119,23 @@ class DataStore extends SqlQuery {
 		}
 	}
 
+	/**
+	 * Whether or not the report should use the caching layer.
+	 *
+	 * Provides an opportunity for plugins to prevent reports from using cache.
+	 *
+	 * @return boolean Whether or not to utilize caching.
+	 */
+	protected function should_use_cache() {
+		/**
+		 * Determines if a report will utilize caching.
+		 *
+		 * @param bool $use_cache Whether or not to use cache.
+		 * @param string $cache_key The report's cache key. Used to identify the report.
+		 */
+		return (bool) apply_filters( 'woocommerce_analytics_report_should_use_cache', true, $this->cache_key );
+	}
+
 	/**
 	 * Returns string to be used as cache key for the data.
 	 *
@@ -143,7 +160,11 @@ class DataStore extends SqlQuery {
 	 * @return mixed
 	 */
 	protected function get_cached_data( $cache_key ) {
-		return Cache::get( $cache_key );
+		if ( $this->should_use_cache() ) {
+			return Cache::get( $cache_key );
+		}
+
+		return false;
 	}
 
 	/**
@@ -154,7 +175,11 @@ class DataStore extends SqlQuery {
 	 * @return bool
 	 */
 	protected function set_cached_data( $cache_key, $value ) {
-		return Cache::set( $cache_key, $value );
+		if ( $this->should_use_cache() ) {
+			return Cache::set( $cache_key, $value );
+		}
+
+		return true;
 	}
 
 	/**
diff --git a/plugins/woocommerce-admin/tests/reports/class-wc-tests-reports-orders-stats.php b/plugins/woocommerce-admin/tests/reports/class-wc-tests-reports-orders-stats.php
index 773c21c68f5..74563534a0a 100644
--- a/plugins/woocommerce-admin/tests/reports/class-wc-tests-reports-orders-stats.php
+++ b/plugins/woocommerce-admin/tests/reports/class-wc-tests-reports-orders-stats.php
@@ -13,6 +13,19 @@ use \Automattic\WooCommerce\Admin\API\Reports\TimeInterval;
  * Class WC_Tests_Reports_Orders_Stats
  */
 class WC_Tests_Reports_Orders_Stats extends WC_Unit_Test_Case {
+	/**
+	 * Don't cache report data during these tests.
+	 */
+	public static function setUpBeforeClass() {
+		add_filter( 'woocommerce_analytics_report_should_use_cache', '__return_false' );
+	}
+
+	/**
+	 * Restore cache for other tests.
+	 */
+	public static function tearDownAfterClass() {
+		remove_filter( 'woocommerce_analytics_report_should_use_cache', '__return_false' );
+	}
 
 	/**
 	 * Test the calculations and querying works correctly for the base case of 1 order.