@open-wa/wa-automate 4.28.10 → 4.29.0

package/dist/api/Client.d.ts

@@ -40,7 +40,10 @@ export declare class Client {
     private _prio;
     private _pageListeners;
     private _registeredPageListeners;
+    private _onLogoutCallbacks;
     private _queues;
+    private _autoEmojiSet;
+    private _onLogoutSet;
     /**
      * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
      * For this reason, listeners assigned to a webhook are only set once and map through all possible webhooks to and fire only if the specific listener is assigned.
@@ -111,13 +114,18 @@ export declare class Client {
      *
      * @event
      * @param fn callback
+     * @param priority A priority of -1 will mean the callback will be triggered after all the non -1 callbacks
      * @fires `true`
      */
     onLogout(fn: (loggedOut?: boolean) => any, priority?: number): Promise<boolean>;
     /**
      * Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.
      */
-    waitWhQIdle(): Promise<any>;
+    waitWhQIdle(): Promise<true | void>;
+    /**
+     * Wait for all queues to be empty
+     */
+    waitAllQEmpty(): Promise<true | void[]>;
     /**
      * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
      */

package/dist/api/Client.js

@@ -56,7 +56,6 @@ const fs = __importStar(require("fs"));
 const datauri_1 = __importDefault(require("datauri"));
 const is_url_superb_1 = __importDefault(require("is-url-superb"));
 const fs_extra_1 = require("fs-extra");
-const tree_kill_1 = __importDefault(require("tree-kill"));
 const browser_1 = require("../controllers/browser");
 const auth_1 = require("../controllers/auth");
 const wa_decrypt_1 = require("@open-wa/wa-decrypt");
@@ -90,7 +89,10 @@ class Client {
         this._prio = Number.MAX_SAFE_INTEGER;
         this._pageListeners = [];
         this._registeredPageListeners = [];
+        this._onLogoutCallbacks = [];
         this._queues = {};
+        this._autoEmojiSet = false;
+        this._onLogoutSet = false;
         /**
          * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
          * For this reason, listeners assigned to a webhook are only set once and map through all possible webhooks to and fire only if the specific listener is assigned.
@@ -248,7 +250,7 @@ class Client {
             logging_1.log.info('LOADED', {
                 PHONE_VERSION: this._sessionInfo.PHONE_VERSION
             });
-            if (((_d = this._createConfig) === null || _d === void 0 ? void 0 : _d.autoEmoji) === undefined || ((_e = this._createConfig) === null || _e === void 0 ? void 0 : _e.autoEmoji)) {
+            if ((((_d = this._createConfig) === null || _d === void 0 ? void 0 : _d.autoEmoji) === undefined || ((_e = this._createConfig) === null || _e === void 0 ? void 0 : _e.autoEmoji)) && !this._autoEmojiSet) {
                 const ident = typeof ((_f = this._createConfig) === null || _f === void 0 ? void 0 : _f.autoEmoji) === "string" ? (_g = this._createConfig) === null || _g === void 0 ? void 0 : _g.autoEmoji : ":";
                 this.onMessage((message) => __awaiter(this, void 0, void 0, function* () {
                     if (message.body && message.body.startsWith(ident) && message.body.endsWith(ident)) {
@@ -258,18 +260,21 @@ class Client {
                         return yield this.sendEmoji(message.from, emojiId, message.id);
                     }
                 }));
+                this._autoEmojiSet = true;
             }
-            if (((_h = this._createConfig) === null || _h === void 0 ? void 0 : _h.deleteSessionDataOnLogout) || ((_j = this._createConfig) === null || _j === void 0 ? void 0 : _j.killClientOnLogout)) {
-                this.onLogout(() => {
-                    var _a, _b;
-                    if ((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.deleteSessionDataOnLogout)
+            if ((((_h = this._createConfig) === null || _h === void 0 ? void 0 : _h.deleteSessionDataOnLogout) || ((_j = this._createConfig) === null || _j === void 0 ? void 0 : _j.killClientOnLogout)) && !this._onLogoutSet) {
+                this.onLogout(() => __awaiter(this, void 0, void 0, function* () {
+                    var _k, _l;
+                    yield this.waitAllQEmpty();
+                    if ((_k = this._createConfig) === null || _k === void 0 ? void 0 : _k.deleteSessionDataOnLogout)
                         (0, browser_1.deleteSessionData)(this._createConfig);
-                    if ((_b = this._createConfig) === null || _b === void 0 ? void 0 : _b.killClientOnLogout) {
+                    if ((_l = this._createConfig) === null || _l === void 0 ? void 0 : _l.killClientOnLogout) {
                         console.log("Session logged out. Killing client");
                         logging_1.log.warn("Session logged out. Killing client");
                         this.kill("LOGGED_OUT");
                     }
-                });
+                }), -1);
+                this._onLogoutSet = true;
             }
         });
     }
@@ -536,7 +541,7 @@ class Client {
                 fn = _fn;
             }
             if (this._registeredEvListeners && this._registeredEvListeners[funcName]) {
-                return events_1.ev.on(this.getEventSignature(funcName), ({ data }) => fn(data));
+                return events_1.ev.on(this.getEventSignature(funcName), ({ data }) => fn(data), { objectify: true });
             }
             /**
              * If evMode is on then make the callback come from ev.
@@ -567,27 +572,47 @@ class Client {
         });
         if (this._registeredPageListeners.includes(event))
             return true;
+        this._registeredPageListeners.push(event);
+        logging_1.log.info(`setting page listener: ${event}`, this._registeredPageListeners);
         this._page.on(event, (...args) => __awaiter(this, void 0, void 0, function* () {
-            return yield Promise.all(this._pageListeners.filter(l => l.event === event).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            yield Promise.all(this._pageListeners.filter(l => l.event === event).filter(({ priority }) => priority !== -1).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            yield Promise.all(this._pageListeners.filter(l => l.event === event).filter(({ priority }) => priority == -1).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            return;
         }));
-        this._registeredPageListeners.push(event);
     }
     /**
      * Listens to a log out event
      *
      * @event
      * @param fn callback
+     * @param priority A priority of -1 will mean the callback will be triggered after all the non -1 callbacks
      * @fires `true`
      */
     onLogout(fn, priority) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.registerPageEventListener('framenavigated', (frame) => __awaiter(this, void 0, void 0, function* () {
+            const event = 'framenavigated';
+            this._onLogoutCallbacks.push({
+                callback: fn,
+                priority
+            });
+            if (!this._queues[event])
+                this._queues[event] = new p_queue_1.default({
+                    concurrency: 1,
+                    intervalCap: 1,
+                    carryoverConcurrencyCount: true
+                });
+            if (this._registeredPageListeners.includes(event))
+                return true;
+            this.registerPageEventListener(event, (frame) => __awaiter(this, void 0, void 0, function* () {
                 if (frame.url().includes('post_logout=1')) {
                     console.log("LOGGED OUT");
                     logging_1.log.warn("LOGGED OUT");
-                    yield fn(true);
+                    yield Promise.all(this._onLogoutCallbacks.filter(c => c.priority !== -1).map(({ callback }) => this._queues[event].add(() => callback(true))));
+                    yield this._queues[event].onEmpty();
+                    yield Promise.all(this._onLogoutCallbacks.filter(c => c.priority == -1).map(({ callback }) => this._queues[event].add(() => callback(true))));
+                    yield this._queues[event].onEmpty();
                 }
-            }), priority);
+            }), priority || 1);
             return true;
         });
     }
