chore(force-release): release forest-rails 7.0.0

Author: adriguy

CHANGELOG.md

@@ -1,3 +1,46 @@
+# [7.0.0-beta.6](https://github.com/ForestAdmin/forest-rails/compare/v7.0.0-beta.5...v7.0.0-beta.6) (2021-07-20)
+
+
+### Bug Fixes
+
+* allow smart action endpoints to start with slashes ([d4f6a61](https://github.com/ForestAdmin/forest-rails/commit/d4f6a618aeea72364b0e7511545b67fbbfb17c99))
+* allow smart action endpoints to start with slashes ([cf6c6a9](https://github.com/ForestAdmin/forest-rails/commit/cf6c6a96498e6813e4b7ccaa56cacd9abefc332f))
+* fix time based graph when timezone is different with database ([#476](https://github.com/ForestAdmin/forest-rails/issues/476)) ([5d9fb89](https://github.com/ForestAdmin/forest-rails/commit/5d9fb8903ae53615dd1789bdebbc4d9c7d6f4576))
+* stats permissions should be retrieved only one time per team ([#489](https://github.com/ForestAdmin/forest-rails/issues/489)) ([c2e9104](https://github.com/ForestAdmin/forest-rails/commit/c2e9104ebf32deeb3e5676706fdcbaae5de34869))
+* support permissions infos with ruby < 2.7 ([#486](https://github.com/ForestAdmin/forest-rails/issues/486)) ([a611271](https://github.com/ForestAdmin/forest-rails/commit/a611271e709bb6a9ed0d3ebccfb64b6eea1d324d))
+
+
+### Features
+
+* include role in the user data inside the request ([#478](https://github.com/ForestAdmin/forest-rails/issues/478)) ([0a34716](https://github.com/ForestAdmin/forest-rails/commit/0a347165897aa118e486895e55f4b29ba7fb888b))
+* **schema:** move some meta data under stack attribute to prevent blocking scenarios on DWO ([#469](https://github.com/ForestAdmin/forest-rails/issues/469)) ([76aa754](https://github.com/ForestAdmin/forest-rails/commit/76aa7540300f75b0ea1d00ec3b60e4976b7d800e))
+
+# [7.0.0-beta.5](https://github.com/ForestAdmin/forest-rails/compare/v7.0.0-beta.4...v7.0.0-beta.5) (2021-07-09)
+
+
+### Features
+
+* **scopes:** enforce scopes restrictions on a wider range of requests ([#488](https://github.com/ForestAdmin/forest-rails/issues/488)) ([66825a3](https://github.com/ForestAdmin/forest-rails/commit/66825a339fc11d03b8a1653b1877cb9d492dacfb))
+
+# [7.0.0-beta.4](https://github.com/ForestAdmin/forest-rails/compare/v7.0.0-beta.3...v7.0.0-beta.4) (2021-07-06)
+
+
+### Features
+
+* smart action hooks now have access to the http request ([#499](https://github.com/ForestAdmin/forest-rails/issues/499)) ([5cd4a0e](https://github.com/ForestAdmin/forest-rails/commit/5cd4a0e7b9d9e1fcc551198a2eab62e471f51d92))
+
+
+### BREAKING CHANGES
+
+* record is no longer send to the hook midleware & values option on smart action is no longer supported
+
+# [7.0.0-beta.3](https://github.com/ForestAdmin/forest-rails/compare/v7.0.0-beta.2...v7.0.0-beta.3) (2021-07-02)
+
+
+### Features
+
+* **security:** secure segments queries ([#495](https://github.com/ForestAdmin/forest-rails/issues/495)) ([571f889](https://github.com/ForestAdmin/forest-rails/commit/571f889d85c226b8d4b78618150c75f4fa2aa9ad))
+
 ## [6.6.2](https://github.com/ForestAdmin/forest-rails/compare/v6.6.1...v6.6.2) (2021-06-16)
 
 
@@ -27,13 +70,38 @@
 * allow smart action endpoints to start with slashes ([d4f6a61](https://github.com/ForestAdmin/forest-rails/commit/d4f6a618aeea72364b0e7511545b67fbbfb17c99))
 * allow smart action endpoints to start with slashes ([cf6c6a9](https://github.com/ForestAdmin/forest-rails/commit/cf6c6a96498e6813e4b7ccaa56cacd9abefc332f))
 
+# [7.0.0-beta.2](https://github.com/ForestAdmin/forest-rails/compare/v7.0.0-beta.1...v7.0.0-beta.2) (2021-06-07)
+
+
+### Features
+
+* **hooks:** developers can dynamically add or remove smart actions fields ([#465](https://github.com/ForestAdmin/forest-rails/issues/465)) ([970f3d8](https://github.com/ForestAdmin/forest-rails/commit/970f3d82806296137f2e64379c92884b04954580))
+
+
+### BREAKING CHANGES
+
+* **hooks:** fields parameters on hook function is no longer a map of field, it is now an array.
+change hook is no longer choosen by the field name, field need to have hook defined inside it definition by addin a props hook.
+
 # [6.5.0](https://github.com/ForestAdmin/forest-rails/compare/v6.4.1...v6.5.0) (2021-06-03)
 
 
 ### Features
 
 * **schema:** move some meta data under stack attribute to prevent blocking scenarios on DWO ([#469](https://github.com/ForestAdmin/forest-rails/issues/469)) ([76aa754](https://github.com/ForestAdmin/forest-rails/commit/76aa7540300f75b0ea1d00ec3b60e4976b7d800e))
 
+# [7.0.0-beta.1](https://github.com/ForestAdmin/forest-rails/compare/v6.4.1-beta.1...v7.0.0-beta.1) (2021-06-01)
+
+
+### Bug Fixes
+
+* **dependency:** now using forestadmin-jsonapi-serializers instead of the jsonapi-serializers gem ([#475](https://github.com/ForestAdmin/forest-rails/issues/475)) ([3feea36](https://github.com/ForestAdmin/forest-rails/commit/3feea36b3b578638f3ad7c16ebab8e457a68d71f))
+
+
+### BREAKING CHANGES
+
+* **dependency:** Switch from jsonapi-serializers to forestadmin-jsonapi-serializers to serialize data to the JSONAPI format, mainly to avoid conflict with the jsonapi-serializer library
+
 ## [6.4.1](https://github.com/ForestAdmin/forest-rails/compare/v6.4.0...v6.4.1) (2021-06-01)
 
 

Gemfile

@@ -23,7 +23,7 @@ group :test do
 end
 
 gem 'rails', '6.0.3.6'
-gem 'jsonapi-serializers', '1.0.1'
+gem 'forestadmin-jsonapi-serializers'
 gem 'rack-cors'
 gem 'arel-helpers', '2.11.0'
 gem 'groupdate', '5.2.2'

Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    forest_liana (6.6.2)
+    forest_liana (7.0.0-beta.6)
       arel-helpers
       bcrypt
+      forestadmin-jsonapi-serializers (>= 0.14.0)
       groupdate (>= 5.0.0)
       httparty
       ipaddress
       json
       json-jwt
-      jsonapi-serializers (>= 0.14.0)
       jwt
       openid_connect
       rack-cors
@@ -87,6 +87,8 @@ GEM
     diff-lcs (1.4.4)
     docile (1.3.5)
     erubi (1.10.0)
+    forestadmin-jsonapi-serializers (2.0.0.pre.beta.2)
+      activesupport
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     groupdate (5.2.2)
@@ -103,8 +105,6 @@ GEM
       activesupport (>= 4.2)
       aes_key_wrap
       bindata
-    jsonapi-serializers (1.0.1)
-      activesupport
     jwt (2.2.3)
     loofah (2.9.1)
       crass (~> 1.0.2)
@@ -235,12 +235,12 @@ DEPENDENCIES
   bcrypt
   byebug
   forest_liana!
+  forestadmin-jsonapi-serializers
   groupdate (= 5.2.2)
   httparty (= 0.18.1)
   ipaddress (= 0.8.3)
   json
   json-jwt (= 1.12.0)
-  jsonapi-serializers (= 1.0.1)
   jwt
   openid_connect (= 1.2.0)
   rack-cors
@@ -252,4 +252,4 @@ DEPENDENCIES
   useragent
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

app/controllers/forest_liana/actions_controller.rb

@@ -1,8 +1,13 @@
 module ForestLiana
-  class ActionsController < ForestLiana::BaseController
+  class ActionsController < ApplicationController
 
-    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)
@@ -12,49 +17,53 @@ def get_collection(collection_name)
     def get_action(collection_name)
       collection = get_collection(collection_name)
       begin
-         collection.actions.find {|action| ActiveSupport::Inflector.parameterize(action.name) == params[:action_name]}
+        collection.actions.find {|action| ActiveSupport::Inflector.parameterize(action.name) == params[:action_name]}
       rescue => error
         FOREST_LOGGER.error "Smart Action get action retrieval error: #{error}"
         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 @@ def handle_result(result, formatted_fields, action)
         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

app/controllers/forest_liana/application_controller.rb

@@ -34,14 +34,14 @@ def forest_user
 
     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 @@ def authenticate_user_from_jwt
       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

app/controllers/forest_liana/associations_controller.rb

@@ -10,7 +10,7 @@ class AssociationsController < ForestLiana::ApplicationController
 
     def index
       begin
-        getter = HasManyGetter.new(@resource, @association, params)
+        getter = HasManyGetter.new(@resource, @association, params, forest_user)
         getter.perform
 
         respond_to do |format|
@@ -25,7 +25,7 @@ def index
 
     def count
       begin
-        getter = HasManyGetter.new(@resource, @association, params)
+        getter = HasManyGetter.new(@resource, @association, params, forest_user)
         getter.count
 
         render serializer: nil, json: { count: getter.records_count }
@@ -41,7 +41,7 @@ def update
         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

app/controllers/forest_liana/base_controller.rb

@@ -24,7 +24,7 @@ def reject_unauthorized_ip
           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
         }])