[Feature] Support encoded resource ids

composer.json

@@ -34,6 +34,7 @@
         "laravel/framework": "^8.0"
     },
     "require-dev": {
+        "laravel-json-api/hashids": "dev-develop",
         "laravel-json-api/testing": "^1.0.0-alpha.1",
         "orchestra/testbench": "^6.9",
         "phpunit/phpunit": "^9.5"

src/Routing/Route.php

@@ -210,13 +210,43 @@ public function relation(): Relation
      */
     public function substituteBindings(): void
     {
+        if ($this->hasSubstitutedBindings()) {
+            $this->checkBinding();
+            return;
+        }
+
         if ($this->hasResourceId()) {
             $this->setModel($this->schema()->repository()->find(
                 $this->resourceId()
             ));
         }
     }
 
+    /**
+     * Has the model binding already been substituted?
+     *
+     * In a normal Laravel application setup, the `api` middleware group will
+     * include Laravel's binding substitution middleware. This means that
+     * typically the boot JSON:API middleware will run *after* bindings have been
+     * substituted.
+     *
+     * If the route that is being executed has type-hinted the model, this means
+     * the model will already be substituted into the route. For example, this
+     * can occur if the developer has written their own controller action, or
+     * for custom actions.
+     *
+     * @return bool
+     */
+    private function hasSubstitutedBindings(): bool
+    {
+        if ($name = $this->resourceIdName()) {
+            $expected = $this->schema()->model();
+            return $this->route->parameter($name) instanceof $expected;
+        }
+
+        return false;
+    }
+
     /**
      * @param object|null $model
      * @return void
@@ -235,6 +265,30 @@ private function setModel(?object $model): void
         throw new NotFoundHttpException();
     }
 
+    /**
+     * Check the model that has already been substituted.
+     *
+     * If Laravel has substituted bindings before the JSON:API binding substitution
+     * is triggered, we need to check that the model that has been set on the route
+     * by Laravel does exist in our API. This is because the API's existence logic
+     * may not match the route binding query that Laravel executed to substitute
+     * the binding. E.g. if the developer has applied global scopes in the Server's
+     * `serving()` method, these global scopes may have been applied *after* the
+     * binding was substituted.
+     *
+     * @return void
+     */
+    private function checkBinding(): void
+    {
+        $resourceId = $this->server->resources()->create(
+            $this->model(),
+        )->id();
+
+        if (!$this->schema()->repository()->exists($resourceId)) {
+            throw new NotFoundHttpException();
+        }
+    }
+
     /**
      * @return string|null
      */

stubs/schema.stub

@@ -6,7 +6,7 @@ use {{ namespacedModel }};
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\{{ schema }};
 
@@ -42,7 +42,7 @@ class {{ class }} extends {{ schema }}
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn()),
+            WhereIdIn::make($this),
         ];
     }
 

tests/dummy/app/JsonApi/V1/Comments/CommentSchema.php

@@ -25,9 +25,10 @@
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
 use LaravelJsonApi\Eloquent\Fields\Str;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
+use LaravelJsonApi\HashIds\HashId;
 
 class CommentSchema extends Schema
 {
@@ -45,7 +46,7 @@ class CommentSchema extends Schema
     public function fields(): array
     {
         return [
-            ID::make(),
+            HashId::make()->alreadyEncoded(),
             Str::make('content'),
             DateTime::make('createdAt')->sortable()->readOnly(),
             BelongsTo::make('post'),
@@ -60,7 +61,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
         ];
     }
 

tests/dummy/app/JsonApi/V1/Images/ImageSchema.php

@@ -24,7 +24,7 @@
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Str;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
 
@@ -57,7 +57,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
         ];
     }
 

tests/dummy/app/JsonApi/V1/Posts/PostSchema.php

@@ -22,7 +22,6 @@
 use App\Models\Post;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
-use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsToMany;
 use LaravelJsonApi\Eloquent\Fields\Relations\HasMany;
@@ -32,10 +31,11 @@
 use LaravelJsonApi\Eloquent\Filters\OnlyTrashed;
 use LaravelJsonApi\Eloquent\Filters\Scope;
 use LaravelJsonApi\Eloquent\Filters\Where;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
 use LaravelJsonApi\Eloquent\SoftDeletes;
