JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Bad links with engine mounted as root
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Ruby
- Sterne
- 2.3k
- Forks
- 546
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
As described on lib/jsonapi/link_builder.rb#L139,
def resource_url(source)
"#{ base_url }#{ engine_mount_point }#{ resource_path(source) }"
end
But in this case:
constraints subdomain: 'api' do
mount MyEngine::Engine, at: '/' if defined?(MyEngine::Engine)
end
This creates a double / due to root value of engine_mount_point.
I guess a little update of:
@engine_mount_point = @engine ? @engine.routes.find_script_name({}) : ""
should be enough.
Current result:
{
"data": {
"id": "ed526d56-cc7e-41f4-8e99-fccf73fb7500",
"type": "users",
"links": {
"self": "//v1/users/ed526d56-cc7e-41f4-8e99-fccf73fb7500"
},
"attributes": {
"first_name": null,
"last_name": null,
"email": "some@thing.io"
}
}
}
//v1/users/ed526d56-cc7e-41f4-8e99-fccf73fb7500 should be /v1/users/ed526d56-cc7e-41f4-8e99-fccf73fb7500
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne in lib/jsonapi/link_builder.rb bei resource_url und untersuche anschließend, wie engine_mount_point für eine Engine berechnet wird, die bei '/' gemountet ist. Reproduziere den gemeldeten Root-Mount-Fall und überprüfe, dass der generierte self link einen führenden Schrägstrich statt '//v1/users/...' hat; das bestehende Link-Building-Verhalten sollte für Nicht-Root-Mounts weiterhin korrekt bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- rails, ruby
- Bereich
- api, backend
- Issue-Typ
- Bug
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100