BKNDLSS-34660 - [JS]API for delete PUB_SUB channels

Backendless · Feb 16, 2024 · 45080d7 · 45080d7
1 parent 16d9f83
commit 45080d7
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 0 deletions.
diff --git a/backendless.d.ts b/backendless.d.ts
@@ -711,6 +711,8 @@ declare module Backendless {
 
         function subscribe(channelName: string): ChannelClass;
 
+        function deleteChannel(channelName: string): Promise<object>;
+
         function publish(channelName: string, message: string | Object, publishOptions?: Backendless.PublishOptions, deliveryOptions?: Backendless.DeliveryOptions): Promise<Object>;
 
         function sendEmail(subject: string, bodyParts: Backendless.Bodyparts, recipients: string[], attachments?: string[]): Promise<object>;

diff --git a/src/messaging/index.js b/src/messaging/index.js
@@ -54,6 +54,14 @@ export default class Messaging {
     })
   }
 
+  async deleteChannel(channelName) {
+    validateChannelName(channelName)
+
+    return this.app.request.delete({
+      url : this.app.urls.messagingChannelName(channelName),
+    })
+  }
+
   async pushWithTemplate(templateName, templateValues) {
     if (!templateName || typeof templateName !== 'string') {
       throw new Error('Push Template Name must be provided and must be a string.')

diff --git a/src/urls.js b/src/urls.js
@@ -219,6 +219,14 @@ export default class Urls {
     return `${this.messaging()}/${channel}`
   }
 
+  messagingChannels() {
+    return `${this.messaging()}/channels`
+  }
+
+  messagingChannelName(channelName) {
+    return `${this.messagingChannels()}/${channelName}`
+  }
+
   messagingMessage(messageId) {
     return `${this.messaging()}/${messageId}`
   }

diff --git a/test/tsd.ts b/test/tsd.ts
@@ -1559,6 +1559,8 @@ function testMessaging() {
 
     channel = Backendless.Messaging.subscribe(channelName);
 
+    promiseObject = Backendless.Messaging.deleteChannel(channelName);
+
     promiseObject = Backendless.Messaging.publish(channelName, message, publishOptions, deliveryOptions);
 
     promiseObject = Backendless.Messaging.sendEmail(subject, bodyParts, recipients, attachments);

diff --git a/test/unit/specs/messaging/channel.js b/test/unit/specs/messaging/channel.js
@@ -391,6 +391,43 @@ describe('<Messaging> Channel', function() {
 
   })
 
+  describe('Delete', () => {
+    it('deletes the specified channel', async () => {
+      const req1 = prepareMockRequest()
+
+      await Backendless.Messaging.deleteChannel(channelName)
+
+      expect(req1).to.deep.include({
+        method: 'DELETE',
+        path: `${APP_PATH}/messaging/channels/${channelName}`,
+      })
+    })
+
+    it('fails when channelName is invalid', async () => {
+      const errorMsg = 'Channel Name must be provided and must be a string.'
+
+      await expect( Backendless.Messaging.deleteChannel()).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(undefined)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(null)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(true)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(false)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(0)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(123)).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel('')).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel({})).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel([])).to.eventually.be.rejectedWith(errorMsg)
+      await expect( Backendless.Messaging.deleteChannel(() => ({}))).to.eventually.be.rejectedWith(errorMsg)
+    })
+
+    it('fails when channelName has a slash char', async () => {
+      const errorMsg = 'Channel Name can not contain slash chars'
+
+      await expect(Backendless.Messaging.deleteChannel('/channelName')).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Messaging.deleteChannel('channel/Name')).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Messaging.deleteChannel('channelName/')).to.eventually.be.rejectedWith(errorMsg)
+    })
+  })
+
   describe('Connection', () => {
     it('can join and leave the channel', async () => {
       const sub1Promise = rtClient.getNext_SUB_ON() // PUB_SUB_CONNECT