+use LaravelJsonApi\HashIds\HashId;
 
 class PostSchema extends Schema
 {
@@ -62,7 +62,7 @@ class PostSchema extends Schema
     public function fields(): array
     {
         return [
-            ID::make(),
+            HashId::make()->alreadyEncoded(),
             BelongsTo::make('author')->type('users')->readOnly(),
             HasMany::make('comments')->readOnly(),
             Str::make('content'),
@@ -87,7 +87,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
             Scope::make('published', 'wherePublished')->asBoolean(),
             Where::make('slug')->singular(),
             OnlyTrashed::make('trashed'),

tests/dummy/app/JsonApi/V1/Tags/TagSchema.php

@@ -22,12 +22,12 @@
 use App\Models\Tag;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
-use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsToMany;
 use LaravelJsonApi\Eloquent\Fields\Str;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
+use LaravelJsonApi\HashIds\HashId;
 
 class TagSchema extends Schema
 {
@@ -45,7 +45,7 @@ class TagSchema extends Schema
     public function fields(): array
     {
         return [
-            ID::make(),
+            HashId::make()->alreadyEncoded(),
             DateTime::make('createdAt')->sortable()->readOnly(),
             Str::make('name')->sortable(),
             BelongsToMany::make('posts')
@@ -64,7 +64,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
         ];
     }
 

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

@@ -22,12 +22,12 @@
 use App\Models\User;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
-use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Str;
 use LaravelJsonApi\Eloquent\Filters\Where;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
+use LaravelJsonApi\HashIds\HashId;
 
 class UserSchema extends Schema
 {
@@ -45,7 +45,7 @@ class UserSchema extends Schema
     public function fields(): array
     {
         return [
-            ID::make(),
+            HashId::make()->alreadyEncoded(),
             DateTime::make('createdAt')->readOnly(),
             Str::make('name'),
             DateTime::make('updatedAt')->readOnly(),
@@ -58,7 +58,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
             Where::make('email')->singular(),
         ];
     }

tests/dummy/app/JsonApi/V1/Videos/VideoSchema.php

@@ -25,7 +25,7 @@
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsToMany;
 use LaravelJsonApi\Eloquent\Fields\Str;
-use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
 
@@ -60,7 +60,7 @@ public function fields(): array
     public function filters(): array
     {
         return [
-            WhereIn::make('id', $this->idColumn())->delimiter(','),
+            WhereIdIn::make($this)->delimiter(','),
         ];
     }
 

tests/dummy/app/Models/Comment.php

@@ -27,6 +27,7 @@ class Comment extends Model
 {
 
     use HasFactory;
+    use Concerns\HashRouteKey;
 
     /**
      * @var string[]

tests/dummy/app/Models/Concerns/HashRouteKey.php

@@ -0,0 +1,60 @@
+<?php
+/*
+ * Copyright 2021 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\Models\Concerns;
+
+use Vinkla\Hashids\Facades\Hashids;
+
+trait HashRouteKey
+{
+
+    /**
+     * Get the value of the model's route key.
+     *
+     * @return string
+     */
+    public function getRouteKey()
+    {
+        return Hashids::encode(
+            $this->getAttribute($this->getRouteKeyName())
+        );
+    }
+
+    /**
+     * Retrieve the model for a bound value.
+     *
+     * @param  mixed  $value
+     * @param  string|null  $field
+     * @return \Illuminate\Database\Eloquent\Model|null
+     */
+    public function resolveRouteBinding($value, $field = null)
+    {
+        if (empty($field) || $field === $this->getRouteKeyName()) {
+            return $this->newQuery()->where(
+                $field ?: $this->getRouteKeyName(),
+                Hashids::decode($value)
+            )->firstOrFail();
+        }
+
+        return $this
+            ->newQuery()
+            ->where($field, $value)
+            ->firstOrFail();
+    }
+}

tests/dummy/app/Models/Post.php

@@ -31,6 +31,7 @@ class Post extends Model
 
     use HasFactory;
     use SoftDeletes;
+    use Concerns\HashRouteKey;
 
     /**
      * @var string[]

tests/dummy/app/Models/Tag.php

@@ -27,6 +27,7 @@ class Tag extends Model
 {
 
     use HasFactory;
+    use Concerns\HashRouteKey;
 
     /**
      * @var string[]

tests/dummy/app/Models/User.php

@@ -26,6 +26,7 @@ class User extends Authenticatable
 
     use HasFactory;
     use Notifiable;
+    use Concerns\HashRouteKey;
 
     /**
      * The attributes that are mass assignable.