feat: add charts support

.releaserc.js

@@ -46,42 +46,41 @@ module.exports = {
  },
  ],
  '@semantic-release/github',
- // 'semantic-release-rubygem',
- // [
- // 'semantic-release-slack-bot',
- // {
- // markdownReleaseNotes: true,
- // notifyOnSuccess: true,
- // notifyOnFail: false,
- // onSuccessTemplate: {
- // text: "📦 $package_name@$npm_package_version has been released!",
- // blocks: [{
- // type: 'section',
- // text: {
- // type: 'mrkdwn',
- // text: '*New `$package_name` package released!*'
- // }
- // }, {
- // type: 'context',
- // elements: [{
- // type: 'mrkdwn',
- // text: "📦 *Version:* <$repo_url/releases/tag/v$npm_package_version|$npm_package_version>"
- // }]
- // }, {
- // type: 'divider',
- // }],
- // attachments: [{
- // blocks: [{
- // type: 'section',
- // text: {
- // type: 'mrkdwn',
- // text: '*Changes* of version $release_notes',
- // },
- // }],
- // }],
- // },
- // packageName: 'agent_ruby',
- // }
- // ],
+ [
+ 'semantic-release-slack-bot',
+ {
+ markdownReleaseNotes: true,
+ notifyOnSuccess: true,
+ notifyOnFail: false,
+ onSuccessTemplate: {
+ text: "📦 $package_name@$npm_package_version has been released!",
+ blocks: [{
+ type: 'section',
+ text: {
+ type: 'mrkdwn',
+ text: '*New `$package_name` package released!*'
+ }
+ }, {
+ type: 'context',
+ elements: [{
+ type: 'mrkdwn',
+ text: "📦 *Version:* <$repo_url/releases/tag/v$npm_package_version|$npm_package_version>"
+ }]
+ }, {
+ type: 'divider',
+ }],
+ attachments: [{
+ blocks: [{
+ type: 'section',
+ text: {
+ type: 'mrkdwn',
+ text: '*Changes* of version $release_notes',
+ },
+ }],
+ }],
+ },
+ packageName: 'agent_ruby',
+ }
+ ],
  ],
 }

.rubocop.yml

@@ -187,12 +187,12 @@ Metrics/MethodLength:
  Max: 20
  Exclude:
  - 'packages/forest_admin_agent/lib/forest_admin_agent/auth/oauth2/forest_provider.rb'
+ - 'packages/forest_admin_agent/lib/forest_admin_agent/routes/charts/charts.rb'
+ - 'packages/forest_admin_agent/lib/forest_admin_agent/serializer/json_api_serializer.rb'
  - 'packages/forest_admin_datasource_active_record/lib/forest_admin_datasource_active_record/parser/validation.rb'
  - 'packages/forest_admin_datasource_active_record/lib/forest_admin_datasource_active_record/collection.rb'
  - 'packages/forest_admin_datasource_active_record/spec/dummy/**/*'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/collection.rb'
- - 'packages/forest_admin_agent/lib/forest_admin_agent/auth/oauth2/forest_provider.rb'
- - 'packages/forest_admin_agent/lib/forest_admin_agent/serializer/json_api_serializer.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/condition_tree/condition_tree_factory.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/filter_factory.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/condition_tree/nodes/condition_tree_leaf.rb'
@@ -207,7 +207,9 @@ Metrics/ClassLength:
  Exclude:
  - 'packages/forest_admin_agent/lib/forest_admin_agent/utils/schema/generator_field.rb'
  - 'packages/forest_admin_agent/lib/forest_admin_agent/services/permissions.rb'
+ - 'packages/forest_admin_agent/lib/forest_admin_agent/routes/charts/charts.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/utils/collection.rb'
+ - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/aggregation.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/filter_factory.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/condition_tree/nodes/condition_tree_leaf.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/condition_tree/transforms/comparisons.rb'
@@ -232,8 +234,9 @@ Layout/LineLength:
  - 'packages/forest_admin_agent/spec/lib/forest_admin_agent/http/forest_admin_api_requester_spec.rb'
  - 'packages/forest_admin_agent/lib/forest_admin_agent/routes/resources/list.rb'
  - 'packages/forest_admin_agent/lib/forest_admin_agent/services/permissions.rb'
- - 'packages/forest_admin_agent/spec/lib/forest_admin_agent/utils/context_variables_injector_spec.rb'
+ - 'packages/forest_admin_agent/spec/lib/forest_admin_agent/routes/resources/charts/charts_spec.rb'
  - 'packages/forest_admin_agent/spec/lib/forest_admin_agent/services/smart_action_checker_spec.rb'
+ - 'packages/forest_admin_agent/spec/lib/forest_admin_agent/utils/context_variables_injector_spec.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/condition_tree/condition_tree_factory.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/utils/collection.rb'
  - 'packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/query/filter_factory.rb'

