The execution option { compare: "attributes" } used incorrect expre…

…ssion comparisons that impacted `lte` queries on indexes with a single composite key.
tywalch · Oct 20, 2024 · c788e84 · c788e84
1 parent 8a33912
commit c788e84
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -547,3 +547,7 @@ All notable changes to this project will be documented in this file. Breaking ch
 - The execution options `includeKeys` and `raw` were deprecated in version `2.0.0` and have now been removed in favor of the execution option `data`. To migrate from `v2`, use the options `{ data: "includeKeys" }` and `{ data: "raw" }` respectively.
 ### Fixed
 - Response typing and formatting logic for `delete` 
+
+## [3.0.1]
+### Fixed
+- The execution option `{ compare: "attributes" }` used incorrect expression comparisons that impacted `lte` queries on indexes with a single composite key.   
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {

diff --git a/src/entity.js b/src/entity.js
@@ -2899,7 +2899,6 @@ class Entity {
     if (skType === "number") {
       return Comparisons[comparison];
     } else if (
-      comparisonType === ComparisonTypes.attributes ||
       comparisonType === ComparisonTypes.v2
     ) {
       return KeyAttributesComparisons[comparison];

diff --git a/test/generation/comparisonTests/testCases.json b/test/generation/comparisonTests/testCases.json
@@ -461,7 +461,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$clusteredregion#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 >= :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 > :sk1",
       "IndexName": "gsi1pk-gsi1sk-index",
       "FilterExpression": "(#city > :city0) AND (#county > :county0) AND (#__edb_e__ = :__edb_e__0) AND #__edb_v__ = :__edb_v__0"
     },
@@ -520,7 +520,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$isolatedregion#attraction_1#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 >= :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 > :sk1",
       "IndexName": "gsi2pk-gsi2sk-index",
       "FilterExpression": "(#city > :city0) AND #county > :county0"
     },
@@ -570,7 +570,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$attraction_1#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 >= :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 > :sk1",
       "FilterExpression": "(#city > :city0) AND #county > :county0"
     },
     "evaluations": [
@@ -623,7 +623,7 @@
         ":__edb_e___Attraction": "attraction",
         ":__edb_v___Attraction": "1"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 >= :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 > :sk1",
       "IndexName": "gsi1pk-gsi1sk-index",
       "FilterExpression": "(#__edb_e__ = :__edb_e___Attraction AND #__edb_v__ = :__edb_v___Attraction) AND (#city > :city0) AND #county > :county0"
     },
@@ -893,7 +893,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$clusteredregion#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 < :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 <= :sk1",
       "IndexName": "gsi1pk-gsi1sk-index",
       "FilterExpression": "(#city <= :city0) AND (#county <= :county0) AND (#__edb_e__ = :__edb_e__0) AND #__edb_v__ = :__edb_v__0"
     },
@@ -952,7 +952,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$isolatedregion#attraction_1#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 < :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 <= :sk1",
       "IndexName": "gsi2pk-gsi2sk-index",
       "FilterExpression": "(#city <= :city0) AND #county <= :county0"
     },
@@ -1002,7 +1002,7 @@
         ":pk": "$comparison#country_usa#state_wisconsin",
         ":sk1": "$attraction_1#county_dane#city_madison"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 < :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 <= :sk1",
       "FilterExpression": "(#city <= :city0) AND #county <= :county0"
     },
     "evaluations": [
@@ -1055,7 +1055,7 @@
         ":__edb_e___Attraction": "attraction",
         ":__edb_v___Attraction": "1"
       },
-      "KeyConditionExpression": "#pk = :pk and #sk1 < :sk1",
+      "KeyConditionExpression": "#pk = :pk and #sk1 <= :sk1",
       "IndexName": "gsi1pk-gsi1sk-index",
       "FilterExpression": "(#__edb_e__ = :__edb_e___Attraction AND #__edb_v__ = :__edb_v___Attraction) AND (#city <= :city0) AND #county <= :county0"
     },

diff --git a/test/ts_connected.entity.spec.ts b/test/ts_connected.entity.spec.ts
@@ -5015,7 +5015,7 @@ describe('execution option compare', () => {
           ":sk1": "$inregion#county_dane#city_madison",
         },
         "FilterExpression": "(#city > :city0) AND (#county > :county0) AND (#__edb_e__ = :__edb_e__0) AND #__edb_v__ = :__edb_v__0",
-        "KeyConditionExpression": "#pk = :pk and #sk1 >= :sk1",
+        "KeyConditionExpression": "#pk = :pk and #sk1 > :sk1",
         "TableName": "electro"
       });
       expect(v2Params).to.deep.equal({
@@ -5082,7 +5082,7 @@ describe('execution option compare', () => {
           ":sk1": "$inregion#county_dane#city_madison",
         },
         "FilterExpression": "(#city <= :city0) AND (#county <= :county0) AND (#__edb_e__ = :__edb_e__0) AND #__edb_v__ = :__edb_v__0",
-        "KeyConditionExpression": "#pk = :pk and #sk1 < :sk1",
+        "KeyConditionExpression": "#pk = :pk and #sk1 <= :sk1",
         "TableName": "electro"
       });
       expect(v2Params).to.deep.equal({