s3db.js 6.2.0 → 7.0.0

package/src/client.class.js

@@ -0,0 +1,515 @@
+import path from "path";
+import EventEmitter from "events";
+import { chunk } from "lodash-es";
+import { PromisePool } from "@supercharge/promise-pool";
+
+import { idGenerator } from "./concerns/id.js";
+import tryFn from "./concerns/try-fn.js";
+
+import {
+  S3Client,
+  PutObjectCommand,
+  GetObjectCommand,
+  CopyObjectCommand,
+  HeadObjectCommand,
+  DeleteObjectCommand,
+  DeleteObjectsCommand,
+  ListObjectsV2Command,
+} from '@aws-sdk/client-s3';
+import { md5 } from 'hash-wasm';
+
+import { mapAwsError, UnknownError, NoSuchKey, NotFound } from "./errors.js";
+import { ConnectionString } from "./connection-string.class.js";
+
+export class Client extends EventEmitter {
+  constructor({
+    verbose = false,
+    id = null,
+    AwsS3Client,
+    connectionString,
+    parallelism = 10,
+  }) {
+    super();
+    this.verbose = verbose;
+    this.id = id ?? idGenerator();
+    this.parallelism = parallelism;
+    this.config = new ConnectionString(connectionString);
+    this.client = AwsS3Client || this.createClient()
+  }
+
+  createClient() {
+    let options = {
+      region: this.config.region,
+      endpoint: this.config.endpoint,
+    }
+
+    if (this.config.forcePathStyle) options.forcePathStyle = true
+
+    if (this.config.accessKeyId) {
+      options.credentials = {
+        accessKeyId: this.config.accessKeyId,
+        secretAccessKey: this.config.secretAccessKey,
+      }
+    }
+
+    const client = new S3Client(options);
+
+    // Adiciona middleware para Content-MD5 em DeleteObjectsCommand
+    client.middlewareStack.add(
+      (next, context) => async (args) => {
+        if (context.commandName === 'DeleteObjectsCommand') {
+          const body = args.request.body;
+          if (body && typeof body === 'string') {
+            const contentMd5 = Buffer.from(await md5(body), 'hex').toString('base64');
+            args.request.headers['Content-MD5'] = contentMd5;
+          }
+        }
+        return next(args);
+      },
+      {
+        step: 'build',
+        name: 'addContentMd5ForDeleteObjects',
+        priority: 'high',
+      }
+    );
+
+    return client;
+  }
+
+  async sendCommand(command) {
+    this.emit("command.request", command.constructor.name, command.input);
+    const [ok, err, response] = await tryFn(() => this.client.send(command));
+    if (!ok) {
+      const bucket = this.config.bucket;
+      const key = command.input && command.input.Key;
+      throw mapAwsError(err, {
+        bucket,
+        key,
+        commandName: command.constructor.name,
+        commandInput: command.input,
+      });
+    }
+    this.emit("command.response", command.constructor.name, response, command.input);
+    return response;
+  }
+
+  async putObject({ key, metadata, contentType, body, contentEncoding, contentLength }) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    const fullKey = keyPrefix ? path.join(keyPrefix, key) : key;
+    
+    // Ensure all metadata values are strings and keys are valid
+    const stringMetadata = {};
+    if (metadata) {
+      for (const [k, v] of Object.entries(metadata)) {
+        // Ensure key is a valid string and value is a string
+        const validKey = String(k).replace(/[^a-zA-Z0-9\-_]/g, '_');
+        stringMetadata[validKey] = String(v);
+      }
+    }
+    
+    const options = {
+      Bucket: this.config.bucket,
+      Key: keyPrefix ? path.join(keyPrefix, key) : key,
+      Metadata: stringMetadata,
+      Body: body || Buffer.alloc(0),
+    };
+    
+    if (contentType !== undefined) options.ContentType = contentType
+    if (contentEncoding !== undefined) options.ContentEncoding = contentEncoding
+    if (contentLength !== undefined) options.ContentLength = contentLength
+
+    let response, error;
+    try {
+      response = await this.sendCommand(new PutObjectCommand(options));
+      return response;
+    } catch (err) {
+      error = err;
+      throw mapAwsError(err, {
+        bucket: this.config.bucket,
+        key,
+        commandName: 'PutObjectCommand',
+        commandInput: options,
+      });
+    } finally {
+      this.emit('putObject', error || response, { key, metadata, contentType, body, contentEncoding, contentLength });
+    }
+  }
+
+  async getObject(key) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    const options = {
+      Bucket: this.config.bucket,
+      Key: keyPrefix ? path.join(keyPrefix, key) : key,
+    };
+    let response, error;
+    try {
+      response = await this.sendCommand(new GetObjectCommand(options));
+      return response;
+    } catch (err) {
+      error = err;
+      throw mapAwsError(err, {
+        bucket: this.config.bucket,
+        key,
+        commandName: 'GetObjectCommand',
+        commandInput: options,
+      });
+    } finally {
+      this.emit('getObject', error || response, { key });
+    }
+  }
+
+  async headObject(key) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    const options = {
+      Bucket: this.config.bucket,
+      Key: keyPrefix ? path.join(keyPrefix, key) : key,
+    };
+    let response, error;
+    try {
+      response = await this.sendCommand(new HeadObjectCommand(options));
+      return response;
+    } catch (err) {
+      error = err;
+      throw mapAwsError(err, {
+        bucket: this.config.bucket,
+        key,
+        commandName: 'HeadObjectCommand',
+        commandInput: options,
+      });
+    } finally {
+      this.emit('headObject', error || response, { key });
+    }
+  }
+
+  async copyObject({ from, to }) {
+    const options = {
+      Bucket: this.config.bucket,
+      Key: this.config.keyPrefix ? path.join(this.config.keyPrefix, to) : to,
+      CopySource: path.join(this.config.bucket, this.config.keyPrefix ? path.join(this.config.keyPrefix, from) : from),
+    };
+
+    let response, error;
+    try {
+      response = await this.sendCommand(new CopyObjectCommand(options));
+      return response;
+    } catch (err) {
+      error = err;
+      throw mapAwsError(err, {
+        bucket: this.config.bucket,
+        key: to,
+        commandName: 'CopyObjectCommand',
+        commandInput: options,
+      });
+    } finally {
+      this.emit('copyObject', error || response, { from, to });
+    }
+  }
+
+  async exists(key) {
+    const [ok, err] = await tryFn(() => this.headObject(key));
+    if (ok) return true;
+    if (err.name === "NoSuchKey" || err.name === "NotFound") return false;
+    throw err;
+  }
+
+  async deleteObject(key) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    const fullKey = keyPrefix ? path.join(keyPrefix, key) : key;
+    const options = {
+      Bucket: this.config.bucket,
+      Key: keyPrefix ? path.join(keyPrefix, key) : key,
+    };
+
+    let response, error;
+    try {
+      response = await this.sendCommand(new DeleteObjectCommand(options));
+      return response;
+    } catch (err) {
+      error = err;
+      throw mapAwsError(err, {
+        bucket: this.config.bucket,
+        key,
+        commandName: 'DeleteObjectCommand',
+        commandInput: options,
+      });
+    } finally {
+      this.emit('deleteObject', error || response, { key });
+    }
+  }
+
+  async deleteObjects(keys) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    const packages = chunk(keys, 1000);
+
+    const { results, errors } = await PromisePool.for(packages)
+      .withConcurrency(this.parallelism)
+      .process(async (keys) => {
+        // Log existence before deletion
+        for (const key of keys) {
+          const resolvedKey = keyPrefix ? path.join(keyPrefix, key) : key;
+          const bucket = this.config.bucket;
+          const existsBefore = await this.exists(key);
+        }
+        const options = {
+          Bucket: this.config.bucket,
+          Delete: {
+            Objects: keys.map((key) => ({
+              Key: keyPrefix ? path.join(keyPrefix, key) : key,
+            })),
+          },
+        };
+
+        // Debug log
+        let response;
+        const [ok, err, res] = await tryFn(() => this.sendCommand(new DeleteObjectsCommand(options)));
+        if (!ok) throw err;
+        response = res;
+          if (response && response.Errors && response.Errors.length > 0) {
+            // console.error('[Client][ERROR] DeleteObjectsCommand errors:', response.Errors);
+          }
+          if (response && response.Deleted && response.Deleted.length !== keys.length) {
+            // console.error('[Client][ERROR] Nem todos os objetos foram deletados:', response.Deleted, 'esperado:', keys);
+        }
+        return response;
+      });
+
+    const report = {
+      deleted: results,
+      notFound: errors,
+    }
+
+    this.emit("deleteObjects", report, keys);
+    return report;
+  }
+
+  /**
+   * Delete all objects under a specific prefix using efficient pagination
+   * @param {Object} options - Delete options
+   * @param {string} options.prefix - S3 prefix to delete
+   * @returns {Promise<number>} Number of objects deleted
+   */
+  async deleteAll({ prefix } = {}) {
+    const keyPrefix = typeof this.config.keyPrefix === 'string' ? this.config.keyPrefix : '';
+    let continuationToken;
+    let totalDeleted = 0;
+
+    do {
+      const listCommand = new ListObjectsV2Command({
+        Bucket: this.config.bucket,
+        Prefix: keyPrefix ? path.join(keyPrefix, prefix || "") : prefix || "",
+        ContinuationToken: continuationToken,
+      });
+
+      const listResponse = await this.client.send(listCommand);
+
+      if (listResponse.Contents && listResponse.Contents.length > 0) {
+        const deleteCommand = new DeleteObjectsCommand({
+          Bucket: this.config.bucket,
+          Delete: {
+            Objects: listResponse.Contents.map(obj => ({ Key: obj.Key }))
+          }
+        });
+
+        const deleteResponse = await this.client.send(deleteCommand);
+        const deletedCount = deleteResponse.Deleted ? deleteResponse.Deleted.length : 0;
+        totalDeleted += deletedCount;
+
+        this.emit("deleteAll", {
+          prefix,
+          batch: deletedCount,
+          total: totalDeleted
+        });
+      }
+
+      continuationToken = listResponse.IsTruncated ? listResponse.NextContinuationToken : undefined;
+    } while (continuationToken);
+
+    this.emit("deleteAllComplete", {
+      prefix,
+      totalDeleted
+    });
+
+    return totalDeleted;
+  }
+
+  async moveObject({ from, to }) {
+    const [ok, err] = await tryFn(async () => {
+      await this.copyObject({ from, to });
+      await this.deleteObject(from);
+    });
+    if (!ok) {
+      throw new UnknownError("Unknown error in moveObject", { bucket: this.config.bucket, from, to, original: err });
+    }
+    return true;
+  }
+
+  async listObjects({
+    prefix,
+    maxKeys = 1000,
+    continuationToken,
+  } = {}) {
+    const options = {
+      Bucket: this.config.bucket,
+      MaxKeys: maxKeys,
+      ContinuationToken: continuationToken,
+      Prefix: this.config.keyPrefix
+        ? path.join(this.config.keyPrefix, prefix || "")
+        : prefix || "",
+    };
+    const [ok, err, response] = await tryFn(() => this.sendCommand(new ListObjectsV2Command(options)));
+    if (!ok) {
+      throw new UnknownError("Unknown error in listObjects", { prefix, bucket: this.config.bucket, original: err });
+    }
+      this.emit("listObjects", response, options);
+      return response;
+  }
+
+  async count({ prefix } = {}) {
+    let count = 0;
+    let truncated = true;
+    let continuationToken;
+    while (truncated) {
+      const options = {
+        prefix,
+        continuationToken,
+      };
+      const response = await this.listObjects(options);
+      count += response.KeyCount || 0;
+      truncated = response.IsTruncated || false;
+      continuationToken = response.NextContinuationToken;
+    }
+    this.emit("count", count, { prefix });
+    return count;
+  }
+
+  async getAllKeys({ prefix } = {}) {
+    let keys = [];
+    let truncated = true;
+    let continuationToken;
+    while (truncated) {
+      const options = {
+        prefix,
+        continuationToken,
+      };
+      const response = await this.listObjects(options);
+      if (response.Contents) {
+        keys = keys.concat(response.Contents.map((x) => x.Key));
+      }
+      truncated = response.IsTruncated || false;
+      continuationToken = response.NextContinuationToken;
+    }
+    if (this.config.keyPrefix) {
+      keys = keys
+        .map((x) => x.replace(this.config.keyPrefix, ""))
+        .map((x) => (x.startsWith("/") ? x.replace(`/`, "") : x));
+    }
+    this.emit("getAllKeys", keys, { prefix });
+    return keys;
+  }
+
+  async getContinuationTokenAfterOffset(params = {}) {
+    const {
+      prefix,
+      offset = 1000,
+    } = params
+    if (offset === 0) return null;
+    let truncated = true;
+    let continuationToken;
+    let skipped = 0;
+    while (truncated) {
+      let maxKeys =
+        offset < 1000
+          ? offset
+          : offset - skipped > 1000
+            ? 1000
+            : offset - skipped;
+      const options = {
+        prefix,
+        maxKeys,
+        continuationToken,
+      };
+      const res = await this.listObjects(options);
+      if (res.Contents) {
+        skipped += res.Contents.length;
+      }
+      truncated = res.IsTruncated || false;
+      continuationToken = res.NextContinuationToken;
+      if (skipped >= offset) {
+        break;
+      }
+    }
+    this.emit("getContinuationTokenAfterOffset", continuationToken || null, params);
+    return continuationToken || null;
+  }
+
+  async getKeysPage(params = {}) {
+    const {
+      prefix,
+      offset = 0,
+      amount = 100,
+    } = params
+    let keys = [];
+    let truncated = true;
+    let continuationToken;
+    if (offset > 0) {
+      continuationToken = await this.getContinuationTokenAfterOffset({
+        prefix,
+        offset,
+      });
+      if (!continuationToken) {
+        this.emit("getKeysPage", [], params);
+        return [];
+      }
+    }
+    while (truncated) {
+      const options = {
+        prefix,
+        continuationToken,
+      };
+      const res = await this.listObjects(options);
+      if (res.Contents) {
+        keys = keys.concat(res.Contents.map((x) => x.Key));
+      }
+      truncated = res.IsTruncated || false;
+      continuationToken = res.NextContinuationToken;
+      if (keys.length >= amount) {
+        keys = keys.slice(0, amount);
+        break;
+      }
+    }
+    if (this.config.keyPrefix) {
+      keys = keys
+        .map((x) => x.replace(this.config.keyPrefix, ""))
+        .map((x) => (x.startsWith("/") ? x.replace(`/`, "") : x));
+    }
+    this.emit("getKeysPage", keys, params);
+    return keys;
+  }
+
+  async moveAllObjects({ prefixFrom, prefixTo }) {
+    const keys = await this.getAllKeys({ prefix: prefixFrom });
+    const { results, errors } = await PromisePool
+      .for(keys)
+      .withConcurrency(this.parallelism)
+      .process(async (key) => {
+        const to = key.replace(prefixFrom, prefixTo)
+        const [ok, err] = await tryFn(async () => {
+          await this.moveObject({ 
+            from: key, 
+            to,
+          });
+          });
+        if (!ok) {
+          throw new UnknownError("Unknown error in moveAllObjects", { bucket: this.config.bucket, from: key, to, original: err });
+        }
+        return to;
+      });
+    this.emit("moveAllObjects", { results, errors }, { prefixFrom, prefixTo });
+    if (errors.length > 0) {
+      throw new Error("Some objects could not be moved");
+    }
+    return results;
+  }
+}
+
+export default Client;

