Merge pull request #141 from splitio/develop

Develop

Author: mmelograno

.gitignore

@@ -1,6 +1,5 @@
 *.phar
 .idea
-*.sh
 *~
 ci
 composer.lock
@@ -23,3 +22,6 @@ test.php
 
 # phpenv
 .php-version
+
+# Sonarqube
+.scannerwork

.travis.yml

@@ -1,15 +1,20 @@
 language: php
 
+git:
+  depth: false
+
 env:
   global:
     - COMPOSER_DISABLE_XDEBUG_WARN=1
 
 matrix:
   include:
     - dist: precise
-      php: '5.3'
+      php: '5.4'
     - dist: xenial
       php: '7.2'
+      after_success:
+      - bash sonar-scanner.sh
 
 services:
   - redis-server

CHANGES.txt

@@ -1,3 +1,6 @@
+6.2.3 (Nov 1, 2019)
+ - Added flag `IPAddressesEnabled` into options to enable/disable sending MachineName and MachineIP when data is posted in headers.
+
 6.2.2 (Sep 18, 2019)
  - Fetch multiple splits at once on getTreatments/getTreatmentsWithConfig
  - Removed MatcherClient (DependencyMatcher now uses Evaluator directly)

composer.json

@@ -27,9 +27,10 @@
   "require-dev": {
     "phpunit/phpunit": "~4.0",
     "phpdocumentor/phpdocumentor": "2.*",
-    "squizlabs/php_codesniffer": "2.*"
+    "squizlabs/php_codesniffer": "2.*",
+    "rogervila/php-sonarqube-scanner": "0.4.0"
   },
