Initial Version with Log and NoOp clients implemented

Author: vgarvardt

.gitignore

@@ -0,0 +1,2 @@
+vendor/*
+composer.lock

.php_cs

@@ -0,0 +1,40 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->in(__DIR__);
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+
+        // additional symfony fixers
+        'blank_line_after_namespace' => true,
+        'blank_line_before_return' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'function_typehint_space' => true,
+        'hash_to_slash_comment' => true,
+        'include' => true,
+        'lowercase_cast' => true,
+        'new_with_braces' => true,
+        'no_blank_lines_before_namespace' => true,
+        'no_empty_statement' => true,
+        'no_extra_consecutive_blank_lines' => ['use'],
+        'no_leading_import_slash' => true,
+        'no_unused_imports' => true,
+        'no_whitespace_in_blank_line' => true,
+        'object_operator_without_whitespace' => true,
+        'phpdoc_align' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_types' => true,
+        'short_scalar_cast' => true,
+        'single_blank_line_at_eof' => true,
+        'single_quote' => true,
+        'trailing_comma_in_multiline_array' => true,
+        // additional contrib fixers
+        'ordered_imports' => true,
+        'phpdoc_order' => true,
+    ])
+    ->setFinder($finder);

composer.json

@@ -0,0 +1,24 @@
+{
+  "name": "hellofresh/stats-php",
+  "authors": [
+    {
+      "name": "Vladimir Garvardt",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "HelloFresh\\Stats\\": "src/"
+    }
+  },
+  "require": {
+    "php": ">= 5.6",
+    "league/statsd": "^1.4",
+    "psr/http-message": "^1.0",
+    "behat/transliterator": "^1.2"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^4.8.0",
+    "friendsofphp/php-cs-fixer": "^2.3"
+  }
+}

docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3'
+services:
+  app:
+    image: quay.io/hellofresh/php56
+    volumes:
+      - ".:/app"

phpunit.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="true"
+         stopOnFailure="false"
+         syntaxCheck="false"
+         verbose="true"
+>
+    <logging>
+        <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/>
+    </logging>
+
+    <testsuites>
+        <testsuite name="main">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Bucket.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace HelloFresh\Stats;
+
+
+interface Bucket
+{
+    const TOTAL_BUCKET = 'total';
+
+    const SUFFIX_STATUS_OK = 'ok';
+    const SUFFIX_STATUS_FAIL = 'fail';
+
+    const PREFIX_UNICODE = '-u-';
+
+    const METRIC_EMPTY_PLACEHOLDER = '-';
+    const METRIC_ID_PLACEHOLDER = '-id-';
+
+    const DEFAULT_HTTP_REQUEST_SECTION = 'request';
+
+    /**
+     * @return string
+     */
+    public function metric();
+
+    /**
+     * @return string
+     */
+    public function metricWithSuffix();
+
+    /**
+     * @return string
+     */
+    public function metricTotal();
+
+    /**
+     * @return string
+     */
+    public function metricTotalWithSuffix();
+}

src/Bucket/HTTPRequest.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace HelloFresh\Stats\Bucket;
+
+
+use HelloFresh\Stats\HTTPMetricAlterCallback;
+use Psr\Http\Message\RequestInterface;
+
+class HTTPRequest extends Plain
+{
+    /** @var RequestInterface */
+    protected $request;
+    /** @var HTTPMetricAlterCallback */
+    protected $httpMetricAlterCallback;
+
+    /**
+     * HTTPRequest constructor.
+     *
+     * @param string $section
+     * @param RequestInterface $request
+     * @param bool $success
+     * @param HTTPMetricAlterCallback|null $callback
+     */
+    public function __construct($section, RequestInterface $request, $success, HTTPMetricAlterCallback $callback = null)
+    {
+        $this->request = $request;
+        $this->httpMetricAlterCallback = $callback;
+
+        parent::__construct($section, $this->buildMetricOperation(), $success);
+    }
+
+    /**
+     * @return MetricOperation
+     */
+    public function buildMetricOperation()
+    {
+        $operation = new MetricOperation(strtolower($this->request->getMethod()));
+        if ($this->request->getUri()->getPath() != '/') {
+            $partsFilled = 1;
+            foreach (explode('/', $this->request->getUri()->getPath()) as $fragment) {
+                if ($fragment == '') {
+                    continue;
+                }
+
+                $operation[$partsFilled] = $fragment;
+                $partsFilled++;
+                if ($partsFilled >= $operation::LENGTH) {
+                    break;
+                }
+            }
+        }
+
+        if (null != $this->httpMetricAlterCallback) {
+            $operation = call_user_func_array($this->httpMetricAlterCallback, [$operation, $this->request]);
+        }
+
+        return $operation;
+    }
+}