package.json

@@ -19,7 +19,6 @@
  "@semantic-release/exec": "6.0.3",
  "@semantic-release/git": "10.0.1",
  "semantic-release": "21.1.1",
- "semantic-release-rubygem": "^1.2.0",
  "semantic-release-slack-bot": "4.0.2"
  }
 }

packages/forest_admin_agent/forest_admin_agent.gemspec

@@ -34,6 +34,7 @@ admin work on any Ruby application."
  spec.require_paths = ["lib"]
 
  spec.add_dependency "activesupport", ">= 6.1"
+ spec.add_dependency "deepsort", "~> 0.4.5"
  spec.add_dependency "dry-container", "~> 0.11"
  spec.add_dependency "faraday", "~> 2.7"
  spec.add_dependency "filecache", "~> 1.0"

packages/forest_admin_agent/lib/forest_admin_agent/builder/agent_factory.rb

@@ -63,9 +63,7 @@ def build_cache
  return unless @has_env_secret
 
  cache = @container.resolve(:cache)
- cache.get_or_set 'config' do
- @options.to_h
- end
+ cache.set('config', @options.to_h)
  end
 
  def build_logger

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

@@ -9,6 +9,7 @@ def self.routes
  # api_charts_routes,
  System::HealthCheck.new.routes,
  Security::Authentication.new.routes,
+ Charts::Charts.new.routes,
  Resources::Count.new.routes,
  Resources::Delete.new.routes,
  Resources::List.new.routes,

packages/forest_admin_agent/lib/forest_admin_agent/routes/charts/charts.rb

