electrodb 1.6.1 → 1.6.2

package/CHANGELOG.md

@@ -138,4 +138,8 @@ All notable changes to this project will be documented in this file. Breaking ch
 
 ## [1.6.1] - 2021-12-05
 ### Fixed
-- In some cases the `find()` and `match()` methods would incorrectly select an index without a complete partition key. This would result in validation exceptions preventing the user from querying if an index definition and provided attribute object aligned improperly. This was fixed and a slightly more robust mechanism for ranking indexes was made.
+- In some cases the `find()` and `match()` methods would incorrectly select an index without a complete partition key. This would result in validation exceptions preventing the user from querying if an index definition and provided attribute object aligned improperly. This was fixed and a slightly more robust mechanism for ranking indexes was made.
+
+## [1.6.2] = 2021-01-27
+### Changed
+- The methods `create`, `patch`, and `remove` will now refer to primary table keys through parameters via ExpressionAttributeNames when using `attribute_exists()`/`attribute_not_exists()` DynamoDB conditions. Prior to this they were referenced directly which would fail in cases where key names include illegal characters. Parameter implementation change only, non-breaking.

package/README.md

@@ -2,7 +2,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/tywalch/electrodb/badge.svg?branch=master)](https://coveralls.io/github/tywalch/electrodb?branch=master&kill_cache=please)
 [![Coverage Status](https://img.shields.io/npm/dt/electrodb.svg)](https://www.npmjs.com/package/electrodb)
 ![npm bundle size](https://img.shields.io/bundlephobia/min/electrodb) [![Build Status](https://travis-ci.org/tywalch/electrodb.svg?branch=master)](https://travis-ci.org/tywalch/electrodb)
-[![Runkit Demo](https://img.shields.io/badge/runkit-electrodb-db4792)](https://runkit.com/tywalch/creating-and-querying-an-electrodb-service)
+[![Runkit Demo](https://img.shields.io/badge/runkit-electrodb-db4792)](https://runkit.com/tywalch/electrodb-building-queries)
 
 ![ElectroDB](https://github.com/tywalch/electrodb/blob/master/assets/electrodb-drk.png?raw=true)
 ***ElectroDB*** is a DynamoDB library to ease the use of having multiple entities and complex hierarchical relationships in a single DynamoDB table.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {

package/src/clauses.js

@@ -1,5 +1,5 @@
-const { QueryTypes, MethodTypes, ItemOperations, ExpressionTypes } = require("./types");
-const {AttributeOperationProxy, UpdateOperations} = require("./operations");
+const { QueryTypes, MethodTypes, ItemOperations, ExpressionTypes, TableIndex } = require("./types");
+const {AttributeOperationProxy, UpdateOperations, FilterOperationNames} = require("./operations");
 const {UpdateExpression} = require("./update");
 const {FilterExpression} = require("./where");
 const v = require("./validations");
@@ -134,6 +134,12 @@ let clauses = {
 			}
 			try {
 				const attributes = state.getCompositeAttributes();
+				const filter = state.query.filter[ExpressionTypes.ConditionExpression];
+				const {pk, sk} = entity._getPrimaryIndexFieldNames();
+				filter.unsafeSet(FilterOperationNames.exists, pk);
+				if (sk) {
+					filter.unsafeSet(FilterOperationNames.exists, sk);
+				}
 				return state
 					.setMethod(MethodTypes.delete)
 					.setType(QueryTypes.eq)
@@ -189,6 +195,12 @@ let clauses = {
 			try {
 				let record = entity.model.schema.checkCreate({...payload});
 				const attributes = state.getCompositeAttributes();
+				const filter = state.query.filter[ExpressionTypes.ConditionExpression];
+				const {pk, sk} = entity._getPrimaryIndexFieldNames();
+				filter.unsafeSet(FilterOperationNames.notExists, pk);
+				if (sk) {
+					filter.unsafeSet(FilterOperationNames.notExists, sk);
+				}
 				return state
 					.setMethod(MethodTypes.put)
 					.setType(QueryTypes.eq)
@@ -213,6 +225,12 @@ let clauses = {
 			}
 			try {
 				const attributes = state.getCompositeAttributes();
+				const filter = state.query.filter[ExpressionTypes.ConditionExpression];
+				const {pk, sk} = entity._getPrimaryIndexFieldNames();
+				filter.unsafeSet(FilterOperationNames.exists, pk);
+				if (sk) {
+					filter.unsafeSet(FilterOperationNames.exists, sk);
+				}
 				return state
 					.setMethod(MethodTypes.update)
 					.setType(QueryTypes.eq)

package/src/entity.js

@@ -198,11 +198,7 @@ class Entity {
 
 	create(attributes = {}) {
 		let index = TableIndex;
-		let options = {
-			params: {
-				ConditionExpression: this._makeItemDoesntExistConditions(index)
-			}
-		};
+		let options = {};
 		return this._makeChain(index, this._clausesWithFilters, clauses.index, options).create(attributes);
 	}
 
@@ -213,21 +209,13 @@ class Entity {
 
 	patch(facets = {}) {
 		let index = TableIndex;
-		let options = {
-			params: {
-				ConditionExpression: this._makeItemExistsConditions(index)
-			}
-		};
+		let options = {};
 		return this._makeChain(index, this._clausesWithFilters, clauses.index, options).patch(facets);
 	}
 
 	remove(facets = {}) {
 		let index = TableIndex;
-		let options = {
-			params: {
-				ConditionExpression: this._makeItemExistsConditions(index)
-			}
-		};
+		let options = {};
 		return this._makeChain(index, this._clausesWithFilters, clauses.index, options).remove(facets);
 	}
 
@@ -866,29 +854,18 @@ class Entity {
 		return {parameters, config};
 	}
 
-	_makeItemDoesntExistConditions(index) {
-		let hasSortKey = this.model.lookup.indexHasSortKeys[index];
-		let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
+	_getPrimaryIndexFieldNames() {
+		let hasSortKey = this.model.lookup.indexHasSortKeys[TableIndex];
+		let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[TableIndex];
 		let pkField = this.model.indexes[accessPattern].pk.field;
-		let filter = [`attribute_not_exists(${pkField})`];
+		let skField;
 		if (hasSortKey) {
-			let skField = this.model.indexes[accessPattern].sk.field;
-			filter.push(`attribute_not_exists(${skField})`);
+			skField = this.model.indexes[accessPattern].sk.field;
 		}
-		return filter.join(" AND ");
-	}
-
-	_makeItemExistsConditions(index) {
-		let hasSortKey = this.model.lookup.indexHasSortKeys[index];
-		let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
-		let pkField = this.model.indexes[accessPattern].pk.field;
-
-		let filter = [`attribute_exists(${pkField})`];
-		if (hasSortKey) {
-			let skField = this.model.indexes[accessPattern].sk.field;
-			filter.push(`attribute_exists(${skField})`);
+		return {
+			pk: pkField,
+			sk: skField
 		}
-		return filter.join(" AND ");
 	}
 
 	_applyParameterExpressionTypes(params, filter) {

package/src/operations.js

@@ -453,4 +453,9 @@ class AttributeOperationProxy {
     }
 }
 
-module.exports = {UpdateOperations, FilterOperations, ExpressionState, AttributeOperationProxy};
+const FilterOperationNames = Object.keys(FilterOperations).reduce((ops, name) => {
+    ops[name] = name;
+    return ops;
+}, {});
+
+module.exports = {UpdateOperations, FilterOperations, FilterOperationNames, ExpressionState, AttributeOperationProxy};

package/src/where.js

@@ -1,5 +1,5 @@
 const {MethodTypes, ExpressionTypes, BuilderTypes} = require("./types");
-const {AttributeOperationProxy, ExpressionState} = require("./operations");
+const {AttributeOperationProxy, ExpressionState, FilterOperations} = require("./operations");
 const e = require("./errors");
 
 class FilterExpression extends ExpressionState {
@@ -43,6 +43,22 @@ class FilterExpression extends ExpressionState {
 		this.expression = expression;
 	}
 
+	// applies operations without verifying them against known attributes. Used internally for key conditions.
+	unsafeSet(operation, name, ...values) {
+		const {template} = FilterOperations[operation] || {};
+		if (template === undefined) {
+			throw new Error(`Invalid operation: "${operation}". Please report`);
+		}
+		const names = this.setName({}, name, name);
+		if (values.length) {
+			for (const value of values) {
+				this.setValue(name, value);
+			}
+		}
+		const condition = template({}, name.expression, names.prop, ...values);
+		this.add(condition);
+	}
+
 	build() {
 		return this.expression;
 	}