onjs 2.2.1 → 2.3.1

package/.github/workflows/github-actions.yml

@@ -12,6 +12,7 @@ on:
 permissions:
   contents: read
   pull-requests: read
+  id-token: write
 
 concurrency:
   group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
@@ -44,20 +45,26 @@ jobs:
     steps:
       - run: echo "The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      
       - run: echo "The ${{ github.repository }} repository has been cloned to the runner."
       - run: echo "The workflow is now ready to test your code on the runner."
+
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
       - name: Installing dependencies
-        run: npm install
+        run: npm ci
 
       - name: Testing
         run: npm test
+      
       - run: echo "Job's status is ${{ job.status }}."
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
+      
       - name: Publishing to NPM
-        run: npm publish
+        run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -22,7 +22,7 @@ To achieve this on On.js you have to register the event, declare the properties
 
 On.js uses it's own local Redis based queue to order to avoid duplicates if multiple services listen to the same event
 
-On.js provides two options for working with topics. Processing and Dispatching
+On.js provides three options for working with topics. Processing, Dispatching and Broadcasting
 
 Processing means that the task will be added to the queue and processed as soon as the queue determines that it can start processing it.
 
@@ -36,6 +36,16 @@ on
 
 ```
 
+Broadcasting means that the task will immediately be executed by ALL the listeners without using redis, the tasks will be "duplicated" across all listeners.
+
+```
+on
+	.broadcastReceived(eventName: string)
+	.do(callback: function)
+
+```
+
+
 #### Processing
 
 ```

package/lib/on.js

@@ -189,21 +189,18 @@ class On extends EventEmitter {
   }
 
   async _onTopicReceived (event, data) {
-    try {
-      this._eventLog('info', event.eventName, `Creating redis queue with name ${event.eventName}`)
+    this._eventLog('info', event.eventName, `Creating topic queue with name ${event.eventName}`)
 
-      if (event.dispatchAs && event.dispatchAs.length > 0) {
-        this._eventLog('info', event.eventName, `Event is redispatchable`)
-        await this._redispatchToMQ(event, data)
-      }
-      else {
-        this._eventLog('info', event.eventName, `Sending the event to redis as task ${event.eventName}`)
-        this._sendToRedisQueueToProcess(event, data)
-      }
+    if (event.dispatchAs && event.dispatchAs.length > 0) {
+      this._eventLog('info', event.eventName, `Event is redispatchable`)
+      return this._redispatchToMQ(event, data)
     }
-    catch (err) {
-      throw err
+    if (event.asTask) {
+      this._eventLog('info', event.eventName, `Event is going to execute as task`)
+      return this._onTaskReceived(event, data)
     }
+    this._eventLog('info', event.eventName, `Sending the event to redis as task ${event.eventName}`)
+    this._sendToRedisQueueToProcess(event, data)
   }
 
   // Consume queue events from MQ
@@ -318,6 +315,25 @@ class On extends EventEmitter {
     return this
   }
 
+  broadcastReceived (eventName) {
+    this.currentEventNameToRegister = eventName
+    this.currentEventTypeToRegister = 'topic'
+
+    if (this._eventExists(eventName, 'topic')) {
+      this._eventLog('info', eventName, `The event ${eventName} is already registered`)
+      throw new Error(`The event ${eventName} is already registered, possibly as eventReceived`)
+    }
+
+    this.events.push({
+      eventName: eventName,
+      type: 'topic',
+      asTask: true,
+    })
+
+    this._eventLog('info', eventName, `Registered event ${eventName} as broadcast`)
+    return this
+  }
+
   taskReceived (taskName, options = { isDelayed: false }) {
     const eventType = options.isDelayed ? 'delayedQueue' : 'queue'
     this.currentEventNameToRegister = taskName

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onjs",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "On.js is an event library based on RabbitMQ that helps you control events on a microservices arquitecture",
   "main": "index.js",
   "scripts": {