Add json api query support and include support #508

dakota · 2017-03-30T08:50:31Z

This adds support to the json api for parsing query parameters. Included as part of this is ability to pass the include query parameter to conditionally load relationships.

bravo-kernel · 2017-03-30T08:55:53Z

Epic PR 💯

FWIW I am getting the exact same Travis fails here #506 and haven't been able to figure out what causes it yet. So far I see no differences between the previously successful builds and these all-of-a-sudden-fails (I am using the 5.6 to troubleshoot)

jippi · 2017-03-30T09:19:38Z

I think it should be possible / required to whitelist the associations that you can pass into include - and not blow it wide open by default :)

dakota · 2017-03-30T09:22:57Z

I think it should be possible / required to whitelist the associations that you can pass into include - and not blow it wide open by default :)

I definately agree, and will be adding that. Wanted to get the PR open in the meantime

bravo-kernel · 2017-03-30T09:43:01Z

@dakota since this got discussed on Slack... will this include full sparse fieldsets functionality?

GET /articles?include=author&fields[articles]=title,body&fields[people]=name

dakota · 2017-03-30T09:52:33Z

@bravo-kernel It does not, and will not, BUT it lays the foundation to add that functionality, as well as filtering. I will be working on that next, as a separate PR. Don't want to introduce too much in a single PR

bravo-kernel · 2017-03-30T09:53:20Z

I thought so by looking at the code but just wanted to make sure, thanks

codecov-io · 2017-04-02T17:41:58Z

Codecov Report

Merging #508 into master will decrease coverage by 0.35%.
The diff coverage is 91.33%.

@@             Coverage Diff              @@
##             master     #508      +/-   ##
============================================
- Coverage     94.72%   94.36%   -0.36%     
- Complexity      614      649      +35     
============================================
  Files            42       42              
  Lines          1913     1989      +76     
============================================
+ Hits           1812     1877      +65     
- Misses          101      112      +11

Impacted Files	Coverage Δ	Complexity Δ
src/View/JsonApiView.php	`98.33% <50%> (-0.82%)`	`45 <0> (+1)`
src/Error/JsonApiExceptionRenderer.php	`97.84% <50%> (-2.16%)`	`22 <0> (+2)`
src/Schema/JsonApi/DynamicEntitySchema.php	`96.42% <82.35%> (-3.58%)`	`18 <5> (+2)`
src/Listener/JsonApiListener.php	`97.65% <95.19%> (-1.83%)`	`100 <40> (+30)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41aba34...5bf277c. Read the comment docs.

bravo-kernel · 2017-04-04T19:45:07Z

UPDATE: ALL RESOLVED

I ❤️ it.

I don't have time to complete a full integration test but here's some initial feedback to start with.

All tested against my CountriesController index action, all my custom behaviors etc. disabled.

OK: including a single hasMany relationship

Tested against /countries?include=cultures.

OK: the relationships node contains related data as expected (per resource)
OK: the included node gets rendered as expected

{
  "data": [
    {
      "type": "countries",
      "id": "1",
      "attributes": {
        "code": "NL",
        "name": "The Netherlands",
        "native": "Nederland",
        "slug": "nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      },
      "relationships": {
        "cultures": {
          "data": [
            {
              "type": "cultures",
              "id": "1"
            }
          ],
          "links": {
            "self": "/cultures?country_id=1"
          }
        }
      },
      "links": {
        "self": "/countries/1"
      }
    }
  ],
  "included": [
    {
      "type": "cultures",
      "id": "1",
      "attributes": {
        "code": "nl-NL",
        "name": "Dutch",
        "native": "Nederlands",
        "slug": "nl-nl",
        "country_id": 1,
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    }
  ]
}

OK: including a single belongsTo relationship

Tested with `/countries?include=currencies

OK: the relationships node contains related data as expected (per resource)
OK: the included node gets rendered with expected data

