imapflow 1.0.156 → 1.0.158

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.0.158](https://github.com/postalsys/imapflow/compare/v1.0.157...v1.0.158) (2024-03-19)
+
+
+### Bug Fixes
+
+* **locking:** log extra information about locks ([9790ec5](https://github.com/postalsys/imapflow/commit/9790ec575f405820d05dd4777987a88e0a4e819d))
+
+## [1.0.157](https://github.com/postalsys/imapflow/compare/v1.0.156...v1.0.157) (2024-03-19)
+
+
+### Bug Fixes
+
+* **logs:** Log mailbox lock description ([ce87cf5](https://github.com/postalsys/imapflow/commit/ce87cf5a256ddc324624893a1c17992475fafeb3))
+
 ## [1.0.156](https://github.com/postalsys/imapflow/compare/v1.0.155...v1.0.156) (2024-03-07)
 
 

package/lib/commands/idle.js

@@ -21,7 +21,7 @@ async function runIdle(connection) {
                     src: 'c',
                     msg: `DONE`,
                     comment: `breaking IDLE`,
-                    lockId: connection.currentLockId,
+                    lockId: connection.currentLock?.lockId,
                     path: connection.mailbox && connection.mailbox.path
                 });
                 connection.write('DONE');
@@ -44,7 +44,7 @@ async function runIdle(connection) {
 
             connection.log.trace({
                 msg: 'Requesting IDLE break',
-                lockId: connection.currentLockId,
+                lockId: connection.currentLock?.lockId,
                 path: connection.mailbox && connection.mailbox.path,
                 queued: preCheckWaitQueue.length,
                 doneRequested,
@@ -74,7 +74,7 @@ async function runIdle(connection) {
         if (typeof connection.preCheck === 'function') {
             connection.log.trace({
                 msg: 'Clearing pre-check function',
-                lockId: connection.currentLockId,
+                lockId: connection.currentLock?.lockId,
                 path: connection.mailbox && connection.mailbox.path,
                 queued: preCheckWaitQueue.length,
                 doneRequested,

package/lib/imap-flow.js

@@ -211,7 +211,7 @@ class ImapFlow extends EventEmitter {
         this.state = this.states.NOT_AUTHENTICATED;
 
         this.lockCounter = 0;
-        this.currentLockId = 0;
+        this.currentLock = false;
 
         this.tagCounter = 0;
         this.requestTagMap = new Map();
@@ -1313,7 +1313,7 @@ class ImapFlow extends EventEmitter {
 
         await new Promise((resolve, reject) => {
             this.connectTimeout = setTimeout(() => {
-                let err = new Error('Failed to established connection in required time');
+                let err = new Error('Failed to establish connection in required time');
                 err.code = 'CONNECT_TIMEOUT';
                 err.details = {
                     connectionTimeout: this.options.connectionTimeout || CONNECT_TIMEOUT
@@ -2840,26 +2840,51 @@ class ImapFlow extends EventEmitter {
 
     async processLocks(force) {
         if (!force && this.processingLock) {
+            this.log.trace({
+                msg: 'Mailbox locking queued',
+                path: this.mailbox && this.mailbox.path,
+                pending: this.locks.length,
+                idling: this.idling,
+                activeLock: this.currentLock
+                    ? {
+                          lockId: this.currentLock.lockId,
+                          ...(this.currentLock.options?.description && { description: this.currentLock.options?.description })
+                      }
+                    : null
+            });
             return;
         }
+
         if (!this.locks.length) {
             this.processingLock = false;
+            this.log.trace({
+                msg: 'Mailbox locking queue processed',
+                idling: this.idling
+            });
             return;
         }
+
         this.processingLock = true;
 
         const release = () => {
-            if (this.currentLockId) {
-                this.log.trace({ msg: 'Mailbox lock released', lockId: this.currentLockId, path: this.mailbox && this.mailbox.path });
-                this.currentLockId = 0;
+            if (this.currentLock) {
+                this.log.trace({
+                    msg: 'Mailbox lock released',
+                    lockId: this.currentLock.lockId,
+                    path: this.mailbox && this.mailbox.path,
+                    pending: this.locks.length,
+                    idling: this.idling
+                });
+                this.currentLock = false;
             }
             this.processLocks(true).catch(err => this.log.error({ err, cid: this.id }));
         };
 
-        const { resolve, reject, path, options, lockId } = this.locks.shift();
+        const lock = this.locks.shift();
+        const { resolve, reject, path, options, lockId } = lock;
 
         if (!this.usable || this.socket.destroyed) {
-            this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId });
+            this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId, idling: this.idling });
             // reject all
             let error = new Error('Connection not available');
             error.code = 'NoConnection';
@@ -2869,15 +2894,27 @@ class ImapFlow extends EventEmitter {
 
         if (this.mailbox && this.mailbox.path === path && !!this.mailbox.readOnly === !!options.readOnly) {
             // nothing to do here, already selected
-            this.log.trace({ msg: 'Mailbox lock acquired', path, lockId });
-            this.currentLockId = lockId;
+            this.log.trace({
+                msg: 'Mailbox lock acquired [existing]',
+                path,
+                lockId,
+                idling: this.idling,
+                ...(options.description && { description: options.description })
+            });
+            this.currentLock = lock;
             return resolve({ path, release });
         } else {
             try {
                 // Try to open. Throws if mailbox does not exists or can't open
                 await this.mailboxOpen(path, options);
-                this.log.trace({ msg: 'Lock acquired', path, lockId });
-                this.currentLockId = lockId;
+                this.log.trace({
+                    msg: 'Mailbox lock acquired [selected]',
+                    path,
+                    lockId,
+                    idling: this.idling,
+                    ...(options.description && { description: options.description })
+                });
+                this.currentLock = lock;
                 return resolve({ path, release });
             } catch (err) {
                 if (err.responseStatus === 'NO') {
@@ -2891,7 +2928,14 @@ class ImapFlow extends EventEmitter {
                     }
                 }
 
-                this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId });
+                this.log.trace({
+                    msg: 'Failed to acquire mailbox lock',
+                    path,
+                    lockId,
+                    idling: this.idling,
+                    ...(options.description && { description: options.description }),
+                    err
+                });
                 reject(err);
                 await this.processLocks(true);
             }
@@ -2925,7 +2969,18 @@ class ImapFlow extends EventEmitter {
         path = normalizePath(this, path);
 
         let lockId = ++this.lockCounter;
-        this.log.trace({ msg: 'Requesting lock', path, lockId });
+        this.log.trace({
+            msg: 'Requesting lock',
+            path,
+            lockId,
+            ...(options.description && { description: options.description }),
+            activeLock: this.currentLock
+                ? {
+                      lockId: this.currentLock.lockId,
+                      ...(this.currentLock.options?.description && { description: this.currentLock.options?.description })
+                  }
+                : null
+        });
 
         return await new Promise((resolve, reject) => {
             this.locks.push({ resolve, reject, path, options, lockId });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.156",
+    "version": "1.0.158",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {
@@ -32,7 +32,7 @@
         "@babel/eslint-plugin": "7.23.5",
         "@babel/plugin-syntax-class-properties": "7.12.13",
         "@babel/preset-env": "7.24.0",
-        "@types/node": "20.11.24",
+        "@types/node": "20.11.29",
         "eslint": "8.57.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.1.0",
@@ -52,7 +52,7 @@
         "libmime": "5.3.4",
         "libqp": "2.1.0",
         "mailsplit": "5.4.0",
-        "nodemailer": "6.9.11",
+        "nodemailer": "6.9.12",
         "pino": "8.19.0",
         "socks": "2.8.1"
     }