Changeset 7813

Timestamp:

02/06/2014 08:33:50 PM (11 years ago)

Author:

boonebgorges

Message:

Object caching for the more frequently used items in bp-notifications

Several notifications queries are made on every pageload:

• an unread count to set up navigation
• an unread count for the toolbar
• the notification items themselves for the toolbar

These three queries actually result in the identical SQL query, so we can
eliminate two of them by caching the value by the pageload. With persistent
caching, the performance benefits are obviously even greater.

The chosen technique for caching here is 'all_for_user_'. This makes
invalidation fairly straightforward, because we can simply bust the
'all_for_user_x' cache whenever a save or delete takes place on a notification
item that is related to user_x. For more complex parts of the notification
component (such as the notifications page itself), if caching is desired,
it'll probably make sense to split the query and cache individual items.

Fixes #5377

Location:

trunk

Files:

• bp-notifications/bp-notifications-cache.php (added)
• bp-notifications/bp-notifications-classes.php (modified) (3 diffs)
• bp-notifications/bp-notifications-functions.php (modified) (2 diffs)
• bp-notifications/bp-notifications-loader.php (modified) (1 diff)
• tests/testcases/notifications/functions.php (added)

trunk/bp-notifications/bp-notifications-classes.php

@@ -123 +123 @@
         $data_format = array( '%d', '%d', '%d', '%s', '%s', '%s', '%d' );
 
+        do_action_ref_array( 'bp_notification_before_save', array( &$this ) );
+
         // Update
         if ( ! empty( $this->id ) ) {
@@ -139 +141 @@
             $retval   = $wpdb->insert_id;
         }
+
+        do_action_ref_array( 'bp_notification_after_save', array( &$this ) );
 
         // Return the result
@@ -674 +678 @@
         $where = self::get_query_clauses( $args );
 
+        do_action( 'bp_notification_before_delete', $args );
+
         return self::_delete( $where['data'], $where['format'] );
     }

trunk/bp-notifications/bp-notifications-functions.php

@@ -122 +122 @@
 
     // Setup local variables
-    $bp                    = buddypress();
-    $notifications         = BP_Notifications_Notification::get( array(
-        'user_id' => $user_id
-    ) );
+    $bp = buddypress();
+
+    // Get notifications out of the cache, or query if necessary
+    $notifications = wp_cache_get( 'all_for_user_' . $user_id, 'bp_notifications' );
+    if ( false === $notifications ) {
+        $notifications = BP_Notifications_Notification::get( array(
+            'user_id' => $user_id
+        ) );
+        wp_cache_set( 'all_for_user_' . $user_id, $notifications, 'bp_notifications' );
+    }
+
     $grouped_notifications = array(); // Notification groups
     $renderable            = array(); // Renderable notifications
@@ -500 +507 @@
 
     // Get the notifications, and count them
-    $notifications = BP_Notifications_Notification::get( array(
-        'user_id' => $user_id,
-    ) );
+    $notifications = wp_cache_get( 'all_for_user_' . $user_id, 'bp_notifications' );
+    if ( false === $notifications ) {
+        $notifications = BP_Notifications_Notification::get( array(
+            'user_id' => $user_id,
+        ) );
+        wp_cache_set( 'all_for_user_' . $user_id, $notifications, 'bp_notifications' );
+    }
 
     $count = ! empty( $notifications ) ? count( $notifications ) : 0;

trunk/bp-notifications/bp-notifications-loader.php

@@ -50 +50 @@
             'template',
             'functions',
+            'cache',
         );