Changeset 8907

Timestamp:

06/03/2019 02:36:46 PM (5 years ago)

Author:

vedjain

Message:

WC: Refactor participant notifier to fix design flaw. See 703. See desc.

We currently assume that a profile will be associated with only single WordCamp, and handle adding and removing badges (speaker/organizer) with this assumption.
However, this assumption is incorrect and causes badge disappearing bug, as described in 703.

This patch refactors the participant-notifier class such that:

1. Whenever a badge is added, an entry is made in to usermeta table, with meta key as wc_{post_type}_{blog_id}_{post_id]. This has following benefits:
   1. Usermeta table is shared across all WordCamp, so this can act as a central place to record whenever a badge is added for a user.
   2. Since meta key columns is indexed, a count query can be done on wc_{post_type}_% with user_id = {user_id} clause.

Because of how MySQL stores indexes, prefix queries are also as performant as full text queries. This gives us ability to find out in how many WordCamp a user is registered as a speaker/organizer using a single performant query.
We can use the results of this query to decide if we want to remove a badge or not.

2. In block editor, as per ​https://github.com/WordPress/gutenberg/issues/12897, POST data will not be there when publishing a draft post. This patch adds a workaround by checking if we need to add/remove badge even if both previous and next status are publish.
3. Uses a meta data to prevent duplicate activity log request. This is necessary because of workaround described in above patch.

Fixes 703

File:

• sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-participation-notifier/wordcamp-participation-notifier.php (modified) (3 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-participation-notifier/wordcamp-participation-notifier.php

@@ -113 +113 @@
      * or organizer post changes.
      *
+     * IMPORTANT NOTE: If a draft post is published via block editor, we will have to add badges and activity here instead of `post_published_or_unpublished` method.
+     * This is because when post is updated via Block editor, the status change request will not have any POST data, see @link https://github.com/WordPress/gutenberg/issues/12897
+     *
      * @todo The handler doesn't support removing activity, but maybe do that here if support is added.
      *
@@ -118 +121 @@
      */
     protected function published_post_updated( $post ) {
-        $previous_user_id = $this->get_saved_wporg_user_id( $post );
-        $new_user_id      = $this->get_new_wporg_user_id( $post );
-
-        // There is no username, or it hasn't changed, so we don't need to do anything here.
-        if ( $previous_user_id === $new_user_id ) {
-            return;
-        }
-
-        // todo change this to use an if/elseif/elseif structure, just to be safe
-
-        // A new username was added, so add the activity and association.
-        if ( $new_user_id && ! $previous_user_id ) {
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_activity_payload( $post ) );
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'add' ) );
-        }
-
-        // The username was removed, so remove the association.
-        if ( ! $new_user_id && $previous_user_id ) {
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'remove', $previous_user_id ) );
-        }
-
-        // The username changed, so remove the association from the previous user and add both the activity and association to the new user.
-        if ( $new_user_id && $previous_user_id ) {
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'remove', $previous_user_id ) );
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_activity_payload( $post ) );
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'add' ) );
+        $previous_user_id       = $this->get_saved_wporg_user_id( $post );
+        $new_user_id            = $this->get_new_wporg_user_id( $post );
+        $published_activity_key = $this->get_published_activity_key( $post );
+
+
+        if ( $previous_user_id ) {
+            $this->maybe_remove_badge( $post, $previous_user_id );
+        }
+
+        if ( $new_user_id ) {
+
+            if ( ! get_user_meta( $new_user_id, $published_activity_key ) ) {
+                $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_activity_payload( $post ) );
+                update_user_meta( $new_user_id, $published_activity_key, true );
+            }
+
+            $this->add_badge( $post, $new_user_id );
         }
     }