package/src/concerns/base62.js

@@ -0,0 +1,61 @@
+const alphabet = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+const base = alphabet.length;
+const charToValue = Object.fromEntries([...alphabet].map((c, i) => [c, i]));
+
+export const encode = n => {
+  if (typeof n !== 'number' || isNaN(n)) return 'undefined';
+  if (!isFinite(n)) return 'undefined';
+  if (n === 0) return alphabet[0];
+  if (n < 0) return '-' + encode(-Math.floor(n));
+  n = Math.floor(n);
+  let s = '';
+  while (n) {
+    s = alphabet[n % base] + s;
+    n = Math.floor(n / base);
+  }
+  return s;
+};
+
+export const decode = s => {
+  if (typeof s !== 'string') return NaN;
+  if (s === '') return 0;
+  let negative = false;
+  if (s[0] === '-') {
+    negative = true;
+    s = s.slice(1);
+  }
+  let r = 0;
+  for (let i = 0; i < s.length; i++) {
+    const idx = charToValue[s[i]];
+    if (idx === undefined) return NaN;
+    r = r * base + idx;
+  }
+  return negative ? -r : r;
+};
+
+export const encodeDecimal = n => {
+  if (typeof n !== 'number' || isNaN(n)) return 'undefined';
+  if (!isFinite(n)) return 'undefined';
+  const negative = n < 0;
+  n = Math.abs(n);
+  const [intPart, decPart] = n.toString().split('.');
+  const encodedInt = encode(Number(intPart));
+  if (decPart) {
+    return (negative ? '-' : '') + encodedInt + '.' + decPart;
+  }
+  return (negative ? '-' : '') + encodedInt;
+};
+
+export const decodeDecimal = s => {
+  if (typeof s !== 'string') return NaN;
+  let negative = false;
+  if (s[0] === '-') {
+    negative = true;
+    s = s.slice(1);
+  }
+  const [intPart, decPart] = s.split('.');
+  const decodedInt = decode(intPart);
+  if (isNaN(decodedInt)) return NaN;
+  const num = decPart ? Number(decodedInt + '.' + decPart) : decodedInt;
+  return negative ? -num : num;
+};