feat(capabilities): add native query support

.rubocop.yml

@@ -16,6 +16,7 @@ Gemspec/OrderedDependencies:
  - 'packages/forest_admin_agent/forest_admin_agent.gemspec'
  - 'packages/forest_admin_rails/forest_admin_rails.gemspec'
  - 'packages/forest_admin_datasource_toolkit/forest_admin_datasource_toolkit.gemspec'
+ - 'packages/forest_admin_test_toolkit/forest_admin_test_toolkit.gemspec'
  - 'packages/forest_admin_datasource_customizer/forest_admin_datasource_customizer.gemspec'
  - 'packages/forest_admin_datasource_active_record/forest_admin_datasource_active_record.gemspec'
 
@@ -25,6 +26,7 @@ Gemspec/RequireMFA:
  - 'packages/forest_admin_agent/forest_admin_agent.gemspec'
  - 'packages/forest_admin_rails/forest_admin_rails.gemspec'
  - 'packages/forest_admin_datasource_toolkit/forest_admin_datasource_toolkit.gemspec'
+ - 'packages/forest_admin_test_toolkit/forest_admin_test_toolkit.gemspec'
  - 'packages/forest_admin_datasource_customizer/forest_admin_datasource_customizer.gemspec'
  - 'packages/forest_admin_datasource_active_record/forest_admin_datasource_active_record.gemspec'
 
@@ -125,6 +127,13 @@ Style/StringLiterals:
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/version.rb'
  - 'packages/forest_admin_datasource_toolkit/spec/spec_helper.rb'
+ - 'packages/forest_admin_datasource_toolkit/forest_admin_test_toolkit.gemspec'
+ - 'packages/forest_admin_test_toolkit/Gemfile'
+ - 'packages/forest_admin_test_toolkit/Rakefile'
+ - 'packages/forest_admin_test_toolkit/bin/console'
+ - 'packages/forest_admin_test_toolkit/lib/forest_admin_test_toolkit.rb'
+ - 'packages/forest_admin_test_toolkit/lib/forest_admin_test_toolkit/version.rb'
+ - 'packages/forest_admin_test_toolkit/spec/spec_helper.rb'
  - 'packages/forest_admin_datasource_customizer/forest_admin_datasource_customizer.gemspec'
  - 'packages/forest_admin_datasource_customizer/Gemfile'
  - 'packages/forest_admin_datasource_customizer/Rakefile'
@@ -248,6 +257,7 @@ Metrics/ClassLength:
  - 'packages/forest_admin_agent/lib/forest_admin_agent/utils/query_string_parser.rb'
  - 'packages/forest_admin_datasource_active_record/lib/forest_admin_datasource_active_record/utils/query.rb'
  - 'packages/forest_admin_datasource_active_record/lib/forest_admin_datasource_active_record/collection.rb'
+ - 'packages/forest_admin_datasource_active_record/lib/forest_admin_datasource_active_record/datasource.rb'
  - 'packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/collection_customizer.rb'
  - 'packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/binary/binary_collection_decorator.rb'
  - 'packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/search/search_collection_decorator.rb'

Gemfile

@@ -5,9 +5,9 @@ gemspec
 group :development, :tests do
  gem "overcommit", "~> 0.60"
  gem "rspec", "~> 3.0"
- gem "rubocop", "~> 1.33"
- gem "rubocop-performance", "~> 1.19"
- gem "rubocop-rspec", "~> 2.23"
+ gem "rubocop"
+ gem "rubocop-performance"
+ gem "rubocop-rspec"
  gem 'simplecov', "~> 0.22", require: false
  gem 'simplecov_json_formatter', "~> 0.1.4"
 end

packages/forest_admin_agent/lib/forest_admin_agent/http/router.rb

@@ -12,6 +12,7 @@ def self.routes
  Security::ScopeInvalidation.new.routes,
  Charts::Charts.new.routes,
  Capabilities::Collections.new.routes,
