Merge pull request #4 from jshayes/feature/append-tags

Make subsequent calls to withTags append the additional tags

Author: Justin Hayes

src/Helpers/TagNormalizer.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace JSHayes\LaravelDataDogStatsd\Helpers;
+
+use Illuminate\Support\Collection;
+
+class TagNormalizer
+{
+    /**
+     * Normalize the given tags to an array representation
+     *
+     * @param array|string|null $tags
+     *
+     * @return array|null
+     */
+    public static function normalize($tags): ?array
+    {
+        if (is_string($tags)) {
+            return (new Collection(explode(',', $tags)))->mapWithKeys(function ($tag) {
+                [$key, $value] = array_pad(explode(':', $tag, 2), 2, null);
+                return [$key => $value];
+            })->toArray();
+        }
+
+        return $tags;
+    }
+}

src/StatBuilder.php

@@ -3,6 +3,7 @@
 namespace JSHayes\LaravelDataDogStatsd;
 
 use DataDog\DogStatsd;
+use JSHayes\LaravelDataDogStatsd\Helpers\TagNormalizer;
 
 class StatBuilder
 {
@@ -32,7 +33,7 @@ public function __construct(DogStatsd $statsd, string $stat)
      */
     public function withTags($tags): self
     {
-        $this->tags = $tags;
+        $this->tags = array_merge($this->tags ?? [], TagNormalizer::normalize($tags));
         return $this;
     }
 

src/Testing/StatsCollection.php

@@ -5,6 +5,7 @@
 use Countable;
 use Illuminate\Support\Collection;
 use Illuminate\Contracts\Support\Arrayable;
+use JSHayes\LaravelDataDogStatsd\Helpers\TagNormalizer;
 
 class StatsCollection implements Countable, Arrayable
 {
@@ -40,7 +41,7 @@ public function add(string $stat, $value, float $sampleRate = 1.0, $tags = null)
             'stat' => $stat,
             'value' => $value,
             'sample-rate' => $sampleRate,
-            'tags' => $tags,
+            'tags' => TagNormalizer::normalize($tags),
         ]);
         return $this;
     }
@@ -93,7 +94,7 @@ public function filterByValue($value): StatsCollection
      */
     public function filterByTags($tags): StatsCollection
     {
-        return $this->filterBy('tags', $tags);
+        return $this->filterBy('tags', TagNormalizer::normalize($tags));
     }
 
     /**

tests/Unit/DataDogTest.php

@@ -153,7 +153,7 @@ public function it_delegates_the_fluent_timing_call_to_the_statsd_instance()
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->timing(10);
 
-        $spy->shouldHaveReceived('timing')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('timing')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -165,7 +165,7 @@ public function it_delegates_the_fluent_microtiming_call_to_the_statsd_instance(
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->microtiming(10);
 
-        $spy->shouldHaveReceived('microtiming')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('microtiming')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -177,7 +177,7 @@ public function it_delegates_the_fluent_gauge_call_to_the_statsd_instance()
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->gauge(10);
 
-        $spy->shouldHaveReceived('gauge')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('gauge')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -189,7 +189,7 @@ public function it_delegates_the_fluent_histogram_call_to_the_statsd_instance()
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->histogram(10);
 
-        $spy->shouldHaveReceived('histogram')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('histogram')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -201,7 +201,7 @@ public function it_delegates_the_fluent_distribution_call_to_the_statsd_instance
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->distribution(10);
 
-        $spy->shouldHaveReceived('distribution')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('distribution')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -213,7 +213,7 @@ public function it_delegates_the_fluent_set_call_to_the_statsd_instance()
         $dataDog->setStatsdInstance($spy = Mockery::spy(DogStatsd::class));
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->set(10);
 
-        $spy->shouldHaveReceived('set')->with('stat', 10, 0.5, 'tags');
+        $spy->shouldHaveReceived('set')->with('stat', 10, 0.5, ['tags' => null]);
     }
 
     /**
@@ -226,8 +226,8 @@ public function it_delegates_the_fluent_increment_call_to_the_statsd_instance()
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->increment();
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->increment(2);
 
-        $spy->shouldHaveReceived('increment')->with('stat', 0.5, 'tags', 1);
-        $spy->shouldHaveReceived('increment')->with('stat', 0.5, 'tags', 2);
+        $spy->shouldHaveReceived('increment')->with('stat', 0.5, ['tags' => null], 1);
+        $spy->shouldHaveReceived('increment')->with('stat', 0.5, ['tags' => null], 2);
     }
 
     /**
@@ -240,7 +240,7 @@ public function it_delegates_the_fluent_decrement_call_to_the_statsd_instance()
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->decrement();
         $dataDog->stat('stat')->withSampleRate(0.5)->withTags('tags')->decrement(-2);
 
-        $spy->shouldHaveReceived('decrement')->with('stat', 0.5, 'tags', -1);
-        $spy->shouldHaveReceived('decrement')->with('stat', 0.5, 'tags', -2);
+        $spy->shouldHaveReceived('decrement')->with('stat', 0.5, ['tags' => null], -1);
+        $spy->shouldHaveReceived('decrement')->with('stat', 0.5, ['tags' => null], -2);
     }
 }

tests/Unit/Facades/DataDogTest.php

@@ -102,4 +102,28 @@ public function it_can_fluently_increment_a_stat()
 
         DataDog::assertStatWasIncremented('stat')->withTags('tags')->withSampleRate(0.5);
     }
+
+    /**
+     * @test
+     */
+    public function it_can_fluently_append_tags()
+    {
+        DataDog::fake();
+
+        DataDog::stat('stat')
+            ->withTags('tag1')
+            ->withTags(['tag2' => null])
+            ->withTags('tag3,key4:tag4')
+            ->withTags(['key5' => 'tag5', 'key6' => 'tag6'])
+            ->increment();
+
+        DataDog::assertStatWasIncremented('stat')->withTags([
+            'tag1' => null,
+            'tag2' => null,
+            'tag3' => null,
+            'key4' => 'tag4',
+            'key5' => 'tag5',
+            'key6' => 'tag6',
+        ]);
+    }
 }

tests/Unit/Helpers/TagNormalizerTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace JSHayes\LaravelDataDogStatsd\Tests\Unit\Helpers;
+
+use JSHayes\LaravelDataDogStatsd\Tests\TestCase;
+use JSHayes\LaravelDataDogStatsd\Helpers\TagNormalizer;
+
+class TagNormalizerTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_normalizes_string_tags_with_no_keys()
+    {
+        $this->assertSame(['tag1' => null], TagNormalizer::normalize('tag1'));
+        $this->assertSame(['tag1' => null, 'tag2' => null], TagNormalizer::normalize('tag1,tag2'));
+    }
+
+    /**
+     * @test
+     */
+    public function it_normalizes_string_tags_with_keys()
+    {
+        $this->assertSame(['key1' => 'tag1'], TagNormalizer::normalize('key1:tag1'));
+        $this->assertSame(['key1' => 'tag1', 'key2' => 'tag2'], TagNormalizer::normalize('key1:tag1,key2:tag2'));
+    }
+
+    /**
+     * @test
+     */
+    public function it_normalizes_string_tags()
+    {
+        $this->assertSame(['key1' => 'tag1', 'tag2' => null], TagNormalizer::normalize('key1:tag1,tag2'));
+    }
+
+    /**
+     * @test
+     */
+    public function it_does_not_modify_array_tags()
+    {
+        $this->assertSame(['tag1' => null], TagNormalizer::normalize(['tag1' => null]));
+        $this->assertSame(['key1' => 'tag1'], TagNormalizer::normalize(['key1' => 'tag1']));
+        $this->assertSame(
+            ['key1' => 'tag1', 'tag2' => null],
+            TagNormalizer::normalize(['key1' => 'tag1', 'tag2' => null])
+        );
+    }
+}

tests/Unit/Testing/StatsCollectionTest.php

@@ -19,7 +19,7 @@ public function adding_stats_will_add_them_to_the_collection()
 
         $this->assertEquals([
             ['stat' => 'stat1', 'value' => 'test', 'tags' => null, 'sample-rate' => 1.0],
-            ['stat' => 'stat2', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat2', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
             ['stat' => 'stat3', 'value' => 'other', 'tags' => ['key' => 'value'], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
@@ -36,7 +36,7 @@ public function adding_the_same_stat_multiple_times_will_add_them_to_the_collect
 
         $this->assertEquals([
             ['stat' => 'stat', 'value' => 'test', 'tags' => null, 'sample-rate' => 1.0],
-            ['stat' => 'stat', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
             ['stat' => 'stat', 'value' => 'other', 'tags' => ['key' => 'value'], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
@@ -55,7 +55,7 @@ public function filtering_by_stat_will_remove_all_other_stats()
 
         $this->assertEquals([
             ['stat' => 'stat1', 'value' => 'test', 'tags' => null, 'sample-rate' => 1.0],
-            ['stat' => 'stat1', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat1', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
 
@@ -73,7 +73,7 @@ public function filtering_by_value_will_remove_all_stats_with_different_values()
 
         $this->assertEquals([
             ['stat' => 'stat1', 'value' => 'test', 'tags' => null, 'sample-rate' => 1.0],
-            ['stat' => 'stat2', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat2', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
 
@@ -110,8 +110,8 @@ public function filtering_by_tags_will_remove_all_stats_with_different_tags()
         $collection = $collection->filterByTags('tags');
 
         $this->assertEquals([
-            ['stat' => 'stat2', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
-            ['stat' => 'stat3', 'value' => 'another', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat2', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
+            ['stat' => 'stat3', 'value' => 'another', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
 
@@ -130,7 +130,28 @@ public function filtering_by_multiple_fields_will_return_the_correct_set()
         $collection = $collection->filterByStat('stat1')->filterByValue('test')->filterByTags('tags');
 
         $this->assertEquals([
-            ['stat' => 'stat1', 'value' => 'test', 'tags' => 'tags', 'sample-rate' => 1.0],
+            ['stat' => 'stat1', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
         ], $collection->toArray());
     }
+
+    /**
+     * @test
+     */
+    public function filtering_by_tags_will_match_stats_that_have_the_same_normalized_tags()
+    {
+        $collection = new StatsCollection();
+        $collection->add('stat1', 'test', 1.0, 'tags')
+            ->add('stat2', 'other', 1.0, ['key' => 'value'])
+            ->add('stat3', 'another', 1.0, ['tags' => null]);
+
+        $this->assertEquals([
+            ['stat' => 'stat1', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
+            ['stat' => 'stat3', 'value' => 'another', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
+        ], $collection->filterByTags('tags')->toArray());
+
+        $this->assertEquals([
+            ['stat' => 'stat1', 'value' => 'test', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
+            ['stat' => 'stat3', 'value' => 'another', 'tags' => ['tags' => null], 'sample-rate' => 1.0],
+        ], $collection->filterByTags(['tags' => null])->toArray());
+    }
 }