Merge pull request #289 from Secreto31126/user-function

Implemented user_function to handle callbacks

Author: Secreto31126

package.json

@@ -1,6 +1,6 @@
 {
     "name": "whatsapp-api-js",
-    "version": "2.4.0",
+    "version": "2.5.0",
     "author": "Secreto31126",
     "description": "A TypeScript server agnostic Whatsapp's Official API framework",
     "license": "MIT",

src/index.ts

@@ -59,6 +59,11 @@ export default class WhatsAppAPI {
      * If true, API operations will return the fetch promise instead. Intended for low level debugging.
      */
     private parsed: boolean;
+    /**
+     * If false, the user functions won't be offloaded from the main event loop.
+     * Intended for Serverless Environments where the process might be killed after the main function finished.
+     */
+    private offload_functions: boolean;
     /**
      * If false, the API will be used in a less secure way, reducing the need for appSecret. Defaults to true.
      */
@@ -108,6 +113,7 @@ export default class WhatsAppAPI {
         webhookVerifyToken,
         v = "v18.0",
         parsed = true,
+        offload_functions = true,
         secure = true,
         ponyfill = {}
     }: WhatsAppAPIConstructorArguments) {
@@ -152,6 +158,7 @@ export default class WhatsAppAPI {
         this.v = v;
 
         this.parsed = !!parsed;
+        this.offload_functions = !!offload_functions;
     }
 
     //#region Message Operations
@@ -240,7 +247,7 @@ export default class WhatsAppAPI {
             response
         };
 
-        this.offload(this.on?.sent, args);
+        this.user_function(this.on?.sent, args);
 
         return response ?? promise;
     }
@@ -775,7 +782,7 @@ export default class WhatsAppAPI {
                 Whatsapp: this
             };
 
-            this.offload(this.on?.message, args);
+            this.user_function(this.on?.message, args);
         } else if ("statuses" in value) {
             const statuses = value.statuses[0];
 
@@ -799,7 +806,7 @@ export default class WhatsAppAPI {
                 raw: data
             };
 
-            this.offload(this.on?.status, args);
+            this.user_function(this.on?.status, args);
         }
         // If unknown payload, just ignore it
         // Facebook doesn't care about your server's opinion
@@ -868,6 +875,7 @@ export default class WhatsAppAPI {
     /**
      * Get the body of a fetch response
      *
+     * @internal
      * @param promise - The fetch response
      * @returns The json body parsed
      */
@@ -878,19 +886,34 @@ export default class WhatsAppAPI {
     }
 
     /**
-     * Offload a function to the next tick of the event loop
+     * Call a user function, offloading it from the main thread if needed
      *
      * @internal
-     * @param f - The function to offload from the main thread
+     * @param f - The user function to call
      * @param a - The arguments to pass to the function
      */
-    private offload<A, F extends ((...a: A[]) => unknown) | undefined>(
+    private user_function<A, F extends ((...a: A[]) => unknown) | undefined>(
         f: F,
         ...a: A[]
     ) {
         if (f) {
-            // Thanks @RahulLanjewar93
-            Promise.resolve().then(() => f(...a));
+            if (this.offload_functions) {
+                this.offload(f, ...a);
+            } else {
+                f(...a);
+            }
         }
     }
+
+    /**
+     * Offload a function to the next tick of the event loop
+     *
+     * @internal
+     * @param f - The function to offload from the main thread
+     * @param a - The arguments to pass to the function
+     */
+    private offload<A, F extends (...a: A[]) => unknown>(f: F, ...a: A[]) {
+        // Thanks @RahulLanjewar93
+        Promise.resolve().then(() => f(...a));
+    }
 }

src/types.ts

@@ -68,6 +68,11 @@ export type TheBasicConstructorArguments = {
      * Intended for low level debugging.
      */
     parsed?: boolean;
+    /**
+     * If false, the user functions won't be offloaded from the main event loop.
+     * Intended for Serverless Environments where the process might be killed after the main function finished.
+     */
+    offload_functions?: boolean;
     /**
      * If set to false, none of the API checks will be performed, and it will be used in a less secure way.
      *

test/index.test.cjs

@@ -1681,6 +1681,7 @@ describe("WhatsAppAPI", function () {
                     // This should improve the test speed
                     // Validation is already tested in the previous section
                     Whatsapp.secure = false;
+                    Whatsapp.offload_functions = true;
                 });
 
                 it("should parse the post request and call back with the right parameters", async function () {
@@ -1755,6 +1756,31 @@ describe("WhatsAppAPI", function () {
                     sinon_assert.calledOnce(spy_on_message);
                 });
 
+                it("should block the main thread with the user's callback if offload_functions is false", async function () {
+                    // Emulates a blocking function
+                    function block(delay) {
+                        const start = Date.now();
+                        while (Date.now() - start < delay);
+                    }
+
+                    const shorter_delay = 5;
+                    const longer_delay = 10;
+
+                    Whatsapp.offload_functions = false;
+
+                    Whatsapp.on.message = () => {
+                        block(longer_delay);
+                        spy_on_message();
+                    };
+
+                    Whatsapp.post(valid_message_mock);
+
+                    // Do critical operations for less time than the user's function
+                    block(shorter_delay);
+
+                    sinon_assert.calledOnce(spy_on_message);
+                });
+
                 it("should throw TypeError if the request is missing any data", function () {
                     let moddedMock;
 
@@ -1782,6 +1808,7 @@ describe("WhatsAppAPI", function () {
                     // This should improve the test speed
                     // Validation is already tested in the previous section
                     Whatsapp.secure = false;
+                    Whatsapp.offload_functions = true;
                 });
 
                 it("should parse the post request and call back with the right parameters", async function () {
@@ -1832,6 +1859,31 @@ describe("WhatsAppAPI", function () {
                     sinon_assert.calledOnce(spy_on_status);
                 });
 
+                it("should block the main thread with the user's callback if offload_functions is false", async function () {
+                    // Emulates a blocking function
+                    function block(delay) {
+                        const start = Date.now();
+                        while (Date.now() - start < delay);
+                    }
+
+                    const shorter_delay = 5;
+                    const longer_delay = 10;
+
+                    Whatsapp.offload_functions = false;
+
+                    Whatsapp.on.status = () => {
+                        block(longer_delay);
+                        spy_on_status();
+                    };
+
+                    Whatsapp.post(valid_status_mock);
+
+                    // Do critical operations for less time than the user's function
+                    block(shorter_delay);
+
+                    sinon_assert.calledOnce(spy_on_status);
+                });
+
                 it("should throw TypeError if the request is missing any data", function () {
                     let moddedMock;