{
  "data": [
    {
      "type": "countries",
      "id": "1",
      "attributes": {
        "code": "NL",
        "name": "The Netherlands",
        "native": "Nederland",
        "slug": "nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "1"
          },
          "links": {
            "self": "/currencies/1"
          }
        }
      },
      "links": {
        "self": "/countries/1"
      }
    }
  ],
  "included": [
    {
      "type": "currencies",
      "id": "1",
      "attributes": {
        "code": "EUR",
        "name": "Euro",
        "slug": "eur",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    }
  ]
}

OK: including two relationships (hasMany-and-belongsTo)

Tested with /countries?include=cultures,currencies:

OK: the relationships node contains related data as expected (per resource)
OK: the included node gets rendered with expected hasMany and belongsTo data

{
  "data": [
    {
      "type": "countries",
      "id": "1",
      "attributes": {
        "code": "NL",
        "name": "The Netherlands",
        "native": "Nederland",
        "slug": "nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "1"
          },
          "links": {
            "self": "/currencies/1"
          }
        },
        "cultures": {
          "data": [
            {
              "type": "cultures",
              "id": "1"
            }
          ],
          "links": {
            "self": "/cultures?country_id=1"
          }
        }
      },
      "links": {
        "self": "/countries/1"
      }
    }
  ],
  "included": [
    {
      "type": "currencies",
      "id": "1",
      "attributes": {
        "code": "EUR",
        "name": "Euro",
        "slug": "eur",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    },
    {
      "type": "cultures",
      "id": "1",
      "attributes": {
        "code": "nl-NL",
        "name": "Dutch",
        "native": "Nederlands",
        "slug": "nl-nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    }
  ]
}

OK: limiting results when a single belongsTo contain is present in index action

Tested with /countries?include=currencies and the following index action:

    public function index()
    {
       $this->Crud->on('beforePaginate', function (Event $event) {
            $event->subject()->query->contain([
                'Cultures',
            ]);
        });
        return $this->Crud->execute();
    }

OK: the relationships node still contains data for currency
OK: the included node does not get rendered with belongsTo data

{
  "data": [
    {
      "type": "countries",
      "id": "1",
      "attributes": {
        "code": "NL",
        "name": "The Netherlands",
        "native": "Nederland",
        "slug": "nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "1"
          },
          "links": {
            "self": "/currencies/1"
          }
        },
        "cultures": {
          "data": [
            {
              "type": "cultures",
              "id": "1"
            }
          ],
          "links": {
            "self": "/cultures?country_id=1"
          }
        }
      },
      "links": {
        "self": "/countries/1"
      }
    }
  ],
  "included": [
    {
      "type": "currencies",
      "id": "1",
      "attributes": {
        "code": "EUR",
        "name": "Euro",
        "slug": "eur",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    }
  ]
}

OK: limiting results when a single hasMany contain is present in index action

Tested with /countries?include=cultures and the following index action:

    public function index()
    {
       $this->Crud->on('beforePaginate', function (Event $event) {
            $event->subject()->query->contain([
                'Currencies',
            ]);
        });
        return $this->Crud->execute();
    }

OK: the relationships node shows data for cultures
OK: the included node gets rendered as expected

{
  "data": [
    {
      "type": "countries",
      "id": "1",
      "attributes": {
        "code": "NL",
        "name": "The Netherlands",
        "native": "Nederland",
        "slug": "nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "1"
          },
          "links": {
            "self": "/currencies/1"
          }
        },
        "cultures": {
          "data": [
            {
              "type": "cultures",
              "id": "1"
            }
          ],
          "links": {
            "self": "/cultures?country_id=1"
          }
        }
      },
      "links": {
        "self": "/countries/1"
      }
    }
  ],
  "included": [
    {
      "type": "cultures",
      "id": "1",
      "attributes": {
        "code": "nl-NL",
        "name": "Dutch",
        "native": "Nederlands",
        "slug": "nl-nl",
        "approved": true,
        "created": "2017-02-25T20:40:40+00:00",
        "modified": "2017-02-25T20:40:40+00:00"
      }
    }
  ]
}

