fix: audit operator fixes and PHP 8.4 compat

.gitignore

@@ -5,3 +5,8 @@ composer.lock
 coverage.xml
 .phpunit.cache
 phpunit.xml
+
+.claude/
+.DS_Store
+AUDIT_REPORT.md
+FIXES_IMPLEMENTED.md

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## 2.0.0 (unreleased)
+
+### BREAKING
+
+- **Units keep their type.** `setUnit`/`setUnits` (Context and ContextConfig) accept strings or numbers and
+  `getUnit`/`getUnits` return the value as given (old: numbers were cast to strings). A float unit is hashed as
+  its value rounded to an integer, like the JavaScript SDK. String UIDs are trimmed.
+  Unit error messages now match the other SDKs: `Unit '<type>' UID already set.`,
+  `Unit '<type>' UID must not be blank.`, `Unit '<type>' must be a string or a number.`
+- **`track()` validates goal properties.** Anything other than null, a plain object or an associative array
+  raises `Goal '<name>' properties must be of type object.` (old: PHP `TypeError` or silently accepted).
+- **A failed context load no longer rejects.** `createContextAsync()`/`createContextPending()` resolve with a
+  context that is ready and failed, has empty data, stores `readyError()` and logs an `Error` event.
+- **`close()` rethrows a failed final publish.** The events stay queued and the context stays open so `close()`
+  can be retried (old: the error was swallowed and the context closed).
+- New `ABSmartly\SDK\Utils` helpers (`hashUnit`, `base64UrlNoPadding`, `utf8Bytes`, `isObject`, `isNumeric`,
+  `isPromise`).
+
+- **Context reads throw before ready and after finalize** (parity with the JavaScript SDK `_checkReady`).
+  The following methods now throw `ABSmartly\SDK\Exception\LogicException`:
+  `getTreatment`, `peekTreatment`, `getVariableValue`, `peekVariableValue`, `getVariableKeys`,
+  `getExperiments`, `getCustomFieldKeys`, `customFieldValue`, `getCustomFieldValueType`.
+  - Before ready (e.g. a context from `createContextPending()` whose data has not arrived):
+    message `ABsmartly Context is not yet ready.`
+    Old: `peekVariableValue`/`getVariableKeys`/`getExperiments` returned defaults or empty arrays.
+  - After `close()`/`finalize()`: message `ABsmartly Context is finalized.`
+    Old: `peekVariableValue` and `getVariableKeys` kept returning values.
+    `getExperiments()` is still allowed after finalize (as in JS).
+  - The not-ready message changed from `ABSmartly Context is not yet ready` to
+    `ABsmartly Context is not yet ready.` Code matching on the message text must be updated.

composer.json

@@ -5,7 +5,10 @@
         "php-64bit": "^7.4 || ^8.0",
         "lastguest/murmurhash": "~2.1.1",
         "ext-curl": "*",
-        "ext-json": "*"
+        "ext-json": "*",
+        "react/http": "^1.9",
+        "react/async": "^3.0 || ^4.0",
+        "react/promise": "^3.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.26"
@@ -27,5 +30,10 @@
             "email": "ayesh@aye.sh"
         }
     ],
-    "keywords": ["absmartly"]
+    "keywords": [
+        "absmartly"
+    ],
+    "scripts": {
+        "test": "phpunit"
+    }
 }

phpunit.xml.dist

@@ -11,6 +11,7 @@
          convertDeprecationsToExceptions="true"
          failOnRisky="true"
          failOnWarning="true"
+         defaultTestSuite="default"
          verbose="true">
     <testsuites>
         <testsuite name="default">

src/ABsmartly.php

