Changeset 11074

Timestamp:

09/09/2016 03:54:32 PM (9 years ago)

Author:

boonebgorges

Message:

Groups: Bust incrementor cache when modifying group taxonomy terms.

Group taxonomy terms, such as those belonging to bp_group_type, can
affect the results of BP_Groups_Group::get() queries. As such,
changing a group taxonomy term must invalidate the query cache.

WP's taxonomy API doesn't provide a direct method to determine whether
the object whose terms are being modified is a BuddyPress group. So
we infer the object type by looking at the object types that are
registered for the specified taxonomy; if bp_group is one of them, we
invalidate. This could result in cases where the cache is being purged
unnecessarily, but better safe than sorry.

See #5451.

Location:

trunk

Files:

• src/bp-groups/bp-groups-cache.php (modified) (1 diff)
• tests/phpunit/testcases/groups/class-bp-groups-group.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-cache.php

@@ -275 +275 @@
 add_action( 'deleted_group_meta',      'bp_groups_reset_cache_incrementor' );
 add_action( 'added_group_meta',        'bp_groups_reset_cache_incrementor' );
+
+/**
+ * Reset cache incrementor for Groups component when a group's taxonomy terms change.
+ *
+ * We infer that a group is being affected by looking at the objects belonging
+ * to the taxonomy being affected.
+ *
+ * @since 2.7.0
+ *
+ * @param int    $object_id ID of the item whose terms are being modified.
+ * @param array  $terms     Array of object terms.
+ * @param array  $tt_ids    Array of term taxonomy IDs.
+ * @param string $taxonomy  Taxonomy slug.
+ * @return bool True on success, false on failure.
+ */
+function bp_groups_reset_cache_incrementor_on_group_term_change( $object_id, $terms, $tt_ids, $taxonomy ) {
+    $tax_object = get_taxonomy( $taxonomy );
+    if ( $tax_object && in_array( 'bp_group', $tax_object->object_type ) ) {
+        return bp_groups_reset_cache_incrementor();
+    }
+
+    return false;
+}
+add_action( 'bp_set_object_terms', 'bp_groups_reset_cache_incrementor_on_group_term_change', 10, 4 );
+
+/**
+ * Reset cache incrementor for Groups component when a group's taxonomy terms are removed.
+ *
+ * We infer that a group is being affected by looking at the objects belonging
+ * to the taxonomy being affected.
+ *
+ * @since 2.7.0
+ *
+ * @param int    $object_id ID of the item whose terms are being modified.
+ * @param array  $terms     Array of object terms.
+ * @param string $taxonomy  Taxonomy slug.
+ * @return bool True on success, false on failure.
+ */
+function bp_groups_reset_cache_incrementor_on_group_term_remove( $object_id, $terms, $taxonomy ) {
+    $tax_object = get_taxonomy( $taxonomy );
+    if ( $tax_object && in_array( 'bp_group', $tax_object->object_type ) ) {
+        return bp_groups_reset_cache_incrementor();
+    }
+
+    return false;
+}
+add_action( 'bp_remove_object_terms', 'bp_groups_reset_cache_incrementor_on_group_term_remove', 10, 3 );
 
 /* List actions to clear super cached pages on, if super cache is installed */

trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -567 +567 @@
     /**
      * @group cache
+     * @group group_types
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_query_caches_should_be_busted_by_group_term_change() {
+        global $wpdb;
+
+        bp_groups_register_group_type( 'foo' );
+        bp_groups_register_group_type( 'bar' );
+
+        $groups = $this->factory->group->create_many( 2 );
+        bp_groups_set_group_type( $groups[0], 'foo' );
+        bp_groups_set_group_type( $groups[1], 'bar' );
+
+        $found1 = BP_Groups_Group::get( array(
+            'group_type' => 'foo',
+        ) );
+
+        $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found1['groups'], 'id' ) );
+
+        bp_groups_set_group_type( $groups[1], 'foo' );
+
+        $found2 = BP_Groups_Group::get( array(
+            'group_type' => 'foo',
+        ) );
+
+        $this->assertEqualSets( array( $groups[0], $groups[1] ), wp_list_pluck( $found2['groups'], 'id' ) );
+    }
+
+    /**
+     * @group cache
+     * @group group_types
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_query_caches_should_be_busted_by_group_term_removal() {
+        global $wpdb;
+
+        bp_groups_register_group_type( 'foo' );
+
+        $groups = $this->factory->group->create_many( 2 );
+        bp_groups_set_group_type( $groups[0], 'foo' );
+        bp_groups_set_group_type( $groups[1], 'foo' );
+
+        $found1 = BP_Groups_Group::get( array(
+            'group_type' => 'foo',
+        ) );
+
+        $this->assertEqualSets( array( $groups[0], $groups[1] ), wp_list_pluck( $found1['groups'], 'id' ) );
+
+        bp_groups_remove_group_type( $groups[1], 'foo' );
+
+        $found2 = BP_Groups_Group::get( array(
+            'group_type' => 'foo',
+        ) );
+
+        $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found2['groups'], 'id' ) );
+    }
+
+    /**
+     * @group cache
      * @ticket BP5451
      * @ticket BP6643