infopark_cloud_connector 6.8.2.36.82613853 → 6.8.3.1.23895778

data/lib/rails_connector/cache.rb

@@ -1,6 +1,8 @@
 module RailsConnector
 
 class Cache
+  attr_reader :cache_prefix
+
   def initialize(options = {})
     @fallback_backend, @cache_prefix = options[:fallback_backend], options[:cache_prefix]
     @cache = {}
@@ -24,6 +26,10 @@ class Cache
     read(key) || block.call.tap { |value| write(key, value) }
   end
 
+  def clear
+    @cache = {}
+  end
+
   private
 
   def cache_key_for_fallback_backend(key)

data/lib/rails_connector/cms_base_model.rb

@@ -25,7 +25,7 @@ module RailsConnector
             end
       end
 
-      def query_index(model, index, params = {})
+      def query_index(model, index, params = {}, query_options={})
         hash_value = "#{model}/#{index}/#{params[:hash_value]}"
         range_value = params[:range_value] || ""
 
@@ -41,7 +41,7 @@ module RailsConnector
             end
         range_value = Range.new(start_key, end_key + "~")
 
-        adapter.query(hash_value, range_value)
+        adapter.query(hash_value, range_value, query_options)
       end
 
     end

data/lib/rails_connector/cms_cache_storage.rb

@@ -0,0 +1,44 @@
+module RailsConnector
+
+# This module manages storage of different kind of cache data.
+module CmsCacheStorage
+  VERSION = 'v1'.freeze
+
+  class << self
+    attr_writer :cache
+
+    def cache
+      @cache ||= begin
+        prefix = VERSION.dup
+        prefix.concat('-utf8') if String.new.encoding_aware?
+        Cache.new(fallback_backend: Rails.cache, cache_prefix: prefix)
+      end
+    end
+
+    def read_workspace_content_state_id(workspace_id)
+      cache.read("workspace/#{workspace_id}/content_state")
+    end
+
+    def write_workspace_content_state_id(workspace_id, content_state_id)
+      cache.write("workspace/#{workspace_id}/content_state", content_state_id)
+    end
+
+    def read_content_state(content_state_id)
+      cache.read("content/#{content_state_id}")
+    end
+
+    def write_content_state(content_state_id, content_state)
+      cache.write("content/#{content_state_id}", content_state)
+    end
+
+    def read_obj_data(content_state_id, index, key)
+      cache.read("content/#{content_state_id}/obj/#{index}/#{key}")
+    end
+
+    def write_obj_data(content_state_id, index, key, data)
+      cache.write("content/#{content_state_id}/obj/#{index}/#{key}", data)
+    end
+  end
+end
+
+end

data/lib/rails_connector/content_state.rb

@@ -0,0 +1,109 @@
+module RailsConnector
+
+# This class represents a single instance of a content state.
+# Basically a content state has three important characteristics: cache with obj datas,
+# changes representing changed objs and ways they has been changed and an ancestor content state.
+class ContentState < Struct.new(:content_state_id, :changes, :changes_index, :from_content_state_id)
+  class << self
+    private :new
+
+    # Creates a new content state with given changes and ancestor (optional).
+    def create(attributes)
+      new(attributes).tap do |content_state|
+        content_state.index_changes!
+        CmsCacheStorage.write_content_state(content_state.content_state_id, content_state.to_hash)
+      end
+    end
+
+    # Finds a previously saved content state.
+    # Returns nil if not found.
+    def find(content_state_id)
+      if content_state_data = CmsCacheStorage.read_content_state(content_state_id)
+        new(content_state_data)
+      end
+    end
+
+    # Fetches an existing workspace.
+    # If not found creates a new one and returns it.
+    def find_or_create(content_state_id)
+      find(content_state_id) || create(content_state_id: content_state_id)
+    end
+  end
+
+  def initialize(attributes)
+    super(*attributes.symbolize_keys.values_at(:content_state_id, :changes, :changes_index,
+        :from_content_state_id))
+  end
+
+  # Stores arbitrary data in cache.
+  # Cache key is build from given index and key.
+  def save_obj_data(index, key, data)
+    CmsCacheStorage.write_obj_data(content_state_id, index, key, data)
+  end
+
+  # Fetches previously stored arbitrary data from cache.
+  # Returns nil if nothing found.
+  # Cache key is build from given index and key.
+  def find_obj_data(index, key)
+    CmsCacheStorage.read_obj_data(content_state_id, index, key)
+  end
+
+  # Fetches and caches the ancestor.
+  # Returns nil if there is no ancestor.
+  def from_content_state
+    @from_content_state ||= self.class.find(from_content_state_id)
+  end
+
+  # Determines whether given data is still up-to-date for given index and key.
+  def has_changes_for?(index, key, data)
+    case index
+    when 'id'
+      id_index.include?(key)
+    when 'path'
+      path_index.include?(key) || id_index.include?(data.first['_id'].first)
+    when 'ppath'
+      ppath_index.include?(key) || data.find { |d| id_index.include?(d['_id'].first) }
+    end
+  end
+
+  # Computes for a given changes feed a set of access-efficient indexes.
+  def index_changes!
+    id_index, path_index, ppath_index = Set.new, Set.new, Set.new
+    if changes.present?
+      changes.each do |hash|
+        id_index.add(hash['id'])
+        if path = hash['modified_path']
+          path_index.add(path)
+          ppath_index.add(path.gsub(/\/[^\/]+$/, '').presence || '/') if path != '/'
+        end
+      end
+    end
+    self.changes = nil
+    self.changes_index = {'id' => id_index, 'path' => path_index, 'ppath' => ppath_index}
+  end
+
+  # Returns a hash representation of a content state for serialization purpose.
+  def to_hash
+    {
+      content_state_id: content_state_id,
+      changes_index: changes_index,
+      from_content_state_id: from_content_state_id
+    }
+  end
+
+  private
+
+  def id_index
+    @id_index ||= changes_index['id']
+  end
+
+  def path_index
+    @path_index ||= changes_index['path']
+  end
+
+  def ppath_index
+    @ppath_index ||= changes_index['ppath']
+  end
+end
+
+end

