<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[9750] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Remove duplicate events after all events have been added.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/9750">9750</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/9750","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-04-20 22:28:21 +0000 (Mon, 20 Apr 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Events: Remove duplicate events after all events have been added.
`pin_next_online_wordcamp()` will be added in a subsequent commit, and at that point this function will need to be called after all events from been added dynamically.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2020-04-20 22:28:17 UTC (rev 9749)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2020-04-20 22:28:21 UTC (rev 9750)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,6 +182,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $location
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $events = remove_duplicate_events( $events );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Internal location data cannot be exposed in the response, see get_location().
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $location['internal'] ) && $location['internal'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Let the client know that a location was successfully determined based on their IP
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1135,20 +1137,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $regional_wordcamps[] = $data['event'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Remove duplicates events.
- * Favor the regional event since it'll be pinned to the top.
- */
- foreach ( $regional_wordcamps as $regional_event ) {
- $local_events = array_filter( $local_events, function( $local_event ) use ( $regional_event ) {
- if ( parse_url( $regional_event['url'], PHP_URL_HOST ) === parse_url( $local_event['url'], PHP_URL_HOST ) ) {
- return false;
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return true;
- } );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array_merge( $regional_wordcamps, $local_events );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1273,6 +1263,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Remove duplicate events, based on the URL.
+ *
+ * This is needed because sometimes an event gets added from multiple functions; e.g., `get_events()` and also `maybe_add_regional_wordcamps()` and/or `pin_next_online_wordcamp()`.
+ *
+ * @param array $events
+ *
+ * @return array
+ */
+function remove_duplicate_events( $events ) {
+ // Re-index them by a URL to overwrite duplicates
+ $unique_events = array();
+
+ foreach ( $events as $event ) {
+ $parsed_url = parse_url( $event['url'] );
+
+ // Take all essential parts to cover current URL structures, and potential future ones.
+ $normalized_url = sprintf(
+ '%s%s%s',
+ $parsed_url['host'],
+ $parsed_url['path'],
+ $parsed_url['query']
+ );
+ $normalized_url = str_replace( '/', '', $normalized_url );
+
+ $unique_events[ $normalized_url ] = $event;
+ }
+
+ // Restore integer keys.
+ return array_values( $unique_events );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Create a bounded latitude/longitude box of x KM around specific coordinates.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param float $lat The latitude of the location.
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2020-04-20 22:28:17 UTC (rev 9749)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2020-04-20 22:28:21 UTC (rev 9750)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,6 +26,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_build_response();
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_is_client_core();
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_iso_3166_2_country_codes();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tests_failed += test_remove_duplicate_events();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $wpdb->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_time = array_sum( array_column( $wpdb->queries, 1 ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1257,23 +1258,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_expect_no_changes['other-user-agent'] = maybe_add_regional_wordcamps( $local_events, $region_data, $other_user_agent, $time_during_promo_phase_1, $location_country_within_region );
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_expect_changes['core-user-agent'] = maybe_add_regional_wordcamps( $local_events, $region_data, $core_user_agent, $time_during_promo_phase_1, $location_country_within_region );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // There should only be one entry for an event, even if the local event array already contains the regional event.
- $tests_expect_no_changes['duplicate-event'] = maybe_add_regional_wordcamps( array( $region_data['us']['event'] ), $region_data, $core_user_agent, $time_during_promo_phase_1, $location_country_within_region );
-
</del><span class="cx" style="display: block; padding: 0 10px"> foreach ( $tests_expect_no_changes as $name => $result ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch ( $name ) {
- case 'duplicate-event':
- if ( $result !== array( $region_data['us']['event'] ) ) {
- $failed++;
- output_results( $name, false, array( $region_data['us']['event'] ), $result );
- }
- break;
- default:
- if ( $result !== $local_events ) {
- $failed++;
- output_results( $name, false, $local_events, $result );
- }
- break;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $result !== $local_events ) {
+ $failed++;
+ output_results( $name, false, $local_events, $result );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1481,6 +1469,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test `remove_duplicate_events()`.
+ */
+function test_remove_duplicate_events() {
+ $duplicate_events = array(
+ // Each of these represents an event; extraneous fields have been removed for readability.
+ array (
+ 'url' => 'https://2020.us.wordcamp.org/',
+ ),
+
+ array (
+ 'url' => 'https://2020.detroit.wordcamp.org/',
+ ),
+
+ array(
+ // Intentionally missing the trailing slash, to account for inconsistencies in data.
+ 'url' => 'https://2020.us.wordcamp.org',
+ )
+ );
+
+ printf( "\n\nRunning 1 remove_duplicate_events() test\n" );
+
+ $expected_result = array(
+ array (
+ 'url' => 'https://2020.us.wordcamp.org',
+ ),
+
+ array (
+ 'url' => 'https://2020.detroit.wordcamp.org/',
+ ),
+ );
+
+ $actual_result = remove_duplicate_events( $duplicate_events );
+ $passed = $expected_result === $actual_result;
+
+ output_results( 'remove duplicate events', $passed, $expected_result, $actual_result );
+
+ return $passed ? 0 : 1;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Stub to simulate cache misses, so that the tests always get fresh results
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false
</span></span></pre>
</div>
</div>
</body>
</html>