Changeset 7188

Timestamp:

05/09/2018 06:06:54 PM (8 years ago)

Author:

coreymckrill

Message:

Events: Add WP15 promo when no local WP15 events

• Add function to detect WP15 events in a list
• Add function to check conditions and add promo item if conditions are met
• Add unit tests

Location:

sites/trunk/api.wordpress.org/public_html/events/1.0

Files:

• index.php (modified) (2 diffs)
• tests/test-index.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -165 +165 @@
 
         $events = get_events( $event_args );
+        $events = maybe_add_wp15_promo( $events, $_SERVER['HTTP_USER_AGENT'], time() );
         $events = add_regional_wordcamps( $events, $_SERVER['HTTP_USER_AGENT'] );
 
@@ -982 +983 @@
 
 /**
+ * Add a special WP15 meetup event to the Events Widget in Core if the user location doesn't already have a
+ * WP15 event in the list.
+ *
+ * @param array  $local_events The list of events for a particular location.
+ * @param string $user_agent   The User Agent string of the client requesting the events.
+ * @param int    $time         Unix timestamp.
+ *
+ * @return array
+ */
+function maybe_add_wp15_promo( $local_events, $user_agent, $time ) {
+    if ( ! is_client_core( $user_agent ) ) {
+        return $local_events;
+    }
+
+    if ( $time < strtotime( 'April 27th, 2018' ) || $time > strtotime( 'May 28th, 2018' ) ) {
+        return $local_events;
+    }
+
+    $wp15_events = array_filter( $local_events, function( $event ) {
+        return is_wp15_event( $event['title'] );
+    } );
+
+    if ( empty( $wp15_events ) ) {
+        $promo = array(
+            'type'       => 'meetup',
+            'title'      => 'WP15',
+            'url'        => 'https://wordpress.org/news/2018/04/celebrate-the-wordpress-15th-anniversary-on-may-27/',
+            'meetup'     => null,
+            'meetup_url' => null,
+            'date'       => '2018-05-27 12:00:00',
+            'location'   => array(
+                'location' => 'Everywhere',
+            ),
+        );
+
+        array_unshift( $local_events, $promo );
+    }
+
+    return $local_events;
+}
+
+/**
+ * Determine if a meetup event is a WP15 celebration, based on the event title.
+ *
+ * Note that unlike the version of this function in the `wp15-meetup-events` plugin, the event data we're parsing here
+ * doesn't include a meetup event ID or a description, so we must rely on the title. In testing, this resulted in about
+ * 10% fewer events identified.
+ *
+ * @see https://meta.trac.wordpress.org/browser/sites/trunk/wp15.wordpress.net/public_html/content/plugins/wp15-meetup-events/wp15-meetup-events.php#L141
+ *
+ * @param string $title
+ *
+ * @return bool
+ */
+function is_wp15_event( $title ) {
+    $match    = false;
+    $keywords = array(
+        'wp15', '15 year', '15 ano', '15 año', '15 candeline', 'wordt 15',
+        'anniversary', 'aniversário', 'aniversario', 'birthday', 'cumpleaños',
+        'Tanti auguri'
+    );
+
+    foreach ( $keywords as $keyword ) {
+        if ( false !== stripos( $title, $keyword ) ) {
+            $match = true;
+            break;
+        }
+    }
+
+    return $match;
+}
+
+/**
  * Create a bounded latitude/longitude box of x KM around specific coordinates.
  *

sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php

@@ -23 +23 @@
     $tests_failed += test_get_events_country_restriction();
     $tests_failed += test_add_regional_wordcamps();
+    $tests_failed += test_maybe_add_wp15_promo();
     $tests_failed += test_build_response();
     $tests_failed += test_is_client_core();
@@ -1207 +1208 @@
 
 /**
+ * Test `maybe_add_wp15_promo()`
+ *
+ * @return int
+ */
+function test_maybe_add_wp15_promo() {
+    $failed = 0;
+
+    $local_events_yes_wp15 = array(
+        array(
+            'type'       => 'meetup',
+            'title'      => 'WordPress 15th Anniversary Celebration',
+            'url'        => 'https://www.meetup.com/pdx-wp/events/250109566/',
+            'meetup'     => 'Portland WordPress Meetup',
+            'meetup_url' => 'https://www.meetup.com/pdx-wp/',
+            'date'       => '2018-05-27 12:00:00',
+            'location'   => array(
+                'location'  => 'Portland, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 45.540115,
+                'longitude' => - 122.630699,
+            ),
+        ),
+        array(
+            'type'       => 'wordcamp',
+            'title'      => 'WordCamp Portland, Oregon, USA',
+            'url'        => 'https://2018.portland.wordcamp.org',
+            'meetup'     => null,
+            'meetup_url' => null,
+            'date'       => '2018-11-03 00:00:00',
+            'location'   => array(
+                'location'  => 'Portland, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 45.540115,
+                'longitude' => - 122.630699,
+            ),
+        ),
+    );
+
+    $local_events_no_wp15 = array(
+        array(
+            'type'       => 'meetup',
+            'title'      => 'Kickoff: Meet and greet, roundtable discussion',
+            'url'        => 'https://www.meetup.com/Corvallis-WordPress-Meetup/events/250327006/',
+            'meetup'     => 'Corvallis WordPress Meetup',
+            'meetup_url' => 'https://www.meetup.com/Corvallis-WordPress-Meetup/',
+            'date'       => '2018-05-22 18:30:00',
+            'location'   => array(
+                'location'  => 'Corvallis, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 44.563564,
+                'longitude' => - 123.26095,
+            ),
+        ),
+        array(
+            'type'       => 'wordcamp',
+            'title'      => 'WordCamp Portland, Oregon, USA',
+            'url'        => 'https://2018.portland.wordcamp.org',
+            'meetup'     => null,
+            'meetup_url' => null,
+            'date'       => '2018-11-03 00:00:00',
+            'location'   => array(
+                'location'  => 'Portland, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 45.540115,
+                'longitude' => - 122.630699,
+            ),
+        ),
+    );
+
+    $local_events_added_wp15 = array(
+        array(
+            'type'       => 'meetup',
+            'title'      => 'WP15',
+            'url'        => 'https://wordpress.org/news/2018/04/celebrate-the-wordpress-15th-anniversary-on-may-27/',
+            'meetup'     => null,
+            'meetup_url' => null,
+            'date'       => '2018-05-27 12:00:00',
+            'location'   => array(
+                'location' => 'Everywhere',
+            ),
+        ),
+        array(
+            'type'       => 'meetup',
+            'title'      => 'Kickoff: Meet and greet, roundtable discussion',
+            'url'        => 'https://www.meetup.com/Corvallis-WordPress-Meetup/events/250327006/',
+            'meetup'     => 'Corvallis WordPress Meetup',
+            'meetup_url' => 'https://www.meetup.com/Corvallis-WordPress-Meetup/',
+            'date'       => '2018-05-22 18:30:00',
+            'location'   => array(
+                'location'  => 'Corvallis, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 44.563564,
+                'longitude' => - 123.26095,
+            ),
+        ),
+        array(
+            'type'       => 'wordcamp',
+            'title'      => 'WordCamp Portland, Oregon, USA',
+            'url'        => 'https://2018.portland.wordcamp.org',
+            'meetup'     => null,
+            'meetup_url' => null,
+            'date'       => '2018-11-03 00:00:00',
+            'location'   => array(
+                'location'  => 'Portland, OR, USA',
+                'country'   => 'us',
+                'latitude'  => 45.540115,
+                'longitude' => - 122.630699,
+            ),
+        ),
+    );
+
+    $user_agent = 'WordPress/4.9; https://example.org';
+
+    $time_before_date_range = 1523295832;
+    $time_during_date_range = 1525887832;
+
+    printf( "\n\nRunning %d maybe_add_wp15_promo() tests\n", 4 );
+
+    // Test that the promo is added if there is not already a WP15 event.
+    $events_promo_added = maybe_add_wp15_promo( $local_events_no_wp15, $user_agent, $time_during_date_range );
+
+    if ( $events_promo_added !== $local_events_added_wp15 ) {
+        $failed++;
+        output_results( 'needs-promo', false, $local_events_added_wp15, $events_promo_added );
+    }
+
+    // Test that no promo is added if there is already a WP15 event.
+    $events_already_has_one = maybe_add_wp15_promo( $local_events_yes_wp15, $user_agent, $time_during_date_range );
+
+    if ( $events_already_has_one !== $local_events_yes_wp15 ) {
+        $failed++;
+        output_results( 'already-has-event', false, $local_events_yes_wp15, $events_already_has_one );
+    }
+
+    // Test that no changes are made if the user agent isn't Core.
+    $events_no_user_agent = maybe_add_wp15_promo( $local_events_no_wp15, '', $time_during_date_range );
+
+    if ( $events_no_user_agent !== $local_events_no_wp15 ) {
+        $failed++;
+        output_results( 'no-user-agent', false, $local_events_no_wp15, $events_no_user_agent );
+    }
+
+    // Test that no promo is added if the time is outside the date range.
+    $events_outside_date_range = maybe_add_wp15_promo( $local_events_no_wp15, $user_agent, $time_before_date_range );
+
+    if ( $events_outside_date_range !== $local_events_no_wp15 ) {
+        $failed++;
+        output_results( 'outside-date-range', false, $local_events_no_wp15, $events_outside_date_range );
+    }
+
+    return $failed;
+}
+
+/**
  * Stub to simulate cache misses, so that the tests always get fresh results
  *