JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

NameError: uninitialized constant JSONAPI::ResourceController in Rails 7.1

Aperta
#1,464 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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 NOT asked my question on Gitter because Gitter seems to be abandoned by the core team. There a lots of questions posted there that have no responses at all.
  • 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

In trying to update to Rails 7.1 I'm running into random instances of this error when running my test suite.

Error:
Jsonapi::V1::TeamProjectsControllerTest#test_should_not_create_for_a_forbidden_team:
NameError: uninitialized constant JSONAPI::ResourceController
    app/controllers/jsonapi/v1/base_controller.rb:3:in `<main>'
    app/controllers/jsonapi/v1/team_projects_controller.rb:1:in `<main>'
    test/controllers/jsonapi/v1/team_projects_controller_test.rb:126:in `block in <class:TeamProjectsControllerTest>'

Sometimes there will be 2 of them, other times 20 or 30.

Via some trial and error I discovered that if I alter my BaseController to look like this:

class Jsonapi::V1::BaseController < ActionController::Base
  include JSONAPI::ActsAsResourceController
  # ...
end

Instead of this:

class Jsonapi::V1::BaseController < JSONAPI::ResourceController
  # ...
end

then the random errors go away.

I also noticed that these errors were only happening locally, and not in CI, and so I tried setting config.eager_load = true in config/environments/test.rb which also made the errors go away.

I poked around this gem a little bit and I think that this block of code isn't exactly working as expected in Rail 7.1.

https://github.com/cerebris/jsonapi-resources/blob/e92afc690f5c53da6f4fa5e91ca72a50873390be/lib/jsonapi-resources.rb#L12-L18

Ruby: 3.3.6
Rails: 7.1.5.1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalle righe 12-18 di lib/jsonapi-resources.rb e dal percorso di caricamento utilizzato da app/controllers/jsonapi/v1/base_controller.rb. Riproduci il malfunzionamento intermittente tramite test/controllers/jsonapi/v1/team_projects_controller_test.rb con Ruby 3.3.6 e Rails 7.1.5.1. Il lavoro è completato quando la suite di test non genera più l'errore di costante non inizializzata senza richiedere eager loading né il workaround indicato per il controller.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby
Ambito
api, backend
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.