dynamoid 3.8.0 → 3.10.0

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/filter_expression_convertor.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  # @private
+  module AdapterPlugin
+    class AwsSdkV3
+      class FilterExpressionConvertor
+        attr_reader :expression, :name_placeholders, :value_placeholders
+
+        def initialize(conditions, name_placeholders, value_placeholders, name_placeholder_sequence, value_placeholder_sequence)
+          @conditions = conditions
+          @name_placeholders = name_placeholders.dup
+          @value_placeholders = value_placeholders.dup
+          @name_placeholder_sequence = name_placeholder_sequence
+          @value_placeholder_sequence = value_placeholder_sequence
+
+          build
+        end
+
+        private
+
+        def build
+          clauses = @conditions.map do |name, attribute_conditions|
+            attribute_conditions.map do |operator, value|
+              name_or_placeholder = name_or_placeholder_for(name)
+
+              case operator
+              when :eq
+                "#{name_or_placeholder} = #{value_placeholder_for(value)}"
+              when :ne
+                "#{name_or_placeholder} <> #{value_placeholder_for(value)}"
+              when :gt
+                "#{name_or_placeholder} > #{value_placeholder_for(value)}"
+              when :lt
+                "#{name_or_placeholder} < #{value_placeholder_for(value)}"
+              when :gte
+                "#{name_or_placeholder} >= #{value_placeholder_for(value)}"
+              when :lte
+                "#{name_or_placeholder} <= #{value_placeholder_for(value)}"
+              when :between
+                "#{name_or_placeholder} BETWEEN #{value_placeholder_for(value[0])} AND #{value_placeholder_for(value[1])}"
+              when :begins_with
+                "begins_with (#{name_or_placeholder}, #{value_placeholder_for(value)})"
+              when :in
+                list = value.map(&method(:value_placeholder_for)).join(' , ')
+                "#{name_or_placeholder} IN (#{list})"
+              when :contains
+                "contains (#{name_or_placeholder}, #{value_placeholder_for(value)})"
+              when :not_contains
+                "NOT contains (#{name_or_placeholder}, #{value_placeholder_for(value)})"
+              when :null
+                "attribute_not_exists (#{name_or_placeholder})"
+              when :not_null
+                "attribute_exists (#{name_or_placeholder})"
+              end
+            end
+          end.flatten
+
+          @expression = clauses.join(' AND ')
+        end
+
+        def name_or_placeholder_for(name)
+          return name unless name.upcase.in?(Dynamoid::AdapterPlugin::AwsSdkV3::RESERVED_WORDS)
+
+          placeholder = @name_placeholder_sequence.call
+          @name_placeholders[placeholder] = name
+          placeholder
+        end
+
+        def value_placeholder_for(value)
+          placeholder = @value_placeholder_sequence.call
+          @value_placeholders[placeholder] = value
+          placeholder
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/item_updater.rb

@@ -50,7 +50,19 @@ module Dynamoid
         # Replaces the values of one or more attributes
         #
         def set(values)
-          @updates.merge!(sanitize_attributes(values))
+          values_sanitized = sanitize_attributes(values)
+
+          if Dynamoid.config.store_attribute_with_nil_value
+            @updates.merge!(values_sanitized)
+          else
+            # delete explicitly attributes if assigned nil value and configured
+            # to not store nil values
+            values_to_update = values_sanitized.reject { |_, v| v.nil? }
+            values_to_delete = values_sanitized.select { |_, v| v.nil? }
+
+            @updates.merge!(values_to_update)
+            @deletions.merge!(values_to_delete)
+          end
         end
 
         #
@@ -85,10 +97,24 @@ module Dynamoid
 
         private
 
+        # Keep in sync with AwsSdkV3.sanitize_item.
+        #
+        # The only difference is that to update item we need to track whether
+        # attribute value is nil or not.
         def sanitize_attributes(attributes)
+          # rubocop:disable Lint/DuplicateBranch
           attributes.transform_values do |v|
-            v.is_a?(Hash) ? v.stringify_keys : v
+            if v.is_a?(Hash)
+              v.stringify_keys
+            elsif v.is_a?(Set) && v.empty?
+              nil
+            elsif v.is_a?(String) && v.empty?
+              nil
+            else
+              v
+            end
           end
+          # rubocop:enable Lint/DuplicateBranch
         end
       end
     end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/limit.rb

@@ -21,14 +21,17 @@ module Dynamoid
             # lower to obey limits. We can assume the difference won't be
             # negative due to break statements below but choose smaller limit
             # which is why we have 2 separate if statements.
+            #
             # NOTE: Adjusting based on record_limit can cause many HTTP requests
             # being made. We may want to change this behavior, but it affects
             # filtering on data with potentially large gaps.
+            #
             # Example:
             #    User.where('created_at.gte' => 1.day.ago).record_limit(1000)
             #    Records 1-999 User's that fit criteria
             #    Records 1000-2000 Users's that do not fit criteria
             #    Record 2001 fits criteria
