[FEATURE ds-improved-ajax] Finer control over customizing a request #3099

pangratz · 2015-05-24T23:24:31Z

Though ajax() (and ajaxOptions()) of DS.RESTAdapter are marked as
private, they have been overwritten in many applications, since there is
currently no other way to customize the request.

This feature adds new public methods to DS.RESTAdapter, which allow to
customize the properties of a request:

methodForRequest to get the HTTP verb
urlForRequest to get the URL
headersForRequest to get the headers
dataForRequest to get the data (query params or request body)

The params hash passed to those methods has all the properties with
which the corresponding find, createRecord, findQuery, ... call
have been invoked: store, type, snapshot(s), id(s) and query. The
requestType property indicates which method is requested; the possible
values are:

createRecord
updateRecord
deleteRecord
query
queryRecord
findRecord
findAll
findMany
findHasMany
findBelongsTo

Performing the actual AJAX request is handled by the makeRequest
method, which is similar to the existing ajax method: it makes the
request using jQuery.ajax and attaches success and failure handlers.

Say your API handles creation of resources via PUT, this can now be
customized as follows:

// adapters/application.js
import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  methodForRequest: function(params) {
    if (params.requestType === 'createRecord') {
      return "PUT";
    }

    return this._super(...arguments);
  }
});

Credit for the initial idea goes to @igorT in #3047 (comment).

pangratz · 2015-05-24T23:33:34Z

packages/ember-data/tests/integration/adapter/rest-adapter-test.js

