JSONAPISerializer: Allow for extraneous "links" fields in server response (ignore linked resource if not in schema)

[leejt489]

Right now, the JSONAPISerializer looks at each field in the "links" field and tries to assign the link to the record based on the schema https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L236

The problem is that the server may be returning additional links that we don't have implemented in our orbit schema on the client (the client may only be implementing part of the server schema and ignoring fields that are not relevant to the particular client application). So it is possible that linkSchema = schema.models[model].links[link]; evaluates to null, which will cause the next line to throw an error.

I propose either adding the line if (!linkSchema) return; after https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L236,

or changing https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L238 to be if (linkSchema && linkSchema.type === 'hasMany' && isArray(linkValue)) {
and https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L247 to be } else if (linkSchema && linkSchema.type === 'hasOne' && (typeof linkValue === 'string' || typeof linkValue === 'number')) {
depending on whether we want https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L252 to be hit in the event that there is no schema for the linked resource.

[dgeb]

Good catch @leejt489

I propose either adding the line if (!linkSchema) return; after https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L236

I think this is the right approach since Orbit should probably ignore links that are not defined in the schema.

A PR would be much appreciated :)

[leejt489]

Sure thing, though bear with me as I'm relatively new to contributing!

On Oct 21, 2014, at 10:46 AM, Dan Gebhardt [email protected] wrote:

Good catch @leejt489

I propose either adding the line if (!linkSchema) return; after https://github.com/orbitjs/orbit.js/blob/master/lib/orbit-common/jsonapi-serializer.js#L236

I think this is the right approach since Orbit should probably ignore links that are not defined in the schema.

A PR would be much appreciated :)

—
Reply to this email directly or view it on GitHub.

[dgeb]

Closed via #66