wcc-contentful 1.3.2 → 1.4.0.rc1

data/lib/wcc/contentful/simple_client/management.rb

@@ -34,6 +34,22 @@ class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
     resp.assert_ok!
   end
 
+  def locales(**query)
+    resp =
+      _instrument 'locales', query: query do
+        get('locales', query)
+      end
+    resp.assert_ok!
+  end
+
+  def locale(key, query = {})
+    resp =
+      _instrument 'locales', content_type: key, query: query do
+        get("locales/#{key}", query)
+      end
+    resp.assert_ok!
+  end
+
   def editor_interface(content_type_id, query = {})
     resp =
       _instrument 'editor_interfaces', content_type: content_type_id, query: query do

data/lib/wcc/contentful/simple_client.rb

@@ -124,6 +124,7 @@ module WCC::Contentful
 
       q = @query_defaults.dup
       q = q.merge(query) if query
+      q.compact!
 
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       loop do

data/lib/wcc/contentful/store/base.rb

@@ -17,6 +17,10 @@ module WCC::Contentful::Store
   class Base
     include WCC::Contentful::Store::Interface
 
+    def initialize(configuration = nil)
+      @configuration = configuration || WCC::Contentful.configuration
+    end
+
     # Sets the value of the entry with the given ID in the store.
     # @abstract
     def set(_id, _value)
@@ -103,7 +107,8 @@ module WCC::Contentful::Store
       Query.new(
         self,
         content_type: content_type,
-        options: options
+        options: options,
+        configuration: @configuration
       )
     end
 

data/lib/wcc/contentful/store/cdn_adapter.rb

@@ -29,7 +29,7 @@ module WCC::Contentful::Store
     end
 
     def find(key, hint: nil, **options)
-      options = { locale: '*' }.merge!(options || {})
+      options = options&.dup || {}
       entry =
         if hint
           client.public_send(hint.underscore, key, options)
@@ -114,7 +114,7 @@ module WCC::Contentful::Store
           op = :in if op.nil?
         end
 