-  
+
   "autoload": {
     "psr-4": {
       "SplitIO\\": "src/SplitIO/",

sonar-scanner.sh

@@ -0,0 +1,41 @@
+#/bin/bash -e
+
+sonar_scanner() {
+  local params="$@"
+
+  vendor/bin/sonar-scanner \
+    -Dsonar.host.url='https://sonarqube.split-internal.com' \
+    -Dsonar.login="$SONAR_TOKEN" \
+    -Dsonar.ws.timeout='300' \
+    -Dsonar.sources='./src' \
+    -Dsonar.projectName='php-client' \
+    -Dsonar.exclusions='**/tests/**/*.*' \
+    -Dsonar.links.ci='https://travis-ci.com/splitio/php-client' \
+    -Dsonar.links.scm='https://github.com/splitio/php-client' \
+    "${params}"
+
+  return $?
+}
+
+if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
+  sonar_scanner \
+    -Dsonar.pullrequest.provider='GitHub' \
+    -Dsonar.pullrequest.github.repository='splitio/php-client' \
+    -Dsonar.pullrequest.key=$TRAVIS_PULL_REQUEST \
+    -Dsonar.pullrequest.branch=$TRAVIS_PULL_REQUEST_BRANCH \
+    -Dsonar.pullrequest.base=$TRAVIS_BRANCH
+else
+  if [ "$TRAVIS_BRANCH" == 'master' ]; then
+    sonar_scanner \
+      -Dsonar.branch.name=$TRAVIS_BRANCH
+  else
+    if [ "$TRAVIS_BRANCH" == 'develop' ]; then
+      TARGET_BRANCH='master'
+    else
+      TARGET_BRANCH='develop'
+    fi
+    sonar_scanner \
+      -Dsonar.branch.name=$TRAVIS_BRANCH \
+      -Dsonar.branch.target=$TARGET_BRANCH
+  fi
+fi

src/SplitIO/Component/Cache/ImpressionCache.php

@@ -3,22 +3,19 @@
 
 use SplitIO\Component\Common\Di;
 use SplitIO\Component\Cache\KeyFactory;
+use SplitIO\Sdk\QueueMetadataMessage;
 
 class ImpressionCache
 {
     const IMPRESSIONS_QUEUE_KEY = "SPLITIO.impressions";
     const IMPRESSION_KEY_DEFAULT_TTL = 3600;
 
-    public function logImpressions($impressions, $metadata)
+    public function logImpressions($impressions, QueueMetadataMessage $metadata)
     {
         $toStore = array_map(
             function ($imp) use ($metadata) {
                 return json_encode(array(
-                    "m" => array(
-                        "s" => $metadata['sdkVersion'],
-                        "i" => $metadata['machineIp'],
-                        "n" => $metadata['machineName'],
-                    ),
+                    'm' => $metadata->toArray(),
                     "i" => array(
                         "k" => $imp->getId(),
                         "b" => $imp->getBucketingKey(),

src/SplitIO/Sdk/Client.php

@@ -7,7 +7,7 @@
 use SplitIO\Component\Cache\MetricsCache;
 use SplitIO\Sdk\Events\EventDTO;
 use SplitIO\Sdk\Events\EventQueueMessage;
-use SplitIO\Sdk\Events\EventQueueMetadataMessage;
+use SplitIO\Sdk\QueueMetadataMessage;
 use SplitIO\Sdk\Impressions\Impression;
 use SplitIO\TreatmentImpression;
 use SplitIO\Sdk\Impressions\ImpressionLabel;
@@ -38,6 +38,9 @@ public function __construct($options = array())
         if (isset($options['impressionListener'])) {
             $this->impressionListener = new \SplitIO\Sdk\ImpressionListenerWrapper($options['impressionListener']);
         }
+        $this->queueMetadata = new QueueMetadataMessage(
+            isset($options['IPAddressesEnabled']) ? $options['IPAddressesEnabled'] : true
+        );
     }
 
     /**
@@ -305,7 +308,7 @@ private function doInputValidationForTreatments($key, $featureNames, array $attr
     private function registerData($impressions, $attributes, $metricName, $latency = null)
     {
         try {
-            TreatmentImpression::log($impressions);
+            TreatmentImpression::log($impressions, $this->queueMetadata);
             if (isset($this->impressionListener)) {
                 $this->impressionListener->sendDataToClient($impressions, $attributes);
             }
@@ -541,8 +544,7 @@ public function track($key, $trafficType, $eventType, $value = null, $properties
 
         try {
             $eventDTO = new EventDTO($key, $trafficType, $eventType, $value, $properties);
-            $eventMessageMetadata = new EventQueueMetadataMessage();
-            $eventQueueMessage = new EventQueueMessage($eventMessageMetadata, $eventDTO);
+            $eventQueueMessage = new EventQueueMessage($this->queueMetadata, $eventDTO);
             return EventsCache::addEvent($eventQueueMessage);
         } catch (\Exception $exception) {
             // @codeCoverageIgnoreStart

src/SplitIO/Sdk/Events/EventQueueMessage.php

@@ -1,6 +1,8 @@
 <?php
 namespace SplitIO\Sdk\Events;
 
+use SplitIO\Sdk\QueueMetadataMessage;
+
 class EventQueueMessage
 {
     /**
@@ -18,15 +20,15 @@ class EventQueueMessage
      * @param $metadata
      * @param $event
      */
-    public function __construct(EventQueueMetadataMessage $metadata, EventDTO $event)
+    public function __construct(QueueMetadataMessage $metadata, EventDTO $event)
     {
         $this->metadata = $metadata;
         $this->event = $event;
     }
 
 
     /**
-     * @return EventQueueMetadataMessage
+     * @return QueueMetadataMessage
      */
     public function getMetadata()
     {
@@ -36,7 +38,7 @@ public function getMetadata()
     /**
      * @param mixed $metadata
      */
-    public function setMetadata(EventQueueMetadataMessage $metadata)
+    public function setMetadata(QueueMetadataMessage $metadata)
     {
         $this->metadata = $metadata;
     }

src/SplitIO/Sdk/Events/EventQueueMetadataMessage.php renamed to src/SplitIO/Sdk/QueueMetadataMessage.php

@@ -1,7 +1,7 @@
 <?php
-namespace SplitIO\Sdk\Events;
+namespace SplitIO\Sdk;
 
-class EventQueueMetadataMessage
+class QueueMetadataMessage
 {
     private $sdkVersion;
 
@@ -10,16 +10,23 @@ class EventQueueMetadataMessage
     private $machineName;
 
     /**
-     * EventQueueMetadataMessage constructor.
+     * QueueMetadataMessage constructor.
      */
-    public function __construct()
+    public function __construct($IPAddressesEnabled = true)
     {
         $this->sdkVersion = 'php-' . \SplitIO\version();
-        $this->machineIP = \SplitIO\getHostIpAddress();
-        $this->machineName = 'unknown';
+        $this->machineIP = 'NA';
+        $this->machineName = 'NA';
+        if ($IPAddressesEnabled) {
+            $this->machineIP = \SplitIO\getHostIpAddress();
+            if ($this->machineIP != 'unknown') {
+                $this->machineName = 'ip-' . str_replace('.', '-', $this->machineIP);
+            } else {
+                $this->machineName = 'unknown';
+            }
+        }
     }
 
-
     /**
      * @return mixed
      */

src/SplitIO/TreatmentImpression.php

@@ -4,29 +4,26 @@
 use SplitIO\Component\Cache\ImpressionCache;
 use SplitIO\Sdk\Impressions\Impression;
 use SplitIO\Component\Common\Di;
+use SplitIO\Sdk\QueueMetadataMessage;
 
 class TreatmentImpression
 {
     /**
      * @param \SplitIO\Sdk\Impressions\Impression $impressions
      * @return bool
      */
-    public static function log($impressions)
+    public static function log($impressions, QueueMetadataMessage $metadata)
     {
         try {
             Di::getLogger()->debug($impressions);
             if (is_null($impressions) || (is_array($impressions) && 0 == count($impressions))) {
-                return;
+                return null;
             }
             $impressionCache = new ImpressionCache();
             $toStore = (is_array($impressions)) ? $impressions : array($impressions);
             return $impressionCache->logImpressions(
                 $toStore,
-                array(
-                    'sdkVersion' => 'php-' . \SplitIO\version(),
-                    'machineIp' => \SplitIO\getHostIpAddress(),
-                    'machineName' => null, // TODO
-                )
+                $metadata
             );
         } catch (\Exception $e) {
             Di::getLogger()->warning('Unable to write impression back to redis.');