@@ -159 +153 @@
     protected function post_published_or_unpublished( $new_status, $old_status, $post ) {
         if ( 'publish' == $new_status ) {
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_activity_payload( $post ) );
-            $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'add' ) );
+            $user_id = $this->get_new_wporg_user_id( $post );
+
+            if ( ! get_user_meta( $user_id, $this->get_published_activity_key( $post ) ) ) {
+                $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_activity_payload( $post ) );
+                update_user_meta( $user_id, $this->get_published_activity_key( $post ), true );
+            }
+
+            $this->add_badge( $post, $user_id );
         } elseif( 'publish' == $old_status ) {
-            // Get the $user_id from post meta instead of $_POST in case it changed during the unpublish update.
-            // This makes sure that the association is removed from the same user that it was originally added to.
-
             $user_id = $this->get_saved_wporg_user_id( $post );
+            $this->maybe_remove_badge( $post, $user_id );
+        }
+    }
+
+    /**
+     * Makes request to Profile URL to add badge to organizer/speaker. Also adds a meta entry which is used by `maybe_remove_badge` function to figure out whether to remove a badge or not.
+     *
+     * @param WP_Post $post     Speaker/Organizer Post Object.
+     * @param int     $user_id  User ID to add badge for.
+     */
+    protected function add_badge( $post, $user_id ) {
+        if ( ! in_array( $post->post_type, [ 'wcb_speaker', 'wcb_organizer' ] ) || ! $user_id ) {
+            return;
+        }
+
+        $meta_key = $this->get_user_meta_key( $post );
+
+        // User already has a badge. Prevent wasteful API call and bail.
+        if ( get_user_meta( $user_id, $meta_key ) ) {
+            return;
+        }
+
+        update_user_meta( $user_id ,$meta_key, true );
+
+        $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'add', $user_id ) );
+    }
+
+    /**
+     * Makes a request to remove speaker/organizer badge from a user if the user is removed from all WordCamp where they were speaker/organizer.
+     *
+     * @param WP_Post $post     Speaker/Organizer Post Object.
+     * @param int     $user_id  User ID to remove the badge for.
+     */
+    protected function maybe_remove_badge( $post, $user_id ) {
+        global $wpdb;
+
+        if ( ! in_array( $post->post_type, [ 'wcb_speaker', 'wcb_organizer' ] ) ) {
+            return;
+        }
+
+        $meta_key = $this->get_user_meta_key( $post );
+
+        // User does not have a badge anyway. Prevent wasteful API call and bail.
+        if ( ! $user_id || ! get_user_meta( $user_id, $meta_key ) ) {
+            return;
+        }
+
+        delete_user_meta( $user_id, $meta_key );
+
+        $meta_key_prefix = $this->get_user_meta_key_prefix( $post );
+
+        $count = $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM $wpdb->usermeta
+                WHERE
+                    user_id = %d
+                    AND meta_key like '$meta_key_prefix%';
+                ",
+                $user_id
+            )
+        );
+
+        if ( '0' === $count ) {
             $this->remote_post( self::PROFILES_HANDLER_URL, $this->get_post_association_payload( $post, 'remove', $user_id ) );
         }
+    }
+
+    /**
+     * Meta key to store user metadata for organizer/speaker association.
+     *
+     * We store meta_key in form of wc_{post_type}_{blog_id}_{post_id} because
+     *
+     * 1. Since meta_key is indexed, count query on wc_{post_type}% for a specific user_id will be performant. We will use this query to figure out if we want to remove a badge.
+     *
+     * 2. Adding separate rows per WordCamp per User per Post allows us to avoid incorrect badge removal in some cases.
+     * For egs, when an organizer accidentally adds same wporg name to multiple speaker post, and then corrects their mistake by removing it in all but one post.
+     *
+     * 3. Because of verbosity, deleting user meta entry will be less error prone.
+     *
+     * @param WP_Post $post Sponsor/Organizer post object.
+     *
+     * @return string
+     */
+    private function get_user_meta_key( $post ) {
+        return $this->get_user_meta_key_prefix( $post ) . get_current_blog_id() . '_' . $post->ID;
+    }
+
+    /**
+     * Meta key prefix to store user metadata for organizer/speaker association. This prefix is used in count query to figure if a user should have an organizer/speaker badge.
+     *
+     * @param WP_Post $post Sponsor/Organizer post object.
+     *
+     * @return string
+     */
+    private function get_user_meta_key_prefix( $post ) {
+        return 'wc_' .  $post->post_type . '_';
+    }
+
+    /**
+     * Meta key name to store user matadata for whether activity is published or not.
+     * Used to prevent publishing duplicate activities.
+     *
+     * @param WP_Post $post Post object, will be organizer/sponsor/tix_attendee.
+     *
+     * @return string
+     */
+    private function get_published_activity_key( $post ) {
+        return 'wc_published_activity_' . get_current_blog_id() . "_$post->ID";
     }