updated wording split

Author: mmelograno

CHANGES.txt

@@ -41,7 +41,7 @@
  - 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
+ - Fetch multiple feature flags at once on getTreatments/getTreatmentsWithConfig
  - Removed MatcherClient (DependencyMatcher now uses Evaluator directly)
  - Removed shared memory.
  - Several code cleanups
@@ -52,7 +52,7 @@
 
 6.2.0 (May 30, 2019)
  - Added validation for TrafficType in track calls.
- - Added validation when split does not exist on treatments and manager calls.
+ - Added validation when feature flag does not exist on treatments and manager calls.
  - Added multiple factory instantiation check.
  - Removed producer modules.
  - Added properties to track method.
@@ -94,7 +94,7 @@
  - Downgrade logging level for shared memory messages
 
 5.2.3: (Sep 5, 2017)
- - Adding hotfix to return empty splits array in SplitManager when redis is empty.
+ - Adding hotfix to return empty feature flags array in SplitManager when redis is empty.
 
 5.2.2: (Aug 1, 2017)
  - Adding hotfix to return CONTROL if redis is down instead of failing.

src/SplitIO/Grammar/Split.php

@@ -51,7 +51,7 @@ public function __construct(array $split)
         $this->configurations = isset($split['configurations']) && count($split['configurations']) > 0 ?
             $split['configurations'] : null;
 
