Expose new ScoutApmAgent endpoint to start a new request

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## Pending - [2.1.2]
+## Pending - [3.0.0]
+
+ - [BC] Added new method `Scoutapm\ScoutApmAgent::startNewRequest` (#148)
+   - implementors of `Scoutapm\ScoutApmAgent` will now need to implement this new method
 
 ## [2.1.1] 2019-12-17
 

src/Agent.php

@@ -99,7 +99,7 @@ private function __construct(
             $this->warnIfConfigValueIsNotSet(ConfigKey::APPLICATION_KEY);
         }
 
-        $this->request = new Request();
+        $this->startNewRequest();
 
         $this->ignoredEndpoints = new IgnoredEndpoints($configuration->get(ConfigKey::IGNORED_ENDPOINTS));
     }
@@ -339,7 +339,7 @@ public function send() : bool
                 $this->connector->sendCommand($this->request)
             ));
 
-            $this->request = new Request();
+            $this->startNewRequest();
 
             return true;
         } catch (NotConnected $notConnected) {
@@ -353,6 +353,12 @@ public function send() : bool
         }
     }
 
+    /** {@inheritDoc} */
+    public function startNewRequest() : void
+    {
+        $this->request = new Request();
+    }
+
     private function registerIfRequired() : void
     {
         if ($this->registered) {

src/ScoutApmAgent.php

@@ -74,6 +74,11 @@ public function changeRequestUri(string $newRequestUri) : void;
      */
     public function send() : bool;
 
+    /**
+     * Clears any currently recorded request data/spans, and start a new request.
+     */
+    public function startNewRequest() : void;
+
     /**
      * You probably don't need this, it's useful in testing
      *

tests/Unit/AgentTest.php

@@ -397,4 +397,19 @@ public function testRegisterEventIsOnlySentOnceWhenSendingTwoRequestsWithSameAge
         $agent->send();
         $agent->send();
     }
+
+    public function testRequestIsResetAfterStartingANewRequest() : void
+    {
+        $agent = $this->agentFromConfigArray([
+            ConfigKey::APPLICATION_NAME => 'My test app',
+            ConfigKey::APPLICATION_KEY => uniqid('applicationKey', true),
+            ConfigKey::MONITORING_ENABLED => true,
+        ]);
+
+        $requestBeforeReset = $agent->getRequest();
+
+        $agent->startNewRequest();
+
+        self::assertNotSame($requestBeforeReset, $agent->getRequest());
+    }
 }