data/lib/rails_connector/content_state_caching.rb

@@ -0,0 +1,67 @@
+module RailsConnector
+
+# This module provides advances auto-invalidating caching mechanism for storing obj data.
+#
+# To keep it up-to-date it's caches and changes should be updated periodically
+# It's changes should be updated every time a new workspace data has been fetched.
+# It's caches should be updated every time a new obj data has been fetched.
+module ContentStateCaching
+  class << self
+    # How deep should a content state chain be inspected. Default depth is 20.
+    attr_accessor :cache_lookup_depth
+
+    # At which lookup depth to copy a hit found in an ancestor content state
+    # to the current content state's cache. Default depth is 5.
+    attr_accessor :cache_replication_depth
+
+    # Creates a new content state for given workspace with given ancetor and returns it.
+    def store_content_state(workspace_data)
+      ContentState.create(content_state_id: workspace_data.to_content_state_id,
+          changes: workspace_data.changes,
+          from_content_state_id: workspace_data.from_content_state_id)
+    end
+
+    # Fetches last known content state id for a given workspace id.
+    # Returns nil if there is no content state for that workspace.
+    def find_content_state_id(workspace_id)
+      CmsCacheStorage.read_workspace_content_state_id(workspace_id)
+    end
+
+    # Stores current content state id for workspace with given id.
+    def store_content_state_id(workspace_id, content_state_id)
+      CmsCacheStorage.write_workspace_content_state_id(workspace_id, content_state_id)
+    end
+
+    # Updates caches with data from given workspace.
+    # Should be called every time a new OBJ data has been fetched.
+    def store_obj_data(workspace_data, index, key, data)
+      content_state = workspace_data.content_state
+      content_state.save_obj_data(index, key, data) if content_state
+    end
+
+    # Fetches up-to-date obj data for given workspace, index and key.
+    # Returns nil if no up-to-date data found.
+    def find_obj_data(workspace_data, index, key)
+      return unless current_content_state = workspace_data.content_state
+      if index == 'permalink'
+        current_content_state.find_obj_data(index, key)
+      else
+        visitor = ContentStateVisitor.new(current_content_state)
+        cache_lookup_depth.times do |depth|
+          return unless content_state = visitor.visit_next
+          if hit = content_state.find_obj_data(index, key)
+            visitor.visited_except_current.each { |cs| return if cs.has_changes_for?(index, key, hit) }
+            current_content_state.save_obj_data(index, key, hit) if depth >= cache_replication_depth
+            return hit
+          end
+        end
+        nil
+      end
+    end
+  end
+
+  self.cache_replication_depth = 5
+  self.cache_lookup_depth = 20
+end
+
+end

data/lib/rails_connector/content_state_visitor.rb

@@ -0,0 +1,19 @@
+module RailsConnector
+  class ContentStateVisitor
+    def initialize(start_content_state)
+      @next_content_state, @visited = start_content_state, []
+    end
+
+    def visit_next
+      if content_state = @next_content_state
+        @visited << content_state
+        @next_content_state = content_state.from_content_state
+        content_state
+      end
+    end
+
+    def visited_except_current
+      @visited[0..-2]
+    end
+  end
+end

