Add time() method; limit access to InMemoryStatsRecord arrays (#9)

* add timing

* add clarifying docblock

* add ClockInterface

* rename merge method; clean up LeagueStatsDClientAdapter constructor

* in memory clean up

* clarifying docblock

* clean up datadog adapter constructor

* datadoglogging improvements

* add CoversClass attribute

* add `provide`

* changes to in-memory for extensibility

* count + timing

* gauge

* parametrized test

* set

* histogram

* style

* quality of life

Author: cosmastech

composer.json

@@ -28,6 +28,9 @@
     "league/statsd": "For generic statsd clients",
     "monolog/monolog": "For psr log implementation"
   },
+  "provide": {
+    "psr/clock-implementation": "3.0.0"
+  },
   "autoload": {
     "psr-4": {
       "Cosmastech\\StatsDClientAdapter\\": "src"

examples/in_memory.php

@@ -24,7 +24,7 @@ function makeApiRequest()
 /** @var \Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord $stats */
 $stats = $inMemoryAdapter->getStats();
 
-var_dump($stats->timing[0]);
+var_dump($stats->getTimings()[0]);
 /*
 object(Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryTimingRecord)#7 (5) {
   ["stat"]=>

src/Adapters/Concerns/HasDefaultTagsTrait.php

@@ -29,7 +29,7 @@ public function setDefaultTags(array $defaultTags = []): void
      * @param  array<mixed, mixed>  $tags
      * @return array<mixed, mixed>
      */
-    protected function mergeTags(array $tags): array
+    protected function mergeWithDefaultTags(array $tags): array
     {
         return array_merge($this->getDefaultTags(), $tags);
     }

src/Adapters/Concerns/TimeClosureTrait.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Cosmastech\StatsDClientAdapter\Adapters\Concerns;
+
+trait TimeClosureTrait
+{
+    /**
+     * @inheritDoc
+     */
+    public function time(string $stat, callable $closure, float $sampleRate = 1.0, array $tags = [])
+    {
+        $startTime = intval($this->clock->now()->format("Uv"));
+
+        $result = $closure();
+
+        $this->timing(
+            $stat,
+            (intval($this->clock->now()->format("Uv")) - $startTime),
+            $sampleRate,
+            $tags
+        );
+
+        return $result;
+    }
+}

src/Adapters/Datadog/DatadogStatsDClientAdapter.php

@@ -4,106 +4,150 @@
 
 use Cosmastech\StatsDClientAdapter\Adapters\Concerns\HasDefaultTagsTrait;
 use Cosmastech\StatsDClientAdapter\Adapters\Concerns\TagNormalizerAwareTrait;
+use Cosmastech\StatsDClientAdapter\Adapters\Concerns\TimeClosureTrait;
 use Cosmastech\StatsDClientAdapter\Adapters\Contracts\TagNormalizerAware;
 use Cosmastech\StatsDClientAdapter\Adapters\StatsDClientAdapter;
 use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
+use Cosmastech\StatsDClientAdapter\TagNormalizers\TagNormalizer;
+use Cosmastech\StatsDClientAdapter\Utility\Clock;
 use DataDog\DogStatsd;
+use Psr\Clock\ClockInterface;
 
 class DatadogStatsDClientAdapter implements StatsDClientAdapter, TagNormalizerAware
 {
     use HasDefaultTagsTrait;
     use TagNormalizerAwareTrait;
+    use TimeClosureTrait;
+
+    protected readonly DogStatsd $datadogClient;
+
+    protected readonly ClockInterface $clock;
 
     /**
      * @param  DogStatsd  $datadogClient
      * @param  array<mixed, mixed>  $defaultTags
+     * @param  TagNormalizer  $tagNormalizer
+     * @param  ClockInterface  $clock
      */
-    public function __construct(protected readonly DogStatsd $datadogClient, array $defaultTags = [])
-    {
-        $this->tagNormalizer = new NoopTagNormalizer();
+    public function __construct(
+        DogStatsd $datadogClient,
+        array $defaultTags = [],
+        TagNormalizer $tagNormalizer = new NoopTagNormalizer(),
+        ClockInterface $clock = new Clock(),
+    ) {
+        $this->datadogClient = $datadogClient;
         $this->setDefaultTags($defaultTags);
+        $this->setTagNormalizer($tagNormalizer);
+        $this->clock = $clock;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function timing(string $stat, float $durationMs, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->datadogClient->timing(
             $stat,
             $durationMs,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function gauge(string $stat, float $value, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->datadogClient->gauge(
             $stat,
             $value,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function histogram(string $stat, float $value, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->datadogClient->histogram(
             $stat,
             $value,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function distribution(string $stat, float $value, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->datadogClient->distribution(
             $stat,
             $value,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function set(string $stat, float|string $value, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->datadogClient->set(
             $stat,
             $value,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function increment(array|string $stats, float $sampleRate = 1.0, array $tags = [], int $value = 1): void
     {
         $this->datadogClient->increment(
             $stats,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags)),
+            $this->normalizeTags($this->mergeWithDefaultTags($tags)),
             $value
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function decrement(array|string $stats, float $sampleRate = 1.0, array $tags = [], int $value = -1): void
     {
         $this->datadogClient->decrement(
             $stats,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags)),
+            $this->normalizeTags($this->mergeWithDefaultTags($tags)),
             $value
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function updateStats(array|string $stats, int $delta = 1, $sampleRate = 1.0, array $tags = null): void
     {
         $this->datadogClient->updateStats(
             $stats,
             $delta,
             $sampleRate,
-            $this->normalizeTags($this->mergeTags($tags))
+            $this->normalizeTags($this->mergeWithDefaultTags($tags))
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function getClient(): DogStatsd
     {
         return $this->datadogClient;