Custom Message Type

.github/workflows/run-tests.yml

@@ -65,6 +65,34 @@ jobs:
       - name: Cancel workflow runs for commit on error
         if: failure()
         uses: ./.github/.release/actions/actions/utils/fast-jobs-failure
+  acceptance-tests:
+    name: Perform Acceptance BDD tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+      - name: Checkout mock-server action
+        uses: actions/checkout@v3
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Run mock server action
+        uses: ./.github/.release/actions/actions/mock-server
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Install Composer dev depenencies
+        run: |
+          composer install --dev
+      - name: Run acceptance tests
+        run: |
+          composer acceptance-test
+      - name: Expose acceptance tests reports
+        uses: actions/upload-artifact@v2
+        with:
+          name: acceptance-test-reports
+          path: ./tests/Acceptance/reports
   all-tests:
     name: Tests
     needs: [tests]

behat.yml

@@ -1,10 +1,10 @@
 default:
-    autoload:
-        - "%paths.base%/tests/features/bootstrap/"
-    suites:
-        access:
-            paths:    [ "%paths.base%/tests/features/bootstrap/access" ]
-            contexts: [ AccessManagerContext ]
-        utilities:
-            paths:    [ "%paths.base%/tests/features/bootstrap/utilities" ]
-            contexts: [ TimeContext ]
+  autoload:
+    '': "%paths.base%/tests/Acceptance/"
+
+  suites:
+    custom-message-type:
+      paths:
+        - "%paths.base%/tests/Acceptance/CustomMessageType"
+      contexts:
+        - PubNubTests\Acceptance\CustomMessageType\CustomMessageTypeContext

composer.json

@@ -13,7 +13,14 @@
     }
   ],
   "scripts": {
-    "test": "./vendor/bin/phpunit tests/  --verbose --coverage-clover=coverage.clover"
+    "test": "./vendor/bin/phpunit tests/  --verbose --coverage-clover=coverage.clover",
+    "acceptance-test": [
+      "mkdir -p tests/Acceptance/reports",
+      "cp sdk-specifications/features/publish/publish-custom-mssg-type.feature tests/Acceptance/CustomMessageType/publish-custom-mssg-type.feature",
+      "cp sdk-specifications/features/publish/signal-custom-mssg-type.feature tests/Acceptance/CustomMessageType/signal-custom-mssg-type.feature",
+      "cp sdk-specifications/features/history/history-custom-mssg-type.feature tests/Acceptance/CustomMessageType/history-custom-mssg-type.feature",
+      "vendor/bin/behat -f junit -o tests/Acceptance/reports/"
+    ]
   },
   "require": {
     "php": ">=8.0",
@@ -29,7 +36,8 @@
   },
   "autoload": {
     "psr-4": {
-      "PubNub\\": "src/PubNub"
+      "PubNub\\": "src/PubNub",
+      "PubNubTests\\": "tests"
     }
   },
   "autoload-dev": {

src/PubNub/Endpoints/History.php

@@ -31,6 +31,8 @@ class History extends Endpoint
     /** @var bool */
     protected ?bool $includeTimetoken;
 
+    protected ?bool $includeCustomMessageType;
+
     /**
      * @param string $channel
      * @return $this
@@ -97,6 +99,17 @@ public function includeTimetoken($includeTimetoken)
         return $this;
     }
 
+    /**
+     * @param bool $includeTimetoken
+     * @return $this
+     */
+    public function includeCustomMessageType($includeCustomMessageType)
+    {
+        $this->includeCustomMessageType = $includeCustomMessageType;
+
+        return $this;
+    }
+
     /**
      * @throws PubNubValidationException
      */
@@ -138,6 +151,14 @@ protected function customParams()
             $this->includeTimetoken ? $params['include_token'] = "true" : $params['include_token'] = "false";
         }
 
+        if (isset($this->includeCustomMessageType)) {
+            if ($this->includeCustomMessageType) {
+                $params['include_custom_message_type'] = "true";
+            } else {
+                $params['include_custom_message_type'] = "false";
+            }
+        }
+
         return $params;
     }
 

src/PubNub/Endpoints/MessagePersistance/FetchMessages.php

@@ -31,8 +31,9 @@ class FetchMessages extends Endpoint
 
     protected bool $includeMeta = false;
     protected bool $includeUuid = false;
-    protected bool $includeMessageType = false;
+    protected bool $includeMessageType = true;
     protected bool $includeMessageActions = false;
