JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Cross namespace relationships
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Description
The problem:
Right now namespaces are assumed to be used for versioning, though they could also be used for separating entire sets of resources in isolated namespaces. JR does not currently support resource relationships which cross namespaces. #893 attempts to solve this, but as I brought up in the comments there is the potential for the system to encounter a situation where the correct behavior is ambiguous or will be inconsistent depending on the order of serialization.
Proposal:
A simple set of resource resolution rules could be used to solve this issue without the need to specifically mark up relationships definitions on a resource.
Rules:
- All resource resolution will take place relative to the namespace of the request ("Request Namespace").
- Related resources will be assumed to be in the Request Namespace.
- Resource definitions will support a new method called
global_resourcewhich will register a resource type in a "Global Resource Map" to this resource class. - Declaring two resources classes with the same type as
global_resourcewill raise an exception or emit a warning, which should catch conflicts during development. - If a resource class does not exist in the Request Namespace the Global Resource Map will be consulted for the resource class.
- Resources created from the Global Resource Map will still follow same resolution rules starting with the Request Namespace. In other words relationships in a global resource will first resolve based on the Request Namespace.
I believe these rules should allow unambiguous resolution of resources and prevent runtime issues where a resource is serialized with differing sets of rules (resource definitions), and meet the intent of #893.
Let's discuss this and other proposals here. I haven't tried to code this, but I think it's possible to modify the code to support these rules without a lot of refactoring. If you see potential road blocks in either this project or your projects please raise them here.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. First, review the existing namespace and relationship-resolution behavior and the discussion around #893, then clarify the resolution rules and define tests that demonstrate unambiguous cross-namespace behavior before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100