chore(release): Preparing for 3.1.0 release (#174)

optimizely · May 3, 2019 · 6bc0c7b · 6bc0c7b
1 parent 1ca53d1
commit 6bc0c7b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+## 3.1.0
+May 3rd, 2019
+
+### New Features:
+- Introduced Decision notification listener to be able to record:
+    - Variation assignments for users activated in an experiment.
+    - Feature access for users.
+    - Feature variable value for users.
+
+### Bug Fixes:
+- Feature variable APIs return default variable value when featureEnabled property is false. ([#159](https://github.com/optimizely/php-sdk/pull/159))
+
+### Deprecated
+- Activate notification listener is deprecated as of this release. Recommendation is to use the new Decision notification listener. Activate notification listener will be removed in the next major release.
+
 ## 3.0.1
 April 19th, 2019
 

diff --git a/src/Optimizely/Event/Builder/EventBuilder.php b/src/Optimizely/Event/Builder/EventBuilder.php
@@ -38,7 +38,7 @@ class EventBuilder
     /**
      * @const string Version of the Optimizely PHP SDK.
      */
-    const SDK_VERSION = '3.0.1';
+    const SDK_VERSION = '3.1.0';
 
     /**
      * @var string URL to send event to.

diff --git a/src/Optimizely/Notification/NotificationType.php b/src/Optimizely/Notification/NotificationType.php
@@ -18,9 +18,23 @@
 
 class NotificationType
 {
-    // format is EVENT: list of parameters to callback.
+    /*
+     * Notification triggered when an impression event is sent to Optimizely.
+     *
+     * @deprecated since 3.1.0
+     */
     const ACTIVATE = "ACTIVATE:experiment, user_id, attributes, variation, event";
+
+    /*
+     * Notification triggered when a decision is made in
+     * the system i.e. user activation, feature access
+     * or feature-variable value is retrieved.
+     */
     const DECISION = "DECISION:type, user_id, attributes, decision_info";
+
+    /*
+     * Notification triggered when a conversion event is sent to Optimizely.
+     */
     const TRACK = "TRACK:event_key, user_id, attributes, event_tags, event";
 
     public static function isNotificationTypeValid($notification_type)

diff --git a/tests/EventTests/EventBuilderTest.php b/tests/EventTests/EventBuilderTest.php
@@ -68,7 +68,7 @@ public function setUp()
                 ]],
                 'revision' => '15',
                 'client_name' => 'php-sdk',
-                'client_version' => '3.0.1',
+                'client_version' => '3.1.0',
                 'anonymize_ip'=> false,
                 'enrich_decisions' => true,
             ];