data/lib/rails_connector/dynamo_cms_backend.rb

@@ -56,7 +56,7 @@ module RailsConnector
       @query_counter += 1
       instrumenter = ActiveSupport::Notifications.instrumenter
       instrumenter.instrument(
-        "cms_load.rails_connector", :name => "Obj Load", :index => index, :keys => keys
+        "cms_load.rails_connector", :name => "Obj Load", :index => index.to_s, :keys => keys
       ) do
         keys.map do |key|
           results = revision.chain.query(index, key)

data/lib/rails_connector/revision.rb

@@ -58,10 +58,18 @@ module RailsConnector
       rtc['attributes']
     end
 
+    def rtc_id
+      rtc_ref['id']
+    end
+
     private
 
     def rtc
-      @rtc ||= DictStorage.get(read_attribute("rtc_ref"))
+      @rtc ||= DictStorage.get(rtc_ref)
+    end
+
+    def rtc_ref
+      read_attribute('rtc_ref')
     end
   end
 end

data/lib/rails_connector/service_cms_backend.rb

@@ -48,25 +48,24 @@ module RailsConnector
 
   # connects the cloud connector to the connector service
   class ServiceCmsBackend < CmsBackend
-    VERSION = "v1".freeze
     BLOB_DATA_CACHE_PREFIX = 'blob_data'.freeze
+    VALID_INDEX_NAMES = %w[id path ppath permalink].freeze
 
     def initialize
       @query_counter = 0
     end
 
     def begin_caching
-      @editable_cache = Configuration.cache_editable_workspaces ? persistent_cache : Cache.new
-      @read_only_cache = persistent_cache
-      @blob_data_cache = persistent_cache
+      @caching = true
     end
 
     def end_caching
-      @editable_cache = @read_only_cache = @blob_data_cache = nil
+      CmsCacheStorage.cache.clear
+      @caching = false
     end
 
     def caching?
-      @read_only_cache && @editable_cache && @blob_data_cache
+      !!@caching
     end
 
     def query_counter
@@ -74,23 +73,25 @@ module RailsConnector
     end
 
     def find_workspace_data_by_id(id)
-      raw_data = ContentService.query(
-        "workspaces/query",
-        :workspace_id => id
-      )
+      from_content_state_id = ContentStateCaching.find_content_state_id(id)
+      request_params = {:workspace_id => id}
+      request_params[:content_state_id] = from_content_state_id if from_content_state_id
+      raw_data = ContentService.query('workspaces/query', request_params)
       if raw_workspace_data = raw_data['workspace']
-        WorkspaceDataFromService.new raw_workspace_data
+        workspace_data = WorkspaceDataFromService.new(raw_workspace_data)
+        if from_content_state_id != workspace_data.content_state_id
+          ContentStateCaching.store_content_state(workspace_data)
+          ContentStateCaching.store_content_state_id(workspace_data.id,
+              workspace_data.content_state_id)
+        end
+        workspace_data
       end
     end
 
     def find_obj_data_by(workspace_data, index, keys)
-      raw_data =
-        if caching?
-          find_raw_data_from_cache_or_database_by(workspace_data, index, keys)
-        else
-          find_raw_data_from_database_by(workspace_data, index, keys)
-        end
-
+      index = index.to_s
+      assert_valid_index_name(index)
+      raw_data = find_raw_data_from_cache_or_database_by(workspace_data, index, keys)
       raw_data.map do |raw_list|
         raw_list.map do |raw_obj_data|
           ObjDataFromService.new(raw_obj_data)
@@ -99,30 +100,25 @@ module RailsConnector
     end
 
     def find_blob_data_by_id(id)
-      if caching?
-        find_blob_data_from_cache_or_database_by_id(id)
+      cache_key = "#{BLOB_DATA_CACHE_PREFIX}/#{id}"
+      if data_from_cache = CmsCacheStorage.cache.read(cache_key)
+        data_from_cache
       else
-        find_blob_data_from_database_by(id)
+        data_from_database = find_blob_data_from_database_by(id)
+        if maxage = data_from_database['maxage']
+          CmsCacheStorage.cache.write(cache_key, data_from_database, :expires_in => maxage)
+        end
+        data_from_database
       end
     end
 
     private
 
