From a420fa1675e47b64574fb225a9f445f12c81a2fc Mon Sep 17 00:00:00 2001 From: Mehul Kiran Chaudhari <55375534+MehulKChaudhari@users.noreply.github.com> Date: Sun, 23 Feb 2025 01:14:00 +0530 Subject: [PATCH 1/2] fix: update docs to reflect correct record handling and command usage --- CONTRIBUTING.md | 2 +- snippets/updating-data/create-record/handler.js | 9 +++++---- snippets/updating-data/create-record/in-place-body.js | 3 +-- snippets/updating-data/create-record/new.js | 3 +-- snippets/updating-data/save-record/handler.js | 7 +++---- snippets/updating-data/save-record/new.js | 3 +-- .../components/guide-section/subsection-test.js | 2 +- translations/updating-data/create-record/en-us.yaml | 2 +- 8 files changed, 14 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 16d65af..4580220 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ This is an Ember app, so the usual steps follow: ``` 1. Run the app. ```bash - ember serve + npm run start ``` 1. Visit your app at [http://localhost:4200](http://localhost:4200). diff --git a/snippets/updating-data/create-record/handler.js b/snippets/updating-data/create-record/handler.js index 7e5e0f6..56baa52 100644 --- a/snippets/updating-data/create-record/handler.js +++ b/snippets/updating-data/create-record/handler.js @@ -18,10 +18,11 @@ const updatesHandler = { const { data, store } = context.request; const newRequestParams = Object.assign({}, context.request, { - body: serializeResources( - store.cache, - recordIdentifierFor(data.record) - ) + body: JSON.stringify( + serializeResources( + store.cache, + data.record + )) }); return next(newRequestParams); } diff --git a/snippets/updating-data/create-record/in-place-body.js b/snippets/updating-data/create-record/in-place-body.js index 2abd488..ab612f8 100644 --- a/snippets/updating-data/create-record/in-place-body.js +++ b/snippets/updating-data/create-record/in-place-body.js @@ -1,4 +1,3 @@ -import { recordIdentifierFor } from '@ember-data/store'; import { createRecord, serializeResources } from '@ember-data/json-api/request'; const record = store.createRecord('user', {}); @@ -7,7 +6,7 @@ const request = createRecord(record); request.body = JSON.stringify( serializeResources( store.cache, - recordIdentifierFor(record) + record ) ); diff --git a/snippets/updating-data/create-record/new.js b/snippets/updating-data/create-record/new.js index 951f335..589b3dd 100644 --- a/snippets/updating-data/create-record/new.js +++ b/snippets/updating-data/create-record/new.js @@ -1,4 +1,3 @@ -import { recordIdentifierFor } from '@ember-data/store'; import { createRecord, serializeResources } from '@ember-data/json-api/request'; const record = store.createRecord('user', {}); @@ -6,7 +5,7 @@ const request = createRecord(record); request.body = JSON.stringify( serializeResources( store.cache, - recordIdentifierFor(record) + record ) ); diff --git a/snippets/updating-data/save-record/handler.js b/snippets/updating-data/save-record/handler.js index 125b343..1a90e29 100644 --- a/snippets/updating-data/save-record/handler.js +++ b/snippets/updating-data/save-record/handler.js @@ -1,5 +1,4 @@ // Create handler for serialization of any record -import { recordIdentifierFor } from '@ember-data/store'; import { serializeResources } from '@ember-data/json-api/request'; const updatesHandler = { @@ -18,10 +17,10 @@ const updatesHandler = { const { data, store } = context.request; const newRequestParams = Object.assign({}, context.request, { - body: serializeResources( + body: JSON.stringify(serializeResources( store.cache, - recordIdentifierFor(data.record) - ) + data.record + )) }); return next(newRequestParams); } diff --git a/snippets/updating-data/save-record/new.js b/snippets/updating-data/save-record/new.js index 067545a..73fc69c 100644 --- a/snippets/updating-data/save-record/new.js +++ b/snippets/updating-data/save-record/new.js @@ -1,4 +1,3 @@ -import { recordIdentifierFor } from '@ember-data/store'; import { updateRecord, serializePatch } from '@ember-data/json-api/request'; user.name = 'Chris'; @@ -7,7 +6,7 @@ const request = updateRecord(user); request.body = JSON.stringify( serializePatch( store.cache, - recordIdentifierFor(user) + user ) ); diff --git a/tests/integration/components/guide-section/subsection-test.js b/tests/integration/components/guide-section/subsection-test.js index 997e0e9..6c29c16 100644 --- a/tests/integration/components/guide-section/subsection-test.js +++ b/tests/integration/components/guide-section/subsection-test.js @@ -97,7 +97,7 @@ module('Integration | Component | guide-section/subsection', function (hooks) { assert .dom('[data-test-field="Subsection Description"]') .includesText( - 'To create a new record using Ember Data you should use createRecord request and attach "body" to it. In case of JSON:API backend - you can user serializeResources request utility.' + 'To create a new record using Ember Data you should use createRecord request and attach "body" to it. In case of JSON:API backend - you can use serializeResources request utility.' ); const emberClassic = this.element.querySelector( diff --git a/translations/updating-data/create-record/en-us.yaml b/translations/updating-data/create-record/en-us.yaml index c03e200..1efc5d3 100644 --- a/translations/updating-data/create-record/en-us.yaml +++ b/translations/updating-data/create-record/en-us.yaml @@ -1,2 +1,2 @@ title: createRecord -description: To create a new record using Ember Data you should use createRecord request and attach "body" to it. In case of JSON:API backend - you can user serializeResources request utility. +description: To create a new record using Ember Data you should use createRecord request and attach "body" to it. In case of JSON:API backend - you can use serializeResources request utility. From 597ad0966b9afa99d650da4cde25e09a1ab9afb2 Mon Sep 17 00:00:00 2001 From: Mehul Kiran Chaudhari <55375534+MehulKChaudhari@users.noreply.github.com> Date: Sun, 23 Feb 2025 13:08:29 +0530 Subject: [PATCH 2/2] request changes --- snippets/updating-data/create-record/in-place-body.js | 3 ++- snippets/updating-data/create-record/new.js | 3 ++- snippets/updating-data/save-record/new.js | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/snippets/updating-data/create-record/in-place-body.js b/snippets/updating-data/create-record/in-place-body.js index ab612f8..2abd488 100644 --- a/snippets/updating-data/create-record/in-place-body.js +++ b/snippets/updating-data/create-record/in-place-body.js @@ -1,3 +1,4 @@ +import { recordIdentifierFor } from '@ember-data/store'; import { createRecord, serializeResources } from '@ember-data/json-api/request'; const record = store.createRecord('user', {}); @@ -6,7 +7,7 @@ const request = createRecord(record); request.body = JSON.stringify( serializeResources( store.cache, - record + recordIdentifierFor(record) ) ); diff --git a/snippets/updating-data/create-record/new.js b/snippets/updating-data/create-record/new.js index 589b3dd..951f335 100644 --- a/snippets/updating-data/create-record/new.js +++ b/snippets/updating-data/create-record/new.js @@ -1,3 +1,4 @@ +import { recordIdentifierFor } from '@ember-data/store'; import { createRecord, serializeResources } from '@ember-data/json-api/request'; const record = store.createRecord('user', {}); @@ -5,7 +6,7 @@ const request = createRecord(record); request.body = JSON.stringify( serializeResources( store.cache, - record + recordIdentifierFor(record) ) ); diff --git a/snippets/updating-data/save-record/new.js b/snippets/updating-data/save-record/new.js index 73fc69c..067545a 100644 --- a/snippets/updating-data/save-record/new.js +++ b/snippets/updating-data/save-record/new.js @@ -1,3 +1,4 @@ +import { recordIdentifierFor } from '@ember-data/store'; import { updateRecord, serializePatch } from '@ember-data/json-api/request'; user.name = 'Chris'; @@ -6,7 +7,7 @@ const request = updateRecord(user); request.body = JSON.stringify( serializePatch( store.cache, - user + recordIdentifierFor(user) ) );