store-s3-aws 1.3.13 → 1.3.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "store-s3-aws",
-  "version": "1.3.13",
+  "version": "1.3.15",
   "description": "Lib to store files in AWS S3",
   "main": "index.js",
   "scripts": {

package/src/AwsS3Store.js

@@ -1,167 +1,169 @@
-const path = require('path');
-const fs = require('fs');
-const { createReadStream } = require('fs');
-const { S3Client, HeadObjectCommand, GetObjectCommand, DeleteObjectCommand, CopyObjectCommand } = require('@aws-sdk/client-s3');
-const { Upload } = require('@aws-sdk/lib-storage');
-
-class AwsS3Store {
-
-  #clientS3 = null;
-
-  /**
-   * A class for storing authentication data of Whatsapp-web.js to AWS S3.
-   * @example
-   * For example usage see `example/index.js`.
-   * @param {Object} options Specifies the params pattern.
-   * @param {String} options.bucketName Specifies the S3 bucket name.
-   * @param {String} options.remoteDataPath Specifies the remote path to save authentication files.
-   */
-  constructor({ bucketName, remoteDataPath, clientConfig} = {}) {
-    if (!bucketName) throw new Error("A valid bucket name is required for AwsS3Store.");
-    if (!remoteDataPath) throw new Error("A valid remote dir path is required for AwsS3Store.");
-    this.bucketName = bucketName;
-    this.remoteDataPath = remoteDataPath;
-    this.clientConfig = clientConfig
-    this.debugEnabled = process.env.STORE_DEBUG === 'true';
-  }
-
-  async sessionExists(options) {
-    this.debugLog('[METHOD: sessionExists] Triggered.');
-
-    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
-    const params = {
-      Bucket: this.bucketName,
-      Key: remoteFilePath
-    };
-    try {
-      await this.#getClientS3().send(new HeadObjectCommand(params));
-      this.debugLog(`[METHOD: sessionExists] File found. PATH='${remoteFilePath}'.`);
-      return true;
-    } catch (err) {
-      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
-        this.debugLog(`[METHOD: sessionExists] File not found. PATH='${remoteFilePath}'.`);
-        return false;
-      }
-      this.debugLog(`[METHOD: sessionExists] Error: ${err.message}`);
-      // throw err;
-      return
-    }
-  }
-
-  async save(options) {
-    this.debugLog('[METHOD: save] Triggered.');
-    this.debugLog(`Options: ${JSON.stringify(options, null, 2)}`);
-
-    const fileName = path.basename(options.session)
-    const remoteFilePath = path.join(this.remoteDataPath, `${fileName}.zip`).replace(/\\/g, '/');
-    options.remoteFilePath = remoteFilePath;
-    //await this.#deletePrevious(options);
-    
-    const fileStream = createReadStream(`${options.session}.zip`);
-    
-    const upload = new Upload({
-      client: this.#getClientS3(),
-      params: {
-        Bucket: this.bucketName,
-        Key: remoteFilePath,
-        Body: fileStream,
-      },
-      leavePartsOnError: false,
-    });
-    
-    await upload.done();
-    
-    this.debugLog(`[METHOD: save] File saved. PATH='${remoteFilePath}'.`);
-  }
-
-  async extract(options) {
-    this.debugLog('[METHOD: extract] Triggered.');
-
-    this.debugLog(`Options: ${JSON.stringify(options, null, 2)}`);
-
-    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
-    const params = {
-      Bucket: this.bucketName,
-      Key: remoteFilePath
-    };
-    const fileStream = fs.createWriteStream(options.path);
-    const response = await this.#getClientS3().send(new GetObjectCommand(params));
-    await new Promise((resolve, reject) => {
-      response.Body.pipe(fileStream)
-        .on('error', reject)
-        .on('finish', resolve);
-    });
-
-    this.debugLog(`[METHOD: extract] File extracted. REMOTE_PATH='${remoteFilePath}', LOCAL_PATH='${options.path}'.`);
-
-  }
-
-  async delete(options) {
-    this.debugLog('[METHOD: delete] Triggered.');
-
-    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
-    const params = {
-      Bucket: this.bucketName,
-      Key: remoteFilePath
-    };
-    try {
-      await this.#getClientS3().send(new HeadObjectCommand(params));
-      await this.#getClientS3().send(new DeleteObjectCommand(params));
-      this.debugLog(`[METHOD: delete] File deleted. PATH='${remoteFilePath}'.`);
-    } catch (err) {
-      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
-        this.debugLog(`[METHOD: delete] File not found. PATH='${remoteFilePath}'.`);
-        return;
-      } 
-      this.debugLog(`[METHOD: delete] Error: ${err.message}`);
-      // throw err;
-      return
-    }
-  }
-
-  async #deletePrevious(options) {
-    this.debugLog('[METHOD: #deletePrevious] Triggered.');
-
-    const params = {
-      Bucket: this.bucketName,
-      Key: options.remoteFilePath
-    };
-    try {
-      await this.#getClientS3().send(new HeadObjectCommand(params));
-      const backupKey = `${options.remoteFilePath}.backup`;
-      await this.#getClientS3().send(new CopyObjectCommand({
-        Bucket: this.bucketName,
-        CopySource: `${this.bucketName}/${options.remoteFilePath}`,
-        Key: backupKey
-      }));
-      await this.#getClientS3().send(new DeleteObjectCommand(params));
-      this.debugLog(`[METHOD: #deletePrevious] File deleted. PATH='${options.remoteFilePath}'.`);
-    } catch (err) {
-      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
-        this.debugLog(`[METHOD: #deletePrevious] File not found. PATH='${options.remoteFilePath}'.`);
-        return;
-      }
-      this.debugLog(`[METHOD: #deletePrevious] Error: ${err.message}`);
-      // throw err;
-      return
-    }
-  }
-
-  #getClientS3() {
-    if (this.#clientS3 === null) {
-      this.#clientS3 = new S3Client({
-        region: this.clientConfig.region
-      });
-    }
-    return this.#clientS3;
-  }
-
-  debugLog(msg) {
-    if (this.debugEnabled) {
-      const timestamp = new Date().toISOString();
-      console.log(`${timestamp} [STORE_DEBUG] ${msg}`);
-    }
-  }
-}
-
-module.exports = AwsS3Store;
+const path = require('path');
+const fs = require('fs');
+const { createReadStream } = require('fs');
+const { S3Client, HeadObjectCommand, GetObjectCommand, DeleteObjectCommand, CopyObjectCommand } = require('@aws-sdk/client-s3');
+const { Upload } = require('@aws-sdk/lib-storage');
+
+class AwsS3Store {
+
+  #clientS3 = null;
+
+  /**
+   * A class for storing authentication data of Whatsapp-web.js to AWS S3.
+   * @example
+   * For example usage see `example/index.js`.
+   * @param {Object} options Specifies the params pattern.
+   * @param {String} options.bucketName Specifies the S3 bucket name.
+   * @param {String} options.remoteDataPath Specifies the remote path to save authentication files.
+   */
+  constructor({ bucketName, remoteDataPath, clientConfig} = {}) {
+    if (!bucketName) throw new Error("A valid bucket name is required for AwsS3Store.");
+    if (!remoteDataPath) throw new Error("A valid remote dir path is required for AwsS3Store.");
+    this.bucketName = bucketName;
+    this.remoteDataPath = remoteDataPath;
+    this.clientConfig = clientConfig
+    this.debugEnabled = process.env.STORE_DEBUG === 'true';
+  }
+
+  async sessionExists(options) {
+    this.debugLog('[METHOD: sessionExists] Triggered.');
+
+    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
+    const params = {
+      Bucket: this.bucketName,
+      Key: remoteFilePath
+    };
+    try {
+      await this.#getClientS3().send(new HeadObjectCommand(params));
+      this.debugLog(`[METHOD: sessionExists] File found. PATH='${remoteFilePath}'.`);
+      return true;
+    } catch (err) {
+      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
+        this.debugLog(`[METHOD: sessionExists] File not found. PATH='${remoteFilePath}'.`);
+        return false;
+      }
+      this.debugLog(`[METHOD: sessionExists] Error: ${err.message}`);
+      // throw err;
+      return
+    }
+  }
+
+  async save(options) {
+    this.debugLog('[METHOD: save] Triggered.');
+    this.debugLog(`Options: ${JSON.stringify(options, null, 2)}`);
+
+    const fileName = path.basename(options.session)
+    const remoteFilePath = path.join(this.remoteDataPath, `${fileName}.zip`).replace(/\\/g, '/');
+    options.remoteFilePath = remoteFilePath;
+    //await this.#deletePrevious(options);
+    
+    const fileStream = createReadStream(`./.wwebjs_auth/${options.session}.zip`);
+    
+    const upload = new Upload({
+      client: this.#getClientS3(),
+      params: {
+        Bucket: this.bucketName,
+        Key: remoteFilePath,
+        Body: fileStream,
+      },
+      leavePartsOnError: false,
+    });
+    
+    await upload.done();
+    
+    this.debugLog(`[METHOD: save] File saved. PATH='${remoteFilePath}'.`);
+  }
+
+  async extract(options) {
+    this.debugLog('[METHOD: extract] Triggered.');
+
+    this.debugLog(`Options: ${JSON.stringify(options, null, 2)}`);
+
+    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
+    const params = {
+      Bucket: this.bucketName,
+      Key: remoteFilePath
+    };
+    const dir = path.dirname(options.path);
+    await fs.promises.mkdir(dir, { recursive: true });
+    const fileStream = fs.createWriteStream(options.path);
+    const response = await this.#getClientS3().send(new GetObjectCommand(params));
+    await new Promise((resolve, reject) => {
+      response.Body.pipe(fileStream)
+        .on('error', reject)
+        .on('finish', resolve);
+    });
+
+    this.debugLog(`[METHOD: extract] File extracted. REMOTE_PATH='${remoteFilePath}', LOCAL_PATH='${options.path}'.`);
+
+  }
+
+  async delete(options) {
+    this.debugLog('[METHOD: delete] Triggered.');
+
+    const remoteFilePath = path.join(this.remoteDataPath, `${options.session}.zip`).replace(/\\/g, '/');
+    const params = {
+      Bucket: this.bucketName,
+      Key: remoteFilePath
+    };
+    try {
+      await this.#getClientS3().send(new HeadObjectCommand(params));
+      await this.#getClientS3().send(new DeleteObjectCommand(params));
+      this.debugLog(`[METHOD: delete] File deleted. PATH='${remoteFilePath}'.`);
+    } catch (err) {
+      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
+        this.debugLog(`[METHOD: delete] File not found. PATH='${remoteFilePath}'.`);
+        return;
+      } 
+      this.debugLog(`[METHOD: delete] Error: ${err.message}`);
+      // throw err;
+      return
+    }
+  }
+
+  async #deletePrevious(options) {
+    this.debugLog('[METHOD: #deletePrevious] Triggered.');
+
+    const params = {
+      Bucket: this.bucketName,
+      Key: options.remoteFilePath
+    };
+    try {
+      await this.#getClientS3().send(new HeadObjectCommand(params));
+      const backupKey = `${options.remoteFilePath}.backup`;
+      await this.#getClientS3().send(new CopyObjectCommand({
+        Bucket: this.bucketName,
+        CopySource: `${this.bucketName}/${options.remoteFilePath}`,
+        Key: backupKey
+      }));
+      await this.#getClientS3().send(new DeleteObjectCommand(params));
+      this.debugLog(`[METHOD: #deletePrevious] File deleted. PATH='${options.remoteFilePath}'.`);
+    } catch (err) {
+      if (err.name === 'NoSuchKey' || err.name === 'NotFound') {
+        this.debugLog(`[METHOD: #deletePrevious] File not found. PATH='${options.remoteFilePath}'.`);
+        return;
+      }
+      this.debugLog(`[METHOD: #deletePrevious] Error: ${err.message}`);
+      // throw err;
+      return
+    }
+  }
+
+  #getClientS3() {
+    if (this.#clientS3 === null) {
+      this.#clientS3 = new S3Client({
+        region: this.clientConfig.region
+      });
+    }
+    return this.#clientS3;
+  }
+
+  debugLog(msg) {
+    if (this.debugEnabled) {
+      const timestamp = new Date().toISOString();
+      console.log(`${timestamp} [STORE_DEBUG] ${msg}`);
+    }
+  }
+}
+
+module.exports = AwsS3Store;