+            #
             # The underlying implementation will have 1 page for records 1-999
             # then will request with limit 1 for records 1000-2000 (making 1000
             # requests of limit 1) until hit record 2001.

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/projection_expression_convertor.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  # @private
+  module AdapterPlugin
+    class AwsSdkV3
+      class ProjectionExpressionConvertor
+        attr_reader :expression, :name_placeholders
+
+        def initialize(names, name_placeholders, name_placeholder_sequence)
+          @names = names
+          @name_placeholders = name_placeholders.dup
+          @name_placeholder_sequence = name_placeholder_sequence
+
+          build
+        end
+
+        private
+
+        def build
+          return if @names.nil? || @names.empty?
+
+          clauses = @names.map do |name|
+            if name.upcase.in?(Dynamoid::AdapterPlugin::AwsSdkV3::RESERVED_WORDS)
+              placeholder = @name_placeholder_sequence.call
+              @name_placeholders[placeholder] = name
+              placeholder
+            else
+              name.to_s
+            end
+          end
+
+          @expression = clauses.join(' , ')
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/query.rb

@@ -3,6 +3,8 @@
 require_relative 'middleware/backoff'
 require_relative 'middleware/limit'
 require_relative 'middleware/start_key'
+require_relative 'filter_expression_convertor'
+require_relative 'projection_expression_convertor'
 
 module Dynamoid
   # @private
@@ -10,20 +12,19 @@ module Dynamoid
     class AwsSdkV3
       class Query
         OPTIONS_KEYS = %i[
-          limit hash_key hash_value range_key consistent_read scan_index_forward
-          select index_name batch_size exclusive_start_key record_limit scan_limit
-          project
+          consistent_read scan_index_forward select index_name batch_size
+          exclusive_start_key record_limit scan_limit project
         ].freeze
 
         attr_reader :client, :table, :options, :conditions
 
-        def initialize(client, table, opts = {})
+        def initialize(client, table, key_conditions, non_key_conditions, options)
           @client = client
           @table = table
 
-          opts = opts.symbolize_keys
-          @options = opts.slice(*OPTIONS_KEYS)
-          @conditions = opts.except(*OPTIONS_KEYS)
+          @key_conditions = key_conditions
+          @non_key_conditions = non_key_conditions
+          @options = options.slice(*OPTIONS_KEYS)
         end
 
         def call
@@ -53,6 +54,37 @@ module Dynamoid
         private
 
         def build_request
+          # expressions
+          name_placeholder = +'#_a0'
+          value_placeholder = +':_a0'
+
+          name_placeholder_sequence = -> { name_placeholder.next!.dup }
+          value_placeholder_sequence = -> { value_placeholder.next!.dup }
+
+          name_placeholders = {}
+          value_placeholders = {}
+
+          # Deal with various limits and batching
+          batch_size = options[:batch_size]
+          limit = [record_limit, scan_limit, batch_size].compact.min
+
+          # key condition expression
+          convertor = FilterExpressionConvertor.new(@key_conditions, name_placeholders, value_placeholders, name_placeholder_sequence, value_placeholder_sequence)
+          key_condition_expression = convertor.expression
+          value_placeholders = convertor.value_placeholders
+          name_placeholders = convertor.name_placeholders
+
+          # filter expression
+          convertor = FilterExpressionConvertor.new(@non_key_conditions, name_placeholders, value_placeholders, name_placeholder_sequence, value_placeholder_sequence)
+          filter_expression = convertor.expression
+          value_placeholders = convertor.value_placeholders
+          name_placeholders = convertor.name_placeholders
+
+          # projection expression
+          convertor = ProjectionExpressionConvertor.new(options[:project], name_placeholders, name_placeholder_sequence)
+          projection_expression = convertor.expression
+          name_placeholders = convertor.name_placeholders
+
           request = options.slice(
             :consistent_read,
             :scan_index_forward,
@@ -61,15 +93,13 @@ module Dynamoid
             :exclusive_start_key
           ).compact
 
-          # Deal with various limits and batching
-          batch_size = options[:batch_size]
-          limit = [record_limit, scan_limit, batch_size].compact.min
-
-          request[:limit]             = limit if limit
-          request[:table_name]        = table.name
-          request[:key_conditions]    = key_conditions
-          request[:query_filter]      = query_filter
-          request[:attributes_to_get] = attributes_to_get
+          request[:table_name]                  = table.name
+          request[:limit]                       = limit                     if limit
+          request[:key_condition_expression]    = key_condition_expression  if key_condition_expression.present?
+          request[:filter_expression]           = filter_expression         if filter_expression.present?
+          request[:expression_attribute_values] = value_placeholders        if value_placeholders.present?
+          request[:expression_attribute_names]  = name_placeholders         if name_placeholders.present?
+          request[:projection_expression]       = projection_expression     if projection_expression.present?
 
           request
         end