-        param = parameter(field, operator: op, context: context, locale: true)
+        param = parameter(field, operator: op, context: context, locale: false)
 
         self.class.new(
           @store,
@@ -157,10 +157,10 @@ module WCC::Contentful::Store
         @response ||=
           if @relation[:content_type] == 'Asset'
             @client.assets(
-              { locale: '*' }.merge!(@relation.reject { |k| k == :content_type }).merge!(@options)
+              @relation.reject { |k| k == :content_type }.merge(@options)
             )
           else
-            @client.entries({ locale: '*' }.merge!(@relation).merge!(@options))
+            @client.entries(@relation.merge(@options))
           end
       end
 
@@ -180,6 +180,15 @@ module WCC::Contentful::Store
         included
       end
 
+      # Constructs the CDN query parameter from a structured field definition and
+      # operator.
+      # Notes:
+      #  * "eq" can be omitted, e.g. 'fields.slug=/' is equivalent to 'fields.slug[eq]=/'
+      #  * If "locale" is specified in the query, matching is done against that locale,
+      #      unless the query explicitly specifies the locale.  Examples:
+      #      'locale=es-US&fields.title=página principal' matches on the es locale
+      #      'locale=en-US&fields.title=página principal' returns nothing
+      #      'locale=en-US&fields.title.es-US=página principal' returns the page, but in the english locale.
       def parameter(field, operator: nil, context: nil, locale: false)
         if sys?(field)
           "#{field}#{op_param(operator)}"

data/lib/wcc/contentful/store/factory.rb

@@ -5,6 +5,7 @@ require_relative 'memory_store'
 require_relative 'cdn_adapter'
 require_relative '../middleware/store'
 require_relative '../middleware/store/caching_middleware'
+require_relative '../middleware/store/locale_middleware'
 
 module WCC::Contentful::Store
   # This factory presents a DSL for configuring the store stack.  The store stack
@@ -46,6 +47,8 @@ module WCC::Contentful::Store
       self.middleware << [middleware, middleware_params, configure_proc]
     end
 
+    # Replaces a middleware in the chain.  The middleware to replace is selected
+    # by matching the class.
     def replace(middleware, *middleware_params, &block)
       idx = self.middleware.find_index { |m| m[0] == middleware }
       raise ArgumentError, "Middleware #{middleware} not present" if idx.nil?
@@ -54,6 +57,8 @@ module WCC::Contentful::Store
       self.middleware[idx] = [middleware, middleware_params, configure_proc]
     end
 
+    # Removes a middleware from the chain, finding it by matching the class
+    # constant.
     def unuse(middleware)
       idx = self.middleware.find_index { |m| m[0] == middleware }
       return if idx.nil?
@@ -174,7 +179,9 @@ module WCC::Contentful::Store
       # The middleware that by default lives at the top of the middleware stack.
       def default_middleware
         [
-          [WCC::Contentful::Store::InstrumentationMiddleware]
+          [WCC::Contentful::Store::InstrumentationMiddleware],
+          # Stores do not guarantee that the entry is resolved to the locale
+          [WCC::Contentful::Middleware::Store::LocaleMiddleware]
         ].freeze
       end
     end

data/lib/wcc/contentful/store/memory_store.rb

@@ -7,9 +7,12 @@ module WCC::Contentful::Store
   # point for more useful implementations.  It only implements equality queries
   # and does not support querying through an association.
   class MemoryStore < Base
-    def initialize
+    delegate :locale_fallbacks, to: :@configuration
+
+    def initialize(configuration = nil)
       super
 
+      @configuration = configuration
       @mutex = Concurrent::ReentrantReadWriteLock.new
       @hash = {}
     end
@@ -36,7 +39,7 @@ module WCC::Contentful::Store
 
     def find(key, **_options)
       @mutex.with_read_lock do
-        @hash[key]
+        @hash[key].deep_dup
       end
     end
 
@@ -64,9 +67,12 @@ module WCC::Contentful::Store
 
       # For each condition, we apply a new Enumerable#select with a block that
       # enforces the condition.
-      query.conditions.reduce(relation) do |memo, condition|
-        __send__("apply_#{condition.op}", memo, condition)
-      end
+      relation =
+        query.conditions.reduce(relation) do |memo, condition|
+          __send__("apply_#{condition.op}", memo, condition)
+        end
+
+      relation.map(&:deep_dup)
     end
 
     private
@@ -80,8 +86,7 @@ module WCC::Contentful::Store
     end
 
     def eq?(entry, condition)
-      # The condition's path tells us where to find the value in the JSON object
-      val = entry.dig(*condition.path)
+      val = select_value_for_compare(entry, condition)
 
       # For arrays, equality is defined as does the array include the expected value.
       # See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/array-equality-inequality
@@ -101,7 +106,7 @@ module WCC::Contentful::Store
     end
 
     def in?(entry, condition)
-      val = entry.dig(*condition.path)
+      val = select_value_for_compare(entry, condition)
 
       if val.is_a? Array
         # TODO: detect if in ruby 3.1 and use val.intersect?(condition.expected)
@@ -110,5 +115,19 @@ module WCC::Contentful::Store
         condition.expected.include?(val)
       end
     end
+
+    # Selects the value for the condition from the entry, taking into account locale fallbacks
+    def select_value_for_compare(entry, condition)
+      condition.each_locale_fallback do |cond|
+        # The condition's path tells us where to find the value in the JSON object
+        val = entry.dig(*cond.path)
+
+        # If the object has no value for this locale, try the fallbacks
+        next if val.nil?
+
+        # The object has a value for this locale, so we must compare against it and not the fallbacks
+        return val
+      end
+    end
   end
 end

data/lib/wcc/contentful/store/postgres_store.rb

@@ -17,8 +17,8 @@ module WCC::Contentful::Store
     attr_reader :connection_pool
     attr_accessor :logger
 
-    def initialize(_config = nil, connection_options = nil, pool_options = nil)
-      super()
+    def initialize(configuration = nil, connection_options = nil, pool_options = nil)
+      super(configuration)
       @schema_ensured = false
       connection_options ||= { dbname: 'postgres' }
       pool_options ||= {}
@@ -100,7 +100,8 @@ module WCC::Contentful::Store
       Query.new(
         self,
         content_type: content_type,
-        options: options
+        options: options,
+        configuration: @configuration
       )
     end
 

data/lib/wcc/contentful/store/query/condition.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::Store::Query
+  Condition =
+    Struct.new(:path, :op, :expected, :locale_fallbacks) do
+      LINK_KEYS = %w[id type linkType].freeze # rubocop:disable Lint/ConstantDefinitionInBlock
+
+      ##
+      # Breaks the path into an array of tuples, where each tuple represents an
+      # entry subquery.
+      # If the query is a simple query on a field in an entry, there will be one
+      # tuple in the array:
+      #   { 'title' => 'foo' } becomes
+      #   [['fields', 'title', 'en-US']]
+      #
+      # If the query is a query through a link, there will be multiple tuples:
+      #  { 'page' => { 'title' => 'foo' } } becomes
+      #  [['fields', 'page', 'en-US'], ['fields', 'title', 'en-US']]
+      def path_tuples
+        return @path_tuples if @path_tuples
+
+        arr = []
+        remaining = path.dup
+        until remaining.empty?
+          locale = nil
+          link_sys = nil
+          link_field = nil
+
+          sys_or_fields = remaining.shift
+          field = remaining.shift
+          locale = remaining.shift if sys_or_fields == 'fields'
+
+          if remaining[0] == 'sys' && LINK_KEYS.include?(remaining[1])
+            link_sys = remaining.shift
+            link_field = remaining.shift
+          end
+
+          arr << [sys_or_fields, field, locale, link_sys, link_field].compact
+        end
+        @path_tuples = arr.freeze
+      end
+
+      ##
+      # Starting with the last part of the path that is a locale, iterates all the
+      # combinations of potential locale fallbacks.
+      # e.g. if the path is ['fields', 'page', 'es-MX', 'fields', 'title', 'es-MX']
+      # then we get:
+      #  ['fields', 'page', 'es-MX', 'fields', 'title', 'es-MX'] (self)
+      #  ['fields', 'page', 'es-MX', 'fields', 'title', 'es-US']
+      #  ['fields', 'page', 'es-MX', 'fields', 'title', 'en-US']
+      #  ['fields', 'page', 'es-US', 'fields', 'title', 'es-MX']
+      #  ['fields', 'page', 'es-US', 'fields', 'title', 'es-US']
+      #  ['fields', 'page', 'es-US', 'fields', 'title', 'en-US']
+      #  ['fields', 'page', 'en-US', 'fields', 'title', 'es-MX']
+      #  ['fields', 'page', 'en-US', 'fields', 'title', 'es-US']
+      #  ['fields', 'page', 'en-US', 'fields', 'title', 'en-US']
+      def each_locale_fallback(&block)
+        return to_enum(:each_locale_fallback) unless block_given?
+
+        _each_locale_fallback(path_tuples, 0, &block)
+      end
+
+      private
+
+      # Find the next fallback tuples from this set of tuples
+      def _each_locale_fallback(original_tuples, start_at, &block)
+        tuples = original_tuples.deep_dup
+        varying = tuples[start_at]
+
+        if varying[2].nil?
+          # This is a non-localizable query, so just yield it
+          yield Condition.new(tuples.flatten, op, expected, locale_fallbacks)
+          return
+        end
+
+        while varying[2]
+          if tuples.length > start_at + 1
+            # There's more locales that we need to vary to the right, so recurse into those
+            _each_locale_fallback(tuples, start_at + 1, &block)
+          else
+            # We're the tail of the condition, so yield it.
+            yield Condition.new(tuples.flatten, op, expected, locale_fallbacks)
+          end
+
+          varying[2] = locale_fallbacks[varying[2]]
+        end
+      end
+    end
+end

data/lib/wcc/contentful/store/query.rb

@@ -2,6 +2,7 @@
 
 require_relative '../../contentful'
 require_relative './query/interface'
+require_relative './query/condition'
 
 module WCC::Contentful::Store
   # The default query object returned by Stores that extend WCC::Contentful::Store::Base.
@@ -26,11 +27,12 @@ module WCC::Contentful::Store
 
     attr_reader :store, :content_type, :conditions
 
-    def initialize(store, content_type:, conditions: nil, options: nil, **extra)
+    def initialize(store, content_type:, conditions: nil, options: nil, configuration: nil, **extra) # rubocop:disable Metrics/ParameterLists
       @store = store
       @content_type = content_type
       @conditions = conditions || []
       @options = options || {}
+      @configuration = configuration || WCC::Contentful.configuration
       @extra = extra
     end
 
@@ -60,7 +62,7 @@ module WCC::Contentful::Store
     #          Can be an array, symbol, or dotted-notation path specification.
     # @expected The expected value to compare the field's value against.
     # @context A context object optionally containing `context[:locale]`
-    def apply_operator(operator, field, expected, context = nil)
+    def apply_operator(operator, field, expected, _context = nil)
       operator ||= expected.is_a?(Array) ? :in : :eq
       raise ArgumentError, "Operator #{operator} not supported" unless respond_to?(operator)
       raise ArgumentError, 'value cannot be nil (try using exists: false)' if expected.nil?
@@ -75,10 +77,10 @@ module WCC::Contentful::Store
       field = field.to_s if field.is_a? Symbol
       path = field.is_a?(Array) ? field : field.split('.')
 
-      path = self.class.normalize_condition_path(path, context)
+      path = self.class.normalize_condition_path(path, @options)
 
       _append_condition(
-        Condition.new(path, operator, expected)
+        Condition.new(path, operator, expected, @configuration&.locale_fallbacks || {})
       )
     end
 
@@ -177,15 +179,15 @@ module WCC::Contentful::Store
       end
 
       def known_locales
-        @known_locales = WCC::Contentful.locales.keys
+        @known_locales ||= WCC::Contentful.locales&.keys || ['en-US']
       end
       RESERVED_NAMES = %w[fields sys].freeze
 
       # Takes a path array in non-normal form and inserts 'sys', 'fields',
       # and the current locale as appropriate to normalize it.
       # rubocop:disable Metrics/BlockNesting
-      def normalize_condition_path(path, context = nil)
-        context_locale = context[:locale] if context.present?
+      def normalize_condition_path(path, options = nil)
+        context_locale = options[:locale]&.to_s if options.present?
         context_locale ||= 'en-US'
 
         rev_path = path.reverse
@@ -234,33 +236,5 @@ module WCC::Contentful::Store
       end
       # rubocop:enable Metrics/BlockNesting
     end
-
-    Condition =
-      Struct.new(:path, :op, :expected) do
-        LINK_KEYS = %w[id type linkType].freeze # rubocop:disable Lint/ConstantDefinitionInBlock
-
-        def path_tuples
-          @path_tuples ||=
-            [].tap do |arr|
-              remaining = path.dup
-              until remaining.empty?
-                locale = nil
-                link_sys = nil
-                link_field = nil
-
-                sys_or_fields = remaining.shift
-                field = remaining.shift
-                locale = remaining.shift if sys_or_fields == 'fields'
-
-                if remaining[0] == 'sys' && LINK_KEYS.include?(remaining[1])
-                  link_sys = remaining.shift
-                  link_field = remaining.shift
-                end
-
-                arr << [sys_or_fields, field, locale, link_sys, link_field].compact
-              end
-            end
-        end
-      end
   end
 end

data/lib/wcc/contentful/store/rspec_examples/basic_store.rb

@@ -105,7 +105,7 @@ RSpec.shared_examples 'basic store' do
           "type": "Asset",
           "createdAt": "2018-02-12T19:53:39.309Z",
           "updatedAt": "2018-02-12T19:53:39.309Z",
-          "revision": 1
+          "revision": 2
         },
         "fields": {
           "title": {
@@ -133,7 +133,10 @@ RSpec.shared_examples 'basic store' do
   describe '#set/#find' do
     describe 'ensures that the stored value is of type Hash' do
       it 'should not raise an error if value is a Hash' do
-        data = { token: 'jenny_8675309' }
+        data = {
+          'sys' => { 'id' => 'sync:token', 'type' => 'token' },
+          'token' => 'state'
+        }
 
         # assert
         expect { subject.set('sync:token', data) }.to_not raise_error
@@ -146,7 +149,11 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'stores and finds data by ID' do
-      data = { 'key' => 'val', '1' => { 'deep' => 9 } }
+      data = {
+        'sys' => { 'id' => '1234' },
+        'key' => 'val',
+        '1' => { 'deep' => 9 }
+      }
 
       # act
       subject.set('1234', data)
@@ -157,7 +164,11 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'find returns nil if key doesnt exist' do
-      data = { 'key' => 'val', '1' => { 'deep' => 9 } }
+      data = {
+        'sys' => { 'id' => '1234' },
+        'key' => 'val',
+        '1' => { 'deep' => 9 }
+      }
       subject.set('1234', data)
 
       # act
@@ -181,8 +192,16 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'set returns prior value if exists' do
-      data = { 'key' => 'val', '1' => { 'deep' => 9 } }
-      data2 = { 'key' => 'val', '2' => { 'deep' => 11 } }
+      data = {
+        'sys' => { 'id' => '1234', 'revision' => 1 },
+        'key' => 'val',
+        '1' => { 'deep' => 9 }
+      }
+      data2 = {
+        'sys' => { 'id' => '1234', 'revision' => 2 },
+        'key' => 'val',
+        '1' => { 'deep' => 11 }
+      }
 
       # act
       prior1 = subject.set('1234', data)
@@ -193,11 +212,27 @@ RSpec.shared_examples 'basic store' do
       expect(prior2).to eq(data)
       expect(subject.find('1234')).to eq(data2)
     end
+
+    it 'modifying found entry does not modify underlying data' do
+      subject.index(entry)
+
+      # act
+      found = subject.find('1qLdW7i7g4Ycq6i4Cckg44')
+      found['fields']['slug']['en-US'] = 'new slug'
+
+      # assert
+      found2 = subject.find('1qLdW7i7g4Ycq6i4Cckg44')
+      expect(found2.dig('fields', 'slug', 'en-US')).to eq('redirect-with-slug-and-url')
+    end
   end
 
   describe '#delete' do
     it 'deletes an item out of the store' do
-      data = { 'key' => 'val', '1' => { 'deep' => 9 } }
+      data = {
+        'sys' => { 'id' => '1234' },
+        'key' => 'val',
+        '1' => { 'deep' => 9 }
+      }
       subject.set('9999', data)
 
       # act
@@ -209,7 +244,11 @@ RSpec.shared_examples 'basic store' do
     end
 
     it "returns nil if item doesn't exist" do
-      data = { 'key' => 'val', '1' => { 'deep' => 9 } }
+      data = {
+        'sys' => { 'id' => '9999' },
+        'key' => 'val',
+        '1' => { 'deep' => 9 }
+      }
       subject.set('9999', data)
 
       # act
@@ -327,7 +366,10 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'updates an "Asset" when exists' do
-      existing = { 'test' => { 'data' => 'asdf' } }
+      existing = {
+        'sys' => { 'id' => '3pWma8spR62aegAWAWacyA', 'revision' => 1 },
+        'test' => { 'data' => 'asdf' }
+      }
       subject.set('3pWma8spR62aegAWAWacyA', existing)
 
       # act
@@ -341,7 +383,7 @@ RSpec.shared_examples 'basic store' do
     it 'does not overwrite an asset if revision is lower' do
       initial = asset
       updated = asset.deep_dup
-      updated['sys']['revision'] = 2
+      updated['sys']['revision'] = 3
       updated['fields']['title']['en-US'] = 'test title'
 
       subject.index(updated)
@@ -355,7 +397,10 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'removes a "DeletedEntry"' do
-      existing = { 'test' => { 'data' => 'asdf' } }
+      existing = {
+        'sys' => { 'id' => '6HQsABhZDiWmi0ekCouUuy' },
+        'test' => { 'data' => 'asdf' }
+      }
       subject.set('6HQsABhZDiWmi0ekCouUuy', existing)
 
       # act
@@ -381,7 +426,10 @@ RSpec.shared_examples 'basic store' do
     end
 
     it 'removes a "DeletedAsset"' do
-      existing = { 'test' => { 'data' => 'asdf' } }
+      existing = {
+        'sys' => { 'id' => '3pWma8spR62aegAWAWacyA' },
+        'test' => { 'data' => 'asdf' }
+      }
       subject.set('3pWma8spR62aegAWAWacyA', existing)
 
       # act
@@ -528,6 +576,18 @@ RSpec.shared_examples 'basic store' do
       expect(found.dig('sys', 'id')).to eq('idTwo')
       expect(found.dig('fields', 'system', 'en-US')).to eq('Two')
     end
+
+    it 'modifying found entry does not modify underlying data' do
+      subject.index(entry)
+
+      # act
+      found = subject.find_by(filter: { 'sys.id' => '1qLdW7i7g4Ycq6i4Cckg44' }, content_type: 'redirect')
+      found['fields']['slug']['en-US'] = 'new slug'
+
+      # assert
+      found2 = subject.find_by(filter: { 'sys.id' => '1qLdW7i7g4Ycq6i4Cckg44' }, content_type: 'redirect')
+      expect(found2.dig('fields', 'slug', 'en-US')).to eq('redirect-with-slug-and-url')
+    end
   end
 
   describe '#find_all' do
@@ -572,6 +632,18 @@ RSpec.shared_examples 'basic store' do
         %w[k1 k5 k9]
       )
     end
+
+    it 'modifying found entry does not modify underlying data' do
+      subject.index(entry)
+
+      # act
+      found = subject.find_all(content_type: 'redirect').eq('sys.id', '1qLdW7i7g4Ycq6i4Cckg44').first
+      found['fields']['slug']['en-US'] = 'new slug'
+
+      # assert
+      found2 = subject.find_all(content_type: 'redirect').eq('sys.id', '1qLdW7i7g4Ycq6i4Cckg44').first
+      expect(found2.dig('fields', 'slug', 'en-US')).to eq('redirect-with-slug-and-url')
+    end
   end
 
   def make_link_to(id, link_type = 'Entry')