@@ -602,6 +627,18 @@ class Client {
             return true;
         });
     }
+    /**
+     * Wait for all queues to be empty
+     */
+    waitAllQEmpty() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.all([
+                this._webhookQueue,
+                ...Object.values(this._queues)
+            ].filter(q => q).map(q => q === null || q === void 0 ? void 0 : q.onEmpty()));
+            return true;
+        });
+    }
     /**
      * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
      */
@@ -1054,25 +1091,17 @@ class Client {
      * @returns true
      */
     kill(reason = "MANUALLY_KILLED") {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             if (this._currentlyBeingKilled)
                 return;
             this._currentlyBeingKilled = true;
             console.log('Killing client. Shutting Down');
             logging_1.log.info('Killing client. Shutting Down');
-            (0, tools_1.processSendData)({
-                reason
-            });
             const browser = yield ((_a = this === null || this === void 0 ? void 0 : this._page) === null || _a === void 0 ? void 0 : _a.browser());
             const pid = (browser === null || browser === void 0 ? void 0 : browser.process()) ? (_b = browser === null || browser === void 0 ? void 0 : browser.process()) === null || _b === void 0 ? void 0 : _b.pid : null;
             try {
-                if (this._page && !((_c = this._page) === null || _c === void 0 ? void 0 : _c.isClosed()))
-                    yield ((_d = this._page) === null || _d === void 0 ? void 0 : _d.close());
-                if (this._page && ((_e = this._page) === null || _e === void 0 ? void 0 : _e.browser))
-                    yield ((_g = (_f = this._page) === null || _f === void 0 ? void 0 : _f.browser()) === null || _g === void 0 ? void 0 : _g.close());
-                if (pid)
-                    (0, tree_kill_1.default)(pid, 'SIGKILL');
+                yield (0, browser_1.kill)(this._page, browser, false, pid, reason);
             }
             catch (error) {
                 //ignore error

package/dist/cli/index.js

@@ -109,11 +109,11 @@ function start() {
             client.onLogout(() => __awaiter(this, void 0, void 0, function* () {
                 console.error('!!!! CLIENT LOGGED OUT !!!!');
                 if (cliConfig && !cliConfig.noKillOnLogout) {
-                    yield client.waitWhQIdle();
+                    yield client.waitAllQEmpty();
                     console.error("Shutting down.");
                     process.exit();
                 }
-            }));
+            }), -1);
             if (cliConfig === null || cliConfig === void 0 ? void 0 : cliConfig.botPressUrl) {
                 spinner.info('Setting Up Botpress handler');
                 (0, server_1.setupBotPressHandler)(cliConfig, client);

package/dist/controllers/browser.js

@@ -41,7 +41,7 @@ const events_1 = require("./events");
 const pico_s3_1 = require("pico-s3");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const puppeteer = require('puppeteer-extra');
-const tree_kill_1 = __importDefault(require("tree-kill"));
+const promise_1 = __importDefault(require("terminate/promise"));
 const logging_1 = require("../logging/logging");
 const tools_1 = require("../utils/tools");
 let browser;
@@ -406,7 +406,7 @@ const kill = (p, b, exit, pid, reason = "LAUNCH_KILL") => __awaiter(void 0, void
         yield killBrowser(b);
     }
     if (pid)
-        (0, tree_kill_1.default)(pid, 'SIGKILL');
+        yield (0, promise_1.default)(pid, 'SIGKILL').catch(e => console.error('Error while terminating browser PID. You can just ignore this, as the process has most likely been terminated successfully already:', e.message));
     if (exit)
         process.exit();
     return;

package/dist/utils/tools.js

@@ -25,7 +25,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateGHIssueLink = exports.processSendData = exports.processSend = exports.base64MimeType = exports.getDUrl = exports.isDataURL = exports.isBase64 = exports.camelize = exports.without = exports.getConfigFromProcessEnv = exports.smartUserAgent = exports.timeout = void 0;
 const axios_1 = __importDefault(require("axios"));
-const node_child_process_1 = require("node:child_process");
+const child_process_1 = require("child_process");
 //@ts-ignore
 process.send = process.send || function () { };
 const timeout = ms => new Promise(resolve => setTimeout(resolve, ms, 'timeout'));
@@ -147,7 +147,7 @@ const processSendData = (data = {}) => {
 };
 exports.processSendData = processSendData;
 const generateGHIssueLink = (config, sessionInfo, extras = {}) => {
-    const npm_ver = (0, node_child_process_1.execSync)('npm -v');
+    const npm_ver = (0, child_process_1.execSync)('npm -v');
     const labels = [];
     if (sessionInfo.CLI)
         labels.push('CLI');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.28.10",
+  "version": "4.29.0",
   "licenseCheckUrl": "https://openwa.dev/license-check",
   "brokenMethodReportUrl": "https://openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",
@@ -60,6 +60,9 @@
     "node": ">=12.18.3",
     "npm": ">=7.9.0"
   },
+  "resolutions": {
+    "colors": "1.4.0"
+  },
   "devDependencies": {
     "@types/changelog-parser": "^2.7.1",
     "@types/command-line-args": "^5.0.0",
@@ -156,9 +159,9 @@
     "swagger-ui-express": "^4.1.4",
     "tcp-port-used": "^1.0.1",
     "terminal-link": "^2.1.1",
+    "terminate": "^2.5.0",
     "tiny-glob": "^0.2.9",
     "traverse": "^0.6.6",
-    "tree-kill": "^1.2.2",
     "ts-json-schema-generator": "^0.95.0",
     "ts-morph": "^12.0.0",
     "type-fest": "^1.1.1",