merged

Author: Matias Melograno

.travis.yml

@@ -19,6 +19,9 @@ matrix:
 services:
   - redis-server
 
+before-install:
+  - echo "extension = zip.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+
 install:
   - composer install --prefer-source --no-interaction
   - composer update

CHANGES.txt

@@ -1,3 +1,9 @@
+6.2.5 (Apr 27, 2021)
+ - Added delimiter in SharedMemory Cache.
+
+6.2.4 (Mar 20, 2020)
+ - Added missing methods in ClientInterface.
+
 6.2.3 (Nov 1, 2019)
  - Added flag `IPAddressesEnabled` into options to enable/disable sending MachineName and MachineIP when data is posted in headers.
 

Detailed-README.md

@@ -391,7 +391,7 @@ $splitClient = $splitFactory->client();
 Within tests folder you can find different test suites in order to run the Split SDK tests. The most important test suite is: **integration** that wrap the others test suites.
 
 ### Integration test suite
-Before to run this test suite, please be sure to have a Redis instance runing:
+Before to run this test suite, please be sure to have a Redis instance running:
 - In order to have a local Redis instance you can install [Docker Container Tool](https://www.docker.com) and pull the oficial Redis container running the command ```docker pull redis```.
 
 And set the correct values on the **phpunit.xml** that you should have copied from **phpunit.xml.dist** file. 

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 Split Software, Co.
+Copyright © 2020 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -49,7 +49,7 @@ Split has built and maintains SDKs for:
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)

composer.json

@@ -6,11 +6,16 @@
   "authors": [
     {
       "name": "Split",
-      "homepage": "http://split.io"
+      "homepage": "https://www.split.io/",
+      "email": "php@split.io"
     },
     {
-      "name": "Sebastian Arrubia",
-      "email": "sebastian@split.io"
+      "name": "Martin Redolatti",
+      "email": "martin.redolatti@split.io"
+    },
+    {
+      "name": "Matias Melograno",
+      "email": "matias.melograno@split.io"
     }
   ],
 
@@ -28,7 +33,7 @@
     "phpunit/phpunit": "~4.0",
     "phpdocumentor/phpdocumentor": "2.*",
     "squizlabs/php_codesniffer": "2.*",
-    "rogervila/php-sonarqube-scanner": "0.4.0"
+    "rogervila/php-sonarqube-scanner": "1.1.0"
   },
 
   "autoload": {

src/SplitIO/Component/Common/ErrorHandler.php

@@ -74,7 +74,7 @@ public static function stop($throw = false)
     }
 
     /**
-     * Method to add the catched error
+     * Method to add the caught error
      * @param $errno
      * @param string $errstr
      * @param string $errfile

src/SplitIO/Component/Memory/SharedMemory.php

@@ -37,7 +37,7 @@ public static function write($key, $value, $expiration = 60, $mode = 0644, $size
 
         $expiration = time() + $expiration;
 
-        $data = json_encode(array('expiration' => $expiration, 'value' => serialize($value)));
+        $data = json_encode(array('expiration' => $expiration, 'value' => serialize($value))) . "\0";
 
         @$shm_id = shmop_open($key, "c", $mode, $size);
 
@@ -87,7 +87,11 @@ public static function read($key, $mode = 0644, $size = 100)
             throw new ReadSharedMemoryException("The shared memory block could not be read");
         }
 
-        $data = json_decode($cached_string, true);
+        $null_pos = strpos($cached_string, "\0");
+        $data = json_decode(
+            substr($cached_string, 0, $null_pos),
+            true
+        );
 
         if ((isset($data['expiration']) && time() > $data['expiration']) || !isset($data['expiration'])) {
             shmop_delete($shm_id);

src/SplitIO/Sdk/Client.php

@@ -168,37 +168,7 @@ private function doEvaluation($operation, $metricName, $key, $featureName, $attr
     }
 
     /**
-     * Returns the treatment to show this id for this feature.
-     * The set of treatments for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>Any of the parameters were null</li>
-     *     <li>There was an exception</li>
-     *     <li>The SDK does not know this feature</li>
-     *     <li>The feature was deleted through the web console.</li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never  returns null.
-     *
-     * @param $key
-     * @param $featureName
-     * @param $attributes
-     * @return string
+     * @inheritdoc
      */
     public function getTreatment($key, $featureName, array $attributes = null)
     {
@@ -218,42 +188,7 @@ public function getTreatment($key, $featureName, array $attributes = null)
     }
 
     /**
-     * Returns an object with the treatment to show this id for this feature
-     * and the config provided.
-     * The set of treatments and config for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>Any of the parameters were null</li>
-     *     <li>There was an exception</li>
-     *     <li>The SDK does not know this feature</li>
-     *     <li>The feature was deleted through the web console.</li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * This method returns null configuration if:
-     * <ol>
-     *     <li>config was not set up</li>
-     * </ol>
-     * @param $key
-     * @param $featureName
-     * @param $attributes
-     * @return string
+     * @inheritdoc
      */
     public function getTreatmentWithConfig($key, $featureName, array $attributes = null)
     {
@@ -319,7 +254,7 @@ private function registerData($impressions, $attributes, $metricName, $latency =
             }
         } catch (\Exception $e) {
             SplitApp::logger()->critical(
-                ': An exception occured when trying to store impressions.'
+                ': An exception occurred when trying to store impressions.'
             );
         }
     }
@@ -388,35 +323,7 @@ private function doEvaluationForTreatments($operation, $metricName, $key, $featu
     }
 
     /**
-     * Returns an associative array which each key will be
-     * the treatment result for each feature passed as parameter.
-     * The set of treatments for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>featureNames is invalid/li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * @param $key
-     * @param $featureNames
-     * @param $attributes
-     * @return array|control
+     * @inheritdoc
      */
     public function getTreatments($key, $featureNames, array $attributes = null)
     {
@@ -434,44 +341,14 @@ function ($feature) {
                 )
             );
         } catch (\Exception $e) {
-            SplitApp::logger()->critical('getTreatmens method is throwing exceptions');
+            SplitApp::logger()->critical('getTreatments method is throwing exceptions');
             $splitNames = InputValidator::validateFeatureNames($featureNames, 'getTreatments');
             return is_null($splitNames) ? array() : array_fill_keys($splitNames, TreatmentEnum::CONTROL);
         }
     }
 
     /**
-     * Returns an associative array which each key will be
-     * the treatment result and the config for each
-     * feature passed as parameter.
-     * The set of treatments for a feature can be configured
-     * on the Split web console and the config for
-     * that treatment.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>featureNames is invalid/li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * @param $key
-     * @param $featureNames
-     * @param $attributes
-     * @return array|control
+     * @inheritdoc
      */
     public function getTreatmentsWithConfig($key, $featureNames, array $attributes = null)
     {
@@ -492,18 +369,7 @@ public function getTreatmentsWithConfig($key, $featureNames, array $attributes =
     }
 
     /**
-     * A short-hand for
-     * <pre>
-     *     (getTreatment(key, feature) == treatment) ? true : false;
-     * </pre>
-     *
-     * This method never throws exceptions.
-     * Instead of throwing  exceptions, it returns false.
-     *
-     * @param $key
-     * @param $featureName
-     * @param $treatment
-     * @return bool
+     * @inheritdoc
      */
     public function isTreatment($key, $featureName, $treatment)
     {