Db transaction

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '39 13 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/dependency-review.yml

@@ -0,0 +1,14 @@
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v3

.github/workflows/node.js.yml

@@ -0,0 +1,23 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm ci
+      - run: npm test

README.md

@@ -1,7 +1,8 @@
 dynamo-table-extensions
 =======================
 
-[![Build Status](https://secure.travis-ci.org/xarvh/dynamo-table-extensions.png?branch=master)](http://travis-ci.org/xarvh/dynamo-table-extensions)
+[![npm version](https://badge.fury.io/js/dynamo-table-extensions.svg)](https://badge.fury.io/js/dynamo-table-extensions)
+![Build Status](https://github.com/Adslot/dynamo-table-extensions/actions/workflows/node.js.yml/badge.svg)
 
 Adds higher-level methods to [dynamo-table](https://github.com/mhart/dynamo-table).
 

dynamo-adapter.js

@@ -0,0 +1,145 @@
+const {promisify} = require('util');
+const {DynamoTable} = require('./slim');
+
+const isCallback = (fn) => typeof fn === 'function';
+
+const validateCall = (methodName, args, minLength) => {
+  if (args.length < minLength)
+    throw new Error(`Incorrect args supplied to method ${methodName}: expected: ${minLength} got: ${args.length}`);
+}
+
+/**
+  Provides an adapter for the DynamoTable class to allow for promisified
+  api usage when omitting the cb parameter.
+*/
+class DynamoAdapter {
+  constructor(name, options) {
+    this._delegate = new DynamoTable(name, options);
+    this.hooks = options.hooks || {};
+
+    // Delegate externally accessed properties
+    Object.keys(this._delegate).forEach(key => {
+      this[key] = this._delegate[key];
+    });
+
+    // NOTE: Rebind all methods so they can be passed without the class instance
+    // Since we only instantiate once per table and maintain the instances,
+    // the performance should be a big concern
+    Object.getOwnPropertyNames(DynamoAdapter.prototype).forEach(key => {
+      if (typeof this[key] === 'function') this[key] = this[key].bind(this);
+    });
+
+    // NOTE: This function needs to be rebound to the delegate for its use case
+    this['mapToDb'] = this._delegate.mapToDb.bind(this._delegate);
+  }
+
+  // Proxies execution to delegate
+  _call(methodName, minLength, ...args) {
+    validateCall(methodName, args, minLength);
+
+    const cb = args[args.length - 1];
+
+    let method = this._delegate[methodName];
+
+    // TODO: No support for async 'hook'
+    this._runHook(methodName);
+
+    if (!isCallback(cb)) method = promisify(method);
+
+    return method.apply(this._delegate, args);
+  }
+
+  _runHook(methodName) {
+    const hook = this.hooks[methodName];
+
+    return hook ? hook() : null;
+  }
+
+  // Allows additional hook for execution BEFORE function
+  addHook(methodName, fn) {
+    this.hooks[methodName] = fn;
+  }
+
+  // Provides instance copy functionality
+  copy(options) {
+    const overrides = Object.assign({}, this, options);
+
+    return new DynamoAdapter(this.name, overrides);
+  }
+
+  // Accepts minimum 1 parameter
+  addNew(...args) {
+    return this._call('addNew', 1, ...args);
+  }
+
+  // Accepts minimum 0 parameters
+  count(...args) {
+    return this._call('count', 0, ...args);
+  }
+
+  // Accepts minimum 1 parameter
+  get(...args) {
+    return this._call('get', 1, ...args);
+  }
+
+  // Accepts minimum 1 parameter
+  put(...args) {
+    return this._call('put', 1, ...args);
+  }
+
+  // Accept minimum 1 parameter
+  delete(...args) {
+    return this._call('delete', 1, ...args);
+  }
+
+  update(...args) {
+    return this._call('update', 1, ...args);
+  }
+
+  // Accept minimum 1 parameter
+  query(...args) {
+    return this._call('query', 1, ...args);
+  }
+
+  // Accept minimum 0 parameters
+  scan(...args) {
+    return this._call('scan', 0, ...args);
+  }
+
+  // Accept minimum 1 parameter
+  batchGet(...args) {
+    return this._call('batchGet', 1, ...args);
+  }
+
+  // Accept minimum 1 parameter
+  batchWrite(...args) {
+    return this._call('batchWrite', 1, ...args);
+  }
+
+  // Accept minimum 0 parameters
+  createTable(...args) {
+    return this._call('createTable', 0, ...args);
+  }
+
+  // Accept minimum 0 parameters
+  describeTable(...args) {
+    return this._call('describeTable', 0, ...args);
+  }
+
+  // Accept minimum 0 parameters
+  deleteTable(...args) {
+    return this._call('deleteTable', 0, ...args);
+  }
+
+  // Accept minimum 2 parameters
+  throttledBatchWrite(...args) {
+    return this._call('throttledBatchWrite', 2, ...args);
+  }
+
+  // Accept minimum 0 parameters
+  truncate(...args) {
+    return this._call('truncate', 0, ...args);
+  }
+}
+
+module.exports = DynamoAdapter;

index.js

@@ -1,59 +1,9 @@
-var async = require('async')
-var dynamoTable = require('./slim')
+const {DynamoTable} = require('./slim');
+const DynamoAdapter = require('./dynamo-adapter');
 
-module.exports = dynamoTable
+// Library is a factory function which also provides the DynamoTable class
+const dynamo = (...args) => new DynamoAdapter(...args);
 
-var proto = dynamoTable.DynamoTable.prototype
+dynamo.DynamoTable = DynamoTable;
 
-// Ensures that no more than capacityRatio * writeCapacity items are written per second
-proto.throttledBatchWrite = function(capacityRatio, items, cb) {
-  if (!(capacityRatio > 0)) return cb(new Error('non-positive capacityRatio'))
-
-  var self = this
-  self.describeTable(function(err, info) {
-    if (err) return cb(err)
-
-    var itemsPerSecond = Math.ceil(info.ProvisionedThroughput.WriteCapacityUnits * capacityRatio);
-    var written = 0;
-    var ready = true;
-
-    var waitAndWrite = function(cb) {
-      async.until(function() {return ready}, function(cb) {setTimeout(cb, 10)}, function(err) {
-        if (err) return cb(err)
-        ready = false
-        setTimeout(function() {ready = true}, 1000)
-
-        var write = items.slice(written, written + itemsPerSecond)
-        self.batchWrite(write, function(err) {
-          if (err) return cb(err)
-          written += write.length;
-          cb();
-        })
-      })
-    }
-
-    async.whilst(function() {return written < items.length}, waitAndWrite, cb)
-  })
-}
-
-
-proto.truncate = function(cb) {
-  async.series([this.deleteTable.bind(this), this.createTable.bind(this)], cb)
-}
-
-
-proto.addNew = function(record, cb) {
-  var key = Array.isArray(this.key) ? this.key[0] : this.key;
-
-  if (record[key])
-    return this.put(record, cb);
-
-  var self = this;
-
-  // this.nextId is added by `dynamo-table-id`, which must be loaded
-  this.nextId(function(err, id) {
-    if (err) return cb(err);
-    record[key] = id;
-    self.put(record, cb);
-  });
-}
+module.exports = dynamo;