Sintaxe para parâmetros do Data Explorer na Automação

ganncamp · Março 5, 2025, 7:08pm

Tenho uma consulta do Explorador de Dados que aceita um parâmetro ‘group_name’

Gostaria de automatizar a execução para cada grupo relevante e enviar ao grupo os resultados uma vez por semana.

Mas, por mais que eu tente, não consigo descobrir a sintaxe a ser usada para o parâmetro. Eis o que me é apresentado para isso em uma automação totalmente nova:

Acho isso… inútil.

Já tentei várias variações aqui. Quando não recebo um erro das minhas tentativas (encontrado nos logs de erro), parece que não recebo nada.

Se eu usar uma consulta sem parâmetros, ela roda como um raio. Como faço para que funcione para consultas que precisam de parâmetros?

Arkshine · Março 5, 2025, 10:46pm

Eu também consigo reproduzir o problema.

No seu exemplo, digamos que você queira verificar os grupos de moderadores e administradores, você deve ter:

chave: group_name
valor: moderators,admins

Coisas técnicas para ajudar, não se preocupe comigo.
Tentei entender olhando o código e acho que há um problema aqui:

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(

Os parâmetros são transformados antes que run_query seja chamado.
Digamos que você tenha este valor original:
[{\"key\":\"group_names\",\"value\":\"admins,moderators\"}]
O valor transformado será:
{{\"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

No entanto, cast_params parece esperar {\"group_names\"=>\"admins,moderators\"}

Tentei testar esta mudança ingênua e os parâmetros funcionaram.

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 · Março 6, 2025, 10:03pm

Uau, obrigado pela depuração aqui vamos dar uma olhada nisso na próxima semana.

ted · Março 13, 2025, 7:47am

Isso é uma exploração fantástica, @Arkshine!

Estou analisando isso agora. Quando li o código original, tive a impressão de que ele espera que os parâmetros sejam um array de arrays, então estou um pouco receoso de simplesmente descartar o material existente. Tentarei descobrir quando isso pode acontecer.

Postarei aqui quando encontrar algo.

ted · Março 13, 2025, 10:01am

Houve de fato um bug aqui, e em parte graças à investigação de @Arkshine, foi relativamente fácil corrigi-lo:

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.

Isso já foi mesclado, então assim que seu site for implantado, você não terá mais problemas, @ganncamp.

Se entendi corretamente, você deseja uma automação que seja um mapeamento um para um entre um grupo e seu relatório? (Ou seja, group_a recebe um relatório com dados de group_a, etc.)

Não há (atualmente) nenhuma conexão entre a lista de destinatários e os parâmetros do relatório, então para conseguir isso, você precisaria configurar uma automação por grupo. Neste caso, você pode querer alterar o parâmetro para group_id.

ganncamp · Março 13, 2025, 11:51am

Ótimas notícias, @ted!

Sim, a capacidade de fazer um foreach em um conjunto de grupos seria minha próxima solicitação

ted · Março 14, 2025, 2:19am

Isso realmente parece ser algo conveniente de se ter, especialmente para sites com muitos e muitos grupos. Vou anotar a solicitação, mas não posso dizer quando poderemos implementá-la.

j.jaffeux · Março 17, 2025, 10:09am

Este tópico foi fechado automaticamente 3 dias após a última resposta. Novas respostas não são mais permitidas.

Tópico		Respostas	Visualizações
`DataExplorer::ValidationError: Missing parameter` when running Data Explorer queries with [params] via API Data & reporting rest-api , sql-query	9	1108	10 de Maio de 2022
How to add query parameters to Data Explorer? Dev	7	1029	25 de Novembro de 2020
Populate Data Explorer params with URL params Feature data-explorer , completed	13	1483	3 de Setembro de 2025
Param dropdown for group_id in data explorer query Feature data-explorer , completed	17	1112	5 de Junho de 2025
Data explorer group report - parameter bug Bug data-explorer	8	747	28 de Dezembro de 2022

Sintaxe para parâmetros do Data Explorer na Automação

Tópicos relacionados