Merge pull request #30 from acelaya-forks/feature/geolite-timeout

Feature/geolite timeout

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
-## [Unreleased]
+## 1.4.1 - 2020-05-20
 
 #### Added
 
@@ -24,7 +24,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 #### Fixed
 
-* *Nothing*
+* [#29](https://github.com/shlinkio/shlink-ip-geolocation/issues/29) Fixed timeout connections when downloading GeoLite databases leaving connection stuck forever.
 
 
 ## 1.4.0 - 2020-03-13

composer.json

@@ -22,6 +22,7 @@
     },
     "require-dev": {
         "infection/infection": "^0.16.1",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpstan/phpstan": "^0.12.3",
         "phpunit/phpunit": "^9.0.2",
         "roave/security-advisories": "dev-master",

src/GeoLite2/DbUpdater.php

@@ -52,6 +52,7 @@ private function downloadDbFile(string $dest, ?callable $handleProgress = null):
             $this->httpClient->request(RequestMethod::METHOD_GET, $this->options->getDownloadFrom(), [
                 RequestOptions::SINK => $dest,
                 RequestOptions::PROGRESS => $handleProgress,
+                RequestOptions::CONNECT_TIMEOUT => $this->options->getConnectionTimeout(),
             ]);
         } catch (Throwable | GuzzleException $e) {
             throw DbUpdateException::forFailedDownload($e);

src/GeoLite2/GeoLite2Options.php

@@ -15,6 +15,7 @@ class GeoLite2Options extends AbstractOptions
     private string $licenseKey = 'G4Lm0C60yJsnkdPi';
     private string $downloadFrom = 'https://download.maxmind.com/app/geoip_download'
         . '?edition_id=GeoLite2-City&license_key={license_key}&suffix=tar.gz';
+    private float $connectionTimeout = 15.0;
 
     public function getDbLocation(): string
     {
@@ -54,4 +55,15 @@ protected function setLicenseKey(string $licenseKey): self
         $this->licenseKey = $licenseKey;
         return $this;
     }
+
+    protected function setConnectionTimeout(float $connectionTimeout): self
+    {
+        $this->connectionTimeout = $connectionTimeout;
+        return $this;
+    }
+
+    public function getConnectionTimeout(): float
+    {
+        return $this->connectionTimeout;
+    }
 }

test/GeoLite2/DbUpdaterTest.php

@@ -8,6 +8,7 @@
 use GuzzleHttp\Exception\ClientException;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Shlinkio\Shlink\IpGeolocation\Exception\RuntimeException;
@@ -18,6 +19,8 @@
 
 class DbUpdaterTest extends TestCase
 {
+    use ProphecyTrait;
+
     private DbUpdater $dbUpdater;
     private ObjectProphecy $httpClient;
     private ObjectProphecy $filesystem;

test/Resolver/ChainIpLocationResolverTest.php

@@ -5,6 +5,7 @@
 namespace ShlinkioTest\Shlink\IpGeolocation\Resolver;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException;
 use Shlinkio\Shlink\IpGeolocation\Model\Location;
@@ -13,6 +14,8 @@
 
 class ChainIpLocationResolverTest extends TestCase
 {
+    use ProphecyTrait;
+
     private ChainIpLocationResolver $resolver;
     private ObjectProphecy $firstInnerResolver;
     private ObjectProphecy $secondInnerResolver;

test/Resolver/GeoLite2LocationResolverTest.php

@@ -9,13 +9,16 @@
 use GeoIp2\Model\City;
 use MaxMind\Db\Reader\InvalidDatabaseException;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException;
 use Shlinkio\Shlink\IpGeolocation\Model\Location;
 use Shlinkio\Shlink\IpGeolocation\Resolver\GeoLite2LocationResolver;
 
 class GeoLite2LocationResolverTest extends TestCase
 {
+    use ProphecyTrait;
+
     private GeoLite2LocationResolver $resolver;
     private ObjectProphecy $reader;