Fix sorting of Geolocation providers (matomo-org#17835)

* Fix sorting of Geolocation providers

* Adds some tests for provider sorting

Author: sgiehl

plugins/UserCountry/LocationProvider.php

@@ -311,16 +311,17 @@ public static function getAllProviderInfo($newline = "\n", $includeExtra = false
             $info['isVisible'] = $provider->isVisible();
             $info['usageWarning'] = $provider->getUsageWarning();
 
-            $allInfo[$info['order']] = $info;
+            $allInfo[$info['id']] = $info;
         }
 
-        ksort($allInfo);
+        uasort($allInfo, function($a, $b) {
+            if ($a['order'] == $b['order']) {
+                return strcmp($a['id'], $b['id']);
+            }
+            return $a['order'] - $b['order'];
+        });
 
-        $result = array();
-        foreach ($allInfo as $info) {
-            $result[$info['id']] = $info;
-        }
-        return $result;
+        return $allInfo;
     }
 
     /**

plugins/UserCountry/tests/Integration/LocationProviderTest.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\UserCountry\tests\Integration;
+
+use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2\Php;
+use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2\ServerModule;
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
+
+/**
+ * @group UserCountry
+ * @group LocationProvider
+ */
+class LocationProviderTest extends IntegrationTestCase
+{
+    public function testGetAllProviderInfo()
+    {
+        $allProviders = LocationProvider::getAllProviderInfo();
+
+        // We currently have 3 Providers shipped with core
+        $this->assertSame(3, count($allProviders));
+        $this->assertEquals(['default', 'geoip2php', 'geoip2server'], array_keys($allProviders));
+    }
+
+    public function testGetAllProviderInfoWithDuplicateOrder()
+    {
+        \Piwik\Tests\Framework\Mock\LocationProvider::$locations = [
+            [
+                LocationProvider::CITY_NAME_KEY    => 'Manchaster',
+                LocationProvider::REGION_CODE_KEY  => '15',
+                LocationProvider::COUNTRY_CODE_KEY => 'US',
+                LocationProvider::LATITUDE_KEY     => '12',
+                LocationProvider::LONGITUDE_KEY    => '11',
+                LocationProvider::ISP_KEY          => 'Facebook',
+            ],
+        ];
+
+        LocationProvider::$providers = [
+            new LocationProvider\DefaultProvider(),
+            new Php(),
+            new ServerModule(),
+            new \Piwik\Tests\Framework\Mock\LocationProvider(),
+        ];
+
+        $allProviders = LocationProvider::getAllProviderInfo();
+
+        $this->assertSame(4, count($allProviders));
+        $this->assertEquals(['default', 'geoip2php', 'mock_provider', 'geoip2server'], array_keys($allProviders));
+    }
+}

tests/PHPUnit/Framework/Mock/LocationProvider.php

@@ -45,7 +45,7 @@ public function getLocation($info)
 
     public function getInfo()
     {
-        return array('id' => self::ID, 'title' => 'mock provider', 'description' => 'mock provider', 'order' => 10);
+        return array('id' => self::ID, 'title' => 'mock provider', 'description' => 'mock provider', 'order' => 2);
     }
 
     public function isAvailable()