Skip to content

A free open source IT asset/license management system

One more N+1 fix

snipe08601b65cce7
diff --git a/app/Http/Controllers/Api/CustomFieldsetsController.php b/app/Http/Controllers/Api/CustomFieldsetsController.php
index c0a65a239e..5cf1442cbd 100644
--- a/app/Http/Controllers/Api/CustomFieldsetsController.php
+++ b/app/Http/Controllers/Api/CustomFieldsetsController.php
@@ -170,7 +170,12 @@ class CustomFieldsetsController extends Controller
{
$this->authorize('view', CustomField::class);
$set = CustomFieldset::findOrFail($fieldsetId);
- $fields = $set->fields;
+
+ // Constrain the eager load to only the one models_custom_fields pivot
+ // row that matches this specific model
+ $fields = $set->fields()
+ ->with(['defaultValues' => fn($q) => $q->wherePivot('asset_model_id', $modelId)])
+ ->get();
return (new CustomFieldsTransformer)->transformCustomFieldsWithDefaultValues($fields, $modelId, $fields->count());
}
diff --git a/tests/Feature/CustomFieldsets/Api/FieldsWithDefaultValuesTest.php b/tests/Feature/CustomFieldsets/Api/FieldsWithDefaultValuesTest.php
new file mode 100644
index 0000000000..8d89dd0774
--- /dev/null
+++ b/tests/Feature/CustomFieldsets/Api/FieldsWithDefaultValuesTest.php
@@ -0,0 +1,99 @@
+<?php
+
+namespace Tests\Feature\CustomFieldsets\Api;
+
+use App\Models\AssetModel;
+use App\Models\CustomField;
+use App\Models\CustomFieldset;
+use App\Models\User;
+use Illuminate\Support\Facades\DB;
+use Tests\TestCase;
+
+class FieldsWithDefaultValuesTest extends TestCase
+{
+ public function test_returns_fields_with_resolved_default_values_for_the_given_model()
+ {
+ $this->markIncompleteIfMySQL('Custom Fields tests do not work on MySQL');
+
+ $fieldA = CustomField::factory()->create(['name' => 'FieldOneName']);
+ $fieldB = CustomField::factory()->create(['name' => 'FieldTwoName']);
+
+ $fieldset = CustomFieldset::factory()->create();
+ $fieldset->fields()->attach($fieldA->id, ['order' => 1, 'required' => false]);
+ $fieldset->fields()->attach($fieldB->id, ['order' => 2, 'required' => false]);
+
+ $model = AssetModel::factory()->create(['fieldset_id' => $fieldset->id]);
+ $model->defaultValues()->attach($fieldA->id, ['default_value' => 'aa:bb:cc:dd:ee:ff']);
+ $model->defaultValues()->attach($fieldB->id, ['default_value' => '16GB']);
+
+ $superuser = User::factory()->superuser()->create();
+
+ $response = $this->actingAsForApi($superuser)
+ ->postJson(route('api.fieldsets.fields-with-default-value', [
+ 'fieldset' => $fieldset->id,
+ 'model' => $model->id,
+ ]))
+ ->assertOk()
+ ->json();
+
+ $byId = [];
+ foreach ($response['rows'] as $row) {
+ $byId[$row['id']] = $row;
+ }
+ $this->assertSame('aa:bb:cc:dd:ee:ff', $byId[$fieldA->id]['default_value']);
+ $this->assertSame('16GB', $byId[$fieldB->id]['default_value']);
+ }
+
+ public function test_does_not_lazy_load_default_values_per_field()
+ {
+ // Regression test for the N+1 on CustomField::defaultValue($modelId)
+ // on the fieldset-with-defaults endpoint. The controller used to
+ // read $set->fields (lazy-loaded, no relation hint) and the
+ // transformer called $field->defaultValue($modelId) per field,
+ // each firing a `SELECT models.* INNER JOIN models_custom_fields`
+ // against the full set of AssetModel rows with any default for
+ // that field. The fix constrains an eager-load of defaultValues
+ // to the one pivot row that matches the requested model, so the
+ // pivot walk collapses to a single query.
+ $this->markIncompleteIfMySQL('Custom Fields tests do not work on MySQL');
+
+ $fieldA = CustomField::factory()->create(['name' => 'RegressionFieldA']);
+ $fieldB = CustomField::factory()->create(['name' => 'RegressionFieldB']);
+ $fieldC = CustomField::factory()->create(['name' => 'RegressionFieldC']);
+
+ $fieldset = CustomFieldset::factory()->create();
+ $fieldset->fields()->attach($fieldA->id, ['order' => 1, 'required' => false]);
+ $fieldset->fields()->attach($fieldB->id, ['order' => 2, 'required' => false]);
+ $fieldset->fields()->attach($fieldC->id, ['order' => 3, 'required' => false]);
+
+ $model = AssetModel::factory()->create(['fieldset_id' => $fieldset->id]);
+ $model->defaultValues()->attach($fieldA->id, ['default_value' => 'default-mac']);
+ $model->defaultValues()->attach($fieldB->id, ['default_value' => 'default-ram']);
+ $model->defaultValues()->attach($fieldC->id, ['default_value' => 'default-cpu']);
+
+ $superuser = User::factory()->superuser()->create();
+
+ DB::enableQueryLog();
+
+ $this->actingAsForApi($superuser)
+ ->postJson(route('api.fieldsets.fields-with-default-value', [
+ 'fieldset' => $fieldset->id,
+ 'model' => $model->id,
+ ]))
+ ->assertOk();
+
+ $queries = DB::getQueryLog();
+ DB::disableQueryLog();
+
+ $pivotWalks = collect($queries)
+ ->filter(fn ($q) => str_contains($q['query'], '`models`')
+ && str_contains($q['query'], 'inner join `models_custom_fields`'))
+ ->count();
+
+ $this->assertLessThanOrEqual(
+ 1,
+ $pivotWalks,
+ 'Endpoint fired '.$pivotWalks.' models <-> models_custom_fields pivot queries. Expected at most 1 (the constrained eager load upfront).'
+ );
+ }
+}