forest_liana 6.6.1 → 7.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56720f9edd9f48712a65f46e41447785aa04772b3de3f0ef959faea901a3fd97
-  data.tar.gz: 4b26438ea7fb4a2cc807c35c29366697650fe27c11963cf177f631d13b953918
+  metadata.gz: 0bf8bedca443e88f415a14995d430f5ba021cfe846d8471588680c5f35e619eb
+  data.tar.gz: f68ffb4494911b3b674965b3370988c4505be91673f7d67e194482b0975226e2
 SHA512:
-  metadata.gz: 0ba707e8b91588054a0c38de31dc9a02ed5603d0b164ca8040bbe97b08dd426493795dfe283f8af0c49d2ebef73f9c64ff3d18a07e01038cea1ee371ff35286e
-  data.tar.gz: da40468756bdb066b0c45a400e35bab3e2c2846b38efe773dfaae5e3b48b453d9e9a2451fd532702c0d032027bf03541d0151c3ee85f27827a8deed3a7d1131f
+  metadata.gz: 97aeec5fc463e97cc3b8475c0f09228ea131a322d458104f2cf28306d390b904fd433a78e2a53b7baf34aaf05c6f66d7783e15a36b1f464790ab78bc5bd60ea6
+  data.tar.gz: 9339a84947baea79f91ebb48716760eee7f8e2acee6fc473b881904001c7f3f6bd6f1a1de6603df63eeba15967fcf6d982a60a7f42c049f007b958d60ff9732e

data/app/controllers/forest_liana/actions_controller.rb

@@ -1,8 +1,13 @@
 module ForestLiana
   class ActionsController < ForestLiana::BaseController
 
-    def values
-      render serializer: nil, json: {}, status: :ok
+    def get_smart_action_hook_request
+      begin
+        params[:data][:attributes]
+      rescue => error
+        FOREST_LOGGER.error "Smart Action hook request error: #{error}"
+        {}
+      end
     end
 
     def get_collection(collection_name)
@@ -18,43 +23,47 @@ module ForestLiana
         nil
       end
     end
-    
-    def get_record
-      model = ForestLiana::SchemaUtils.find_model_from_collection_name(params[:collectionName])
-      redord_getter = ForestLiana::ResourceGetter.new(model, {:id => params[:recordIds][0]})
-      redord_getter.perform
-      redord_getter.record
-    end
 
     def get_smart_action_load_ctx(fields)
-      fields = fields.reduce({}) do |p, c|
-        ForestLiana::WidgetsHelper.set_field_widget(c)
-        p.update(c[:field] => c.merge!(value: nil))
+      fields = fields.map do |field|
+        ForestLiana::WidgetsHelper.set_field_widget(field)
+        field[:value] = nil unless field[:value]
+        field
       end
-      {:record => get_record, :fields => fields}
+      {:fields => fields, :params => params}
     end
 
-    def get_smart_action_change_ctx(fields)
-      fields = fields.reduce({}) do |p, c|
-        field = c.permit!.to_h.symbolize_keys
+    def get_smart_action_change_ctx(fields, field_changed)
+      found_field_changed = fields.find{|field| field[:field] == field_changed}
+      fields = fields.map do |field|
+        field = field.permit!.to_h.symbolize_keys
         ForestLiana::WidgetsHelper.set_field_widget(field)
-        p.update(c[:field] => field)
+        field
       end
-      {:record => get_record, :fields => fields}
+      {:field_changed => found_field_changed, :fields => fields, :params => params}
     end
 
-    def handle_result(result, formatted_fields, action)
-      if result.nil? || !result.is_a?(Hash)
-        return render status: 500, json: { error: 'Error in smart action load hook: hook must return an object' }
+    def handle_result(result, action)
+      if result.nil? || !result.is_a?(Array)
+        return render status: 500, json: { error: 'Error in smart action load hook: hook must return an array of fields' }
       end