src/Bucket/MetricOperation.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace HelloFresh\Stats\Bucket;
+
+
+use HelloFresh\Stats\Bucket;
+
+class MetricOperation extends \SplFixedArray
+{
+    const LENGTH = 3;
+
+    /**
+     * MetricOperation constructor.
+     *
+     * @param array $operations
+     */
+    public function __construct(array $operations = [])
+    {
+        parent::__construct(static::LENGTH);
+
+        // ensure that operations is not bigger than allowed
+        array_splice($operations, static::LENGTH);
+
+        foreach ($operations as $key => $value) {
+            $this->offsetSet($key, $value);
+        }
+
+        $opLength = count($operations);
+        for ($i = $opLength; $i < static::LENGTH; $i++) {
+            $this->offsetSet($i, Bucket::METRIC_EMPTY_PLACEHOLDER);
+        }
+    }
+}

src/Bucket/Plain.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace HelloFresh\Stats\Bucket;
+
+
+use Behat\Transliterator\Transliterator;
+use HelloFresh\Stats\Bucket;
+
+class Plain implements Bucket
+{
+    /** @var string */
+    protected $section;
+    /** @var string */
+    protected $operation;
+    /** @var bool */
+    protected $success;
+
+    protected static $status = [true => Bucket::SUFFIX_STATUS_OK, false => Bucket::SUFFIX_STATUS_FAIL];
+
+    /**
+     * Plain constructor.
+     *
+     * @param string $section
+     * @param MetricOperation $operation
+     * @param bool $success
+     */
+    public function __construct($section, MetricOperation $operation, $success)
+    {
+        $this->section = static::sanitizeMetricName($section);
+        $this->success = $success;
+
+        $operationSanitized = [];
+        foreach ($operation as $op) {
+            $operationSanitized[] = static::sanitizeMetricName($op);
+        }
+        $this->operation = implode('.', $operationSanitized);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function metric()
+    {
+        return sprintf('%s.%s', $this->section, $this->operation);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function metricWithSuffix()
+    {
+        return sprintf('%s-%s.%s', $this->section, static::$status[$this->success], $this->operation);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function metricTotal()
+    {
+        return sprintf('%s.%s', Bucket::TOTAL_BUCKET, $this->section);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function metricTotalWithSuffix()
+    {
+        return sprintf('%s.%s-%s', Bucket::TOTAL_BUCKET, $this->section, static::$status[$this->success]);
+    }
+
+    /**
+     * @param string $metric
+     *
+     * @return string
+     */
+    public static function sanitizeMetricName($metric)
+    {
+        if ($metric == "") {
+            return Bucket::METRIC_EMPTY_PLACEHOLDER;
+        }
+
+        // convert unicode symbols to ASCII
+        $asciiMetric = Transliterator::utf8ToAscii($metric);
+        if ($asciiMetric != $metric) {
+            $metric = Bucket::PREFIX_UNICODE . $asciiMetric;
+        }
+
+        // replace underscores with double underscores
+        // and dots with single underscore
+        return str_replace(
+            '.',
+            '_',
+            str_replace('_', '__', $metric)
+        );
+    }
+}