-        SplitApp::logger()->info("Constructing Split: ".$this->name);
+        SplitApp::logger()->info("Constructing Feature Flag: ".$this->name);
 
         if (isset($split['conditions']) && is_array($split['conditions'])) {
             $this->conditions = array();

src/SplitIO/Sdk/Client.php

@@ -47,7 +47,7 @@ public function __construct($options = array())
      * Builds new Impression object
      *
      * @param $matchingKey
-     * @param $feature
+     * @param $featureFlag
      * @param $treatment
      * @param string $label
      * @param null $time
@@ -56,34 +56,34 @@ public function __construct($options = array())
      *
      * @return \SplitIO\Sdk\Impressions\Impression
      */
-    private function createImpression($key, $feature, $treatment, $changeNumber, $label = '', $bucketingKey = null)
+    private function createImpression($key, $featureFlag, $treatment, $changeNumber, $label = '', $bucketingKey = null)
     {
         if (!$this->labelsEnabled) {
             $label = null;
         }
-        $impression = new Impression($key, $feature, $treatment, $label, null, $changeNumber, $bucketingKey);
+        $impression = new Impression($key, $featureFlag, $treatment, $label, null, $changeNumber, $bucketingKey);
         return $impression;
     }
 
     /**
      * Verifies inputs for getTreatment and getTreatmentWithConfig methods
      *
      * @param $key
-     * @param $featureName
+     * @param $featureFlagName
      * @param $attributes
      * @param $operation
      *
      * @return null|mixed
      */
-    private function doInputValidationForTreatment($key, $featureName, array $attributes = null, $operation)
+    private function doInputValidationForTreatment($key, $featureFlagName, array $attributes = null, $operation)
     {
         $key = InputValidator::validateKey($key, $operation);
         if (is_null($key)) {
             return null;
         }
 
-        $featureName = InputValidator::validateFeatureName($featureName, $operation);
-        if (is_null($featureName)) {
+        $featureFlag = InputValidator::validateFeatureFlagName($featureFlagName, $operation);
+        if (is_null($featureFlag)) {
             return null;
         }
 
@@ -94,7 +94,7 @@ private function doInputValidationForTreatment($key, $featureName, array $attrib
         return array(
             'matchingKey' => $key['matchingKey'],
             'bucketingKey' => $key['bucketingKey'],
-            'featureName' => $featureName
+            'featureFlagName' => $featureFlag
         );
     }
 
@@ -104,31 +104,31 @@ private function doInputValidationForTreatment($key, $featureName, array $attrib
      * @param $operation
      * @param $metricName
      * @param $key
-     * @param $featureName
+     * @param $featureFlagName
      * @param $attributes
      *
      * @return mixed
      */
-    private function doEvaluation($operation, $metricName, $key, $featureName, $attributes)
+    private function doEvaluation($operation, $metricName, $key, $featureFlagName, $attributes)
     {
         $default = array('treatment' => TreatmentEnum::CONTROL, 'config' => null);
 
-        $inputValidation = $this->doInputValidationForTreatment($key, $featureName, $attributes, $operation);
+        $inputValidation = $this->doInputValidationForTreatment($key, $featureFlagName, $attributes, $operation);
         if (is_null($inputValidation)) {
             return $default;
         }
         $matchingKey = $inputValidation['matchingKey'];
         $bucketingKey = $inputValidation['bucketingKey'];
-        $featureName = $inputValidation['featureName'];
+        $featureFlagName = $inputValidation['featureFlagName'];
         try {
-            $result = $this->evaluator->evaluateFeature($matchingKey, $bucketingKey, $featureName, $attributes);
-            if (!InputValidator::isSplitFound($result['impression']['label'], $featureName, $operation)) {
+            $result = $this->evaluator->evaluateFeature($matchingKey, $bucketingKey, $featureFlagName, $attributes);
+            if (!InputValidator::isSplitFound($result['impression']['label'], $featureFlagName, $operation)) {
                 return $default;
             }
             // Creates impression
             $impression = $this->createImpression(
                 $matchingKey,
-                $featureName,
+                $featureFlagName,
                 $result['treatment'],
                 $result['impression']['changeNumber'],
                 $result['impression']['label'],
@@ -150,7 +150,7 @@ private function doEvaluation($operation, $metricName, $key, $featureName, $attr
             // Creates impression
             $impression = $this->createImpression(
                 $matchingKey,
-                $featureName,
+                $featureFlagName,
                 TreatmentEnum::CONTROL,
                 -1, // At this point we have no information on the real changeNumber (redis might have failed)
                 ImpressionLabel::EXCEPTION,
@@ -160,7 +160,7 @@ private function doEvaluation($operation, $metricName, $key, $featureName, $attr
         } catch (\Exception $e) {
             SplitApp::logger()->critical(
                 "An error occurred when attempting to log impression for " .
-                "feature: $featureName, key: $matchingKey"
+                "featureFlagName: $featureFlagName, key: $matchingKey"
             );
             SplitApp::logger()->critical($e);
         }
@@ -190,14 +190,14 @@ public function getTreatment($key, $featureName, array $attributes = null)
     /**
      * @inheritdoc
      */
-    public function getTreatmentWithConfig($key, $featureName, array $attributes = null)
+    public function getTreatmentWithConfig($key, $featureFlagName, array $attributes = null)
     {
         try {
             return $this->doEvaluation(
                 'getTreatmentWithConfig',
                 Metrics::MNAME_SDK_GET_TREATMENT_WITH_CONFIG,
                 $key,
-                $featureName,
+                $featureFlagName,
                 $attributes
             );
         } catch (\Exception $e) {
@@ -216,18 +216,18 @@ public function getTreatmentWithConfig($key, $featureName, array $attributes = n
      *
      * @return null|mixed
      */
-    private function doInputValidationForTreatments($key, $featureNames, array $attributes = null, $operation)
+    private function doInputValidationForTreatments($key, $featureFlagNames, array $attributes = null, $operation)
     {
-        $splitNames = InputValidator::validateFeatureNames($featureNames, $operation);
-        if (is_null($splitNames)) {
+        $featureFlags = InputValidator::validateFeatureFlagNames($featureFlagNames, $operation);
+        if (is_null($featureFlags)) {
             return null;
         }
 
         $key = InputValidator::validateKey($key, $operation);
         if (is_null($key) || !InputValidator::validAttributes($attributes, $operation)) {
             return array(
                 'controlTreatments' => array_fill_keys(
-                    $splitNames,
+                    $featureFlags,
                     array('treatment' => TreatmentEnum::CONTROL, 'config' => null)
                 ),
             );
@@ -236,7 +236,7 @@ private function doInputValidationForTreatments($key, $featureNames, array $attr
         return array(
             'matchingKey' => $key['matchingKey'],
             'bucketingKey' => $key['bucketingKey'],
-            'featureNames' => $splitNames,
+            'featureFlagNames' => $featureFlags,
         );
     }
 
@@ -260,14 +260,14 @@ private function registerData($impressions, $attributes, $metricName, $latency =
      * @param $operation
      * @param $metricName
      * @param $key
-     * @param $featureNames
+     * @param $featureFlagNames
      * @param $attributes
      *
      * @return mixed
      */
-    private function doEvaluationForTreatments($operation, $metricName, $key, $featureNames, $attributes)
+    private function doEvaluationForTreatments($operation, $metricName, $key, $featureFlagNames, $attributes)
     {
-        $inputValidation = $this->doInputValidationForTreatments($key, $featureNames, $attributes, $operation);
+        $inputValidation = $this->doInputValidationForTreatments($key, $featureFlagNames, $attributes, $operation);
         if (is_null($inputValidation)) {
             return array();
         }
@@ -277,34 +277,34 @@ private function doEvaluationForTreatments($operation, $metricName, $key, $featu
 
         $matchingKey = $inputValidation['matchingKey'];
         $bucketingKey = $inputValidation['bucketingKey'];
-        $splitNames = $inputValidation['featureNames'];
+        $featureFlags = $inputValidation['featureFlagNames'];
 
         try {
             $result = array();
             $impressions = array();
             $evaluationResults = $this->evaluator->evaluateFeatures(
                 $matchingKey,
                 $bucketingKey,
-                $splitNames,
+                $featureFlags,
                 $attributes
             );
-            foreach ($evaluationResults['evaluations'] as $splitName => $evalResult) {
-                if (InputValidator::isSplitFound($evalResult['impression']['label'], $splitName, $operation)) {
+            foreach ($evaluationResults['evaluations'] as $featureFlag => $evalResult) {
+                if (InputValidator::isSplitFound($evalResult['impression']['label'], $featureFlag, $operation)) {
                     // Creates impression
                     $impressions[] = $this->createImpression(
                         $matchingKey,
-                        $splitName,
+                        $featureFlag,
                         $evalResult['treatment'],
                         $evalResult['impression']['changeNumber'],
                         $evalResult['impression']['label'],
                         $bucketingKey
                     );
-                    $result[$splitName] = array(
+                    $result[$featureFlag] = array(
                         'treatment' => $evalResult['treatment'],
                         'config' => $evalResult['config'],
                     );
                 } else {
-                    $result[$splitName] = array('treatment' => TreatmentEnum::CONTROL, 'config' => null);
+                    $result[$featureFlag] = array('treatment' => TreatmentEnum::CONTROL, 'config' => null);
                 }
             }
             $this->registerData($impressions, $attributes, $metricName, $evaluationResults['latency']);
@@ -320,7 +320,7 @@ private function doEvaluationForTreatments($operation, $metricName, $key, $featu
     /**
      * @inheritdoc
      */
-    public function getTreatments($key, $featureNames, array $attributes = null)
+    public function getTreatments($key, $featureFlagNames, array $attributes = null)
     {
         try {
             return array_map(
@@ -331,45 +331,45 @@ function ($feature) {
                     'getTreatments',
                     Metrics::MNAME_SDK_GET_TREATMENTS,
                     $key,
-                    $featureNames,
+                    $featureFlagNames,
                     $attributes
                 )
             );
         } catch (\Exception $e) {
             SplitApp::logger()->critical('getTreatments method is throwing exceptions');
-            $splitNames = InputValidator::validateFeatureNames($featureNames, 'getTreatments');
-            return is_null($splitNames) ? array() : array_fill_keys($splitNames, TreatmentEnum::CONTROL);
+            $featureFlags = InputValidator::validateFeatureFlagNames($featureFlagNames, 'getTreatments');
+            return is_null($featureFlags) ? array() : array_fill_keys($featureFlags, TreatmentEnum::CONTROL);
         }
     }
 
     /**
      * @inheritdoc
      */
-    public function getTreatmentsWithConfig($key, $featureNames, array $attributes = null)
+    public function getTreatmentsWithConfig($key, $featureFlagNames, array $attributes = null)
     {
         try {
             return $this->doEvaluationForTreatments(
                 'getTreatmentsWithConfig',
                 Metrics::MNAME_SDK_GET_TREATMENTS_WITH_CONFIG,
                 $key,
-                $featureNames,
+                $featureFlagNames,
                 $attributes
             );
         } catch (\Exception $e) {
             SplitApp::logger()->critical('getTreatmentsWithConfig method is throwing exceptions');
-            $splitNames = InputValidator::validateFeatureNames($featureNames, 'getTreatmentsWithConfig');
-            return is_null($splitNames) ? array() :
-                array_fill_keys($splitNames, array('treatment' => TreatmentEnum::CONTROL, 'config' => null));
+            $featureFlags = InputValidator::validateFeatureFlagNames($featureFlagNames, 'getTreatmentsWithConfig');
+            return is_null($featureFlags) ? array() :
+                array_fill_keys($featureFlags, array('treatment' => TreatmentEnum::CONTROL, 'config' => null));
         }
     }
 
     /**
      * @inheritdoc
      */
-    public function isTreatment($key, $featureName, $treatment)
+    public function isTreatment($key, $featureFlagName, $treatment)
     {
         try {
-            $calculatedTreatment = $this->getTreatment($key, $featureName);
+            $calculatedTreatment = $this->getTreatment($key, $featureFlagName);
 
             if ($calculatedTreatment !== TreatmentEnum::CONTROL) {
                 if ($treatment == $calculatedTreatment) {

src/SplitIO/Sdk/ClientInterface.php

@@ -12,7 +12,7 @@ interface ClientInterface
      *     <li>Any of the parameters were null</li>
      *     <li>There was an exception</li>
      *     <li>The SDK does not know this feature flag</li>
-     *     <li>The feature flag was deleted through the web console.</li>
+     *     <li>The feature flag was deleted through the Split user interface.</li>
      * </ol>
      * 'control' is a reserved treatment, to highlight these
      * exceptional circumstances.
@@ -48,7 +48,7 @@ public function getTreatment($key, $featureFlagName, array $attributes = null);
      *     <li>Any of the parameters were null</li>
      *     <li>There was an exception</li>
      *     <li>The SDK does not know this feature flag</li>
-     *     <li>The feature flag was deleted through the web console.</li>
+     *     <li>The feature flag was deleted through the Split user interface.</li>
      * </ol>
      * 'control' is a reserved treatment, to highlight these
      * exceptional circumstances.

src/SplitIO/Sdk/Impressions/ImpressionLabel.php

@@ -8,7 +8,7 @@
 class ImpressionLabel
 {
     /**
-     * Condition: Split Was Killed
+     * Condition: Feature flag Was Killed
      * Treatment: Default treatment
      * Label: killed
      */
@@ -22,7 +22,7 @@ class ImpressionLabel
     const NO_CONDITION_MATCHED = "default rule";
 
     /**
-     * Condition: Split definition was not found
+     * Condition: Feature flag definition was not found
      * Treatment: control
      * Label: split not found
      */