Sintassi dei parametri di Data Explorer in Automazione

ganncamp · 5 Marzo 2025, 7:08pm

Ho una query di Esplora dati che accetta un parametro ‘group_name’

Vorrei automatizzare l’esecuzione per ogni gruppo pertinente e inviare al gruppo i risultati una volta alla settimana.

Ma per quanto mi sforzi, non riesco a capire la sintassi da usare per il parametro. Ecco cosa mi viene presentato per questo in un’automazione nuovissima:

Trovo questo… inutile.

Ho provato diverse varianti qui. Quando non ricevo un errore dai miei tentativi (trovati nei log degli errori), sembra che non ottenga nulla.

Se uso una query senza parametri, viene eseguita come un fulmine. Come posso farla funzionare per le query che necessitano di parametri?

Arkshine · 5 Marzo 2025, 10:46pm

Posso riprodurre il problema anche io.

Nel tuo esempio, supponiamo che tu voglia controllare i gruppi di moderatori e amministratori, dovresti avere:

key: group_name
value: moderators,admins

Roba tecnica per aiutare, non badare a me.
Ho provato a capire guardando il codice e penso ci sia un problema qui:

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(

I parametri vengono trasformati prima che venga chiamata run_query.
Supponiamo che tu abbia questo valore originale:
[{"key":"group_names","value":"admins,moderators"}]
Il valore trasformato sarà:
[{"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

Tuttavia, cast_params sembra aspettarsi {"group_names"=>"admins,moderators"}

Ho provato a testare questa modifica ingenua e i parametri hanno funzionato.

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

wow grazie per il debug qui ci daremo un’occhiata la prossima settimana.

ted · 13 Marzo 2025, 7:47am

Che fantastica esplorazione, @Arkshine!

Ci sto lavorando ora. Quando ho letto il codice originale ho avuto l’impressione che si aspettasse che i parametri fossero un array di array, quindi sono un po’ titubante a buttare via tutto quello che c’è. Cercherò di capire quando potrebbe succedere.

Pubblicherò qui quando avrò trovato qualcosa.

ted · 13 Marzo 2025, 10:01am

C’è stato effettivamente un bug qui, e in parte grazie all’indagine di @Arkshine, è stato relativamente facile da correggere:

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.

Questo è già stato unito, quindi una volta che il tuo sito sarà stato distribuito, dovresti essere sbloccato @ganncamp.

Se ho capito bene, desideri un’automazione che sia una mappatura uno-a-uno tra un gruppo e il suo report? (Cioè, group_a riceve un report con dati di group_a, ecc.)

Non c’è (attualmente) alcuna connessione tra l’elenco dei destinatari e i parametri del report, quindi per realizzarlo dovresti impostare un’automazione per gruppo. In questo caso, potresti voler cambiare il parametro in group_id.

ganncamp · 13 Marzo 2025, 11:51am

Ottime notizie @ted!

Sì, la possibilità di eseguire un foreach su un set di gruppi sarebbe la mia prossima richiesta

ted · 14 Marzo 2025, 2:19am

Questa sembra effettivamente una cosa comoda da avere, specialmente per siti con tantissimi gruppi. Prenderò nota della richiesta, ma non posso dire quando ci lavoreremo.

j.jaffeux · 17 Marzo 2025, 10:09am

Questo argomento è stato automaticamente chiuso 3 giorni dopo l’ultima risposta. Non sono più consentite nuove risposte.

Argomento		Risposte	Visualizzazioni
`DataExplorer::ValidationError: Missing parameter` when running Data Explorer queries with [params] via API Data & reporting rest-api , sql-query	9	1109	Maggio 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	1484	Settembre 3, 2025
Param dropdown for group_id in data explorer query Feature data-explorer , completed	17	1112	Giugno 5, 2025
Data explorer group report - parameter bug Bug data-explorer	8	747	Dicembre 28, 2022

Sintassi dei parametri di Data Explorer in Automazione

Argomenti correlati