Changeset 13154

Timestamp:

11/20/2021 02:21:24 PM (2 years ago)

Author:

imath

Message:

Avoid generating many new_avatar activities in a short time frame

For an hour time frame, if a user publishes many new_avatar activities, only the latest one will be kept.

Props oztaser

See #8581

Location:

trunk

Files:

• src/bp-members/bp-members-activity.php (modified) (1 diff)
• tests/phpunit/testcases/members/activity.php (modified) (1 diff)

trunk/src/bp-members/bp-members-activity.php

@@ -193 +193 @@
     $user_id = apply_filters( 'bp_members_new_avatar_user_id', $user_id );
 
+    // Check to make sure that a user has just one `new_avatar` activity per throttle time.
+    $last_new_avatar_activity = bp_activity_get(
+        array(
+            'user_id'   => $user_id,
+            'component' => buddypress()->members->id,
+            'type'      => 'new_avatar',
+            'per_page'  => 1,
+        )
+    );
+
+    if ( ! empty( $last_new_avatar_activity['activities'] ) ) {
+        /**
+         * Filters the throttle time, in seconds, used to prevent generating multiple `new_avatar` activity
+         * in a short amount of time.
+         *
+         * @since 10.0.0
+         *
+         * @param int $value Throttle time, in seconds.
+         */
+        $throttle_period = apply_filters( 'bp_members_new_avatar_throttle_time', HOUR_IN_SECONDS );
+        $then            = strtotime( $last_new_avatar_activity['activities'][0]->date_recorded );
+        $now             = bp_core_current_time( true, 'timestamp' );
+
+        // Delete the old activity.
+        if ( ( $now - $then ) < $throttle_period ) {
+            bp_activity_delete(
+                array(
+                    'id' => $last_new_avatar_activity['activities'][0]->id,
+                )
+            );
+        }
+    }
+
     // Add the activity.
-    bp_activity_add( array(
-        'user_id'   => $user_id,
-        'component' => buddypress()->members->id,
-        'type'      => 'new_avatar'
-    ) );
+    bp_activity_add(
+        array(
+            'user_id'   => $user_id,
+            'component' => buddypress()->members->id,
+            'type'      => 'new_avatar',
+        )
+    );
 }
 add_action( 'bp_members_avatar_uploaded', 'bp_members_new_avatar_activity' );

trunk/tests/phpunit/testcases/members/activity.php

@@ -94 +94 @@
         $this->assertSame( $expected, $found );
     }
+
+    /**
+     * @group bp_members_new_avatar_activity
+     */
+    public function test_bp_members_new_avatar_activity_throttled() {
+        $u = self::factory()->user->create();
+        $a = self::factory()->activity->create( array(
+            'component' => 'members',
+            'type'      => 'new_avatar',
+            'user_id'   => $u,
+        ) );
+
+        bp_members_new_avatar_activity( $u );
+
+        $new_avatar_activities = bp_activity_get( array(
+            'user_id'     => $u,
+            'component'   => buddypress()->members->id,
+            'type'        => 'new_avatar',
+            'count_total' => 'count_query',
+        ) );
+
+        $this->assertEquals( 1, $new_avatar_activities['total'] );
+        $this->assertNotSame( $a, $new_avatar_activities['activities'][0]->id );
+    }
+
+    /**
+     * @group bp_members_new_avatar_activity
+     */
+    public function test_bp_members_new_avatar_activity_outside_of_throttle_time() {
+        $u = self::factory()->user->create();
+
+        $time      = strtotime( bp_core_current_time() );
+        $prev_time = date( 'Y-m-d H:i:s', $time - ( 121 * HOUR_IN_SECONDS ) );
+
+        $a = self::factory()->activity->create( array(
+            'component'     => 'members',
+            'type'          => 'new_avatar',
+            'user_id'       => $u,
+            'recorded_time' => $prev_time,
+        ) );
+
+        bp_members_new_avatar_activity( $u );
+
+        $new_avatar_activities = bp_activity_get( array(
+            'user_id'     => $u,
+            'component'   => buddypress()->members->id,
+            'type'        => 'new_avatar',
+            'count_total' => 'count_query',
+        ) );
+
+        $this->assertEquals( 2, $new_avatar_activities['total'] );
+    }
 }