@twin.org/entity-storage-connector-dynamodb 0.0.1-next.3 → 0.0.1-next.31

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/entity-storage-connector-dynamodb
 The tests developed are functional tests and need an instance of DynamoDB up and running. To run DynamoDB locally:
 
 ```sh
-docker run -p 8000:8000 --name dynamodb --hostname dynamodb -d amazon/dynamodb-local
+docker run -p 8000:8000 --name twin-entity-storage-dynamodb --hostname dynamodb -d amazon/dynamodb-local
 ```
 
 Afterwards you can run the tests as follows:

package/dist/cjs/index.cjs

@@ -50,9 +50,6 @@ class DynamoDbEntityStorageConnector {
     /**
      * Create a new instance of DynamoDbEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);
@@ -214,17 +211,25 @@ class DynamoDbEntityStorageConnector {
         }
         return true;
     }
+    /**
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
+     */
+    getSchema() {
+        return this._entitySchema;
+    }
     /**
      * Get an entity.
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
      * @param secondaryIndex Get the item using a secondary index.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         try {
             const docClient = this.createDocClient();
-            if (core.Is.undefined(secondaryIndex)) {
+            if (core.Is.empty(secondaryIndex) && core.Is.empty(conditions)) {
                 const getCommand = new libDynamodb.GetCommand({
                     TableName: this._config.tableName,
                     Key: {
@@ -236,27 +241,27 @@ class DynamoDbEntityStorageConnector {
                 delete response.Item?.[DynamoDbEntityStorageConnector._PARTITION_ID_NAME];
                 return response.Item;
             }
-            const secIndex = secondaryIndex.toString();
-            const globalSecondaryIndex = `${secIndex}Index`;
-            const queryCommand = new clientDynamodb.QueryCommand({
-                TableName: this._config.tableName,
-                IndexName: globalSecondaryIndex,
-                KeyConditionExpression: `#${secIndex} = :id AND #${DynamoDbEntityStorageConnector._PARTITION_ID_NAME} = :${DynamoDbEntityStorageConnector._PARTITION_ID_NAME}`,
-                ExpressionAttributeNames: {
-                    [`#${secIndex}`]: secIndex,
-                    [`#${DynamoDbEntityStorageConnector._PARTITION_ID_NAME}`]: DynamoDbEntityStorageConnector._PARTITION_ID_NAME
-                },
-                ExpressionAttributeValues: {
-                    [`:${DynamoDbEntityStorageConnector._PARTITION_ID_NAME}`]: {
-                        S: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE
-                    },
-                    ":id": { S: id }
+            const finalConditions = {
+                conditions: []
+            };
+            if (core.Is.stringValue(secondaryIndex)) {
+                finalConditions.conditions.push({
+                    property: secondaryIndex,
+                    comparison: entity.ComparisonOperator.Equals,
+                    value: id
+                });
+            }
+            if (core.Is.arrayValue(conditions)) {
+                for (const c of conditions) {
+                    finalConditions.conditions.push({
+                        property: c.property,
+                        comparison: entity.ComparisonOperator.Equals,
+                        value: c.value
+                    });
                 }
-            });
-            const response = await docClient.send(queryCommand);
-            if (response.Items?.length === 1) {
-                return utilDynamodb.unmarshall(response.Items[0]);
             }
+            const queryResult = await this.internalQuery(finalConditions, undefined, undefined, undefined, 1, secondaryIndex);
+            return queryResult.entities[0];
         }
         catch (err) {
             if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
@@ -268,28 +273,40 @@ class DynamoDbEntityStorageConnector {
                 id
             }, err);
         }
-        return undefined;
     }
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    async set(entity) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity);
-        const id = entity[this._primaryKey.property];
+    async set(entity$1, conditions) {
+        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
+        const id = entity$1[this._primaryKey.property];
         try {
             const docClient = this.createDocClient();
+            const { conditionExpression, attributeNames, attributeValues } = this.buildConditionExpression(conditions);
             const putCommand = new libDynamodb.PutCommand({
                 TableName: this._config.tableName,
                 Item: {
                     [DynamoDbEntityStorageConnector._PARTITION_ID_NAME]: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE,
-                    ...entity
-                }
+                    ...entity$1
+                },
+                // Only set the condition expression if we have conditions to match
+                // and the primary key exists, otherwise we are creating a new object
+                ConditionExpression: core.Is.stringValue(conditionExpression)
+                    ? `(attribute_exists(${this._primaryKey.property}) AND ${conditionExpression}) OR attribute_not_exists(${this._primaryKey.property})`
+                    : undefined,
+                ExpressionAttributeNames: attributeNames,
+                ExpressionAttributeValues: attributeValues
             });
             await docClient.send(putCommand);
         }
         catch (err) {
+            if (core.BaseError.isErrorName(err, "ConditionalCheckFailedException")) {
+                return;
+            }
             if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
                 throw new core.GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
                     tableName: this._config.tableName
@@ -303,22 +320,30 @@ class DynamoDbEntityStorageConnector {
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         try {
             const docClient = this.createDocClient();
+            const { conditionExpression, attributeNames, attributeValues } = this.buildConditionExpression(conditions);
             const deleteCommand = new libDynamodb.DeleteCommand({
                 TableName: this._config.tableName,
                 Key: {
                     [DynamoDbEntityStorageConnector._PARTITION_ID_NAME]: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE,
                     [this._primaryKey.property]: id
-                }
+                },
+                ConditionExpression: conditionExpression,
+                ExpressionAttributeNames: attributeNames,
+                ExpressionAttributeValues: attributeValues
             });
             await docClient.send(deleteCommand);
         }
         catch (err) {
+            if (core.BaseError.isErrorName(err, "ConditionalCheckFailedException")) {
+                return;
+            }
             if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
                 throw new core.GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
                     table: this._config.tableName
@@ -340,80 +365,7 @@ class DynamoDbEntityStorageConnector {
      * and a cursor which can be used to request more entities.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize) {
-        const sql = "";
-        try {
-            const returnSize = pageSize ?? DynamoDbEntityStorageConnector._PAGE_SIZE;
-            let indexName;
-            // If we have a sortable property defined in the descriptor then we must use
-            // the secondary index for the query
-            if (core.Is.arrayValue(sortProperties)) {
-                if (sortProperties.length > 1) {
-                    throw new core.GeneralError(this.CLASS_NAME, "sortSingle");
-                }
-                for (const sortProperty of sortProperties) {
-                    const propertySchema = this._entitySchema.properties?.find(e => e.property === sortProperty.property);
-                    if (core.Is.undefined(propertySchema) ||
-                        (!propertySchema.isPrimary &&
-                            !propertySchema.isSecondary &&
-                            core.Is.empty(propertySchema.sortDirection))) {
-                        throw new core.GeneralError(this.CLASS_NAME, "sortNotIndexed", {
-                            property: sortProperty.property
-                        });
-                    }
-                    indexName = propertySchema.isPrimary
-                        ? undefined
-                        : `${sortProperty.property}Index`;
-                }
-            }
-            const attributeNames = { "#partitionId": "partitionId" };
-            const attributeValues = {
-                [`:${DynamoDbEntityStorageConnector._PARTITION_ID_NAME}`]: {
-                    S: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE
-                }
-            };
-            const expressions = this.buildQueryParameters("", conditions, attributeNames, attributeValues);
-            let keyExpression = "#partitionId = :partitionId";
-            if (expressions.keyCondition.length > 0) {
-                keyExpression += ` AND ${expressions.keyCondition}`;
-            }
-            const query = new clientDynamodb.QueryCommand({
-                TableName: this._config.tableName,
-                IndexName: indexName,
-                KeyConditionExpression: keyExpression,
-                FilterExpression: core.Is.stringValue(expressions.filterCondition)
-                    ? expressions.filterCondition
-                    : undefined,
-                ExpressionAttributeNames: attributeNames,
-                ExpressionAttributeValues: attributeValues,
-                ProjectionExpression: properties?.map(p => p).join(", "),
-                Limit: returnSize,
-                ExclusiveStartKey: core.Is.empty(cursor)
-                    ? undefined
-                    : core.ObjectHelper.fromBytes(core.Converter.base64ToBytes(cursor))
-            });
-            const connection = this.createDocClient();
-            const results = await connection.send(query);
-            let entities = [];
-            if (core.Is.arrayValue(results.Items)) {
-                entities = results.Items.map(item => utilDynamodb.unmarshall(item));
-            }
-            return {
-                entities,
-                cursor: core.Is.empty(results.LastEvaluatedKey)
-                    ? undefined
-                    : core.Converter.bytesToBase64(core.ObjectHelper.toBytes(results.LastEvaluatedKey))
-            };
-        }
-        catch (err) {
-            if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
-                throw new core.GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
-                    table: this._config.tableName
-                }, err);
-            }
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", {
-                sql
-            }, err);
-        }
+        return this.internalQuery(conditions, sortProperties, properties, cursor, pageSize);
     }
     /**
      * Delete the table.
@@ -427,7 +379,7 @@ class DynamoDbEntityStorageConnector {
         catch { }
     }
     /**
-     * Create an SQL condition clause.
+     * Create the parameters for a query.
      * @param objectPath The path for the nested object.
      * @param condition The conditions to create the query from.
      * @param attributeNames The attribute names to use in the query.
@@ -435,7 +387,7 @@ class DynamoDbEntityStorageConnector {
      * @returns The condition clause.
      * @internal
      */
-    buildQueryParameters(objectPath, condition, attributeNames, attributeValues) {
+    buildQueryParameters(objectPath, condition, attributeNames, attributeValues, secondaryIndex) {
         // If no conditions are defined then return empty string
         if (core.Is.undefined(condition)) {
             return {
@@ -444,11 +396,21 @@ class DynamoDbEntityStorageConnector {
             };
         }
         if ("conditions" in condition) {
+            if (condition.conditions.length === 0) {
+                return {
+                    keyCondition: "",
+                    filterCondition: ""
+                };
+            }
             // It's a group of comparisons, so check the individual items and combine with the logical operator
-            const joinConditions = condition.conditions.map(c => this.buildQueryParameters(objectPath, c, attributeNames, attributeValues));
+            const joinConditions = condition.conditions.map(c => this.buildQueryParameters(objectPath, c, attributeNames, attributeValues, secondaryIndex));
             const logicalOperator = this.mapConditionalOperator(condition.logicalOperator);
-            const keyCondition = joinConditions.map(j => j.keyCondition).join(` ${logicalOperator} `);
+            const keyCondition = joinConditions
+                .filter(j => j.keyCondition.length > 0)
+                .map(j => j.keyCondition)
+                .join(` ${logicalOperator} `);
             const filterCondition = joinConditions
+                .filter(j => j.filterCondition.length > 0)
                 .map(j => j.filterCondition)
                 .join(` ${logicalOperator} `);
             return {
@@ -459,9 +421,10 @@ class DynamoDbEntityStorageConnector {
         const schemaProp = this._entitySchema.properties?.find(p => p.property === condition.property);
         // It's a single value so just create the property comparison for the condition
         const comparison = this.mapComparisonOperator(objectPath, condition, schemaProp?.type, attributeNames, attributeValues);
+        const isKey = schemaProp?.isPrimary || (schemaProp?.isSecondary && schemaProp?.property === secondaryIndex);
         return {
-            keyCondition: schemaProp?.isPrimary ? comparison : "",
-            filterCondition: schemaProp?.isPrimary ? "" : comparison
+            keyCondition: isKey ? comparison : "",
+            filterCondition: !isKey ? comparison : ""
         };
     }
     /**
@@ -482,6 +445,14 @@ class DynamoDbEntityStorageConnector {
         }
         prop += comparator.property;
         let attributeName = this.populateAttributeNames(prop, attributeNames);
+        if (core.Is.empty(comparator.value)) {
+            if (comparator.comparison === entity.ComparisonOperator.Equals) {
+                return `attribute_not_exists(${attributeName})`;
+            }
+            else if (comparator.comparison === entity.ComparisonOperator.NotEquals) {
+                return `attribute_exists(${attributeName})`;
+            }
+        }
         let propName = `:${attributeName.replace(/\./g, "").replace(/#/g, "")}`;
         if (core.Is.array(comparator.value)) {
             const dbValues = comparator.value.map(v => this.propertyToDbValue(v, type));
@@ -605,7 +576,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection.
-     * @returns The dynamo db connection.
+     * @returns The Dynamo DB connection.
      * @internal
      */
     createConnection() {
@@ -613,7 +584,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection configuration.
-     * @returns The dynamo db connection configuration.
+     * @returns The Dynamo DB connection configuration.
      * @internal
      */
     createConnectionConfig() {
@@ -642,6 +613,132 @@ class DynamoDbEntityStorageConnector {
             return false;
         }
     }
+    /**
+     * Find all the entities which match the conditions.
+     * @param conditions The conditions to match for the entities.
+     * @param sortProperties The optional sort order.
+     * @param properties The optional properties to return, defaults to all.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param secondaryIndex The secondary index to use for the query.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @internal
+     */
+    async internalQuery(conditions, sortProperties, properties, cursor, pageSize, secondaryIndex) {
+        try {
+            const returnSize = pageSize ?? DynamoDbEntityStorageConnector._PAGE_SIZE;
+            let indexName = core.Is.stringValue(secondaryIndex)
+                ? `${secondaryIndex}Index`
+                : undefined;
+            // If we have a sortable property defined in the descriptor then we must use
+            // the secondary index for the query
+            let scanAscending = true;
+            if (core.Is.arrayValue(sortProperties)) {
+                if (sortProperties.length > 1) {
+                    throw new core.GeneralError(this.CLASS_NAME, "sortSingle");
+                }
+                for (const sortProperty of sortProperties) {
+                    const propertySchema = this._entitySchema.properties?.find(e => e.property === sortProperty.property);
+                    if (core.Is.undefined(propertySchema) ||
+                        (!propertySchema.isPrimary &&
+                            !propertySchema.isSecondary &&
+                            core.Is.empty(propertySchema.sortDirection))) {
+                        throw new core.GeneralError(this.CLASS_NAME, "sortNotIndexed", {
+                            property: sortProperty.property
+                        });
+                    }
+                    indexName = propertySchema.isPrimary
+                        ? undefined
+                        : `${sortProperty.property}Index`;
+                    scanAscending = sortProperty.sortDirection === entity.SortDirection.Ascending;
+                }
+            }
+            const attributeNames = { "#partitionId": "partitionId" };
+            const attributeValues = {
+                [`:${DynamoDbEntityStorageConnector._PARTITION_ID_NAME}`]: {
+                    S: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE
+                }
+            };
+            const expressions = this.buildQueryParameters("", conditions, attributeNames, attributeValues, secondaryIndex);
+            let keyExpression = "#partitionId = :partitionId";
+            if (expressions.keyCondition.length > 0) {
+                keyExpression += ` AND ${expressions.keyCondition}`;
+            }
+            const query = new clientDynamodb.QueryCommand({
+                TableName: this._config.tableName,
+                IndexName: indexName,
+                KeyConditionExpression: keyExpression,
+                FilterExpression: core.Is.stringValue(expressions.filterCondition)
+                    ? expressions.filterCondition
+                    : undefined,
+                ExpressionAttributeNames: attributeNames,
+                ExpressionAttributeValues: attributeValues,
+                ProjectionExpression: properties?.map(p => p).join(", "),
+                Limit: returnSize,
+                ScanIndexForward: scanAscending,
+                ExclusiveStartKey: core.Is.empty(cursor)
+                    ? undefined
+                    : core.ObjectHelper.fromBytes(core.Converter.base64ToBytes(cursor))
+            });
+            const connection = this.createDocClient();
+            const results = await connection.send(query);
+            let entities = [];
+            if (core.Is.arrayValue(results.Items)) {
+                entities = results.Items.map(item => {
+                    const unmarshalled = utilDynamodb.unmarshall(item);
+                    delete unmarshalled[DynamoDbEntityStorageConnector._PARTITION_ID_NAME];
+                    return unmarshalled;
+                });
+            }
+            return {
+                entities,
+                cursor: core.Is.empty(results.LastEvaluatedKey)
+                    ? undefined
+                    : core.Converter.bytesToBase64(core.ObjectHelper.toBytes(results.LastEvaluatedKey))
+            };
+        }
+        catch (err) {
+            if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
+                throw new core.GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
+                    table: this._config.tableName
+                }, err);
+            }
+            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", undefined, err);
+        }
+    }
+    /**
+     * Build the condition expression for the query.
+     * @param conditions The conditions to build the expression from.
+     * @returns The condition expression.
+     * @throws GeneralError if the property is not found in the schema.
+     * @internal
+     */
+    buildConditionExpression(conditions) {
+        let conditionExpression;
+        let attributeNames;
+        let attributeValues;
+        if (core.Is.arrayValue(conditions)) {
+            const expressions = [];
+            for (const c of conditions) {
+                const schemaProp = this._entitySchema.properties?.find(p => p.property === c.property);
+                if (core.Is.undefined(schemaProp)) {
+                    throw new core.GeneralError(this.CLASS_NAME, "propertyNotFound", {
+                        property: c.property
+                    });
+                }
+                const attributeName = `#${c.property}`;
+                const attributeValueName = `:${c.property}`;
+                attributeNames ??= {};
+                attributeValues ??= {};
+                attributeNames[attributeName] = c.property;
+                attributeValues[attributeValueName] = c.value;
+                expressions.push(`${attributeName} = ${attributeValueName}`);
+            }
+            conditionExpression = expressions.join(" AND ");
+        }
+        return { conditionExpression, attributeNames, attributeValues };
+    }
 }
 
 exports.DynamoDbEntityStorageConnector = DynamoDbEntityStorageConnector;