@@ -0,0 +1,174 @@
+<?php
+
+namespace ABSmartly\SDK;
+
+use ABSmartly\SDK\Client\Client;
+use ABSmartly\SDK\Client\ClientConfig;
+use ABSmartly\SDK\Context\AsyncContextDataProvider;
+use ABSmartly\SDK\Context\Context;
+use ABSmartly\SDK\Context\ContextConfig;
+use ABSmartly\SDK\Context\ContextData;
+use ABSmartly\SDK\Context\ContextDataProvider;
+use ABSmartly\SDK\Context\ContextPublisher;
+use ABSmartly\SDK\Context\ContextEventLogger;
+use ABSmartly\SDK\Http\HTTPClient;
+use React\Promise\PromiseInterface;
+
+use function React\Promise\reject;
+use function React\Promise\resolve;
+
+class ABsmartly {
+
+	private Client $client;
+	private ContextPublisher $handler;
+	private ContextDataProvider $provider;
+	private ?ContextEventLogger $eventLogger;
+
+	public function __construct(Config $config) {
+		$this->client = $config->getClient();
+		$this->provider = $config->getContextDataProvider();
+		$this->handler = $config->getContextEventHandler();
+		$this->eventLogger = $config->getContextEventLogger();
+	}
+
+	/**
+	 * @param string $endpoint URL to your API endpoint. Most commonly "your-company.absmartly.io".
+	 * @param string $apiKey API key which can be found on the Web Console.
+	 * @param string $application Name of the application where the SDK is installed. Applications are created on the
+	 *                  Web Console and should match the applications where your experiments will be running.
+	 * @param string $environment Environment of the platform where the SDK is installed. Environments are created on
+	 *                  the Web Console and should match the available environments in your infrastructure.
+	 * @param int $retries The number of retries before the SDK stops trying to connect.
+	 * @param int $timeout Amount of time, in milliseconds, before the SDK will stop trying to connect.
+	 * @param callable|null $eventLogger A callback function which runs after SDK events.
+	 * @return ABsmartly ABsmartly instance created using the credentials and details above.
+	 */
+	public static function createSimple(
+		string $endpoint,
+		string $apiKey,
+		string $application,
+		string $environment,
+		int $retries = 5,
+		int $timeout = 3000,
+		?callable $eventLogger = null
+	): ABsmartly {
+		return new ABsmartly(static::buildConfig($endpoint, $apiKey, $application, $environment, $retries, $timeout, $eventLogger));
+	}
+
+	/**
+	 * @deprecated Use createSimple(); this legacy signature takes environment before application.
+	 *
+	 * @param string $endpoint URL to your API endpoint. Most commonly "your-company.absmartly.io".
+	 * @param string $apiKey API key which can be found on the Web Console.
+	 * @param string $environment Environment of the platform where the SDK is installed. Environments are created on
+	 *                  the Web Console and should match the available environments in your infrastructure.
+	 * @param string $application Name of the application where the SDK is installed. Applications are created on the
+	 *                  Web Console and should match the applications where your experiments will be running.
+	 * @param int $retries The number of retries before the SDK stops trying to connect.
+	 * @param int $timeout Amount of time, in milliseconds, before the SDK will stop trying to connect.
+	 * @param callable|null $eventLogger A callback function which runs after SDK events.
+	 * @return ABsmartly ABsmartly instance created using the credentials and details above.
+	 */
+	public static function createWithDefaults(
+		string $endpoint,
+		string $apiKey,
+		string $environment,
+		string $application,
+		int $retries = 5,
+		int $timeout = 3000,
+		?callable $eventLogger = null
+	): ABsmartly {
+		return new ABsmartly(static::buildConfig($endpoint, $apiKey, $application, $environment, $retries, $timeout, $eventLogger));
+	}
+
+	protected static function buildConfig(
+		string $endpoint,
+		string $apiKey,
+		string $application,
+		string $environment,
+		int $retries,
+		int $timeout,
+		?callable $eventLogger
+	): Config {
+		$clientConfig = new ClientConfig(
+			$endpoint,
+			$apiKey,
+			$application,
+			$environment,
+		);
+		$clientConfig->setRetries($retries);
+		$clientConfig->setTimeout($timeout);
+
+		$client = new Client($clientConfig, new HTTPClient());
+		$sdkConfig = new Config($client);
+		if ($eventLogger !== null) {
+			$sdkConfig->setContextEventLogger(new \ABSmartly\SDK\Context\ContextEventLoggerCallback($eventLogger));
+		}
+		return $sdkConfig;
+	}
+
+	public function createContext(ContextConfig $contextConfig): Context {
+		$this->applyEventLogger($contextConfig);
+		return Context::createFromContextConfig($this, $contextConfig, $this->provider, $this->handler);
+	}
+
+	public function createContextWithData(ContextConfig $contextConfig, ContextData $contextData): Context {
+		$this->applyEventLogger($contextConfig);
+		return Context::createFromContextConfig($this, $contextConfig, $this->provider, $this->handler, $contextData);
+	}
+
+	private function applyEventLogger(ContextConfig $contextConfig): void {
+		if ($this->eventLogger !== null && $contextConfig->getEventLogger() === null) {
+			$contextConfig->setEventLogger($this->eventLogger);
+		}
+	}
+
+	public function createContextAsync(ContextConfig $contextConfig): PromiseInterface {
+		$this->applyEventLogger($contextConfig);
+		if (!$this->provider instanceof AsyncContextDataProvider) {
+			try {
+				return resolve($this->createContext($contextConfig));
+			} catch (\Throwable $e) {
+				return reject($e);
+			}
+		}
+
+		return $this->createContextPending($contextConfig)['promise'];
+	}
+
+	public function createContextPending(ContextConfig $contextConfig): array {
+		$this->applyEventLogger($contextConfig);
+		$context = Context::createPending($this, $contextConfig, $this->provider, $this->handler);
+
+		if (!$this->provider instanceof AsyncContextDataProvider) {
+			$promise = resolve(null)->then(function() use ($context) {
+				try {
+					$data = $this->provider->getContextData();
+				} catch (\Throwable $error) {
+					$context->setContextDataFailed($error);
+					return $context;
+				}
+				$context->setContextData($data);
+				return $context;
+			});
+		} else {
+			$promise = $this->provider->getContextDataAsync()
+				->then(
+					function($data) use ($context) {
+						$context->setContextData($data);
+						return $context;
+					},
+					function(\Throwable $error) use ($context) {
+						$context->setContextDataFailed($error);
+						return $context;
+					}
+				);
+		}
+
+		return ['context' => $context, 'promise' => $promise];
+	}
+
+	public function close(): void {
+		$this->client->close();
+	}
+}

