[DOC] Improve warning for mismatched id in store.findRecord #4609
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hjdivad
suggested changes
Oct 21, 2016
| @@ -1223,8 +1224,7 @@ Store = Service.extend({ | |||
|
|
|||
| The request is made through the adapters' `queryRecord`: | |||
|
|
|||
| ```javascript | |||
| // app/adapters/user.js | |||
| ```app/adapters/user.js | |||
There was a problem hiding this comment.
this change looks unintentional
There was a problem hiding this comment.
I believe it is intentional. The markdown parser for JavaScript blocks in the API guides has an enhancement to show the filename in the heading when the filename is included after the three backticks. It uses the file extension to detect what source highlighting should be used.
vs
There was a problem hiding this comment.
Yep yep yep, that was the intention.
| @@ -39,7 +39,7 @@ export function _find(adapter, store, typeClass, id, internalModel, options) { | |||
| var payload = normalizeResponseHelper(serializer, store, typeClass, adapterPayload, id, 'findRecord'); | |||
| assert('Ember Data expected the primary data returned from a `findRecord` response to be an object but instead it found an array.', !Array.isArray(payload.data)); | |||
|
|
|||
| warn(`You requested a record of type '${typeClass.modelName}' with id '${id}' but the adapter returned a payload with primary data having an id of '${payload.data.id}'. Looks like you want to use store.queryRecord instead http://emberjs.com/api/data/classes/DS.Store.html#method_queryRecord`, payload.data.id === id, { | |||
| warn(`You requested a record of type '${typeClass.modelName}' with id '${id}' but the adapter returned a payload with primary data having an id of '${payload.data.id}'. Use 'store.findRecord()' when the requested id is the same as the one returned by the adapter. In other cases use 'store.queryRecord()' instead http://emberjs.com/api/data/classes/DS.Store.html#method_queryRecord`, payload.data.id === id, { | |||
hjdivad
approved these changes
Oct 21, 2016
|
Build failure looks unrelated to the changes in this pr restarting. |
|
Thanks @pangratz. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempt to make it more clear what the action is when your adapter returns a different id than you requested via
store.findRecord().This addresses concerns raised in #4604
@bmac can you take a look and check if it is more clear now what the problem is and how it can be solved?