Add unmarshalling of Links #4
Conversation
models_test.go
Outdated
| PostID int `jsonapi:"attr,post_id"` | ||
| Body string `jsonapi:"attr,body"` | ||
| Links *Links `jsonapi:"links,omitempty"` | ||
| Relation *SingleRelationLink `jsonapi:"relation,single-relation-link"` |
There was a problem hiding this comment.
This is used for tests. This is added because relations, as currently implemented, only work for the data field. But according the spec:
A “relationship object” MUST contain at least one of the following: links, data, meta
Right now, it only works for data, so this adds it for links. Note: I have not tested or checked to see if this works for meta, but my says it does not.
There was a problem hiding this comment.
Sounds silly, but it took me a bit to get my bearings: I'd consider renaming this to be consistent with the toy things you're testing here (Car, Post, Comment, etc) and not Relation and SingleRelationLink. Maybe something like adding LikedBy to Post with *UserRelationLink (a link to a collection of users who liked the post). But anything else, really, if you can think of what makes sense with Comment!
| linkModelValue := linkModel.Elem() | ||
| linkModelType := linkModelValue.Type() | ||
|
|
||
| for i := 0; i < linkModelValue.NumField(); i++ { |
There was a problem hiding this comment.
We are iterating through the model because this is the only way to find the attribute on the struct that has the jsonapi:"links" tag. So once we find it, we unmarshal it onto the model (the Resource struct).
| } | ||
| } | ||
| if assignedValue { | ||
| models = reflect.Append(models, linkModel) |
There was a problem hiding this comment.
We are appending here because we are operating when the current relationship is a list of relations.
| @@ -324,9 +366,23 @@ func unmarshalNode(data *Node, model reflect.Value, included *map[string]*Node) | |||
| } | |||
|
|
|||
| fieldValue.Set(m) | |||
| } | |||
|
|
|||
| } else if annotation == annotationLinks { | |||
There was a problem hiding this comment.
This is to handle when the a Resource struct has a jsonapi:"links" tag directly on it. In which case, we just unmarshal it directly.
| "body": "First", | ||
| "title": "Post", | ||
| }, | ||
| "links": map[string]string{ |
There was a problem hiding this comment.
Tests when links are at the same level as the other jsonapi tags. Relates to this
request_test.go
Outdated
| "title": "Post", | ||
| }, | ||
| "relationships": map[string]interface{}{ | ||
| "single-relation-link": map[string]interface{}{ |
There was a problem hiding this comment.
Tests when a relation only has links and does not have data or meta. Relates to this
| // of `jsonapi:"links"` is done below via the | ||
| // Linkable interface. | ||
| // And the logic for Marshalling links should be done | ||
| // via that interface. |
There was a problem hiding this comment.
This function is called during MarshalPayload. The links functionality here is handled through the Linkable interface. We don't want to do anything here because if the resource struct implements the interface, then links will be handled there. Otherwise, we just want to handle the annotaiton or else it will blow up below.
models_test.go
Outdated
| PostID int `jsonapi:"attr,post_id"` | ||
| Body string `jsonapi:"attr,body"` | ||
| Links *Links `jsonapi:"links,omitempty"` | ||
| Relation *SingleRelationLink `jsonapi:"relation,single-relation-link"` |
There was a problem hiding this comment.
Sounds silly, but it took me a bit to get my bearings: I'd consider renaming this to be consistent with the toy things you're testing here (Car, Post, Comment, etc) and not Relation and SingleRelationLink. Maybe something like adding LikedBy to Post with *UserRelationLink (a link to a collection of users who liked the post). But anything else, really, if you can think of what makes sense with Comment!
Description
According to the JSON:API Spec, an object may contain a
selflink:We did not have the ability to unmarshal an object that had the
linksannotation to it. This PR adds the ability to unmarshal it.Tests