Fix setting the IP address on the user context when it's not available (getsentry#565)

alexander-schranz · ste93cry · web-flow · commit b013a88fe6c8 · 2021-10-11T15:41:12.000+02:00
Co-authored-by: Stefano Arlandini &lt;sarlandini@alice.it&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Unreleased
 
 - Add return typehints to the methods of the `SentryExtension` class to prepare for Symfony 6 (#563)
+- Fix setting the IP address on the user context when it's not available (#565)
 
 ## 4.2.3 (2021-09-21)
 
diff --git a/src/EventListener/RequestListener.php b/src/EventListener/RequestListener.php
@@ -60,7 +60,8 @@ public function handleKernelRequestEvent(RequestListenerRequestEvent $event): vo
         }
 
         $token = null;
-        $userData = UserDataBag::createFromUserIpAddress($event->getRequest()->getClientIp());
+        $userData = new UserDataBag();
+        $userData->setIpAddress($event->getRequest()->getClientIp());
 
         if (null !== $this->tokenStorage) {
             $token = $this->tokenStorage->getToken();
diff --git a/tests/EventListener/RequestListenerTest.php b/tests/EventListener/RequestListenerTest.php
@@ -420,6 +420,17 @@ public function getCredentials()
             },
             new UserDataBag(null, null, '127.0.0.1', 'foo_user'),
         ];
+
+        yield 'request.clientIp IS NULL' => [
+            new RequestEvent(
+                $this->createMock(HttpKernelInterface::class),
+                new Request(),
+                HttpKernelInterface::MASTER_REQUEST
+            ),
+            $this->getMockedClientWithOptions(new Options(['send_default_pii' => true])),
+            null,
+            new UserDataBag(),
+        ];
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,8 @@ public function handleKernelRequestEvent(RequestListenerRequestEvent $event): vo`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`$token = null;`
`63`		`- $userData = UserDataBag::createFromUserIpAddress($event->getRequest()->getClientIp());`
	`63`	`+ $userData = new UserDataBag();`
	`64`	`+ $userData->setIpAddress($event->getRequest()->getClientIp());`
`64`	`65`
`65`	`66`	`if (null !== $this->tokenStorage) {`
`66`	`67`	`$token = $this->tokenStorage->getToken();`