<!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>[7145] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Only restrict results to a country when explicitly requested.</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/7145">7145</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/7145","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>2018-04-20 20:29:40 +0000 (Fri, 20 Apr 2018)</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: Only restrict results to a country when explicitly requested.
Otherwise, this creates a situation where an event within driving distance is not shown to somebody, just because it's on the other side of a border. There are some cases where the event might not be relevant (e.g., different languages are spoken in those countries), but there are many others where the event is relevant, so it's better to err on the side of showing too many events than too few.
See https://wordpress.slack.com/archives/C08M59V3P/p1524168308000202.</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 2018-04-20 20:29:37 UTC (rev 7144)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2018-04-20 20:29:40 UTC (rev 7145)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +75,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function parse_request() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $location_args = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $location_args = array( 'restrict_by_country' => false );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If a precise location is known, use a GET request. The values here should come from the `location` key of the result of a POST request.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_GET['latitude'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,6 +85,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_GET['country'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $location_args['country'] = $_GET['country'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $location_args['restrict_by_country'] = true;
</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"> // If a precise location is not known, create a POST request with a bunch of data which can be used to determine a precise location for future GET requests.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,6 +145,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $location ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $event_args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'is_client_core' => is_client_core( $_SERVER['HTTP_USER_AGENT'] ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'restrict_by_country' => $location_args['restrict_by_country'],
</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"> if ( isset( $_REQUEST['number'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -722,7 +724,7 @@
</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"> // Allow queries for limiting to specific countries.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $args['country'] ) && preg_match( '![a-z]{2}!i', $args['country'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['restrict_by_country'] && ! empty( $args['country'] ) && preg_match( '![a-z]{2}!i', $args['country'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wheres[] = '`country` = %s';
</span><span class="cx" style="display: block; padding: 0 10px"> $sql_values[] = $args['country'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -882,7 +884,7 @@
</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"> // Allow queries for limiting to specific countries.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $request_args['country'] ) && preg_match( '![a-z]{2}!i', $request_args['country'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $request_args['restrict_by_country'] && ! empty( $request_args['country'] ) && preg_match( '![a-z]{2}!i', $request_args['country'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $where[] = '`country` = %s';
</span><span class="cx" style="display: block; padding: 0 10px"> $values[] = $request_args['country'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 2018-04-20 20:29:37 UTC (rev 7144)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2018-04-20 20:29:40 UTC (rev 7145)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,6 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_location();
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_events();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tests_failed += test_get_events_country_restriction();
</ins><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_add_regional_wordcamps();
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,6 +125,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'country-code-australia' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'input' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'AU',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'restrict_by_country' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'AU',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -905,7 +907,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get the cases for testing `get_location()`
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the cases for testing `get_events()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -930,6 +932,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'input' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'number' => '1',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'AU',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'restrict_by_country' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'count' => 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -942,6 +945,80 @@
</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 `get_events()` `restricted_by_country` parameter.
+ *
+ * @return bool The number of failures
+ */
+function test_get_events_country_restriction() {
+ $failed = 0;
+ $cases = get_events_country_restriction_test_cases();
+
+ printf( "\n\nRunning %d events restrict by country tests\n", count( $cases ) );
+
+ foreach ( $cases as $case_id => $case ) {
+ $actual_result = get_events( $case['input'] );
+ $actual_countries = array_column( array_column( $actual_result, 'location' ), 'country' );
+ $actual_countries = array_unique( array_map( 'strtoupper', $actual_countries ) );
+
+ sort( $actual_countries );
+
+ $passed = $actual_countries === $case['expected_countries'];
+
+ output_results( $case_id, $passed, $case['expected_countries'], $actual_countries );
+
+ if ( ! $passed ) {
+ $failed++;
+ }
+ }
+
+ return $failed;
+}
+
+/**
+ * Get the cases for testing the `get_events()` `restricted_by_country` parameter.
+ *
+ * @return array
+ */
+function get_events_country_restriction_test_cases() {
+ $cases = array(
+ 'restricted-by-country' => array(
+ 'input' => array(
+ 'number' => '500',
+ 'country' => 'CA',
+ 'restrict_by_country' => true,
+ ),
+ 'expected_countries' => array( 'CA' ),
+ ),
+
+ /*
+ * This assumes there will always be at least an upcoming event on both sides of the border, so the
+ * coordinates need to be half-way between two very active groups in different countries, where the
+ * mid-point is less than `$event_distances['meetup']`.
+ *
+ * If Toronto, CA and Buffalo, US no longer work in the future, then another possible location would be
+ * `53.997654, -6.403377` -- between Belfast, GB and Dublin, IE -- or `47.986952, -122.961350` --
+ * between Seattle, US and Victoria, CA.
+ *
+ * See https://wordpress.slack.com/archives/C08M59V3P/p1524168308000202.
+ */
+ 'not-restricted-by-country' => array(
+ 'input' => array(
+ 'number' => '500',
+ 'restrict_by_country' => false,
+
+ 'nearby' => array(
+ 'latitude' => '43.254372',
+ 'longitude' => '-79.063746',
+ ),
+ ),
+ 'expected_countries' => array( 'CA', 'US' ),
+ ),
+ );
+
+ return $cases;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test `build_response()`
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @todo It might be better to do more abstracted tests of `main()`, rather than coupling to the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1010,6 +1087,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'location' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'CA',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'location_args' => array(
+ 'restrict_by_country' => true,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'location' => array(
</span></span></pre>
</div>
</div>
</body>
</html>