OK: limiting results when a two contains are present in index action

Same result as the previous test. This time tested with /countries?include=currencies and the following index action.

OK: the relationships node shows data for cultures
OK: the included node gets limited to the resource passed with ?include=

    public function index()
    {
       $this->Crud->on('beforePaginate', function (Event $event) {
            $event->subject()->query->contain([
                'Cultures',
                'Currencies',
            ]);
        });
        return $this->Crud->execute();
    }

Usability

I'm ashamed to admit but I was unable to figure out (from the stack trace) which one of the three resources in ?include=cultures,donkey,currencies was causing the following error. I think it would be very useful if the detail message would mention which resource(s) are failing (if even possible ofcourse).

  "errors": [
    {
      "code": "400",
      "title": "Bad Request",
      "detail": "Invalid relationship path supplied in include parameter"

Update:

Thanks, this feedback is much much better ☺️.

It only detects the first invalid so monkey does not show up (in a list) but I guess that's nitpicking. ?include=cultures,donkey,monkey,currencies

{
  "errors": [
    {
      "code": "400",
      "title": "Bad Request",
      "detail": "Invalid relationship path 'donkey' supplied in include parameter"

bravo-kernel · 2017-04-05T06:01:07Z

I've added a few more tests.

~~I hope this also makes clear how badly I need to get the integration tests working for JsonApiListener (#513)~~

dakota · 2017-04-06T13:36:16Z

@bravo-kernel Made quite a few changes now.

Firstly, all your supplied test cases are working (With integration tests 🎉 )

I have also started work on supporting arbitrarily deeply nested includes/contains. Will get that finished soon.

As a consequence this should also make nested relationships work

bravo-kernel · 2017-04-08T08:28:14Z

UPDATE: RESOLVED

Listener config

I copy-pasted the following from your docs example and it is giving me this error (cake 3.3.9);

"code": "500",
"title": "Internal Server Error",
"detail": "Call to undefined method Crud\Listener\JsonApiListener::setConfig()"

    public function index()
    {
        $this->Crud
          ->listener('jsonApi')
          ->setConfig('queryParameters.include.blacklist', ['countries']);

        $this->Crud->on('beforePaginate', function (Event $event) {
        });

        return $this->Crud->execute();
    }

Stack trace

{
  "errors": [
    {
      "code": "500",
      "title": "Internal Server Error",
      "detail": "Call to undefined method Crud\\Listener\\JsonApiListener::setConfig()"
    }
  ],
  "debug": {
    "class": "Error",
    "trace": [
      {
        "file": "/home/vagrant/projects/alt3-api/vendor/friendsofcake/crud/src/Controller/ControllerTrait.php",
        "line": 51,
        "function": "call_user_func_array",
        "args": [
          [
            {
              "paginate": {
                "sortWhitelist": [
                  "code",
                  "name"
                ]
              },
              "name": "Currencies",
              "helpers": [],
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "response": {},
              "autoRender": true,
              "components": [],
              "View": null,
              "plugin": null,
              "passedArgs": [],
              "modelClass": "Currencies",
              "viewClass": null,
              "viewVars": [],
              "dispatchComponents": {
                "Crud": true
              },
              "RequestHandler": {
                "enabled": true,
                "response": {},
                "ext": null,
                "request": {
                  "params": {
                    "plugin": null,
                    "controller": "Currencies",
                    "action": "index",
                    "_ext": null,
                    "pass": [],
                    "_method": "GET",
                    "_matchedRoute": "/currencies",
                    "isAjax": false
                  },
                  "data": [],
                  "query": [],
                  "cookies": {
                    "CAKEPHP": "a93dsl3393955f5lphabses856",
                    "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                  },
                  "url": "currencies",
                  "base": "",
                  "webroot": "/",
                  "here": "/currencies",
                  "trustProxy": false
                },
                "components": []
              },
              "Crud": {
                "request": {
                  "params": {
                    "plugin": null,
                    "controller": "Currencies",
                    "action": "index",
                    "_ext": null,
                    "pass": [],
                    "_method": "GET",
                    "_matchedRoute": "/currencies",
                    "isAjax": false
                  },
                  "data": [],
                  "query": [],
                  "cookies": {
                    "CAKEPHP": "a93dsl3393955f5lphabses856",
                    "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                  },
                  "url": "currencies",
                  "base": "",
                  "webroot": "/",
                  "here": "/currencies",
                  "trustProxy": false
                },
                "response": {},
                "components": []
              },
              "Auth": {
                "components": [
                  "RequestHandler",
                  "Flash"
                ],
                "allowedActions": [
                  "home",
                  "index",
                  "view",
                  "index",
                  "view"
                ],
                "request": {
                  "params": {
                    "plugin": null,
                    "controller": "Currencies",
                    "action": "index",
                    "_ext": null,
                    "pass": [],
                    "_method": "GET",
                    "_matchedRoute": "/currencies",
                    "isAjax": false
                  },
                  "data": [],
                  "query": [],
                  "cookies": {
                    "CAKEPHP": "a93dsl3393955f5lphabses856",
                    "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                  },
                  "url": "currencies",
                  "base": "",
                  "webroot": "/",
                  "here": "/currencies",
                  "trustProxy": false
                },
                "response": {},
                "session": {}
              },
              "Alt3Api": {
                "request": {
                  "params": {
                    "plugin": null,
                    "controller": "Currencies",
                    "action": "index",
                    "_ext": null,
                    "pass": [],
                    "_method": "GET",
                    "_matchedRoute": "/currencies",
                    "isAjax": false
                  },
                  "data": [],
                  "query": [],
                  "cookies": {
                    "CAKEPHP": "a93dsl3393955f5lphabses856",
                    "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                  },
                  "url": "currencies",
                  "base": "",
                  "webroot": "/",
                  "here": "/currencies",
                  "trustProxy": false
                },
                "response": {},
                "components": []
              },
              "Prg": {
                "request": {
                  "params": {
                    "plugin": null,
                    "controller": "Currencies",
                    "action": "index",
                    "_ext": null,
                    "pass": [],
                    "_method": "GET",
                    "_matchedRoute": "/currencies",
                    "isAjax": false
                  },
                  "data": [],
                  "query": [],
                  "cookies": {
                    "CAKEPHP": "a93dsl3393955f5lphabses856",
                    "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                  },
                  "url": "currencies",
                  "base": "",
                  "webroot": "/",
                  "here": "/currencies",
                  "trustProxy": false
                },
                "response": {},
                "components": []
              }
            },
            "index"
          ],
          []
        ]
      },
      {
        "file": "/home/vagrant/projects/alt3-api/vendor/cakephp/cakephp/src/Http/ActionDispatcher.php",
        "line": 122,
        "function": "invokeAction",
        "class": "App\\Controller\\AppController",
        "type": "->",
        "args": []
      },
      {
        "file": "/home/vagrant/projects/alt3-api/vendor/cakephp/cakephp/src/Http/ActionDispatcher.php",
        "line": 96,
        "function": "_invoke",
        "class": "Cake\\Http\\ActionDispatcher",
        "type": "->",
        "args": [
          {
            "paginate": {
              "sortWhitelist": [
                "code",
                "name"
              ]
            },
            "name": "Currencies",
            "helpers": [],
            "request": {
              "params": {
                "plugin": null,
                "controller": "Currencies",
                "action": "index",
                "_ext": null,
                "pass": [],
                "_method": "GET",
                "_matchedRoute": "/currencies",
                "isAjax": false
              },
              "data": [],
              "query": [],
              "cookies": {
                "CAKEPHP": "a93dsl3393955f5lphabses856",
                "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
              },
              "url": "currencies",
              "base": "",
              "webroot": "/",
              "here": "/currencies",
              "trustProxy": false
            },
            "response": {},
            "autoRender": true,
            "components": [],
            "View": null,
            "plugin": null,
            "passedArgs": [],
            "modelClass": "Currencies",
            "viewClass": null,
            "viewVars": [],
            "dispatchComponents": {
              "Crud": true
            },
            "RequestHandler": {
              "enabled": true,
              "response": {},
              "ext": null,
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "components": []
            },
            "Crud": {
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "response": {},
              "components": []
            },
            "Auth": {
              "components": [
                "RequestHandler",
                "Flash"
              ],
              "allowedActions": [
                "home",
                "index",
                "view",
                "index",
                "view"
              ],
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "response": {},
              "session": {}
            },
            "Alt3Api": {
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "response": {},
              "components": []
            },
            "Prg": {
              "request": {
                "params": {
                  "plugin": null,
                  "controller": "Currencies",
                  "action": "index",
                  "_ext": null,
                  "pass": [],
                  "_method": "GET",
                  "_matchedRoute": "/currencies",
                  "isAjax": false
                },
                "data": [],
                "query": [],
                "cookies": {
                  "CAKEPHP": "a93dsl3393955f5lphabses856",
                  "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
                },
                "url": "currencies",
                "base": "",
                "webroot": "/",
                "here": "/currencies",
                "trustProxy": false
              },
              "response": {},
              "components": []
            }
          }
        ]
      },
      {
        "file": "/home/vagrant/projects/alt3-api/vendor/cakephp/cakephp/src/Routing/Dispatcher.php",
        "line": 60,
        "function": "dispatch",
        "class": "Cake\\Http\\ActionDispatcher",
        "type": "->",
        "args": [
          {
            "params": {
              "plugin": null,
              "controller": "Currencies",
              "action": "index",
              "_ext": null,
              "pass": [],
              "_method": "GET",
              "_matchedRoute": "/currencies",
              "isAjax": false
            },
            "data": [],
            "query": [],
            "cookies": {
              "CAKEPHP": "a93dsl3393955f5lphabses856",
              "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
            },
            "url": "currencies",
            "base": "",
            "webroot": "/",
            "here": "/currencies",
            "trustProxy": false
          },
          {}
        ]
      },
      {
        "file": "/home/vagrant/projects/alt3-api/webroot/index.php",
        "line": 36,
        "function": "dispatch",
        "class": "Cake\\Routing\\Dispatcher",
        "type": "->",
        "args": [
          {
            "params": {
              "plugin": null,
              "controller": "Currencies",
              "action": "index",
              "_ext": null,
              "pass": [],
              "_method": "GET",
              "_matchedRoute": "/currencies",
              "isAjax": false
            },
            "data": [],
            "query": [],
            "cookies": {
              "CAKEPHP": "a93dsl3393955f5lphabses856",
              "csrfToken": "0d2c72f16a2aaabf9a38f18fa8974f66a2d87967"
            },
            "url": "currencies",
            "base": "",
            "webroot": "/",
            "here": "/currencies",
            "trustProxy": false
          },
          {}
        ]
      }
    ]
  }
}

dakota · 2017-04-08T09:58:19Z

@bravo-kernel Probably because you are using CakePHP 3.3 still :) Will get that updated

bravo-kernel · 2017-04-09T12:17:16Z

UPDATE: EXPLAINED (WORKS FOR ME)

The blacklist works as expected except... when there already is a contain in the action itself, like shown below. I expected included to be empty due to the blacklist-config winning. If I'm missing the point here please elaborate.

    public function index()
    {
        $this->Crud
          ->listener('jsonApi')
          ->config('queryParameters.include.blacklist', ['currencies', 'cultures']);

         $this->Crud->on('beforePaginate', function (Event $event) {
            $event->subject()->query->contain([
                'Currencies',
                'Cultures'
            ]);
         });

        return $this->Crud->execute();
    }

bravo-kernel · 2017-04-10T19:37:26Z

UPDATE: SOLVED

Just tested the view action with your include and it works like a charm 👍

However, I did notice that the include does not accept/respect my dasherized models and throws the following error when using the expected /users/1?include=user-profiles

"code": "400",
"title": "Bad Request",
"detail": "Invalid relationship path 'user-profiles' supplied in include parameter"

Changing the include to underscored /users/1?include=user_profiles makes it work but produces incorrect underscored json as can be seen below (where only the self-link is using correct dash):

{
  "data": {
    "type": "users",
    "id": "1",
    "attributes": {
      "email": "bravo@kernel.com",
      "username": null,
      "slug": null,
      "confirmed": false,
      "created": "2017-03-08T14:32:31+00:00",
      "modified": "2017-03-08T14:32:31+00:00"
    },
    "relationships": {
      "user_profile": {
        "data": {
          "type": "user_profiles",
          "id": "333"
        },
        "links": {
          "self": "/user-profiles/view/333"
        }
      }
    },
    "links": {
      "self": "/users/1"
    }
  },
  "included": [
    {
      "type": "user_profiles",
      "id": "333",
      "attributes": {
        "newsletter": false,
        "notifications": false,
        "created": "2017-03-08T14:32:31+00:00",
        "modified": "2017-03-08T14:32:31+00:00"
      }
    }
  ]
}

dakota · 2017-04-11T16:35:44Z

The blacklist works as expected except... when there already is a contain in the action itself

This is the expected behaviour. The blacklist/whitelist ONLY affects the include query parameter. If no query parameter is supplied then the include config option, or auto-determination is used as previously.

bravo-kernel · 2017-04-11T16:53:05Z

Thanks for explaining mr. @dakota. Since there are no more things on my list I would say this is functionally good to go. Awesome job 💯

dakota · 2017-04-12T05:57:55Z

If everybody is happy, I'll go ahead and merge?

jippi · 2017-04-12T07:17:16Z

Thanks @dakota !

bravo-kernel · 2017-04-12T07:22:12Z

👏

ADmad · 2017-04-12T07:24:16Z

Does this warrant a new minor release or a bugfix release should suffice?

dakota · 2017-04-12T07:37:24Z

Depends on how strict we are about feature additions? It doesn't really change how the default behaviour worked

bravo-kernel mentioned this pull request Mar 30, 2017

Adds neomerx dev dependency required for running unit tests #506

Closed

bravo-kernel mentioned this pull request Mar 31, 2017

Adds JsonApiListener disclaimer #495

Merged

dakota force-pushed the add-json-api-query-support branch from 777c80c to 1d9b76e Compare April 3, 2017 11:33

dakota added the JSONAPI label Apr 6, 2017

dakota and others added 17 commits April 6, 2017 15:18

Add basic support for query parameters including the include param

f13c31a

Base associations on contain value instead of entity key value

1494983

Do not override already set schemas

c7469bc

Update tests to pass

bdf8b20

Test that query param config test works

ae171f3

Update tests

71698e1

Add some comments and small code cleanup

b4fc11c

Add test for includes parser

759d509

Add white and black lists for include parameter

ff033cb

Update test to pass with include changes

db7ecc7

Add tests for include parsing and support for wildcards

ae5ffc1

Allow blacklisting/whitelisting everything

eb222eb

Only include what is actually included

1183fcb

Include blacklist wildcard

732d24b

Add some documentation for include parameter

d834076

Support CakePHP < 3.4

83a5ded

Fix array error

3317cab

dakota added 5 commits April 6, 2017 15:21

Correctly parse the include config for include query

f64bbc8

Add more integration tests, and check for singular include

3f6cc10

Make exception better and add test for contained

cf9f3a2

Take into account non query requests (Like post)

c125291

Add more routes

9aebb9d

dakota force-pushed the add-json-api-query-support branch from b9fc0a2 to 9aebb9d Compare April 6, 2017 13:34

dakota added 5 commits April 6, 2017 19:11

Only render json api error if it's a json api request

6a44020

Update json api listener tests

c4726e2

Move responsibility of removing of relationship keys to the schema.

60faaf0

As a consequence this should also make nested relationships work

Use the repository that we already know about

16643f1

Add test for deeply nested json api requests

b8d4056

dakota added 2 commits April 8, 2017 18:41

Don't use 3.4+ only method

6420a95

Fix codesniffer errors

5bf277c

dakota added 3 commits April 11, 2017 16:36

Allow configuring multi-barreled relationship name inflection

bfc545c

Fix relation self link generation

3ac72e4

Remove unused association key

542a317

jippi merged commit d1d1c0b into FriendsOfCake:master Apr 12, 2017

dakota deleted the add-json-api-query-support branch April 12, 2017 07:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add json api query support and include support #508

Add json api query support and include support #508

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

jippi commented Mar 30, 2017

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

codecov-io commented Apr 2, 2017 •

edited

Loading

bravo-kernel commented Apr 4, 2017 •

edited

Loading

bravo-kernel commented Apr 5, 2017 •

edited

Loading

dakota commented Apr 6, 2017

bravo-kernel commented Apr 8, 2017 •

edited

Loading

dakota commented Apr 8, 2017

bravo-kernel commented Apr 9, 2017 •

edited

Loading

bravo-kernel commented Apr 10, 2017 •

edited

Loading

dakota commented Apr 11, 2017

bravo-kernel commented Apr 11, 2017

dakota commented Apr 12, 2017

jippi commented Apr 12, 2017

bravo-kernel commented Apr 12, 2017

ADmad commented Apr 12, 2017

dakota commented Apr 12, 2017

Add json api query support and include support #508

Add json api query support and include support #508

Conversation

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

jippi commented Mar 30, 2017

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

dakota commented Mar 30, 2017

bravo-kernel commented Mar 30, 2017

codecov-io commented Apr 2, 2017 • edited Loading

Codecov Report

bravo-kernel commented Apr 4, 2017 • edited Loading

UPDATE: ALL RESOLVED

OK: including a single hasMany relationship

OK: including a single belongsTo relationship

OK: including two relationships (hasMany-and-belongsTo)

OK: limiting results when a single belongsTo contain is present in index action

OK: limiting results when a single hasMany contain is present in index action

OK: limiting results when a two contains are present in index action

Usability

bravo-kernel commented Apr 5, 2017 • edited Loading

dakota commented Apr 6, 2017

bravo-kernel commented Apr 8, 2017 • edited Loading

UPDATE: RESOLVED

Listener config

Stack trace

dakota commented Apr 8, 2017

bravo-kernel commented Apr 9, 2017 • edited Loading

UPDATE: EXPLAINED (WORKS FOR ME)

bravo-kernel commented Apr 10, 2017 • edited Loading

UPDATE: SOLVED

dakota commented Apr 11, 2017

bravo-kernel commented Apr 11, 2017

dakota commented Apr 12, 2017

jippi commented Apr 12, 2017

bravo-kernel commented Apr 12, 2017

ADmad commented Apr 12, 2017

dakota commented Apr 12, 2017

codecov-io commented Apr 2, 2017 •

edited

Loading

bravo-kernel commented Apr 4, 2017 •

edited

Loading

bravo-kernel commented Apr 5, 2017 •

edited

Loading

bravo-kernel commented Apr 8, 2017 •

edited

Loading

bravo-kernel commented Apr 9, 2017 •

edited

Loading

bravo-kernel commented Apr 10, 2017 •

edited

Loading