Syntaxe pour les paramètres de Data Explorer dans Automation

ganncamp · Mars 5, 2025, 7:08

J’ai une requête Data Explorer qui accepte un paramètre ‘group_name’

Je voudrais automatiser son exécution pour chaque groupe pertinent et envoyer les résultats au groupe une fois par semaine.

Mais, malgré tous mes efforts, je n’arrive pas à trouver la syntaxe à utiliser pour le paramètre. Voici ce qui m’est présenté pour cela dans une automatisation toute neuve :

Je trouve cela… peu utile.

J’ai essayé plusieurs variantes ici. Lorsque je n’obtiens pas d’erreur de mes tentatives (trouvées dans les journaux d’erreurs), je ne reçois apparemment rien du tout.

Si j’utilise une requête sans paramètres, elle s’exécute comme sur des roulettes. Comment faire pour qu’elle fonctionne pour les requêtes qui ont besoin de paramètres ?

Arkshine · Mars 5, 2025, 10:46

Je peux reproduire le problème également.

Dans votre exemple, disons que vous voulez vérifier les groupes de modérateurs et d’administrateurs, vous êtes censé avoir :

clé : group_name
valeur : moderators,admins

Trucs techniques pour aider, ne faites pas attention à moi.
J’ai essayé de comprendre en regardant le code, et je pense qu’il y a un problème ici :

github.com/discourse/discourse-data-explorer

lib/discourse_data_explorer/report_generator.rb

main


      
          
            result = DataExplorer.run_query(query, params)
            query.update!(last_run_at: Time.now)
          
            return [] if opts[:skip_empty] && result[:pg_result].values.empty?
            table =
              ResultToMarkdown.convert(result[:pg_result], render_url_columns: opts[:render_url_columns])
          
            build_report_pms(query, table, recipients, attach_csv: opts[:attach_csv], result:)
          end
          
          def self.generate_post(query_id, query_params, opts = {})
            query = DiscourseDataExplorer::Query.find(query_id)
            return {} if !query
          
            params = params_to_hash(query_params)
          
            result = DataExplorer.run_query(query, params)
            query.update!(last_run_at: Time.now)
          
            return {} if opts[:skip_empty] && result[:pg_result].values.empty?

github.com/discourse/discourse-data-explorer

lib/discourse_data_explorer/report_generator.rb

