A free open source IT asset/license management system
Fixed RB-22017 - better handle asset listing for models when no RMB ID is given
snipeaad47ce620fe
diff --git a/app/Http/Controllers/Api/AssetModelsController.php b/app/Http/Controllers/Api/AssetModelsController.phpindex d4a326146c..fce0a03206 100644--- a/app/Http/Controllers/Api/AssetModelsController.php+++ b/app/Http/Controllers/Api/AssetModelsController.php@@ -216,12 +216,39 @@ class AssetModelsController extends Controller** @param int $id*/- public function assets($id): array+ public function assets(Request $request, $id): JsonResponse|array{$this->authorize('view', AssetModel::class);- $assets = Asset::where('model_id', '=', $id)->get();+ $model = AssetModel::findOrFail($id);++ // Eager-load the same relations AssetsTransformer walks per row.+ // Without this, a page of 500 assets triggers 500-plus follow-up+ // queries for status, company, assignedTo, adminuser, and the+ // model / manufacturer / category chain the transformer expands+ // on each row.+ $assets = Asset::where('model_id', $model->id)+ ->with(+ 'model',+ 'model.category',+ 'model.manufacturer',+ 'model.depreciation',+ 'model.fieldset',+ 'location',+ 'defaultLoc',+ 'status',+ 'company',+ 'assignedTo',+ 'adminuser',+ 'supplier',+ );++ $total = $assets->count();+ $offset = ($request->input('offset') > $total) ? $total : app('api_offset_value');+ $limit = app('api_limit_value');++ $assets = $assets->skip($offset)->take($limit)->get();- return (new AssetsTransformer)->transformAssets($assets, $assets->count());+ return (new AssetsTransformer)->transformAssets($assets, $total);}/**diff --git a/routes/api.php b/routes/api.phpindex 28bd4944be..b72fc65998 100644--- a/routes/api.php+++ b/routes/api.php@@ -991,7 +991,7 @@ Route::group(['prefix' => 'v1', 'middleware' => ['api', 'api-throttle:api']], fu])->name('api.models.selectlist');- Route::get('assets',+ Route::get('{id}/assets',[Api\AssetModelsController::class,'assets',diff --git a/tests/Feature/AssetModels/Api/AssetsForAssetModelTest.php b/tests/Feature/AssetModels/Api/AssetsForAssetModelTest.phpnew file mode 100644index 0000000000..bec6b354d8--- /dev/null+++ b/tests/Feature/AssetModels/Api/AssetsForAssetModelTest.php@@ -0,0 +1,122 @@+<?php++namespace Tests\Feature\AssetModels\Api;++use App\Models\Asset;+use App\Models\AssetModel;+use App\Models\User;+use Illuminate\Testing\Fluent\AssertableJson;+use Tests\TestCase;++/**+ * Covers GET /api/v1/models/{id}/assets. The route was reintroduced+ * after landing inside a `models/` prefix group had accidentally+ * dropped the {id} path segment, which routed calls to the id-less+ * `models/assets` at the assets() controller method and blew up with+ * ArgumentCountError because the method requires the id.+ */+class AssetsForAssetModelTest extends TestCase+{+ public function test_viewing_assets_for_asset_model_requires_authentication()+ {+ $model = AssetModel::factory()->create();++ $this->getJson(route('api.models.assets', ['id' => $model->id]))+ ->assertUnauthorized();+ }++ public function test_viewing_assets_for_asset_model_requires_permission()+ {+ $model = AssetModel::factory()->create();++ $this->actingAsForApi(User::factory()->create())+ ->getJson(route('api.models.assets', ['id' => $model->id]))+ ->assertForbidden();+ }++ public function test_error_returned_if_asset_model_does_not_exist()+ {+ // Snipe-IT's exception handler returns 200 + status "error" for+ // ModelNotFoundException on API requests, matching what the+ // sibling AssetModel endpoints already do (see+ // RestoreAssetModelTest::test_error_returned_if_asset_model_does_not_exist).+ $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => 999999]))+ ->assertOk()+ ->assertStatusMessageIs('error');+ }++ public function test_returns_only_assets_belonging_to_the_named_model()+ {+ $targetModel = AssetModel::factory()->create();+ $otherModel = AssetModel::factory()->create();++ $targetAssets = Asset::factory()->count(3)->create(['model_id' => $targetModel->id]);+ Asset::factory()->count(2)->create(['model_id' => $otherModel->id]);++ $response = $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => $targetModel->id]))+ ->assertOk()+ ->assertJsonStructure(['total', 'rows'])+ ->assertJson(fn (AssertableJson $json) => $json+ ->where('total', 3)+ ->has('rows', 3)+ ->etc());++ $returnedIds = collect($response->json('rows'))->pluck('id')->sort()->values()->all();+ $expectedIds = $targetAssets->pluck('id')->sort()->values()->all();+ $this->assertSame($expectedIds, $returnedIds);+ }++ public function test_returns_empty_list_when_model_has_no_assets()+ {+ $model = AssetModel::factory()->create();++ $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => $model->id]))+ ->assertOk()+ ->assertJson(fn (AssertableJson $json) => $json+ ->where('total', 0)+ ->has('rows', 0)+ ->etc());+ }++ public function test_limit_query_parameter_bounds_the_returned_rows()+ {+ $model = AssetModel::factory()->create();+ Asset::factory()->count(5)->create(['model_id' => $model->id]);++ // total should reflect the full matching set. rows should+ // reflect the requested page size. Pagination is what makes+ // this endpoint safe against models with thousands of assets.+ $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => $model->id, 'limit' => 2]))+ ->assertOk()+ ->assertJson(fn (AssertableJson $json) => $json+ ->where('total', 5)+ ->has('rows', 2)+ ->etc());+ }++ public function test_offset_query_parameter_skips_earlier_rows()+ {+ $model = AssetModel::factory()->create();+ Asset::factory()->count(5)->create(['model_id' => $model->id]);++ $firstPage = $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => $model->id, 'limit' => 2, 'offset' => 0]))+ ->assertOk()+ ->json('rows');++ $secondPage = $this->actingAsForApi(User::factory()->superuser()->create())+ ->getJson(route('api.models.assets', ['id' => $model->id, 'limit' => 2, 'offset' => 2]))+ ->assertOk()+ ->json('rows');++ $this->assertCount(2, $firstPage);+ $this->assertCount(2, $secondPage);+ $firstPageIds = collect($firstPage)->pluck('id')->all();+ $secondPageIds = collect($secondPage)->pluck('id')->all();+ $this->assertEmpty(array_intersect($firstPageIds, $secondPageIds), 'Offset pagination must not overlap between pages.');+ }+}