La modifica del serializzatore di categoria si comporta diversamente in 2.4.0

Sviluppatore
1

Dopo l’aggiornamento a Release v2.4.0.beta2 · discourse/discourse · GitHub, quasi tutti i nostri plugin (ad esempio anteprime dell’elenco degli argomenti, eventi, posizioni, valutazioni, ecc.) stanno riscontrando un problema con il metodo add_to_serializer di plugin.rb.

L’utilizzo esistente seguiva questo formato:

add_to_serializer(:serializer, property) { value }

Questo non funziona più in un ambiente di produzione. Funziona ancora in un ambiente di sviluppo.

Inizialmente, pensavo che potesse essere correlato al modo in cui viene gestito l’abilitazione dei plugin. Poiché il metodo _include? di add_to_serializer utilizza lo stato enabled?

if define_include_method
   # Non includere i metodi serializzati se il plugin è disabilitato
  klass.public_send(:define_method, "include_#{attr}?") { plugin.enabled? }
end

Tuttavia, l’utilizzo del sistema enabled_site_setting non sembra risolvere il problema. Inoltre, enabled? sembra comunque predefinito su true

def enabled?
  @enabled_site_setting ? SiteSetting.get(@enabled_site_setting) : true
end

Per risolvere il problema immediato, abbiamo modificato il modo in cui i nostri plugin serializzano i dati, ma vorrei capire cosa sta succedendo se possibile. Qualcuno ha qualche idea su cosa stia accadendo?

cc @merefield, @fzngagan

2

Questo è altamente insolito, dato che lo utilizziamo nei sondaggi e questi non sono certamente rotti. L’unica cosa a cui posso pensare è che fossero rotti nella versione beta ma riparati nel master? Puoi provare su tests-passed e vedere se funzionano?

3

Lo testerò ulteriormente oggi. L’uso nei sondaggi è leggermente diverso, poiché il metodo _include? viene sempre preceduto da un terzo parametro false. Sospetto che il metodo include? possa essere il problema.

add_to_serializer(:post, :polls_votes, false)
4

Sembra che questo problema sia specifico delle modifiche ai serializzatori delle categorie.

https://staging.discourse.angusmcleod.com.au ha un solo plugin installato, “test-add-to-serializer”

Come puoi vedere nel file plugin.rb, vengono apportate diverse modifiche ai serializzatori.

Le modifiche ai serializzatori non relativi alle categorie sembrano funzionare, ma le modifiche al serializzatore basic_category funzionano solo in ambiente di sviluppo.

Non troverai le proprietà della categoria di test in

https://staging.discourse.angusmcleod.com.au/categories.json

o

https://staging.discourse.angusmcleod.com.au/c/records-musicians.json

Ma troverai le altre proprietà di test in

https://staging.discourse.angusmcleod.com.au/t/this-is-a-title-of-a-topic/42.json

o

https://staging.discourse.angusmcleod.com.au/latest.json

Quindi il problema sembra non riguardare il metodo add_to_serializer in sé, ma la modifica del serializzatore basic_category.

5

@j.jaffeux @dan Ciao :), sembra che abbiate fatto recentemente del lavoro su discourse-voting per risolvere lo stesso problema che ho illustrato sopra.

Sapete perché non è più sufficiente aggiungere proprietà al basic_category_serializer?

6

Posso confermare che questo sta interessando tests-passed

7

Dan non c’è, ma in sostanza ci sono tre diversi luoghi in cui serializziamo le categorie con quantità variabili di dati. Vedremo se esiste un modo per eliminare il mixin qui, il che rende tutto più difficile da analizzare.

8

Corretto e backportato su stable e beta.

Dan ha configurato correttamente la struttura di ereditarietà; si trattava semplicemente di un bug nel core presente da moltissimo tempo.

9

Grazie @sam, molto apprezzato.

10

Grazie per aver segnalato e sollecitato la questione: è stata davvero molto complessa da individuare. Ho dedicato del tempo a studiare gli interni di Rails per capire il problema.

Se sei curioso di sapere come ci assicuriamo che questo funzioni correttamente in futuro, dai un’occhiata al nuovo test.

11

Grazie mille, @sam, per averlo risolto così rapidamente.

@angus, il nostro plugin funzionerà senza le modifiche recenti che abbiamo apportato a causa di questa correzione?