+    protected bool $includeCustomMessageType = true;
 
     protected array $customParamMapping = [
         'start' => 'start',
@@ -41,6 +42,7 @@ class FetchMessages extends Endpoint
         'includeMeta' => 'include_meta',
         'includeUuid' => 'include_uuid',
         'includeMessageType' => 'include_message_type',
+        'includeCustomMessageType' => 'include_custom_message_type',
     ];
 
     public function channels(...$channel)
@@ -91,6 +93,12 @@ public function includeMessageType($includeMessageType)
         return $this;
     }
 
+    public function includeCustomMessageType($includeCustomMessageType)
+    {
+        $this->includeCustomMessageType = $includeCustomMessageType;
+        return $this;
+    }
+
     public function includeMessageActions($includeMessageActions)
     {
         $this->includeMessageActions = $includeMessageActions;
@@ -117,7 +125,11 @@ protected function customParams()
     {
         $params = [];
         foreach ($this->customParamMapping as $customParam => $requestParam) {
-            if (isset($this->$customParam) && !empty($this->$customParam)) {
+            if (isset($this->$customParam) && !is_null($this->$customParam)) {
+                if (strpos($customParam, 'include') === 0) {
+                    $params[$requestParam] = $this->$customParam ? 'true' : 'false';
+                    continue;
+                }
                 $params[$requestParam] = $this->$customParam;
             }
         }

src/PubNub/Endpoints/PubSub/Signal.php

@@ -20,6 +20,9 @@ class Signal extends Endpoint
     /** @var  string $channel to send message on*/
     protected $channel;
 
+    /** @var string $customMessageType User defined message type */
+    protected ?string $customMessageType;
+
     /**
      * @param mixed $message
      * @return $this
@@ -42,6 +45,17 @@ public function channel($channel)
         return $this;
     }
 
+    /**
+     * @param string $customMessageType
+     * @return $this
+     */
+    public function customMessageType(?string $customMessageType)
+    {
+        $this->customMessageType = $customMessageType;
+
+        return $this;
+    }
+
     /**
      * @throws PubNubValidationException
      */
@@ -84,7 +98,13 @@ protected function buildData()
 
     protected function customParams()
     {
-        return [];
+        $params = [];
+
+        if (isset($this->customMessageType)) {
+            $params['custom_message_type'] = $this->customMessageType;
+        }
+
+        return $params;
     }
 
     /**

src/PubNub/Models/Consumer/MessagePersistence/PNFetchMessagesItemResult.php

@@ -4,12 +4,13 @@
 
 class PNFetchMessagesItemResult
 {
-    protected mixed $message;
-    protected string $timetoken;
-    protected mixed $metadata;
-    protected mixed $actions;
-    protected string $uuid;
-    protected string $messageType;
+    protected mixed $message = null;
+    protected ?string $timetoken = null;
+    protected mixed $metadata = null;
+    protected mixed $actions = null;
+    protected ?string $uuid = null;
+    protected ?string $messageType = null;
+    protected ?string $customMessageType = null;
 
 
     public function __construct(mixed $message, string $timetoken)
@@ -42,12 +43,18 @@ public function setMessageType(string $messageType)
         return $this;
     }
 
+    public function setCustomMessageType(string $customMessageType)
+    {
+        $this->customMessageType = $customMessageType;
+        return $this;
+    }
+
     public function getMessage(): mixed
     {
         return $this->message;
     }
 
-    public function getTimetoken(): string
+    public function getTimetoken(): ?string
     {
         return $this->timetoken;
     }
@@ -62,16 +69,21 @@ public function getActions(): mixed
         return $this->actions;
     }
 
-    public function getUuid(): string
+    public function getUuid(): ?string
     {
         return $this->uuid;
     }
 
-    public function getMessageType(): string
+    public function getMessageType(): ?string
     {
         return $this->messageType;
     }
 
+    public function getCustomMessageType(): ?string
+    {
+        return $this->customMessageType;
+    }
+
     public static function fromJson($json, $crypto): static
     {
         $message = $json['message'];
@@ -91,6 +103,10 @@ public static function fromJson($json, $crypto): static
             $item->setMessageType($json['message_type']);
         }
 
+        if (isset($json['custom_message_type'])) {
+            $item->setCustomMessageType($json['custom_message_type']);
+        }
+
         if (isset($json['meta'])) {
             $item->setMetadata($json['meta']);
         }