src/Assignment.php

@@ -9,8 +9,8 @@ class Assignment {
 	public int $iteration = 0;
 	public int $fullOnVariant = 0;
 	public string $name = '';
-	public ?string $unitType;
-	public array $trafficSplit;
+	public ?string $unitType = null;
+	public array $trafficSplit = [];
 	public int $variant = 0;
 	public bool $assigned = false;
 	public bool $overridden = false;
@@ -19,8 +19,9 @@ class Assignment {
 	public bool $custom = false;
 
 	public bool $audienceMismatch = false;
-	public stdClass $variables;
+	public ?stdClass $variables = null;
 
-	public bool $exposed;
+	public bool $exposed = false;
+	public int $attrsSeq = 0;
 }
 

src/AudienceMatcher.php

@@ -17,6 +17,10 @@ public function evaluate(stdClass $audience, array $attributes): ?bool {
 			return null;
 		}
 
+		if (!is_array($audience->filter) && !is_object($audience->filter)) {
+			return null;
+		}
+
 		return $this->expression->evaluateBooleanExpr($audience->filter, (object) $attributes);
 	}
 }

src/Client/AsyncClientInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ABSmartly\SDK\Client;
+
+use ABSmartly\SDK\PublishEvent;
+use React\Promise\PromiseInterface;
+
+interface AsyncClientInterface extends ClientInterface {
+	public function getContextDataAsync(): PromiseInterface;
+	public function publishAsync(PublishEvent $publishEvent): PromiseInterface;
+}