Changeset 11943

Timestamp:

07/06/2022 05:47:25 PM (3 years ago)

Author:

iandunn

Message:

GP Profiles: Ignore updates that aren't initiated by a user.

Functions like WordPressdotorg\GlotPress\Plugin_Directory\Sync\Translation_Sync::sync_translations() can trigger a create() or save(), but only actions initiated by a contributor should trigger a notification.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-profiles

Files:

• profiles.php (modified) (2 diffs)
• tests/e2e.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-profiles/profiles.php

@@ -23 +23 @@
 }
 
-add_action( 'gp_translation_created', __NAMESPACE__ . '\add_single_translation_activity' );
-add_action( 'gp_translation_saved', __NAMESPACE__ . '\add_single_translation_activity', 10, 2 );
-add_action( 'gp_translation_set_bulk_action_post', __NAMESPACE__ . '\add_bulk_translation_activity', 10, 4 );
+add_action( 'plugins_loaded', __NAMESPACE__ . '\register_callbacks' );
+
+function register_callbacks() : void {
+    // Ignore programmatic actions, only notify for user-initiated actions.
+    if ( empty( $_POST ) || ! is_user_logged_in() ) {
+        return;
+    }
+
+    add_action( 'gp_translation_created', __NAMESPACE__ . '\add_single_translation_activity' );
+    add_action( 'gp_translation_saved', __NAMESPACE__ . '\add_single_translation_activity', 10, 2 );
+    add_action( 'gp_translation_set_bulk_action_post', __NAMESPACE__ . '\add_bulk_translation_activity', 10, 4 );
+}
 
 /**
@@ -51 +60 @@
 
     /*
+     * Regular user is suggesting a string.
+     *
      * `GP_Route_Translation::translations_post` saves the translation as `waiting` for all users. Then, if the
-     * user is an editor, it saves it second time to update the status to `current`. We can ignore the first save
-     * since two avoid two bumps for a single action.
+     * user is an editor, it saves it a second time to update the status to `current`. We can ignore the first save,
+     * to avoid two notifications for a single action.
      */
     if ( 'waiting' === $new_translation->status && ! $current_user_is_editor ) {
         $type = 'glotpress_translation_suggested';
-    } elseif ( 'current' === $new_translation->status && 'current' !== $previous_translation->status ) {
+
+    // Editor is approving a suggested string.
+    // Avoid sending a notification when a `current` post is re-saved, like when dismissing warnings.
+    } elseif ( 'current' === $new_translation->status && isset( $previous_translation->status ) && 'current' !== $previous_translation->status ) {
         $type = 'glotpress_translation_approved';
+
     } else {
         return;

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-profiles/tests/e2e.php

@@ -47 +47 @@
     GlotPress_Profiles\add_single_translation_activity( $translation );
 
+    $previous_translation = new GP_Translation( array(
+        'user_id' => $user->ID,
+        'status'  => 'waiting',
+    ) );
     $translation = new GP_Translation( array(
         'user_id' => $user->ID,
         'status'  => 'current',
     ) );
-    GlotPress_Profiles\add_single_translation_activity( $translation );
+    GlotPress_Profiles\add_single_translation_activity( $translation, $previous_translation );
 
     echo "\nThe daily digest count should have been bumped on https://profiles.wordpress.org/$user->user_nicename/ \n";