+ Resources::NativeQuery.new.routes,
  Resources::Count.new.routes,
  Resources::Delete.new.routes,
  Resources::Csv.new.routes,

packages/forest_admin_agent/lib/forest_admin_agent/routes/abstract_route.rb

@@ -8,6 +8,8 @@ def initialize
 
  def build(args)
  @datasource = ForestAdminAgent::Facades::Container.datasource
+ return unless args[:params]['collection_name']
+
  @collection = @datasource.get_collection(args[:params]['collection_name'])
  end
 

packages/forest_admin_agent/lib/forest_admin_agent/routes/capabilities/collections.rb

@@ -18,6 +18,13 @@ def handle_request(args = {})
  @datasource = ForestAdminAgent::Facades::Container.datasource
  collections = args[:params]['collectionNames'] || []
 
+ connections = []
+ ForestAdminAgent::Builder::AgentFactory.instance.customizer.datasources.map do |root_datasource|
+ connections = connections.union(
+ root_datasource.live_query_connections.keys.map { |connection_name| { name: connection_name } }
+ )
+ end
+
  result = collections.map do |collection_name|
  collection = @datasource.get_collection(collection_name)
  {
@@ -34,7 +41,8 @@ def handle_request(args = {})
 
  {
  content: {
- collections: result
+ collections: result,
+ nativeQueryConnections: connections
  },
  status: 200
  }

packages/forest_admin_agent/lib/forest_admin_agent/routes/query_handler.rb

@@ -0,0 +1,56 @@
+module ForestAdminAgent
+ module Routes
+ module QueryHandler
+ include ForestAdminAgent::Utils
+ include ForestAdminAgent::Builder
+ include ForestAdminDatasourceToolkit::Components::Query
+ include ForestAdminDatasourceToolkit::Validations
+
+ def inject_context_variables(connection_name, query, permissions, caller, context_variables)
+ user = permissions.get_user_data(caller.id)
+ team = permissions.get_team(caller.rendering_id)
+ context_variables = ContextVariables.new(team, user, context_variables)
+
+ ContextVariablesInjector.inject_context_in_native_query(connection_name, query, context_variables)
+ end
+
+ def execute_query(query, connection_name, permissions, caller, context_variables)
+ root_datasource = AgentFactory.instance.customizer.get_root_datasource_by_connection(connection_name)
+ query = query.strip
+ query, context_variables = inject_context_variables(connection_name, query, permissions, caller,
+ context_variables)
+
+ root_datasource.execute_native_query(
+ connection_name,
+ query,
+ context_variables.values
+ )
+ end
+
+ def parse_query_segment(collection, args, permissions, caller)
+ return unless args[:params][:segmentQuery]
+
+ unless args[:params][:connectionName]
+ raise ForestAdminAgent::Http::Exceptions::UnprocessableError, 'Missing native query connection attribute'
+ end
+
+ QueryValidator.valid?(args[:params][:segmentQuery])
+
+ permissions.can_execute_query_segment?(collection, args[:params][:segmentQuery], args[:params][:connectionName])
+
+ ids = execute_query(
+ args[:params][:segmentQuery],
+ args[:params][:connectionName],
+ permissions,
+ caller,
+ args[:params][:contextVariables]
+ ).map(&:values)
+
+ condition_tree_segment = ConditionTree::ConditionTreeFactory.match_ids(collection, ids)
+ ConditionTreeValidator.validate(condition_tree_segment, collection)
+
+ condition_tree_segment
+ end
+ end
+ end
+end

packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/count.rb

@@ -6,6 +6,8 @@ module Resources
  class Count < AbstractAuthenticatedRoute
  include ForestAdminAgent::Builder
  include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+ include ForestAdminAgent::Routes::QueryHandler
+
  def setup_routes
  add_route('forest_count', 'get', '/:collection_name/count', ->(args) { handle_request(args) })
 
@@ -18,7 +20,16 @@ def handle_request(args = {})
 
  if @collection.is_countable?
  filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
- condition_tree: @permissions.get_scope(@collection)
+ condition_tree: ConditionTreeFactory.intersect(
+ [
+ @permissions.get_scope(@collection),
+ parse_query_segment(@collection, args, @permissions, @caller),
+ ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(@collection, args)
+ ]
+ ),
+ search: QueryStringParser.parse_search(@collection, args),
+ search_extended: QueryStringParser.parse_search_extended(args),
+ segment: QueryStringParser.parse_segment(@collection, args)
  )
  aggregation = ForestAdminDatasourceToolkit::Components::Query::Aggregation.new(operation: 'Count')
  result = @collection.aggregate(@caller, filter, aggregation)

packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/csv.rb

@@ -4,6 +4,7 @@ module Resources
  class Csv < AbstractAuthenticatedRoute
  include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
  include ForestAdminAgent::Utils
+ include ForestAdminAgent::Routes::QueryHandler
 
  def setup_routes
  add_route(
@@ -25,6 +26,7 @@ def handle_request(args = {})
  condition_tree: ConditionTreeFactory.intersect(
  [
  @permissions.get_scope(@collection),
+ parse_query_segment(@collection, args, @permissions, @caller),
  ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(
  @collection, args
  )

packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/list.rb

@@ -5,6 +5,8 @@ module Routes
  module Resources
  class List < AbstractAuthenticatedRoute
  include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+ include ForestAdminAgent::Utils
+ include ForestAdminAgent::Routes::QueryHandler
 
  def setup_routes
  add_route('forest_list', 'get', '/:collection_name', ->(args) { handle_request(args) })
@@ -17,20 +19,21 @@ def handle_request(args = {})
  @permissions.can?(:browse, @collection)
 
  filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
- condition_tree: ConditionTreeFactory.intersect([
- @permissions.get_scope(@collection),
- ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(
- @collection, args
- )
- ]),
- page: ForestAdminAgent::Utils::QueryStringParser.parse_pagination(args),
- search: ForestAdminAgent::Utils::QueryStringParser.parse_search(@collection, args),
- search_extended: ForestAdminAgent::Utils::QueryStringParser.parse_search_extended(args),
- sort: ForestAdminAgent::Utils::QueryStringParser.parse_sort(@collection, args),
- segment: ForestAdminAgent::Utils::QueryStringParser.parse_segment(@collection, args)
+ condition_tree: ConditionTreeFactory.intersect(
+ [
+ @permissions.get_scope(@collection),
+ QueryStringParser.parse_condition_tree(@collection, args),
+ parse_query_segment(@collection, args, @permissions, @caller)
+ ]
+ ),
+ page: QueryStringParser.parse_pagination(args),
+ search: QueryStringParser.parse_search(@collection, args),
+ search_extended: QueryStringParser.parse_search_extended(args),
+ sort: QueryStringParser.parse_sort(@collection, args),
+ segment: QueryStringParser.parse_segment(@collection, args)
  )
 
- projection = ForestAdminAgent::Utils::QueryStringParser.parse_projection_with_pks(@collection, args)
+ projection = QueryStringParser.parse_projection_with_pks(@collection, args)
  records = @collection.list(@caller, filter, projection)
 
  {

packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/native_query.rb

@@ -0,0 +1,117 @@
+require 'jsonapi-serializers'
+require 'active_support/inflector'
+
+module ForestAdminAgent
+ module Routes
+ module Resources
+ class NativeQuery < AbstractAuthenticatedRoute
+ include ForestAdminAgent::Builder
+ include ForestAdminAgent::Utils
+ include ForestAdminDatasourceToolkit::Exceptions
+ include ForestAdminDatasourceToolkit::Components::Charts
+ include ForestAdminAgent::Routes::QueryHandler
+
+ def setup_routes
+ add_route(
+ 'forest_native_query',
+ 'post',
+ '/_internal/native_query',
+ lambda { |args|
+ handle_request(args)
+ }
+ )
+
+ self
+ end
+
+ def handle_request(args = {})
+ build(args)
+ query = args[:params][:query].strip
+
+ QueryValidator.valid?(query)
+ unless args[:params][:connectionName]
+ raise ForestAdminAgent::Http::Exceptions::UnprocessableError, 'Missing native query connection attribute'
+ end
+
+ @permissions.can_chart?(args[:params])
+
+ query.gsub!('?', args[:params][:record_id].to_s) if args[:params][:record_id]
+ self.type = args[:params][:type]
+ result = execute_query(
+ query,
+ args[:params][:connectionName],
+ @permissions,
+ @caller,
+ args[:params][:contextVariables]
+ )
+
+ { content: Serializer::ForestChartSerializer.serialize(send(:"make_#{@type}", result)) }
+ end
+
+ private
+
+ def type=(type)
+ chart_types = %w[Value Objective Pie Line Leaderboard]
+ unless chart_types.include?(type)
+ raise ForestAdminDatasourceToolkit::Exceptions::ForestException, "Invalid Chart type #{type}"
+ end
+
+ @type = type.downcase
+ end
+
+ def raise_error(result, key_names)
+ raise ForestException,
+ "The result columns must be named #{key_names} instead of '#{result.keys.join("', '")}'"
+ end
+
+ def make_value(result)
+ return unless result.count
+
+ result = result.first
+
+ raise_error(result, "'value'") unless result.key?(:value)
+
+ ValueChart.new(result[:value] || 0, result[:previous] || nil).serialize
+ end
+
+ def make_objective(result)
+ return unless result.count
+
+ result = result.first
+
+ raise_error(result, "'value', 'objective'") unless result.key?(:value) || result.key?(:objective)
+
+ ObjectiveChart.new(result[:value] || 0, result[:objective]).serialize
+ end
+
+ def make_pie(result)
+ return unless result.count
+
+ raise_error(result[0], "'key', 'value'") if !result[0]&.key?(:value) || !result[0]&.key?(:key)
+
+ PieChart.new(result).serialize
+ end
+
+ def make_leaderboard(result)
+ return unless result.count
+
+ raise_error(result[0], "'key', 'value'") if !result[0]&.key?(:value) || !result[0]&.key?(:key)
+
+ LeaderboardChart.new(result).serialize
+ end
+
+ def make_line(result)
+ return unless result.count
+
+ result = result.map! do |result_line|
+ raise_error(result_line, "'key', 'value'") if !result_line.key?(:value) || !result_line.key?(:key)
+
+ { label: result_line[:key], values: { value: result_line[:value] } }
+ end
+
+ LineChart.new(result).serialize
+ end
+ end
+ end
+ end
+end

packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/update.rb

@@ -21,8 +21,7 @@ def handle_request(args = {})
  id = Utils::Id.unpack_id(@collection, args[:params]['id'], with_key: true)
  condition_tree = ConditionTree::ConditionTreeFactory.match_records(@collection, [id])
  filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
- condition_tree: ConditionTree::ConditionTreeFactory.intersect([condition_tree, scope]),
- page: ForestAdminAgent::Utils::QueryStringParser.parse_pagination(args)
+ condition_tree: ConditionTree::ConditionTreeFactory.intersect([condition_tree, scope])
  )
  data = format_attributes(args)
  @collection.update(@caller, filter, data)

packages/forest_admin_agent/lib/forest_admin_agent/routes/security/scope_invalidation.rb

@@ -18,7 +18,7 @@ def setup_routes
  def handle_request(args)
  # Check if user is logged
  Utils::QueryStringParser.parse_caller(args)
- Permissions.invalidate_cache('forest.scopes')
+ Permissions.invalidate_cache('forest.rendering')
 
  { content: nil, status: 204 }
  end