@@ -81,51 +111,6 @@ module Dynamoid
         def scan_limit
           options[:scan_limit]
         end
-
-        def hash_key_name
-          (options[:hash_key] || table.hash_key)
-        end
-
-        def range_key_name
-          (options[:range_key] || table.range_key)
-        end
-
-        def key_conditions
-          result = {
-            hash_key_name => {
-              comparison_operator: AwsSdkV3::EQ,
-              attribute_value_list: AwsSdkV3.attribute_value_list(AwsSdkV3::EQ, options[:hash_value].freeze)
-            }
-          }
-
-          conditions.slice(*AwsSdkV3::RANGE_MAP.keys).each do |k, _v|
-            op = AwsSdkV3::RANGE_MAP[k]
-
-            result[range_key_name] = {
-              comparison_operator: op,
-              attribute_value_list: AwsSdkV3.attribute_value_list(op, conditions[k].freeze)
-            }
-          end
-
-          result
-        end
-
-        def query_filter
-          conditions.except(*AwsSdkV3::RANGE_MAP.keys).reduce({}) do |result, (attr, cond)|
-            condition = {
-              comparison_operator: AwsSdkV3::FIELD_MAP[cond.keys[0]],
-              attribute_value_list: AwsSdkV3.attribute_value_list(AwsSdkV3::FIELD_MAP[cond.keys[0]], cond.values[0].freeze)
-            }
-            result[attr] = condition
-            result
-          end
-        end
-
-        def attributes_to_get
-          return if options[:project].nil?
-
-          options[:project].map(&:to_s)
-        end
       end
     end
   end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/scan.rb

@@ -3,6 +3,8 @@
 require_relative 'middleware/backoff'
 require_relative 'middleware/limit'
 require_relative 'middleware/start_key'
+require_relative 'filter_expression_convertor'
+require_relative 'projection_expression_convertor'
 
 module Dynamoid
   # @private
@@ -45,6 +47,31 @@ module Dynamoid
         private
 
         def build_request
+          # expressions
+          name_placeholder = +'#_a0'
+          value_placeholder = +':_a0'
+
+          name_placeholder_sequence = -> { name_placeholder.next!.dup }
+          value_placeholder_sequence = -> { value_placeholder.next!.dup }
+
+          name_placeholders = {}
+          value_placeholders = {}
+
+          # Deal with various limits and batching
+          batch_size = options[:batch_size]
+          limit = [record_limit, scan_limit, batch_size].compact.min
+
+          # filter expression
+          convertor = FilterExpressionConvertor.new(conditions, name_placeholders, value_placeholders, name_placeholder_sequence, value_placeholder_sequence)
+          filter_expression = convertor.expression
+          value_placeholders = convertor.value_placeholders
+          name_placeholders = convertor.name_placeholders
+
+          # projection expression
+          convertor = ProjectionExpressionConvertor.new(options[:project], name_placeholders, name_placeholder_sequence)
+          projection_expression = convertor.expression
+          name_placeholders = convertor.name_placeholders
+
           request = options.slice(
             :consistent_read,
             :exclusive_start_key,
@@ -52,14 +79,12 @@ module Dynamoid
             :index_name
           ).compact
 
-          # Deal with various limits and batching
-          batch_size = options[:batch_size]
-          limit = [record_limit, scan_limit, batch_size].compact.min
-
-          request[:limit]             = limit if limit
-          request[:table_name]        = table.name
-          request[:scan_filter]       = scan_filter
-          request[:attributes_to_get] = attributes_to_get
+          request[:table_name]                  = table.name
+          request[:limit]                       = limit                 if limit
+          request[:filter_expression]           = filter_expression     if filter_expression.present?
+          request[:expression_attribute_values] = value_placeholders    if value_placeholders.present?
+          request[:expression_attribute_names]  = name_placeholders     if name_placeholders.present?
+          request[:projection_expression]       = projection_expression if projection_expression.present?
 
           request
         end
@@ -71,25 +96,6 @@ module Dynamoid
         def scan_limit
           options[:scan_limit]
         end
-
-        def scan_filter
-          conditions.reduce({}) do |result, (attr, cond)|
-            condition = {
-              comparison_operator: AwsSdkV3::FIELD_MAP[cond.keys[0]],
-              attribute_value_list: AwsSdkV3.attribute_value_list(AwsSdkV3::FIELD_MAP[cond.keys[0]], cond.values[0].freeze)
-            }
-            # nil means operator doesn't require attribute value list
-            conditions.delete(:attribute_value_list) if conditions[:attribute_value_list].nil?
-            result[attr] = condition
-            result
-          end
-        end
-
-        def attributes_to_get
-          return if options[:project].nil?
-
-          options[:project].map(&:to_s)
-        end
       end
     end
   end