Changeset 5138

Timestamp:

03/09/2017 09:18:39 PM (8 years ago)

Author:

iandunn

Message:

Events API: Cache the results of get_location()

Location:

sites/trunk/api.wordpress.org/public_html/events/1.0

Files:

• index.php (modified) (4 diffs)
• tests/test-index.php (modified) (3 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -10 +10 @@
 
     bootstrap();
+    wp_cache_init();
 
     // The test suite just needs the functions defined and doesn't want any headers or output
@@ -15 +16 @@
         return;
     }
-
-    wp_cache_init();
 
     $cache_group   = 'events';
@@ -211 +210 @@
 
 function get_location( $args = array() ) {
+    global $cache_life, $cache_group;
+
+    $cache_key = 'get_location:' . md5( serialize( $args ) );
+    $location  = wp_cache_get( $cache_key, $cache_group );
+
+    if ( false !== $location ) {
+        return $location;
+    }
 
     // For a country request, no lat/long are returned.
@@ -285 +292 @@
     }
 
+    wp_cache_set( $cache_key, $location, $cache_group, $cache_life );
     return $location;
 }

sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php

@@ -49 +49 @@
 
 /**
+ * Add a cachebusting parameter to bypass the object cache
+ *
+ * Cache keys are generated based on the function's input arguments (e.g., get_location()), so adding a unique
+ * parameter on every function call ensures that the unit tests will never get a cached result.
+ *
+ * @param array $arguments
+ *
+ * @return array
+ */
+function add_cachebusting_parameter( $arguments ) {
+    $arguments['cachebuster'] = microtime( true );
+
+    return $arguments;
+}
+
+/**
  * Test `get_location()`
  *
@@ -60 +76 @@
 
     foreach ( $cases as $case_id => $case ) {
+        $case['input'] = add_cachebusting_parameter( $case['input'] );
         $actual_result = get_location( $case['input'] );
 
@@ -605 +622 @@
 
     foreach ( $cases as $case_id => $case ) {
+        $case['input'] = add_cachebusting_parameter( $case['input'] );
         $actual_result = get_city_from_coordinates( $case['input']['latitude'], $case['input']['longitude'] );
         $passed        = $case['expected'] === $actual_result;