-      is_same_data_structure = ForestLiana::IsSameDataStructureHelper::Analyser.new(formatted_fields, result, 1)
-      unless is_same_data_structure.perform
-        return render status: 500, json: { error: 'Error in smart action hook: fields must be unchanged (no addition nor deletion allowed)' }
+
+      # Validate that the fields are well formed.
+      begin
+        # action.hooks[:change] is a hashmap here
+        # to do the validation, only the hook names are require
+        change_hooks_name = action.hooks[:change].nil? ? nil : action.hooks[:change].keys
+        ForestLiana::SmartActionFieldValidator.validate_smart_action_fields(result, action.name, change_hooks_name)
+      rescue ForestLiana::Errors::SmartActionInvalidFieldError => invalid_field_error
+        FOREST_LOGGER.warn invalid_field_error.message
+      rescue ForestLiana::Errors::SmartActionInvalidFieldHookError => invalid_hook_error
+        FOREST_LOGGER.error invalid_hook_error.message
+        return render status: 500, json: { error: invalid_hook_error.message }
       end
 
       # Apply result on fields (transform the object back to an array), preserve order.
-      fields = action.fields.map do |field|
-        updated_field = result[field[:field]]
+      fields = result.map do |field|
+        updated_field = result.find{|f| f[:field] == field[:field]}
 
         # Reset `value` when not present in `enums` (which means `enums` has changed).
         if updated_field[:enums].is_a?(Array)
@@ -72,41 +81,49 @@ module ForestLiana
         updated_field
       end
 
-      render serializer: nil, json: { fields: fields}, status: :ok
+      render serializer: nil, json: { fields: fields }, status: :ok
     end
 
     def load
-      action = get_action(params[:collectionName])
+      load_request = get_smart_action_hook_request
+
+      action = get_action(load_request[:collection_name])
 
       if !action
         render status: 500, json: {error: 'Error in smart action load hook: cannot retrieve action from collection'}
       else
-        # Transform fields from array to an object to ease usage in hook, adds null value.
+        # Get the smart action hook load context
         context = get_smart_action_load_ctx(action.fields)
-        formatted_fields = context[:fields].clone # clone for following test on is_same_data_structure
 
         # Call the user-defined load hook.
         result = action.hooks[:load].(context)
 
-        handle_result(result, formatted_fields, action)
+        handle_result(result, action)
       end
     end
 
     def change
-      action = get_action(params[:collectionName])
+      change_request = get_smart_action_hook_request
+
+      action = get_action(change_request[:collection_name])
 
       if !action
-        render status: 500, json: {error: 'Error in smart action change hook: cannot retrieve action from collection'}
-      else
-        # Transform fields from array to an object to ease usage in hook.
-        context = get_smart_action_change_ctx(params[:fields])
-        formatted_fields = context[:fields].clone # clone for following test on is_same_data_structure
+        return render status: 500, json: {error: 'Error in smart action change hook: cannot retrieve action from collection'}
+      elsif change_request[:fields].nil?
+        return render status: 500, json: {error: 'Error in smart action change hook: fields params is mandatory'}
+      elsif !change_request[:fields].is_a?(Array)
+        return render status: 500, json: {error: 'Error in smart action change hook: fields params must be an array'}
+      end
 
-        # Call the user-defined change hook.
-        result = action.hooks[:change][params[:changedField]].(context)
+      # Get the smart action hook change context
+      context = get_smart_action_change_ctx(change_request[:fields], change_request[:changed_field])
 
-        handle_result(result, formatted_fields, action)
-      end
+      field_changed_hook = context[:field_changed][:hook]
+
+      # Call the user-defined change hook.
+      result = action.hooks[:change][field_changed_hook].(context)
+
+      handle_result(result, action)
     end
   end
 end

data/app/controllers/forest_liana/application_controller.rb

@@ -34,14 +34,14 @@ module ForestLiana
 
     def serialize_model(record, options = {})
       options[:is_collection] = false
-      json = JSONAPI::Serializer.serialize(record, options)
+      json = ForestAdmin::JSONAPI::Serializer.serialize(record, options)
 
       force_utf8_encoding(json)
     end
 
     def serialize_models(records, options = {}, fields_searched = [])
       options[:is_collection] = true