+  adapter.ajax = function(request) {
+    passedUrl = request.url;
+    passedVerb = request.method;
+    passedHash = request.body ? { data: request.body } : undefined;


I didn't want to update all assertions below, hence this weird setup; I think this can be refactored/simplified more once this is accepted ...

Not relevant anymore, since everything is behind a feature flag...

pangratz · 2015-05-25T01:08:37Z

packages/ember-data/lib/adapters/rest-adapter.js

+  urlForRequest(params) {
+    var { type, id, ids, snapshot, snapshots, requestType, query } = params;
+
+    // type and id is not passed from updateRecord and deleteRecord, hence they


SeyZ · 2015-10-21T11:14:29Z

Awesome thanks @pangratz

pangratz · 2015-12-21T16:19:13Z

Just a heads up: I am rebasing this PR onto latest master and also try to put everything behind a feature flag...

tchak · 2015-12-22T18:40:39Z

💯 this is so awesome! I will be able to kill all the hacks I have in ajaxOptions :)

workmanw · 2015-12-22T22:00:31Z

Is the thought to make headersForRequest and bodyForRequest public? I'm currently using ajaxOptions and had no idea it was technically private. Several SO answers and blog posts mention using ajaxOptions.

Either way, there should definitely be a public way to do this that isn't declarative. Things like CSRFs and sessions can be rotating constantly.

pangratz · 2015-12-22T22:13:29Z

@workmanw I haven't added documentation for the methods yet, but I think it would be favorable to make those methods public. Currently ajax and ajaxOptions are private but they are overwritten many times in different apps since there is currently no other way to customize the request...

pangratz · 2015-12-23T15:46:19Z

I rebased onto latest master branch and put everything behind a feature flag ds-improved-ajax. Also, rudimentary documentation has been added for the new public methods.

For easier review of the commits which add the calls in the adapter methods, the whitespace should be ignored by appending ?w=1 to the GitHub commit URL:

pangratz · 2016-03-16T21:32:50Z

I once again rebased onto latest master and squashed all commits into 1. This is ready to go @bmac.

bmac · 2016-03-18T16:42:38Z

addon/adapters/rest.js

+     * @param {Object} params
+     * @return {Object} request object
+     */
+    requestFor(params) {


Lets rename this to _requestFor.

Though `ajax()` (and `ajaxOptions()`) of `DS.RESTAdapter` are marked as private, they have been overwritten in many applications, since there is currently no other way to customize the request. This feature adds new public methods to `DS.RESTAdapter`, which allow to customize the properties of a request: - `methodForRequest` to get the HTTP verb - `urlForRequest` to get the URL - `headersForRequest` to get the headers - `dataForRequest` to get the data (query params or request body) The `params` hash passed to those methods has all the properties with which the corresponding `find`, `createRecord`, `findQuery`, ... call have been invoked: store, type, snapshot(s), id(s) and query. The `requestType` property indicates which method is requested; the possible values are: - `createRecord` - `updateRecord` - `deleteRecord` - `query` - `queryRecord` - `findRecord` - `findAll` - `findMany` - `findHasMany` - `findBelongsTo` Performing the actual AJAX request is handled by the `_makeRequest` method, which is similar to the existing `ajax` method: it makes the request using `jQuery.ajax` and attaches success and failure handlers. --- Say your API handles creation of resources via PUT, this can now be customized as follows: ``` js // adapters/application.js import DS from 'ember-data'; export DS.RESTAdapter.extend({ methodForRequest: function(params) { if (params.requestType === 'createRecord') { return "PUT"; } return this._super(...arguments); } }); ```

bmac · 2016-03-21T19:29:58Z

Looks good.

[FEATURE ds-improved-ajax] Finer control over customizing a request

pangratz reviewed May 24, 2015
View reviewed changes

pangratz mentioned this pull request May 24, 2015

Difficult to use PUT for creating records #3047

Closed

pangratz reviewed May 25, 2015
View reviewed changes

sly7-7 mentioned this pull request May 28, 2015

maxUrlLength -> maxURLLength #3119

Merged

pangratz mentioned this pull request Aug 19, 2015

Fix: IE11 compatibility of JSONAPI adapter #3675

Closed

pangratz mentioned this pull request Oct 21, 2015

How could I use put method to update a record instead of patch method #3870

Closed

bmac added the team-review label Dec 22, 2015

pangratz changed the title ~~Split construction of AJAX options into separate methods~~ [FEATURE ds-improved-ajax] Finer control over customizing a request Dec 23, 2015

pangratz removed the team-review label Mar 16, 2016

bmac reviewed Mar 18, 2016
View reviewed changes

bmac added a commit that referenced this pull request Mar 21, 2016

Merge pull request #3099 from pangratz/request_options

e57f67e

[FEATURE ds-improved-ajax] Finer control over customizing a request

bmac merged commit e57f67e into emberjs:master Mar 21, 2016

pangratz deleted the request_options branch March 21, 2016 21:52

bmac mentioned this pull request Apr 28, 2016

Support other dataTypes in Adapter#AjaxOptions #4357

Closed

marcoow mentioned this pull request Jun 20, 2016

Ember 2.7 and 2.8 seems to be not sending AUTHORIZATION data mainmatter/ember-simple-auth#1003

Closed

JeroenvdV mentioned this pull request Jun 24, 2016

Override headersForRequest, fixes #1003 mainmatter/ember-simple-auth#1009

Closed

pangratz mentioned this pull request Jul 30, 2016

Wrong adapter used for retrieving related records #3878

Closed

bmac mentioned this pull request Aug 12, 2016

headers being a CP may be a poor choice #4496

Closed

amiel mentioned this pull request Sep 27, 2016

query keys in query string amiel/ember-data-url-templates#19

Closed

bartocc mentioned this pull request Apr 25, 2017

Update data-adapter-mixin.js mainmatter/ember-simple-auth#1297

Closed

sandstrom mentioned this pull request Jan 18, 2018

[QUEST] Making jQuery Optional #5320

Closed

6 tasks

samdemaeyer mentioned this pull request Oct 26, 2018

Fix bug (Array params have indexes) and upgrade ember-cli amiel/ember-data-url-templates#48

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE ds-improved-ajax] Finer control over customizing a request #3099

[FEATURE ds-improved-ajax] Finer control over customizing a request #3099

pangratz commented May 24, 2015

pangratz May 24, 2015

pangratz Feb 15, 2016

pangratz May 25, 2015

SeyZ commented Oct 21, 2015

pangratz commented Dec 21, 2015

tchak commented Dec 22, 2015

workmanw commented Dec 22, 2015

pangratz commented Dec 22, 2015

pangratz commented Dec 23, 2015

pangratz commented Mar 16, 2016

bmac Mar 18, 2016

bmac commented Mar 21, 2016

[FEATURE ds-improved-ajax] Finer control over customizing a request #3099

[FEATURE ds-improved-ajax] Finer control over customizing a request #3099

Conversation

pangratz commented May 24, 2015

pangratz May 24, 2015

Choose a reason for hiding this comment

pangratz Feb 15, 2016

Choose a reason for hiding this comment

pangratz May 25, 2015

Choose a reason for hiding this comment

SeyZ commented Oct 21, 2015

pangratz commented Dec 21, 2015

tchak commented Dec 22, 2015

workmanw commented Dec 22, 2015

pangratz commented Dec 22, 2015

pangratz commented Dec 23, 2015

pangratz commented Mar 16, 2016

bmac Mar 18, 2016

Choose a reason for hiding this comment

bmac commented Mar 21, 2016