main


      
            build_report_post(query, table, attach_csv: opts[:attach_csv], result:)
          end
          
          def self.params_to_hash(query_params)
            params = JSON.parse(query_params)
          
            params.map { |p| p.is_a?(Hash) ? [p["key"], p["value"]] : p }.to_h
          end
          
          def self.build_report_pms(query, table = "", targets = [], attach_csv: false, result: nil)
            pms = []
            upload = create_csv_upload(query, result) if attach_csv
          
            targets.each do |target|
              name = target[0]
              pm_type = "target_#{target[1]}s"
          
              pm = {}
              pm["title"] = I18n.t(

Les paramètres sont transformés avant que run_query ne soit appelé.
Disons que vous avez cette valeur d’origine :
[{\"key\":\"group_names\",\"value\":\"admins,moderators\"}]
La valeur transformée sera :
{{\"key\"=>\"group_names\", \"value\"=>\"admins,moderators\"}=>nil}

github.com/discourse/discourse-data-explorer

lib/discourse_data_explorer/data_explorer.rb

main


      
          def self.run_query(query, req_params = {}, opts = {})
            # Safety checks
            # see test 'doesn't allow you to modify the database #2'
            if query.sql =~ /;/
              err = ValidationError.new(I18n.t("js.errors.explorer.no_semicolons"))
              return { error: err, duration_nanos: 0 }
            end
          
            query_args = {}
            begin
              query_args = query.cast_params req_params
            rescue ValidationError => e
              return { error: e, duration_nanos: 0 }
            end
          
            time_start, time_end, explain, err, result = nil
            begin
              ActiveRecord::Base.connection.transaction do
                # Setting transaction to read only prevents shoot-in-foot actions like SELECT FOR UPDATE
                # see test 'doesn't allow you to modify the database #1'
                DB.exec "SET TRANSACTION READ ONLY"

github.com/discourse/discourse-data-explorer

app/models/discourse_data_explorer/query.rb

main


      
          def cast_params(input_params)
            result = {}.with_indifferent_access
            self.params.each do |pobj|
              result[pobj.identifier] = pobj.cast_to_ruby input_params[pobj.identifier]
            end
            result
          end

Cependant, cast_params semble s’attendre à {\"group_names\"=>\"admins,moderators\"}

J’ai essayé de tester ce changement naïf, et les paramètres ont fonctionné.

def self.params_to_hash(query_params)
  params = JSON.parse(query_params)
  params_hash = {}

  params.each do |param|
    key = param["key"]
    value = param["value"]
    params_hash[key] = value
  end

  params_hash
end

sam · Mars 6, 2025, 10:03

merci pour le débogage ici nous allons examiner cela la semaine prochaine.

ted · Mars 13, 2025, 7:47

C’est une excellente exploration de grotte, @Arkshine !

Je suis en train de regarder ça. Quand j’ai lu le code original, j’ai eu l’impression qu’il attendait les paramètres comme un tableau de tableaux, donc je suis un peu réticent à jeter tout de suite le contenu existant. J’essaierai de comprendre quand cela pourrait se produire.

Je posterai ici quand j’aurai trouvé quelque chose.

ted · Mars 13, 2025, 10:01

Il y avait bien un bug ici, et en partie grâce à l’enquête de @Arkshine, il a été relativement facile à corriger :

github.com/discourse/discourse-data-explorer

FIX: Discourse automation reports with parameters

main ← fix/report-generator-parameters

opened 09:29AM - 13 Mar 25 UTC

Drenmi

+21 -17

### What is the problem? When setting up an automation to create a DM or a po…st with a report on a recurring basis, and using a Data Explorer query that has parameters, we encounter an error. ### Why is this happening? The `.params_to_hash` currently expects an array of arrays for the parameters, e.g.: ```ruby [["group_name", "admins"]] ``` but in reality they seem to be arrays of hashes: ```ruby [{ "key" => "group_name", "value" => "admins" }] ``` ### How come we only found out now? We do have tests for the report generator, and we do pass query parameters to it, but 1) we hard-code the parameters as an array of arrays and 2) the parameters aren't in the query used as a fixture. ### How does this fix it? This change makes `ReportGenerator.params_to_hash` work with arrays of hashes. It also preserves the ability to work with nested arrays in case this is used somewhere else.

Cela a déjà été fusionné, donc une fois que votre site aura été déployé, vous devriez être débloqué @ganncamp.

Si je comprends bien, vous souhaitez une automatisation qui soit une correspondance un à un entre un groupe et son rapport ? (C’est-à-dire que group_a reçoit un rapport avec les données de group_a, etc.)

Il n’y a (actuellement) aucun lien entre la liste des destinataires et les paramètres du rapport, donc pour y parvenir, vous devrez configurer une automatisation par groupe. Dans ce cas, vous pourriez vouloir changer le paramètre en group_id.

ganncamp · Mars 13, 2025, 11:51

Excellente nouvelle @ted !

Oui, pouvoir faire un foreach sur un ensemble de groupes allait être ma prochaine demande

ted · Mars 14, 2025, 2:19

Cela semble en effet être une chose pratique à avoir, surtout pour les sites avec beaucoup, beaucoup de groupes. Je vais noter la demande, mais je ne peux pas dire quand nous y parviendrons.

j.jaffeux · Mars 17, 2025, 10:09

Ce sujet a été automatiquement fermé 3 jours après la dernière réponse. Les nouvelles réponses ne sont plus autorisées.

Sujet		Réponses	Vues
`DataExplorer::ValidationError: Missing parameter` when running Data Explorer queries with [params] via API Data & reporting rest-api , sql-query	9	1108	Mai 10, 2022
How to add query parameters to Data Explorer? Dev	7	1029	Novembre 25, 2020
Populate Data Explorer params with URL params Feature data-explorer , completed	13	1483	Septembre 3, 2025
Param dropdown for group_id in data explorer query Feature data-explorer , completed	17	1112	Juin 5, 2025
Data explorer group report - parameter bug Bug data-explorer	8	747	Décembre 28, 2022

Syntaxe pour les paramètres de Data Explorer dans Automation

Sujets connexes