-      json = JSONAPI::Serializer.serialize(records, options)
+      json = ForestAdmin::JSONAPI::Serializer.serialize(records, options)
 
       if options[:params] && options[:params][:search]
         # NOTICE: Add the Smart Fields with a 'String' type.
@@ -86,15 +86,6 @@ module ForestLiana
       end
     end
 
-    def get_smart_action_context
-      begin
-        params[:data][:attributes].values[0].to_hash.symbolize_keys
-      rescue => error
-        FOREST_LOGGER.error "Smart Action context retrieval error: #{error}"
-        {}
-      end
-    end
-
     def internal_server_error
       head :internal_server_error
     end

data/app/controllers/forest_liana/associations_controller.rb

@@ -41,7 +41,7 @@ module ForestLiana
         updater.perform
 
         if updater.errors
-          render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
+          render serializer: nil, json: ForestAdmin::JSONAPI::Serializer.serialize_errors(
             updater.errors), status: 422
         else
           head :no_content

data/app/controllers/forest_liana/base_controller.rb

@@ -24,7 +24,7 @@ module ForestLiana
           end
         end
       rescue ForestLiana::Errors::ExpectedError => exception
-        error_data = JSONAPI::Serializer.serialize_errors([{
+        error_data = ForestAdmin::JSONAPI::Serializer.serialize_errors([{
           status: exception.error_code,
           detail: exception.message
         }])

data/app/controllers/forest_liana/resources_controller.rb

@@ -41,7 +41,7 @@ module ForestLiana
           status: :unprocessable_entity, serializer: nil
       rescue ForestLiana::Errors::ExpectedError => error
         error.display_error
-        error_data = JSONAPI::Serializer.serialize_errors([{
+        error_data = ForestAdmin::JSONAPI::Serializer.serialize_errors([{
           status: error.error_code,
           detail: error.message
         }])
@@ -73,7 +73,7 @@ module ForestLiana
           status: :unprocessable_entity, serializer: nil
       rescue ForestLiana::Errors::ExpectedError => error
         error.display_error
-        error_data = JSONAPI::Serializer.serialize_errors([{
+        error_data = ForestAdmin::JSONAPI::Serializer.serialize_errors([{
           status: error.error_code,
           detail: error.message
         }])
@@ -108,12 +108,12 @@ module ForestLiana
         creator.perform
 
         if creator.errors
-          render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
+          render serializer: nil, json: ForestAdmin::JSONAPI::Serializer.serialize_errors(
             creator.errors), status: 400
         elsif creator.record.valid?
           render serializer: nil, json: render_record_jsonapi(creator.record)
         else
-          render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
+          render serializer: nil, json: ForestAdmin::JSONAPI::Serializer.serialize_errors(
             creator.record.errors), status: 400
         end
       rescue => error
@@ -131,12 +131,12 @@ module ForestLiana
         updater.perform
 
         if updater.errors
-          render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
+          render serializer: nil, json: ForestAdmin::JSONAPI::Serializer.serialize_errors(
             updater.errors), status: 400
         elsif updater.record.valid?
           render serializer: nil, json: render_record_jsonapi(updater.record)
         else
-          render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
+          render serializer: nil, json: ForestAdmin::JSONAPI::Serializer.serialize_errors(
             updater.record.errors), status: 400
         end
       rescue => error
@@ -249,6 +249,7 @@ module ForestLiana
       {
         user_id: user['id'],
         filters: collection_list_request[:filters],
+        segmentQuery: collection_list_request[:segmentQuery],
       }
     end
   end

data/app/serializers/forest_liana/intercom_attribute_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class IntercomAttributeSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :session_count
     attribute :last_seen_ip

data/app/serializers/forest_liana/intercom_conversation_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class IntercomConversationSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :created_at
     attribute :updated_at

data/app/serializers/forest_liana/mixpanel_event_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class MixpanelEventSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :id
     attribute :event

data/app/serializers/forest_liana/serializer_factory.rb

@@ -53,7 +53,7 @@ module ForestLiana
 
     def serializer_for(active_record_class)
       serializer = Class.new {
-        include JSONAPI::Serializer
+        include ForestAdmin::JSONAPI::Serializer
 
         def self_link
           "/forest#{super.underscore}"

data/app/serializers/forest_liana/stat_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StatSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :value
 

data/app/serializers/forest_liana/stripe_bank_account_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StripeBankAccountSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :account_holder_name
     attribute :account_holder_type

data/app/serializers/forest_liana/stripe_card_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StripeCardSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :last4
     attribute :brand

data/app/serializers/forest_liana/stripe_invoice_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StripeInvoiceSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :amount_due
     attribute :amount_paid

data/app/serializers/forest_liana/stripe_payment_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StripePaymentSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :description
     attribute :refunded

data/app/serializers/forest_liana/stripe_subscription_serializer.rb

@@ -1,6 +1,6 @@
 module ForestLiana
   class StripeSubscriptionSerializer
-    include JSONAPI::Serializer
+    include ForestAdmin::JSONAPI::Serializer
 
     attribute :cancel_at_period_end
     attribute :canceled_at

data/app/services/forest_liana/apimap_sorter.rb

@@ -52,6 +52,7 @@ module ForestLiana
       'description',
       'position',
       'widget',
+      'hook',
     ]
     KEYS_SEGMENT = ['name']
 

data/app/services/forest_liana/permissions_checker.rb

@@ -1,12 +1,12 @@
 module ForestLiana
   class PermissionsChecker
     @@permissions_cached = Hash.new
-    @@scopes_cached = Hash.new
+    @@renderings_cached = Hash.new
     @@roles_acl_activated = false
-    # TODO: handle cache scopes per rendering
+
     @@expiration_in_seconds = (ENV['FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS'] || 3600).to_i
 
-    def initialize(resource, permission_name, rendering_id, user_id: nil, smart_action_request_info: nil, collection_list_parameters: nil, query_request_info: nil)
+    def initialize(resource, permission_name, rendering_id, user_id: nil, smart_action_request_info: nil, collection_list_parameters: Hash.new, query_request_info: nil)
       
       @collection_name = resource.present? ? ForestLiana.name_for(resource) : nil
       @permission_name = permission_name
@@ -39,13 +39,16 @@ module ForestLiana
         permissions['data'] = ForestLiana::PermissionsFormatter.convert_to_new_format(permissions['data'], @rendering_id)
         @@permissions_cached[@rendering_id] = permissions
       end
-      add_scopes_to_cache(permissions)
+
+      # NOTICE: Add stats permissions to the RenderingPermissions
+      permissions['data']['renderings'][@rendering_id]['stats'] = permissions['stats']
+      add_rendering_permissions_to_cache(permissions)
     end
 
-    def add_scopes_to_cache(permissions)
+    def add_rendering_permissions_to_cache(permissions)
       permissions['data']['renderings'].keys.each { |rendering_id|
-        @@scopes_cached[rendering_id] = permissions['data']['renderings'][rendering_id]
-        @@scopes_cached[rendering_id]['last_fetch'] = Time.now
+        @@renderings_cached[rendering_id] = permissions['data']['renderings'][rendering_id]
+        @@renderings_cached[rendering_id]['last_fetch'] = Time.now
       } if permissions['data']['renderings']
     end
 
@@ -59,20 +62,17 @@ module ForestLiana
         return stat_with_parameters_allowed?
       end
 
-      
-
       if permissions && permissions[@collection_name] &&
         permissions[@collection_name]['collection']
         if @permission_name === 'actions'
           return smart_action_allowed?(permissions[@collection_name]['actions'])
         else
           if @permission_name === 'browseEnabled'
-            refresh_scope_cache if scope_cache_expired?
-            scope_permissions = get_scope_in_permissions
-            if scope_permissions
-              # NOTICE: current_scope will either contains conditions filter and
-              #         dynamic user values definition, or null for collection that does not use scopes
-              return false unless are_scopes_valid?(scope_permissions)
+            refresh_rendering_cache if rendering_cache_expired?
+
+            # NOTICE: In this case we need to check that that query is allowed
+            if @collection_list_parameters[:segmentQuery].present?
+              return false unless segment_query_allowed?
             end
           end
           return is_user_allowed(permissions[@collection_name]['collection'][@permission_name])
@@ -82,23 +82,27 @@ module ForestLiana
       end
     end
 
-    def get_scope_in_permissions
-      @@scopes_cached[@rendering_id] &&
-      @@scopes_cached[@rendering_id][@collection_name] &&
-      @@scopes_cached[@rendering_id][@collection_name]['scope']
+    def get_segments_in_permissions
+      @@renderings_cached[@rendering_id] &&
+      @@renderings_cached[@rendering_id][@collection_name] &&
+      @@renderings_cached[@rendering_id][@collection_name]['segments']
     end
 
-    def scope_cache_expired?
-      return true unless @@scopes_cached[@rendering_id] && @@scopes_cached[@rendering_id]['last_fetch']
+    def rendering_cache_expired?
+      return true unless @@renderings_cached[@rendering_id] && @@renderings_cached[@rendering_id]['last_fetch']
 
-      elapsed_seconds = date_difference_in_seconds(Time.now, @@scopes_cached[@rendering_id]['last_fetch'])
+      elapsed_seconds = date_difference_in_seconds(Time.now, @@renderings_cached[@rendering_id]['last_fetch'])
       elapsed_seconds >= @@expiration_in_seconds
     end
 
-    # This will happen only on rolesACLActivated (as scope cache will always be up to date on disabled)
-    def refresh_scope_cache
+    # This will happen only on rolesACLActivated (as segments cache will always be up to date on disabled)
+    def refresh_rendering_cache
       permissions = ForestLiana::PermissionsGetter::get_permissions_for_rendering(@rendering_id, rendering_specific_only: true)
-      add_scopes_to_cache(permissions)
+
+      # NOTICE: Add stats permissions to the RenderingPermissions
+      permissions['data']['renderings'][@rendering_id]['stats'] = permissions['stats']
+
+      add_rendering_permissions_to_cache(permissions)
     end
 
     # When acl disabled permissions are stored and retrieved by rendering
@@ -112,12 +116,12 @@ module ForestLiana
     end
 
     def get_live_query_permissions_content
-      permissions = get_permissions
+      permissions = @@renderings_cached[@rendering_id]
       permissions && permissions['stats'] && permissions['stats']['queries']
     end
     
     def get_stat_with_parameters_content(statPermissionType)
-      permissions = get_permissions
+      permissions = @@renderings_cached[@rendering_id]
       permissions && permissions['stats'] && permissions['stats'][statPermissionType]
     end
 
@@ -154,11 +158,13 @@ module ForestLiana
       is_user_allowed(smart_action_permissions['triggerEnabled'])
     end
 
-    def are_scopes_valid?(scope_permissions)
-      return ForestLiana::ScopeValidator.new(
-        scope_permissions['filter'],
-        scope_permissions['dynamicScopesValues']['users']
-      ).is_scope_in_request?(@collection_list_parameters)
+    def segment_query_allowed?
+      segments_queries_permissions = get_segments_in_permissions
+
+      return false unless segments_queries_permissions
+
+      # NOTICE: @query_request_info matching an existing segment query 
+      return segments_queries_permissions.include? @collection_list_parameters[:segmentQuery]
     end
 
     def live_query_allowed?
@@ -201,7 +207,7 @@ module ForestLiana
     # Used only for testing purpose
     def self.empty_cache
       @@permissions_cached = Hash.new
-      @@scopes_cached = Hash.new
+      @@renderings_cached = Hash.new
       @@roles_acl_activated = false
       @@expiration_in_seconds = (ENV['FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS'] || 3600).to_i
     end