Merge pull request #21 from adjoeio/fix-range-key-condition-for-get-items

remove range key condition from GetItems method of repo

Author: sjakobs

dynamo_global_index_interface.go

@@ -15,6 +15,9 @@ type GlobalIndexInterface interface {
 	// returns true if items are found, returns false and nil if no items found, returns false and error in case of error
 	GetItemsWithContext(ctx context.Context, key KeyInterface, items interface{}) (bool, error)
 
+	// GetItemsWithRangeWithContext same as GetItemsWithContext, but also respects range key
+	GetItemsWithRangeWithContext(ctx context.Context, key KeyInterface, items interface{}) (bool, error)
+
 	// GetItems by key; it accepts a key interface that is used to get the table name, hash key and range key if it exists; the output will be given in items
 	// returns true if items are found, returns false and nil if no items found, returns false and error in case of error
 	GetItems(key KeyInterface, items interface{}) (bool, error)

dynamo_repository.go

@@ -391,7 +391,7 @@ func (repository *Repository) GetItemsWithContext(ctx context.Context, key KeyIn
 		return false, err
 	}
 
-	err := buildTableKeyCondition(repository.table(key.TableName()), key).AllWithContext(ctx, items)
+	err := repository.table(key.TableName()).Get(*key.HashKeyName(), key.HashKey()).AllWithContext(ctx, items)
 	if err != nil {
 		if err == dynamo.ErrNotFound {
 			repository.log.info(ctx, key.TableName(), ErrNoItemFound.Error())

global_index.go

@@ -56,6 +56,38 @@ func (gi GlobalIndex) GetItemsWithContext(ctx context.Context, key KeyInterface,
 		return false, err
 	}
 
+	err := gi.table(key.TableName()).Get(*key.HashKeyName(), key.HashKey()).Index(gi.name).AllWithContext(ctx, items)
+	if err != nil {
+		if err == dynamo.ErrNotFound {
+			gi.log.info(ctx, key.TableName(), ErrNoItemFound.Error())
+			return false, nil
+		}
+
+		gi.log.error(ctx, key.TableName(), err.Error())
+		return false, err
+	}
+
+	val := reflect.ValueOf(items)
+	if val.Kind() == reflect.Ptr {
+		val = val.Elem()
+	}
+
+	if val.Kind() == reflect.Array || val.Kind() == reflect.Slice {
+		if val.Len() == 0 {
+			return false, nil
+		}
+	}
+
+	return true, nil
+}
+
+// GetItemsWithRangeWithContext queries multiple items by key (hash key) and returns it in the slice of items respecting the range key
+func (gi GlobalIndex) GetItemsWithRangeWithContext(ctx context.Context, key KeyInterface, items interface{}) (bool, error) {
+	if err := isValidKey(key); err != nil {
+		gi.log.error(ctx, key.TableName(), err.Error())
+		return false, err
+	}
+
 	err := buildTableKeyCondition(gi.table(key.TableName()), key).Index(gi.name).AllWithContext(ctx, items)
 	if err != nil {
 		if err == dynamo.ErrNotFound {

repository_global_index_test.go

@@ -1,6 +1,7 @@
 package djoemo_test
 
 import (
+	"context"
 	"errors"
 
 	"go.uber.org/mock/gomock"
@@ -238,7 +239,9 @@ var _ = Describe("Global Index", func() {
 			It("should return false and nil if item was not found", func() {
 				key := Key().WithTableName(UserTableName).
 					WithHashKeyName("UUID").
-					WithHashKey("uuid")
+					WithHashKey("uuid").
+					WithRangeKeyName("AppID").
+					WithRangeKey("appid")
 
 				dMock.Should().
 					Query(
@@ -276,6 +279,37 @@ var _ = Describe("Global Index", func() {
 			})
 
 		})
+		Describe("GetItemsWithRangeWithContext", func() {
+			It("should get items with Hash and Range", func() {
+				key := Key().WithTableName(UserTableName).
+					WithHashKeyName("UUID").
+					WithHashKey("uuid").
+					WithRangeKeyName("AppID").
+					WithRangeKey("appid")
+
+				userDBOutput := []map[string]interface{}{
+					{"UUID": "uuid", "UserName": "name1"},
+					{"UUID": "uuid", "UserName": "name2"},
+				}
+
+				dMock.Should().
+					Query(
+						dMock.WithTable(key.TableName()),
+						dMock.WithIndex(IndexName),
+						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
+						dMock.WithCondition(*key.RangeKeyName(), key.RangeKey(), "EQ"),
+						dMock.WithQueryOutput(userDBOutput),
+					).Exec()
+
+				users := &[]User{}
+				found, err := repository.GIndex(IndexName).GetItemsWithRangeWithContext(context.Background(), key, users)
+				Expect(err).To(BeNil())
+				Expect(found).To(BeTrue())
+				result := *users
+				Expect(len(result)).To(BeEqualTo(2))
+				Expect(result[0].UUID).To(BeEqualTo(userDBOutput[0]["UUID"]))
+			})
+		})
 	})
 
 	Describe("Query Items", func() {