Socket madness problem fix (#2)

Author: serhii-nochevnyi

CHANGELOG.md

@@ -3,6 +3,10 @@ CHANGELOG
 
 [//]: # (comment: Don't forget to update src/DogStatsd.php:DogStatsd::version when releasing a new version)
 
+# 1.6.1 / 2023-06-22
+* Added message counter
+* Close socket after `$maxCountMessagesOnSocketSession` number of messages sent
+
 # 1.6.0 / 2023-05-1
 * Lazy creation of sockets
 * Resend on socket errors. Default max attempts is 2. Can be configured with `max_attempts_to_send` option.

src/BatchedDogStatsd.php

@@ -14,6 +14,7 @@
  */
 class BatchedDogStatsd extends DogStatsd
 {
+    public static $maxCountMessagesOnSocketSession = 0;
     public static $maxBufferLength = 50;
     private static $buffer = [];
     private static $bufferLength = 0;

src/DogStatsd.php

@@ -15,7 +15,7 @@ class DogStatsd
 
     const DEFAULT_MAX_ATTEMPTS_TO_SEND = 1;
     // phpcs:enable
-    public static $version = '1.6.0';
+    public static $version = '1.6.1';
     private static $eventUrl = '/api/v1/events';
     /**
      * @var bool|resource|\Socket
@@ -87,6 +87,9 @@ class DogStatsd
     // Used for the telemetry tags
     private $packets_dropped;
 
+    private $countSentMessages = 0;
+    public static $maxCountMessagesOnSocketSession = 50;
+
     /**
      * DogStatsd constructor, takes a configuration array. The configuration can take any of the following values:
      * host,
@@ -508,6 +511,9 @@ protected function sendMessage($message, $attempt = 0)
                     return $this->sendMessage($message, ++$attempt);
                 }
             }
+        } elseif (++$this->countSentMessages > static::$maxCountMessagesOnSocketSession) {
+            $this->closeSocket();
+            $this->countSentMessages = 0;
         }
 
         return $res;

tests/UnitTests/BatchedDogStatsdTest.php

@@ -38,19 +38,24 @@ public function testReportSendsOnceBufferIsFilled()
         $batchedDog->gauge($udpMessage . '2', 21);
 
         $spy = $this->getSocketSpy();
+
         $this->assertSame(
             0,
             count($spy->argsFromSocketSendtoCalls),
             'Should not have sent any message until the buffer is full'
         );
-
         $batchedDog->gauge($udpMessage . '3', 21);
 
         $this->assertSame(
             1,
             count($spy->argsFromSocketSendtoCalls),
             'Should send all buffered UDP messages once buffer is filled'
         );
+        $this->assertSame(
+            1,
+            count($spy->argsFromSocketCloseCalls),
+            'Socket was not closed'
+        );
 
         $this->assertSameTelemetry(
             $expectedUdpMessageOnceSent,

tests/UnitTests/DogStatsd/CountSentMessagesTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace DataDog\UnitTests\DogStatsd;
+
+use DataDog\DogStatsd;
+use DataDog\TestHelpers\SocketSpyTestCase;
+
+class CountSentMessagesTest extends SocketSpyTestCase
+{
+    public function testReportDoesNotSendIfBufferNotFilled()
+    {
+        $batchedDog = new DogStatsd();
+
+        $batchedDog->report('some fake UDP message');
+
+        $spy = $this->getSocketSpy();
+
+        $this->assertSame(
+            1,
+            count($spy->argsFromSocketSendtoCalls),
+            'Should sent UDP message'
+        );
+
+        $this->assertSame(
+            0,
+            count($spy->argsFromSocketCloseCalls),
+            'Socket should be not closed'
+        );
+    }
+
+    public function testReportSendsOnceBufferIsFilled()
+    {
+        $batchedDog = new DogStatsd();
+
+        $batchedDog::$maxCountMessagesOnSocketSession = 2;
+
+        $udpMessage = 'some fake UDP message';
+
+        $spy = $this->getSocketSpy();
+
+        $batchedDog->gauge($udpMessage . '1', 21);
+        $batchedDog->gauge($udpMessage . '2', 21);
+        $batchedDog->gauge($udpMessage . '3', 21);
+
+        $this->assertSame(
+            3,
+            count($spy->argsFromSocketSendtoCalls),
+            'Should send all UDP messages'
+        );
+        $this->assertSame(
+            1,
+            count($spy->argsFromSocketCloseCalls),
+            'Socket was not closed'
+        );
+
+        $this->assertSame(
+            "some fake UDP message1:21|g\n",
+            $spy->argsFromSocketSendtoCalls[0][1],
+            'Should concatenate UDP messages with newlines'
+        );
+        $this->assertSame(
+            "some fake UDP message2:21|g\n",
+            $spy->argsFromSocketSendtoCalls[1][1],
+            'Should concatenate UDP messages with newlines'
+        );
+        $this->assertSame(
+            "some fake UDP message3:21|g\n",
+            $spy->argsFromSocketSendtoCalls[2][1],
+            'Should concatenate UDP messages with newlines'
+        );
+    }
+}