fix(ap-2131): incorrect payload format of data requests (#17)

* fix(ap-2131): incorrect payload format of data requests

* chore: bump version

* chore: correct code comments

* refactor: include polyfill into flatten util

Author: rmamchyk

App/Beacon.php

@@ -7,6 +7,7 @@
 use Evolv\EvolvContext;
 
 
+const CLIENT_NAME = 'php-sdk';
 const ENDPOINT_PATTERN = "/\/(v\d+)\/\w+\/([a-z]+)$/i";
 
 class Beacon {
@@ -53,7 +54,7 @@ private function wrapMessages()
     {
         return [
             'uid' => $this->context->uid,
-            'client' => 'php-sdk',
+            'client' => CLIENT_NAME,
             'messages' => $this->messages
         ];
     }
@@ -67,7 +68,7 @@ private function transmit()
         if ($this->v1Events) {
             foreach($this->messages as $message) {
                 $editedMessage = $message;
-                $editedMessage = $message['payload'] ?? [];
+                $editedMessage = $message['payload'];
                 $editedMessage['type'] = $message['type'];
 
                 $this->send($editedMessage);
@@ -81,7 +82,7 @@ public function emit(string $type, $payload, bool $flush = false)
     {
         $this->messages[] = [
             'type' => $type,
-            'payload' => $payload,
+            'payload' => empty($payload) ? new \stdClass() : $payload,
             'timestamp' => time()
         ];
 
@@ -91,4 +92,4 @@ public function emit(string $type, $payload, bool $flush = false)
     public function flush() {
         $this->transmit();
     }
-} 
+}

App/EvolvClient.php

@@ -7,7 +7,12 @@
 use function Evolv\Utils\waitFor;
 use function Evolv\Utils\emit;
 
-
+/**
+ * The EvolvClient provides a low level integration with the Evolv participant APIs.
+ * 
+ * The client provides asynchronous access to key states, values, contexts, and configurations.
+ * 
+ */
 class EvolvClient
 {
     const INITIALIZED = 'initialized';
@@ -16,16 +21,19 @@ class EvolvClient
     const EVENT_EMITTED = 'event.emitted';
 
     public bool $initialized = false;
+    /**
+     * The context against which the key predicates will be evaluated.
+     */
     public EvolvContext $context;
     private $store;
     private bool $autoconfirm;
     private Beacon $contextBeacon;
     private Beacon $eventBeacon;
 
     /**
-     * @param string $environment
-     * @param string $endpoint
-     * @param bool $autoconfirm
+     * @param string $environment The current environment id.
+     * @param string $endpoint The participants API endpoint.
+     * @param bool $autoconfirm Optional. True by default. The autoconfirm flag.
      * @return object
      */
     public function __construct(string $environment, string $endpoint = 'https://participants.evolv.ai/', bool $autoconfirm = true)
@@ -44,14 +52,11 @@ public function __construct(string $environment, string $endpoint = 'https://par
      * Initializes the client with required context information.
      *
      * @param string $uid A globally unique identifier for the current participant.
-     * @param object $remoteContext A map of data used for evaluating context predicates and analytics.
-     * @param object $localContext A map of data used only for evaluating context predicates.
-     * @return array
+     * @param array $remoteContext A map of data used for evaluating context predicates and analytics.
+     * @param array $localContext A map of data used only for evaluating context predicates.
      */
-
     public function initialize(string $uid, array $remoteContext = [], array $localContext = [], $httpClient = null)
     {
-
         if ($this->initialized) {
             throw new \Exception('Evolv: Client is already initialized');
             exit('Evolv: Client is already initialized');
@@ -62,15 +67,6 @@ public function initialize(string $uid, array $remoteContext = [], array $localC
             exit('Evolv: "uid" must be specified');
         }
 
-        $this->context->initialize($uid, $remoteContext, $localContext);
-        $this->store->initialize($this->context, $httpClient);
-
-        if ($this->autoconfirm) {
-            $this->confirm();
-        }
-
-        $this->initialized = true;
-
         waitFor(CONTEXT_INITIALIZED, function($type, $ctx) {
             $this->contextBeacon->emit($type, $this->context->remoteContext);
         });
@@ -81,12 +77,27 @@ public function initialize(string $uid, array $remoteContext = [], array $localC
             }
             $this->contextBeacon->emit($type, ['key' => $key, 'value' => $value]);
         });
-        waitFor(CONTEXT_VALUE_CHANGED, function($type, $key, $value, $local) {
+        waitFor(CONTEXT_VALUE_CHANGED, function($type, $key, $value, $before, $local) {
             if ($local) {
                 return;
             }
             $this->contextBeacon->emit($type, ['key' => $key, 'value' => $value]);
         });
+        waitFor(CONTEXT_VALUE_REMOVED, function ($type, $key, $local) {
+            if ($local) {
+                return;
+            }
+            $this->contextBeacon->emit($type, ['key' => $key]);
+        });
+
+        $this->context->initialize($uid, $remoteContext, $localContext);
+        $this->store->initialize($this->context, $httpClient);
+
+        if ($this->autoconfirm) {
+            $this->confirm();
+        }
+
+        $this->initialized = true;
 
         emit(EvolvClient::INITIALIZED);
     }
@@ -117,8 +128,7 @@ public function initialize(string $uid, array $remoteContext = [], array $localC
      *
      * @param string $topic The event topic on which the listener should be invoked.
      * @param callable $listener The listener to be invoked for the specified topic.
-     * @function
-     * @see  EvolvClient for listeners that should only be invoked once.
+     * @see EvolvClient for listeners that should only be invoked once.
      */
     public function on(string $topic, callable $listener)
     {
@@ -129,8 +139,8 @@ public function on(string $topic, callable $listener)
      * Send an event to the events endpoint.
      *
      * @param string $type The type associated with the event.
-     * @param object $metadata  Any metadata to attach to the event.
-     * @param boolean $flush If true, the event will be sent immediately.
+     * @param mixed $metadata  Any metadata to attach to the event.
+     * @param bool $flush If true, the event will be sent immediately.
      */
     public function emit(string $type, $metadata, bool $flush = false)
     {
@@ -146,9 +156,8 @@ public function emit(string $type, $metadata, bool $flush = false)
      * Check all active keys that start with the specified prefix.
      *
      * @param string $prefix The prefix of the keys to check.
-     * @returns {SubscribablePromise.<Object|Error>} A SubscribablePromise that resolves to object
-     * describing the state of active keys.
-     * @function
+     * @param callable $listener Optional. The callback function to listen to active keys changes.
+     * @return array An array describing the state of active keys.
      */
     public function getActiveKeys(string $prefix = '', callable $listener = null)
     {
@@ -159,8 +168,8 @@ public function getActiveKeys(string $prefix = '', callable $listener = null)
      * Get the value of a specified key.
      *
      * @param string $key The key of the value to retrieve.
-     * @returns @mixed A value of the specified key.
-     * @function
+     * @param callable $listener Optional. The callback function to listen to the specified key changes.
+     * @return mixed A value of the specified key.
      */
     public function get(string $key = '', callable $listener = null)
     {
@@ -229,12 +238,12 @@ public function confirm()
      * Marks a consumer as unsuccessfully retrieving and / or applying requested values, making them ineligible for
      * inclusion in optimization statistics.
      *
-     * @param  object $details Optional. Information on the reason for contamination. If provided, the object should
+     * @param array $details Optional. Information on the reason for contamination. If provided, the object should
      * contain a reason. Optionally, a 'details' value should be included for extra debugging info
-     * @param boolean $allExperiments If true, the user will be excluded from all optimizations, including optimization
+     * @param bool $allExperiments If true, the user will be excluded from all optimizations, including optimization
      * not applicable to this page
      */
-    public function contaminate($details, bool $allExperiments = false)
+    public function contaminate(array $details, bool $allExperiments = false)
     {
         $allocations = $this->context->get('experiments.allocations');
         if (!isset($allocations) || !count($allocations)) {
@@ -281,10 +290,3 @@ public function contaminate($details, bool $allExperiments = false)
         emit(EvolvClient::CONTAMINATED);
     }
 }
-
-
-
-
-
-
-

App/EvolvContext.php

@@ -25,10 +25,28 @@
 
 const DEFAULT_QUEUE_LIMIT = 50;
 
+/**
+ * The EvolvContext provides functionality to manage data relating to the client state, or context in which the
+ * variants will be applied.
+ *
+ * This data is used for determining which variables are active, and for general analytics.
+ *
+ */
 class EvolvContext
 {
+    /**
+     * A unique identifier for the participant.
+     */
     public string $uid;
+
+    /**
+     * The context information for evaluation of predicates and analytics.
+     */
     public array $remoteContext = [];
+
+    /**
+     * The context information for evaluation of predicates only, and not used for analytics.
+     */
     public array $localContext = [];
     private bool $initialized = false;
 
@@ -39,6 +57,11 @@ private function ensureInitialized(): void
         }
     }
 
+    /**
+     * Computes the effective context from the local and remote contexts.
+     *
+     * @return array The effective context from the local and remote contexts.
+     */
     public function resolve()
     {
         $this->ensureInitialized();
@@ -109,7 +132,7 @@ public function set(string $key, $value, bool $local = false): void
      * Retrieve a value from the context.
      *
      * @param string $key The kay associated with the value to retrieve.
-     * @returns {*} The value associated with the specified key.
+     * @return mixed The value associated with the specified key.
      */
     public function get(string $key)
     {
@@ -128,7 +151,7 @@ public function get(string $key)
      *
      * Note: This will cause the effective genome to be recomputed.
      *
-     * @param  string $key  The key to remove from the context.
+     * @param string $key The key to remove from the context.
      */
     public function remove(string $key)
     {
@@ -152,7 +175,7 @@ public function remove(string $key)
      * Note: This will cause the effective genome to be recomputed.
      *
      * @param array $update The values to update the context with.
-     * @param boolean $local If true, the values will only be added to the localContext.
+     * @param bool $local If true, the values will only be added to the localContext.
      */
     public function update(array $update, $local = false) {
         $this->ensureInitialized();
@@ -187,8 +210,8 @@ public function update(array $update, $local = false) {
     /**
      * Checks if the specified key is currently defined in the context.
      *
-     * @param $key The key to check.
-     * @returns bool True if the key has an associated value in the context.
+     * @param string $key The key to check.
+     * @return bool True if the key has an associated value in the context.
      */
     public function contains(string $key)
     {
@@ -202,9 +225,9 @@ public function contains(string $key)
      *
      * @param string $key The array to add to.
      * @param array $value Value to add to the array.
-     * @param bool $local {Boolean} If true, the value will only be added to the localContext.
-     * @param int $limit {Number} Max length of array to maintain.
-     * @returns boolean True if value was successfully added.
+     * @param bool $local If true, the value will only be added to the localContext.
+     * @param int $limit Max length of array to maintain.
+     * @return bool True if value was successfully added.
      */
     public function pushToArray(string $key, $value, $local = false, $limit = null)
     {

App/Predicate.php

@@ -124,19 +124,19 @@ private function evaluatePredicate($context, $predicate, array &$passedRules, ar
 
     /**
      * @typedef EvaluationResult
-     * @property {Set<object>} passed
-     * @property {Set<object>} failed
-     * @property {boolean} rejected
-     * @property {Set<string>} touched
+     * @property array passed
+     * @property array failed
+     * @property array rejected
+     * @property array touched
      */
 
     /**
      * Evaluates a query against a user object and saves passing/failing rule ids to provided sets.
-     * @param context A context object containing describing the context the predicate should be evaluated against.
-     * @param predicate Nested predicate object that rules structured into groups as a deeply nested tree.
+     * @param array context A context object containing describing the context the predicate should be evaluated against.
+     * @param array predicate Nested predicate object that rules structured into groups as a deeply nested tree.
      *                  note: There is no set limit to the depth of this tree, hence we must work with it
      *                  using recursion.
-     * @returns {EvaluationResult}
+     * @return {EvaluationResult}
      */
     public function evaluate($context, $predicate)
     {

App/Utils/flatten.php

@@ -2,12 +2,25 @@
 
 namespace Evolv\Utils;
 
+if (!function_exists('array_is_list')) {
+    function array_is_list(array $array): bool
+    {
+        $i = 0;
+        foreach ($array as $k => $v) {
+            if ($k !== $i++) {
+                return false;
+            }
+        }
+        return true;
+    }
+}
+
 function flatten_recursive(array $current, string $parentKey) {
     $items = [];
 
     foreach($current as $key => $value) {
         $newKey = $parentKey ? ($parentKey . '.' . $key) : $key;
-        if (is_array($value)) {
+        if (is_array($value) && !array_is_list($value)) {
             $items = array_merge($items, flatten_recursive($current[$key], $newKey));
         } else {
             $items[$newKey] = $value;
@@ -19,4 +32,4 @@ function flatten_recursive(array $current, string $parentKey) {
 
 function flatten(array $array) {
     return flatten_recursive($array, '');
-}
+}

Example/index.php

@@ -2,7 +2,11 @@
 
 declare (strict_types=1);
 
-use  Evolv\EvolvClient;
+ini_set('display_errors', '1');
+ini_set('display_startup_errors', '1');
+error_reporting(E_ALL);
+
+use Evolv\EvolvClient;
 
 require_once __DIR__ . '/../vendor/autoload.php';
 

composer.json

@@ -2,7 +2,7 @@
     "name": "evolv/php-sdk",
     "description": "This is the official PHP client for the Evolv AI optimization platform.",
     "type": "library",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "require-dev": {
         "phpunit/phpunit": "^9.5",
         "phpdocumentor/phpdocumentor":  "v3.1.2",