-    def encoding_aware_cache_prefix
-      prefix = VERSION.dup
-      prefix.concat('-utf8') if String.new.encoding_aware?
-      prefix
-    end
-
-    def persistent_cache
-      Cache.new(:fallback_backend => Rails.cache, :cache_prefix => encoding_aware_cache_prefix)
-    end
-
     def find_raw_data_from_cache_or_database_by(workspace_data, index, keys)
       keys_from_database = []
       # load results from cache
       results_from_cache = keys.map do |key|
-        cache_for(workspace_data).read(cache_key_for(workspace_data, index, key)).tap do |objs|
+        find_raw_data_from_cache_by(workspace_data, index, key).tap do |objs|
           keys_from_database << key unless objs
         end
       end
@@ -140,6 +136,10 @@ module RailsConnector
       end
     end
 
+    def find_raw_data_from_cache_by(workspace_data, index, key)
+      ContentStateCaching.find_obj_data(workspace_data, index, key) if caching?
+    end
+
     def find_raw_data_from_database_by(workspace_data, index, keys)
       return [] if keys.blank?
       instrumenter = ActiveSupport::Notifications.instrumenter
@@ -177,28 +177,7 @@ module RailsConnector
     end
 
     def store_item_in_cache(workspace_data, index, key, item)
-      cache_for(workspace_data).write(cache_key_for(workspace_data, index, key), item) if caching?
-    end
-
-    def cache_key_for(workspace_data, index, key)
-      "rev/#{workspace_data.revision_id}/obj/#{index}/#{key}"
-    end
-
-    def cache_for(workspace_data)
-      workspace_data.cachable? ? @read_only_cache : @editable_cache
-    end
-
-    def find_blob_data_from_cache_or_database_by_id(id)
-      cache_key = "#{BLOB_DATA_CACHE_PREFIX}/#{id}"
-      if data_from_cache = @blob_data_cache.read(cache_key)
-        data_from_cache
-      else
-        data_from_database = find_blob_data_from_database_by(id)
-        if maxage = data_from_database['maxage']
-          @blob_data_cache.write(cache_key, data_from_database, :expires_in => maxage)
-        end
-        data_from_database
-      end
+      ContentStateCaching.store_obj_data(workspace_data, index, key, item)
     end
 
     def find_blob_data_from_database_by(id)
@@ -206,6 +185,10 @@ module RailsConnector
       ContentService.query('blobs/query', :blob_ids => [id])['blobs'][id]
     end
 
+    def assert_valid_index_name(index)
+      raise ArgumentError, "invalid index name '#{index}'" unless VALID_INDEX_NAMES.include?(index)
+    end
+
   end
 
 end

data/lib/rails_connector/workspace_data_from_service.rb

@@ -13,14 +13,34 @@ class WorkspaceDataFromService
     @data["id"]
   end
 
-  def cachable?
-    @data["is_cachable"]
-  end
-
   # remove this method after DynamoCmsBackend has been removed from the Cloud Connector
   def content_cache_id=(id)
     # ignore, since not using content caches
   end
+
+  def content_state_id
+    @data['content_state_id']
+  end
+
+  def content_state
+    @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
+  end
+
+  def diff
+    @data['diff']
+  end
+
+  def changes
+    diff && diff['changes']
+  end
+
+  def from_content_state_id
+    diff && diff['from_content_state_id']
+  end
+
+  def to_content_state_id
+    diff && diff['to_content_state_id']
+  end
 end
 
 end # module RailsConnector

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infopark_cloud_connector
 version: !ruby/object:Gem::Version
-  version: 6.8.2.36.82613853
+  version: 6.8.3.1.23895778
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-31 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.8.2.36.82613853
+        version: 6.8.3.1.23895778
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.8.2.36.82613853
+        version: 6.8.3.1.23895778
 description: The Cloud Connector for Infopark CMS Fiona enables you to develop modern,
   dynamic Web 2.0 applications using Ruby on Rails and at the same time display CMS
   managed content.
@@ -89,9 +89,13 @@ files:
 - lib/rails_connector/cms_api_search_request.rb
 - lib/rails_connector/cms_backend.rb
 - lib/rails_connector/cms_base_model.rb
+- lib/rails_connector/cms_cache_storage.rb
 - lib/rails_connector/cms_rest_api.rb
 - lib/rails_connector/content_cache.rb
 - lib/rails_connector/content_service.rb
+- lib/rails_connector/content_state.rb
+- lib/rails_connector/content_state_caching.rb
+- lib/rails_connector/content_state_visitor.rb
 - lib/rails_connector/controller_runtime.rb
 - lib/rails_connector/date_attribute.rb
 - lib/rails_connector/default_search_request.rb
@@ -142,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1009000627
+      hash: -805109069
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: