Merge pull request #50 from renoki-co/feature/callable-exports

[feature] Added callable support

Author: rennokki

README.md

@@ -181,12 +181,14 @@ To do so, use the `exportResponse` function. The function will return the respon
 ```php
 use RenokiCo\LaravelExporter\Exporter;
 
-Exporter::exportResponse(<<<'PROM'
-# TYPE openswoole_max_conn gauge
-openswoole_max_conn 256
-# TYPE openswoole_coroutine_num gauge
-openswoole_coroutine_num 1
-PROM;)
+Exporter::exportResponse(function () {
+    return <<<'PROM'
+    # TYPE openswoole_max_conn gauge
+    openswoole_max_conn 256
+    # TYPE openswoole_coroutine_num gauge
+    openswoole_coroutine_num 1
+    PROM;
+);
 ```
 
 When accessing the `/metrics` endpoint, the response will be the one declared earlier.

composer.json

@@ -47,6 +47,7 @@
         "sort-packages": true
     },
     "minimum-stability": "dev",
+    "prefer-stable": true,
     "extra": {
         "laravel": {
             "providers": [

src/Exporter.php

@@ -93,13 +93,13 @@ public static function metrics(array $classes)
      * Export a string as response to a group instead of the computed
      * metrics by the given collectors.
      *
-     * @param  string  $group
-     * @param  string  $text
+     * @param  string|callable  $handler
+     * @param  string|callable  $group
      * @return void
      */
-    public static function exportResponse(string $text, string $group = 'metrics')
+    public static function exportResponse(string|callable $handler, string $group = 'metrics')
     {
-        static::$plainTextResponses[$group] = $text;
+        static::$plainTextResponses[$group] = $handler;
     }
 
     /**
@@ -155,8 +155,8 @@ public static function run(string $group = 'metrics')
      */
     public static function exportAsPlainText(string $group = 'metrics'): string
     {
-        if ($text = static::$plainTextResponses[$group] ?? false) {
-            return $text;
+        if ($handler = static::$plainTextResponses[$group] ?? false) {
+            return is_callable($handler) ? $handler() : $handler;
         }
 
         return (new RenderTextFormat)->render(

tests/MetricTest.php

@@ -109,4 +109,35 @@ public function test_unknown_group(): void
         $registry = Exporter::run('you-dont-know-me');
         self::assertNotNull($registry);
     }
+
+    public function test_response_with_callable_plain_text(): void
+    {
+        Exporter::metrics([OutsideMetric::class]);
+
+        Exporter::metric(OutsideMetric::class)->incBy(20);
+
+        $this->assertStringContainsString(
+            'laravel_outside_metric{label="default-label"} 20',
+            Exporter::exportAsPlainText()
+        );
+
+        Exporter::metric(OutsideMetric::class)->incBy(20, ['label' => 'injected-value']);
+
+        $triggered = false;
+
+        Exporter::exportResponse(function () use (&$triggered) {
+            $triggered = true;
+
+            return 'some-random-text';
+        });
+
+        $this->assertFalse($triggered);
+
+        $this->assertStringContainsString(
+            'some-random-text',
+            Exporter::exportAsPlainText()
+        );
+
+        $this->assertTrue($triggered);
+    }
 }