Merge branch 'release/2.4.0'

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.4.0] - 2022-06-25
+
+### Added
+
+- The `JsonApiException` class now has a `context()` method. Laravel's exception handler uses this to add log context
+  when the exception is logged. This means logging of JSON:API exceptions will now include the HTTP status code and the
+  JSON:API errors.
+- Moved the default `406 Not Acceptable` and `415 Unsupported Media Type` messages to the following two new exception
+  classes:
+    - `Exceptions\HttpNotAcceptableException`
+    - `Exceptions\HttpUnsupportedMediaTypeException`
+
+### Fixed
+
+- [#184](https://github.com/laravel-json-api/laravel/issues/184) Ensure that an `Accept` header with the media type
+  `application/json` is rejected with a `406 Not Acceptable` response. Previously this media type worked, which is
+  incorrect as the JSON:API specification requires the media type `application/vnd.api+json`.
+- [#197](https://github.com/laravel-json-api/laravel/pull/197) Fix sending `null` for a to-one relationship update.
+
 ## [2.3.0] - 2022-04-11
 
 ### Added

composer.json

@@ -25,9 +25,9 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "laravel-json-api/core": "^2.2",
+        "laravel-json-api/core": "^2.3",
         "laravel-json-api/eloquent": "^2.1.1",
-        "laravel-json-api/encoder-neomerx": "^2.0",
+        "laravel-json-api/encoder-neomerx": "^2.0.1",
         "laravel-json-api/exceptions": "^1.1",
         "laravel-json-api/spec": "^1.2",
         "laravel-json-api/validation": "^2.1",

src/Exceptions/HttpNotAcceptableException.php

@@ -0,0 +1,49 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Laravel\Exceptions;
+
+use Illuminate\Http\Response;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Throwable;
+
+class HttpNotAcceptableException extends HttpException
+{
+    /**
+     * HttpNotAcceptableException constructor.
+     *
+     * @param string|null $message
+     * @param Throwable|null $previous
+     * @param array $headers
+     * @param int $code
+     */
+    public function __construct(
+        string $message = null,
+        Throwable $previous = null,
+        array $headers = [],
+        int $code = 0
+    ) {
+        if (null === $message) {
+            $message = __("The requested resource is capable of generating only content not acceptable "
+                . "according to the Accept headers sent in the request.");
+        }
+
+        parent::__construct(Response::HTTP_NOT_ACCEPTABLE, $message, $previous, $headers, $code);
+    }
+}

src/Exceptions/HttpUnsupportedMediaTypeException.php

@@ -0,0 +1,44 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Laravel\Exceptions;
+
+use Illuminate\Http\Response;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Throwable;
+
+class HttpUnsupportedMediaTypeException extends HttpException
+{
+    /**
+     * HttpUnsupportedMediaTypeException constructor.
+     *
+     * @param string|null $message
+     * @param Throwable|null $previous
+     * @param array $headers
+     * @param int $code
+     */
+    public function __construct(string $message = null, Throwable $previous = null, array $headers = [], int $code = 0)
+    {
+        if (null === $message) {
+            $message = __('The request entity has a media type which the server or resource does not support.');
+        }
+
+        parent::__construct(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, $message, $previous, $headers, $code);
+    }
+}

src/Http/Requests/ResourceQuery.php

@@ -21,16 +21,15 @@
 
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\Response;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Query\QueryParameters;
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
 use LaravelJsonApi\Core\Query\FieldSets;
 use LaravelJsonApi\Core\Query\FilterParameters;
 use LaravelJsonApi\Core\Query\IncludePaths;
 use LaravelJsonApi\Core\Query\SortFields;
+use LaravelJsonApi\Laravel\Exceptions\HttpNotAcceptableException;
 use LogicException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use function array_key_exists;
 
@@ -48,11 +47,11 @@ class ResourceQuery extends FormRequest implements QueryParameters
     private static $queryOneResolver;
 
     /**
+     * The media types the resource accepts, in addition to JSON:API.
+     *
      * @var string[]
      */
-    protected array $mediaTypes = [
-        self::JSON_API_MEDIA_TYPE,
-    ];
+    protected array $mediaTypes = [];
 
     /**
      * The include paths to use if the client provides none.
@@ -304,10 +303,24 @@ protected function failedValidation(Validator $validator)
      */
     protected function isAcceptableMediaType(): bool
     {
+        /**
+         * We expect the JSON:API media type to exactly match.
+         */
+        foreach ($this->getAcceptableContentTypes() as $contentType) {
+            if (self::JSON_API_MEDIA_TYPE === $contentType) {
+                return true;
+            }
+        }
+
+        /**
+         * Otherwise we check if any additional media types match.
+         */
         return $this->accepts($this->mediaTypes());
     }
 
     /**
+     * Get the media types the resource accepts, in addition to JSON:API.
+     *
      * @return string[]
      */
     protected function mediaTypes(): array
@@ -322,10 +335,6 @@ protected function mediaTypes(): array
      */
     protected function notAcceptable(): HttpExceptionInterface
     {
-        return new HttpException(
-            Response::HTTP_NOT_ACCEPTABLE,
-            __("The requested resource is capable of generating only content not acceptable "
-            . "according to the Accept headers sent in the request.")
-        );
+        return new HttpNotAcceptableException();
     }
 }

src/Http/Requests/ResourceRequest.php

@@ -22,7 +22,6 @@
 use Illuminate\Contracts\Validation\Factory as ValidationFactory;
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\Response;
 use Illuminate\Support\Collection;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Schema\Relation;
@@ -31,10 +30,10 @@
 use LaravelJsonApi\Core\Query\IncludePaths;
 use LaravelJsonApi\Core\Store\LazyRelation;
 use LaravelJsonApi\Core\Support\Str;
+use LaravelJsonApi\Laravel\Exceptions\HttpUnsupportedMediaTypeException;
 use LaravelJsonApi\Spec\RelationBuilder;
 use LaravelJsonApi\Spec\ResourceBuilder;
 use LogicException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use function array_key_exists;
 
@@ -205,7 +204,7 @@ public function document(): array
     {
         $document = $this->json()->all();
 
-        if (!is_array($document) || !isset($document['data']) || !is_array($document['data'])) {
+        if (!is_array($document) || !array_key_exists('data', $document) || !(is_array($document['data']) || is_null($document['data']))) {
             throw new LogicException('Expecting JSON API specification compliance to have been run.');
         }
 
@@ -349,10 +348,7 @@ protected function isSupportedMediaType(): bool
      */
     protected function unsupportedMediaType(): HttpExceptionInterface
     {
-        return new HttpException(
-            Response::HTTP_UNSUPPORTED_MEDIA_TYPE,
-            __('The request entity has a media type which the server or resource does not support.')
-        );
+        return new HttpUnsupportedMediaTypeException();
     }
 
     /**

tests/dummy/app/Http/Controllers/Api/V1/UserController.php

@@ -26,8 +26,10 @@
 
 class UserController extends Controller
 {
-
     use Actions\FetchOne;
+    use Actions\FetchRelated;
+    use Actions\FetchRelationship;
+    use Actions\UpdateRelationship;
 
     /**
      * Return the current user.

tests/dummy/app/JsonApi/V1/Phones/PhoneSchema.php

@@ -0,0 +1,49 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace App\JsonApi\V1\Phones;
+
+use App\Models\Phone;
+use LaravelJsonApi\Eloquent\Fields\DateTime;
+use LaravelJsonApi\Eloquent\Fields\ID;
+use LaravelJsonApi\Eloquent\Fields\Str;
+use LaravelJsonApi\Eloquent\Schema;
+
+class PhoneSchema extends Schema
+{
+    /**
+     * The model the schema corresponds to.
+     *
+     * @var string
+     */
+    public static string $model = Phone::class;
+
+    /**
+     * @inheritDoc
+     */
+    public function fields(): iterable
+    {
+        return [
+            ID::make(),
+            DateTime::make('createdAt')->readOnly(),
+            Str::make('number'),
+            DateTime::make('updatedAt')->readOnly(),
+        ];
+    }
+}

tests/dummy/app/JsonApi/V1/Server.php

@@ -65,6 +65,7 @@ protected function allSchemas(): array
         return [
             Comments\CommentSchema::class,
             Images\ImageSchema::class,
+            Phones\PhoneSchema::class,
             Posts\PostSchema::class,
             Tags\TagSchema::class,
             Users\UserSchema::class,

tests/dummy/app/JsonApi/V1/Users/UserRequest.php

@@ -0,0 +1,36 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace App\JsonApi\V1\Users;
+
+use LaravelJsonApi\Laravel\Http\Requests\ResourceRequest;
+use LaravelJsonApi\Validation\Rule as JsonApiRule;
+
+class UserRequest extends ResourceRequest
+{
+    /**
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'phone' => JsonApiRule::toOne(),
+        ];
+    }
+}