<!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>[5497] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Remove `get_city_from_coordinates()` to improve performance</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 { 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/5497">5497</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/5497","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>2017-05-17 20:30:29 +0000 (Wed, 17 May 2017)</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 `get_city_from_coordinates()` to improve performance
The function was not performant, and it's not easy to make it that way. It's only needed for a few edge cases, and we can get the location from the events themselves (similar to <a href="http://meta.trac.wordpress.org/changeset/5491">r5491</a>). So, removing this is a good trade-off.
Because we are able to rebuild the location, no changes are needed in Core, and a new version of this endpoint is not needed.
See <a href="http://meta.trac.wordpress.org/ticket/2823">#2823</a>
Props dd32</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 2017-05-17 19:23:19 UTC (rev 5496)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-05-17 20:30:29 UTC (rev 5497)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,7 +124,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $events = get_events( $event_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $location['internal'] ) && $location['internal'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $location['description'] ) || ( isset( $location['internal'] ) && $location['internal'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $location = rebuild_location_from_event_source( $events );
</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">@@ -474,10 +474,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ! empty( $args['longitude'] ) && is_numeric( $args['longitude'] )
</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">- $city = get_city_from_coordinates( $args['latitude'], $args['longitude'] );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $location = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => $city ? $city : "{$args['latitude']}, {$args['longitude']}",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => $args['latitude'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => $args['longitude']
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -675,48 +673,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $country;
</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 name of the city that's closest to the given coordinates
- *
- * @todo - This can probably be optimized by SELECT'ing from a derived table of the closest rows, instead of the
- * entire table, similar to the technique described at
- * http://www.techfounder.net/2009/02/02/selecting-closest-values-in-mysql/
- * There's only 140k rows in the table, though, so this is performant for now.
- *
- * NOTE: If this causes any performance issues, it's possible that it could be removed entirely. The Core client
- * saves the location locally, so it could display that instead of using this. However, there were some
- * edge cases early in development that caused us to add this. I don't remember what they were, though, and
- * didn't properly document them in r5128. So, if we ever want to attempt removing this, we'll need to test
- * for unintended side effects. The Core client would need to be updated to display the saved location, so
- * removing this would probably require creating a new version of the endpoint, and leaving this version for
- * older installs.
- *
- * @param float $latitude
- * @param float $longitude
- *
- * @return false|string
- */
-function get_city_from_coordinates( $latitude, $longitude ) {
- global $wpdb;
-
- $results = $wpdb->get_col( $wpdb->prepare( "
- SELECT
- name,
- ABS( %f - latitude ) AS latitude_distance,
- ABS( %f - longitude ) AS longitude_distance
- FROM geoname
- HAVING
- latitude_distance < 0.3 AND -- 0.3 degrees is about 30 miles
- longitude_distance < 0.3
- ORDER by latitude_distance ASC, longitude_distance ASC
- LIMIT 1",
- $latitude,
- $longitude
- ) );
-
- return isset( $results[0] ) ? $results[0] : false;
-}
-
</del><span class="cx" style="display: block; padding: 0 10px"> function get_events( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb, $cache_life, $cache_group;
</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 2017-05-17 19:23:19 UTC (rev 5496)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-05-17 20:30:29 UTC (rev 5497)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,7 +18,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tests_failed += test_get_city_from_coordinates();
</del><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="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -697,7 +696,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'locale' => 'en_US',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => 'seattle',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '47.606',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '-122.332',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -712,7 +711,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'locale' => 'af',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => 'otavi',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '-19.634',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '17.332',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -791,68 +790,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $cases;
</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">-/**
- * Test `get_city_from_coordinates()`
- *
- * @todo This can probably be refactored along with test_get_location() into a more abstract/DRY general-purpose
- * test runner.
- *
- * @return bool The number of failures
- */
-function test_get_city_from_coordinates() {
- $failed = 0;
- $cases = get_city_from_coordinates_test_cases();
-
- printf( "\n\nRunning %d city from coordinate tests\n", count( $cases ) );
-
- foreach ( $cases as $case_id => $case ) {
- $case['input'] = add_cachebusting_parameter( $case['input'] );
- $actual_result = get_city_from_coordinates( $case['input']['latitude'], $case['input']['longitude'] );
- $passed = $case['expected'] === $actual_result;
-
- output_results( $case_id, $passed, $case['expected'], $actual_result );
-
- if ( ! $passed ) {
- $failed++;
- }
- }
-
- return $failed;
-}
-
-/**
- * Get the cases for testing `get_city_from_coordinates()`
- *
- * @return array
- */
-function get_city_from_coordinates_test_cases() {
- $cases = array(
- 'lower-latitude-higher-longitude' => array(
- 'input' => array(
- 'latitude' => '60.199',
- 'longitude' => '24.660'
- ),
- 'expected' => 'Espoo',
- ),
-
- 'higher-latitude-lower-longitude' => array(
- 'input' => array(
- 'latitude' => '22.000',
- 'longitude' => '95.900'
- ),
- 'expected' => 'Mandalay',
- ),
-
- 'middle-of-no-and-where' => array(
- 'input' => array(
- 'latitude' => '-23.121',
- 'longitude' => '125.071'
- ),
- 'expected' => false,
- ),
- );
-
- return $cases;
-}
-
</del><span class="cx" style="display: block; padding: 0 10px"> run_tests();
</span></span></pre>
</div>
</div>
</body>
</html>