The path to 1.0

[lindyhopchris]

Now that neomerx/json-api is at 1.0 we want to get this library to 1.0 as soon as possible - to give people confidence that the API is stable.

The recent routing refactor and reducing the number of units per resource type (currently on develop - will be released as 0.8) puts in a lot of pre-1.0 changes that we wanted to do to simplify the package.

Required 1.0 Features

• Full support for filtering, paging etc for relationship endpoints - including test helpers. See Pagination in readRelatedResource #22, Include related resources #23, Test helper for relationships #27, Adding include, filter, sort... on Related Resource #77
• Support with when retrieving single records. See with not being called in single record request #62
• Hydrator simplification. See Hydrator Simplification #69
• Hydrate Eloquent polymorphic relationships. See Hydrate polymorphic relationships #35
• Generic authorizer that hands off to Laravel policies. See Method for using Laravel native Policies for API authorization? #45
• Refactor JsonApiController so that it has the majority of the workflow that currently exists within EloquentController. Extend the Eloquent controller from this new controller.
• Add a broadcast helper trait. See Convert Model to JsonApi object in a custom Controller. #36
• Add a blade template helper to encode JSON API data into a HTML page. See Convert Model to JsonApi object in a custom Controller. #36
• Convert tests to Laravel 5.4 style - i.e. remove dependency on laravel/browser-kit-testing.
• Drop support for Laravel 5.3 and ensure support for 5.4 and 5.5 at 1.0.
• Unit tests in this package rather than relying on the demo app to test package is working.
  Add json-api:cache and json-api:clear commands to cache the ApiInterface object. This will give a performance benefit to HTTP requests along the lines of route:cache.

Required Internal Changes

• Rename the Resource class as it is a reserved word in PHP 7.0
• Extract StandardObjectInterface and related generic classes to a separate utility library.
• Single ValidatorErrorFactoryInterface in the cloudcreativity/json-api package rather than extending that interface in laravel-json-api.
• Ideally stop injecting HttpServiceInterface and instead inject the ApiInterface and RequestInterface directly. This is possible as long as no services are created post the JSON-API middleware running.

Opening this issue so that people can comment on any features that they think are needed for 1.0.

[lindyhopchris]

v0.9 released with:

• Above internal changes
• Blade template helpers
• Broadcasting trait

[jstoone]

Hi Chris,
Awesome to see how the road towards v1.0 is getting closer and closer!

I'm up for working on converting/modernizing the tests. But may I suggest using orchestral/testbench? I used it when I developed the dixieio/eloquent-model-future and it just made writing tests using laravel facades and configs a breeze and super reliable.

If like the approach I'm up for throwing a PR tonight. 😄

[lindyhopchris]

Hi @jstoone

Your help with the tests would be super appreciated and would definitely speed up getting to 1.0.

I'd be happy to use testbench where it is not possible to write unit tests. Generally I'm trying to write the majority of units so that they are unit testable - i.e. their dependencies are Illuminate contracts. E.g. the LinkFactory takes a UrlGenerator dependency, which is a contract so should be unit tested as such.

There are however some parts of the package where that's not possible - and the part the really jumps to mind is anything to do with Eloquent models.

So what I'd suggest is we create two sub directories in the tests folder - Unit and Integration. The Integration folder can hold any tests that need testbench. And then maybe if you started with those, seeing as I've never used testbench before, and concentrate on the Eloquent stuff?

If that sounds like a plan, I'll push a commit to the develop branch with the new test structure and then you can fork off that commit. (I was also planning to drop support for Laravel 5.3 on develop, so will do that at the same time.)

[lindyhopchris]

@jstoone I've restructured the tests on develop. I'm heading off now so will be back online tomorrow morning (UK time)

[jstoone]

@lindyhopchris Sounds great, and the Unit and Integration split seems very obvious. I'll get started on the migration to testbench sometime tomorrow afternoon, and hopefully reach a point where I can submit a WIP PR, which we can use as a base for discussion.

Exciting times! 🔥

[lindyhopchris]

@jstoone great tip on the testbench repo - just used that in a package at work and it makes things a lot simpler.

i was going to start setting up the tests this evening unless you'd already started?

[jstoone]

@lindyhopchris it is really a gem when it comes to testing features that are more tightly coupled to Laravel. Also great that you've had the opportunity to play around with it. 👍

I have started setting them up, but then life entered the door and denied me access to my spare time.

I was planning on finishing it around Saturday or Sunday, but with that said if you want to get it done tonight feel free to take over. I haven't produced any progress on the setup, mainly playing around to see what would feel the best. I'll pick something else on the checklist for the weekend json-api hackathon. 🎉

Also in general, if you feel like getting code reviews on your changes, just assign me and I'll review. That would also help me gain more knowledge regarding the package. There is always time for a code review or two during my day. 🙂

[lindyhopchris]

@jstoone didn't do any on it last night as I didn't want to cross over with anything you were doing (and only just seen your message now this morning). So if you want to carry on with the test stuff this weekend that will really help.

Thanks for offer of help re: code reviews. Will take you up on that!

[jstoone]

@lindyhopchris alright! Awesome to finally get the PR pushed out and merged! 🎉

Is there anything that you would find handy, that I'd start working on now?

[lindyhopchris]

Thanks for your PR. Definitely some help with writing tests for the Eloquent classes. I'm doing some work on this package tonight so will let you know which class you could take once I've had a look over things this evening.

[jstoone]

@lindyhopchris you're very welcome, it's great to be able to contribute.

Just throw me a bone when you're ready, and I'll figure out what to do with it once it's there. 😁

[lindyhopchris]

@jstoone was thinking if it's possible to test the make:json-api:resource command, then that might be something you could do considering that you wrote the generator originally?