From eac468514ba3e4a6d6909b328170514af630879a Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Fri, 8 May 2020 13:10:58 +0200
Subject: [PATCH] Allow to determine if remote addresses should be obfuscated
 at configuration level

---
 config/autoload/url-shortener.global.php       |  1 +
 module/Core/config/dependencies.config.php     |  6 +++++-
 module/Core/src/Service/VisitsTracker.php      | 11 ++++++++---
 module/Core/test/Service/VisitsTrackerTest.php |  2 +-
 4 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/config/autoload/url-shortener.global.php b/config/autoload/url-shortener.global.php
index 165e0258..8439cc8a 100644
--- a/config/autoload/url-shortener.global.php
+++ b/config/autoload/url-shortener.global.php
@@ -12,6 +12,7 @@ return [
             'hostname' => '',
         ],
         'validate_url' => false,
+        'obfuscate_remote_addr' => true,
         'visits_webhooks' => [],
         'default_short_codes_length' => DEFAULT_SHORT_CODES_LENGTH,
     ],
diff --git a/module/Core/config/dependencies.config.php b/module/Core/config/dependencies.config.php
index 5db524b8..90a4ffaf 100644
--- a/module/Core/config/dependencies.config.php
+++ b/module/Core/config/dependencies.config.php
@@ -54,7 +54,11 @@ return [
         Options\UrlShortenerOptions::class => ['config.url_shortener'],
 
         Service\UrlShortener::class => [Util\UrlValidator::class, 'em', Resolver\PersistenceDomainResolver::class],
-        Service\VisitsTracker::class => ['em', EventDispatcherInterface::class],
+        Service\VisitsTracker::class => [
+            'em',
+            EventDispatcherInterface::class,
+            'config.url_shortener.obfuscate_remote_addr',
+        ],
         Service\ShortUrlService::class => ['em', Service\ShortUrl\ShortUrlResolver::class, Util\UrlValidator::class],
         Visit\VisitLocator::class => ['em'],
         Visit\VisitsStatsHelper::class => ['em'],
diff --git a/module/Core/src/Service/VisitsTracker.php b/module/Core/src/Service/VisitsTracker.php
index f477681a..a60513e4 100644
--- a/module/Core/src/Service/VisitsTracker.php
+++ b/module/Core/src/Service/VisitsTracker.php
@@ -22,11 +22,16 @@ class VisitsTracker implements VisitsTrackerInterface
 {
     private ORM\EntityManagerInterface $em;
     private EventDispatcherInterface $eventDispatcher;
+    private bool $obfuscateRemoteAddr;
 
-    public function __construct(ORM\EntityManagerInterface $em, EventDispatcherInterface $eventDispatcher)
-    {
+    public function __construct(
+        ORM\EntityManagerInterface $em,
+        EventDispatcherInterface $eventDispatcher,
+        bool $obfuscateRemoteAddr
+    ) {
         $this->em = $em;
         $this->eventDispatcher = $eventDispatcher;
+        $this->obfuscateRemoteAddr = $obfuscateRemoteAddr;
     }
 
     /**
@@ -34,7 +39,7 @@ class VisitsTracker implements VisitsTrackerInterface
      */
     public function track(ShortUrl $shortUrl, Visitor $visitor): void
     {
-        $visit = new Visit($shortUrl, $visitor);
+        $visit = new Visit($shortUrl, $visitor, $this->obfuscateRemoteAddr);
 
         $this->em->persist($visit);
         $this->em->flush();
diff --git a/module/Core/test/Service/VisitsTrackerTest.php b/module/Core/test/Service/VisitsTrackerTest.php
index 9028d2c7..6ae5acf6 100644
--- a/module/Core/test/Service/VisitsTrackerTest.php
+++ b/module/Core/test/Service/VisitsTrackerTest.php
@@ -37,7 +37,7 @@ class VisitsTrackerTest extends TestCase
         $this->em = $this->prophesize(EntityManager::class);
         $this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
 
-        $this->visitsTracker  = new VisitsTracker($this->em->reveal(), $this->eventDispatcher->reveal());
+        $this->visitsTracker  = new VisitsTracker($this->em->reveal(), $this->eventDispatcher->reveal(), true);
     }
 
     /** @test */