JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Linked data with polymorphism does not work with custom `key_type`
Nessuno ha ancora preso questa issue.
- Lingua principale
- Ruby
- Stelle
- 2.3k
- Fork
- 546
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
This issue is a (choose one):
- Problem/bug report.
- Feature request.
- Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.
Checklist before submitting:
- I've searched for an existing issue.
- I've asked my question on Gitter and have not received a satisfactory answer.
- I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
- The feature I'm asking for is compliant with the JSON:API spec.
Description
If you create a polymorphic association with custom key_type id is always taken which leads to a wrong data sharing.
Bug reports:
Everything is on lib/jsonapi/resource_serializer.rb:464
When calling source.public_send("#{relationship.name}_id"), it is fine (faster) but it does not take care about custom key_type.
But if you call source.public_send(relationship.name).try(:id), you're using the custom key_type.
Features:
We can set another argument to has_one to be able to mention that the key_type has been modified.
Here is my proposition:
# app/resources/my_awesome_resource
has_one :positionable, polymorphic: true, foreign_key: :positionable_id, foreign_key_type_changed: true
# jsonapi/resource_serializer.rb
def foreign_key_value(source, relationship)
# If you have changed the key_name, don't even try to look at `"#{relationship.name}_id"`
# just load the association and call the custom key_name
foreign_key_type_changed = relationship.options[:foreign_key_type_changed] || false
related_resource_id =
if source.preloaded_fragments.has_key?(format_key(relationship.name))
source.preloaded_fragments[format_key(relationship.name)].values.first.try(:id)
elsif !foreign_key_type_changed && source.respond_to?("#{relationship.name}_id")
# If you have direct access to the underlying id, you don't have to load the relationship
# which can save quite a lot of time when loading a lot of data.
# This does not apply to e.g. has_one :through relationships.
source.public_send("#{relationship.name}_id")
else
source.public_send(relationship.name).try(:id)
end
return nil unless related_resource_id
@id_formatter.format(related_resource_id)
end
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da lib/jsonapi/resource_serializer.rb:464 e ispeziona foreign_key_value, concentrandoti su come le relazioni polimorfiche ottengono i propri ID quando è configurato un key_type personalizzato. Riproduci il caso segnalato e aggiungi una copertura che mostri che l'ID della relazione serializzata rispetta il key_type personalizzato invece di usare sempre l'ID diretto dell'associazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rails, ruby
- Ambito
- api, backend
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 52/100