@@ -0,0 +1,214 @@
+require 'jsonapi-serializers'
+require 'active_support/inflector'
+
+module ForestAdminAgent
+ module Routes
+ module Charts
+ class Charts < AbstractAuthenticatedRoute
+ include ForestAdminAgent::Builder
+ include ForestAdminAgent::Utils
+ include ForestAdminDatasourceToolkit::Components::Query
+ include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+ include ForestAdminDatasourceToolkit::Components::Charts
+
+ attr_reader :filter
+
+ FORMAT = {
+ Day: '%d/%m/%Y',
+ Week: 'W%W-%Y',
+ Month: '%b %y',
+ Year: '%Y'
+ }.freeze
+
+ def setup_routes
+ add_route('forest_chart', 'post', '/stats/:collection_name', lambda { |args|
+ handle_request(args)
+ })
+ self
+ end
+
+ def handle_request(args = {})
+ build(args)
+ @permissions.can_chart?(args[:params])
+ @args = args
+ self.type = args[:params][:type]
+ @filter = Filter.new(
+ condition_tree: ConditionTreeFactory.intersect(
+ [
+ @permissions.get_scope(@collection),
+ ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(
+ @collection, args
+ )
+ ]
+ )
+ )
+
+ inject_context_variables
+
+ { content: Serializer::ForestChartSerializer.serialize(send(:"make_#{@type}")) }
+ 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 inject_context_variables
+ user = @permissions.get_user_data(@caller.id)
+ team = @permissions.get_team(@caller.rendering_id)
+
+ context_variables = ForestAdminAgent::Utils::ContextVariables.new(team, user,
+ @args[:params][:contextVariables])
+ return unless @args[:params][:filter]
+
+ @filter = @filter.override(condition_tree: ContextVariablesInjector.inject_context_in_filter(
+ @filter.condition_tree, context_variables
+ ))
+ end
+
+ def make_value
+ value = compute_value(@filter)
+ previous_value = nil
+ is_and_aggregator = @filter.condition_tree&.try(:aggregator) == 'And'
+ with_count_previous = @filter.condition_tree&.some_leaf(&:use_interval_operator)
+
+ if with_count_previous && !is_and_aggregator
+ previous_value = compute_value(FilterFactory.get_previous_period_filter(@filter, @caller.timezone))
+ end
+
+ ValueChart.new(value, previous_value)
+ end
+
+ def make_objective
+ ObjectiveChart.new(compute_value(@filter))
+ end
+
+ def make_pie
+ group_field = @args[:params][:groupByFieldName]
+ aggregation = Aggregation.new(
+ operation: @args[:params][:aggregator],
+ field: @args[:params][:aggregateFieldName],
+ groups: group_field ? [{ field: group_field }] : []
+ )
+
+ result = @collection.aggregate(@caller, @filter, aggregation)
+
+ PieChart.new(result.map { |row| { key: row[:group][group_field], value: row[:value] } })
+ end
+
+ def make_line
+ group_by_field_name = @args[:params][:groupByFieldName]
+ time_range = @args[:params][:timeRange]
+ filter_only_with_values = @filter.override(
+ condition_tree: ConditionTree::ConditionTreeFactory.intersect(
+ [
+ @filter.condition_tree,
+ ConditionTree::Nodes::ConditionTreeLeaf.new(group_by_field_name, ConditionTree::Operators::PRESENT)
+ ]
+ )
+ )
+ rows = @collection.aggregate(
+ @caller,
+ filter_only_with_values,
+ Aggregation.new(
+ operation: @args[:params][:aggregator],
+ field: @args[:params][:aggregateField],
+ groups: [{ field: group_by_field_name, operation: time_range }]
+ )
+ )
+
+ values = {}
+ rows.each { |row| values[row[:group][group_by_field_name]] = row[:value] }
+ dates = values.keys.sort
+ current = dates[0]
+ last = dates.last
+ result = []
+ while current <= last
+ result << {
+ label: current.strftime(FORMAT[time_range.to_sym]),
+ values: { value: values[current] || 0 }
+ }
+ current += 1.send(time_range.downcase.pluralize.to_sym)
+ end
+
+ LineChart.new(result)
+ end
+
+ def make_leaderboard
+ field = @collection.fields[@args[:params][:relationshipFieldName]]
+
+ if field && field.type == 'OneToMany'
+ inverse = ForestAdminDatasourceToolkit::Utils::Collection.get_inverse_relation(
+ @collection,
+ @args[:params][:relationshipFieldName]
+ )
+ if inverse
+ collection = field.foreign_collection
+ filter = @filter.nest(inverse)
+ aggregation = Aggregation.new(
+ operation: @args[:params][:aggregator],
+ field: @args[:params][:aggregateFieldName],
+ groups: [{ field: "#{inverse}:#{@args[:params][:labelFieldName]}" }]
+ )
+ end
+ end
+
+ if field && field.type == 'ManyToMany'
+ origin = ForestAdminDatasourceToolkit::Utils::Collection.get_through_origin(
+ @collection,
+ @args[:params][:relationshipFieldName]
+ )
+ target = ForestAdminDatasourceToolkit::Utils::Collection.get_through_target(
+ @collection,
+ @args[:params][:relationshipFieldName]
+ )
+ if origin && target
+ collection = field.through_collection
+ filter = @filter.nest(origin)
+ aggregation = Aggregation.new(
+ operation: @args[:params][:aggregator],
+ field: @args[:params][:aggregateFieldName] ? "#{target}:#{@args[:params][:aggregateFieldName]}" : nil,
+ groups: [{ field: "#{origin}:#{@args[:params][:labelFieldName]}" }]
+ )
+ end
+ end
+
+ if collection && filter && aggregation
+ rows = @datasource.collection(collection).aggregate(
+ @caller,
+ filter,
+ aggregation,
+ @args[:params][:limit]
+ )
+
+ result = rows.map do |row|
+ {
+ key: row[:group][aggregation.groups[0][:field]],
+ value: row[:value]
+ }
+ end
+
+ return LeaderboardChart.new(result)
+ end
+
+ raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+ 'Failed to generate leaderboard chart: parameters do not match pre-requisites'
+ end
+
+ def compute_value(filter)
+ aggregation = Aggregation.new(operation: @args[:params][:aggregator],
+ field: @args[:params][:aggregateFieldName])
+ result = @collection.aggregate(@caller, filter, aggregation)
+
+ result[0][:value] || 0
+ end
+ end
+ end
+ end
+end

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

@@ -33,17 +33,17 @@ def handle_request(args = {})
  def link_one_to_one_relations(args, record)
  args[:params][:data][:relationships]&.map do |field, value|
  schema = @collection.fields[field]
- if schema.type == 'OneToOne'
- id = Utils::Id.unpack_id(@collection, value['data']['id'], with_key: true)
- foreign_collection = @datasource.collection(schema.foreign_collection)
- # Load the value that will be used as origin_key
- origin_value = record[schema.origin_key_target]
+ next unless schema.type == 'OneToOne'
 
- # update new relation (may update zero or one records).
- condition_tree = ConditionTree::ConditionTreeFactory.match_records(foreign_collection, [id])
- filter = Filter.new(condition_tree: condition_tree)
- foreign_collection.update(@caller, filter, { schema.origin_key => origin_value })
- end
+ id = Utils::Id.unpack_id(@collection, value['data']['id'], with_key: true)
+ foreign_collection = @datasource.collection(schema.foreign_collection)
+ # Load the value that will be used as origin_key
+ origin_value = record[schema.origin_key_target]
+
+ # update new relation (may update zero or one records).
+ condition_tree = ConditionTree::ConditionTreeFactory.match_records(foreign_collection, [id])
+ filter = Filter.new(condition_tree: condition_tree)
+ foreign_collection.update(@caller, filter, { schema.origin_key => origin_value })
  end
  end
  end