feat: add Model::firstOrInsert() with failure handling

system/BaseModel.php

@@ -18,6 +18,7 @@
 use CodeIgniter\Database\BaseResult;
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use CodeIgniter\Database\Exceptions\DataException;
+use CodeIgniter\Database\Exceptions\UniqueConstraintViolationException;
 use CodeIgniter\Database\Query;
 use CodeIgniter\Database\RawSql;
 use CodeIgniter\DataCaster\Cast\CastInterface;
@@ -869,6 +870,7 @@ protected function validateID(mixed $id, bool $allowArray = true): void
      * @return ($returnID is true ? false|int|string : bool)
      *
      * @throws ReflectionException
+     * @throws UniqueConstraintViolationException
      */
     public function insert($row = null, bool $returnID = true)
     {

system/Model.php

@@ -19,6 +19,7 @@
 use CodeIgniter\Database\ConnectionInterface;
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use CodeIgniter\Database\Exceptions\DataException;
+use CodeIgniter\Database\Exceptions\UniqueConstraintViolationException;
 use CodeIgniter\Entity\Entity;
 use CodeIgniter\Exceptions\BadMethodCallException;
 use CodeIgniter\Exceptions\InvalidArgumentException;
@@ -715,6 +716,54 @@ protected function doProtectFieldsForInsert(array $row): array
         return $row;
     }
 
+    /**
+     * Finds the first row matching attributes or inserts a new row.
+     *
+     * Note: without a DB unique constraint, this is not race-safe.
+     *
+     * @param array<string, mixed>|object $attributes
+     * @param array<string, mixed>|object $values
+     *
+     * @return array<string, mixed>|false|object
+     */
+    public function firstOrInsert(array|object $attributes, array|object $values = []): array|false|object
+    {
+        if (is_object($attributes)) {
+            $attributes = $this->transformDataToArray($attributes, 'insert');
+        }
+
+        if ($attributes === []) {
+            throw new InvalidArgumentException('firstOrInsert() requires non-empty $attributes.');
+        }
+
+        $row = $this->where($attributes)->first();
+        if ($row !== null) {
+            return $row;
+        }
+
+        if (is_object($values)) {
+            $values = $this->transformDataToArray($values, 'insert');
+        }
+
+        $data = array_merge($attributes, $values);
+
+        try {
+            $id = $this->insert($data);
+        } catch (UniqueConstraintViolationException) {
+            return $this->where($attributes)->first() ?? false;
+        }
+
+        if ($id === false) {
+            if ($this->db->getLastException() instanceof UniqueConstraintViolationException) {
+                return $this->where($attributes)->first() ?? false;
+            }
+
+            return false;
+        }
+
+        return $this->where($this->primaryKey, $id)->first() ?? false;
+    }
+
     public function update($id = null, $row = null): bool
     {
         if (isset($this->tempData['data'])) {

tests/system/Models/FirstOrInsertModelTest.php

@@ -0,0 +1,271 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Models;
+
+use CodeIgniter\Database\Exceptions\DatabaseException;
+use CodeIgniter\Database\Exceptions\UniqueConstraintViolationException;
+use CodeIgniter\Exceptions\InvalidArgumentException;
+use PHPUnit\Framework\Attributes\Group;
+use ReflectionProperty;
+use stdClass;
+use Tests\Support\Models\UserModel;
+
+/**
+ * @internal
+ */
+#[Group('DatabaseLive')]
+final class FirstOrInsertModelTest extends LiveModelTestCase
+{
+    protected function tearDown(): void
+    {
+        $this->enableDBDebug();
+        parent::tearDown();
+    }
+
+    public function testReturnsExistingRecord(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $row = $this->model->firstOrInsert(['email' => '[email protected]']);
+
+        $this->assertIsObject($row);
+        $this->assertSame('Derek Jones', $row->name);
+        $this->assertSame('[email protected]', $row->email);
+        $this->assertSame('US', $row->country);
+    }
+
+    public function testDoesNotInsertWhenRecordExists(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $this->model->firstOrInsert(['email' => '[email protected]']);
+
+        // Seeder inserts 4 users; calling firstOrInsert on an existing
+        // record must not add a fifth one.
+        $this->seeNumRecords(4, 'user', ['deleted_at' => null]);
+    }
+
+    public function testValuesAreIgnoredWhenRecordExists(): void
+    {
+        $this->createModel(UserModel::class);
+
+        // The $values array must not be used to modify the found record.
+        $row = $this->model->firstOrInsert(
+            ['email' => '[email protected]'],
+            ['name' => 'Should Not Change', 'country' => 'XX'],
+        );
+
+        $this->assertIsObject($row);
+        $this->assertSame('Derek Jones', $row->name);
+        $this->assertSame('US', $row->country);
+    }
+
+    public function testInsertsNewRecordWhenNotFound(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $row = $this->model->firstOrInsert([
+            'name'    => 'New User',
+            'email'   => '[email protected]',
+            'country' => 'US',
+        ]);
+
+        $this->assertIsObject($row);
+        $this->assertSame('[email protected]', $row->email);
+        $this->seeInDatabase('user', ['email' => '[email protected]', 'deleted_at' => null]);
+    }
+
+    public function testMergesValuesOnInsert(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $row = $this->model->firstOrInsert(
+            ['email' => '[email protected]'],
+            ['name' => 'New User', 'country' => 'CA'],
+        );
+
+        $this->assertIsObject($row);
+        $this->assertSame('New User', $row->name);
+        $this->assertSame('CA', $row->country);
+        $this->seeInDatabase('user', [
+            'email'      => '[email protected]',
+            'name'       => 'New User',
+            'country'    => 'CA',
+            'deleted_at' => null,
+        ]);
+    }
+
+    public function testAcceptsObjectForValues(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $values          = new stdClass();
+        $values->name    = 'Object User';
+        $values->country = 'DE';
+
+        $row = $this->model->firstOrInsert(
+            ['email' => '[email protected]'],
+            $values,
+        );
+
+        $this->assertIsObject($row);
+        $this->assertSame('Object User', $row->name);
+        $this->assertSame('DE', $row->country);
+        $this->seeInDatabase('user', ['email' => '[email protected]', 'deleted_at' => null]);
+    }
+
+    public function testAcceptsObjectForAttributes(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $attributes        = new stdClass();
+        $attributes->email = '[email protected]';
+
+        $row = $this->model->firstOrInsert($attributes);
+
+        $this->assertIsObject($row);
+        $this->assertSame('Derek Jones', $row->name);
+        $this->seeNumRecords(4, 'user', ['deleted_at' => null]);
+    }
+
+    public function testAcceptsObjectForAttributesAndInsertsWhenNotFound(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $attributes          = new stdClass();
+        $attributes->email   = '[email protected]';
+        $attributes->name    = 'New User';
+        $attributes->country = 'US';
+
+        $row = $this->model->firstOrInsert($attributes);
+
+        $this->assertIsObject($row);
+        $this->assertSame('[email protected]', $row->email);
+        $this->seeInDatabase('user', ['email' => '[email protected]', 'deleted_at' => null]);
+    }
+
+    public function testThrowsOnEmptyAttributes(): void
+    {
+        $this->createModel(UserModel::class);
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->model->firstOrInsert([]);
+    }
+
+    public function testHandlesRaceConditionWithDebugEnabled(): void
+    {
+        // Subclass that simulates a concurrent insert winning the race:
+        // doInsert() first persists the row (the "other process"), then
+        // throws UniqueConstraintViolationException as if our own attempt
+        // also tried to insert the same row.
+        $model = new class ($this->db) extends UserModel {
+            protected function doInsert(array $row): bool
+            {
+                parent::doInsert($row);
+
+                throw new UniqueConstraintViolationException('Duplicate entry');
+            }
+        };
+
+        $row = $model->firstOrInsert(
+            ['email' => '[email protected]'],
+            ['name' => 'Race User', 'country' => 'US'],
+        );
+
+        $this->assertIsObject($row);
+        $this->assertSame('[email protected]', $row->email);
+        // The "other process" inserted exactly one record.
+        $this->seeNumRecords(1, 'user', ['email' => '[email protected]', 'deleted_at' => null]);
+    }
+
+    public function testHandlesRaceConditionWithDebugDisabled(): void
+    {
+        $this->disableDBDebug();
+
+        // Subclass that simulates a concurrent insert: the "other process"
+        // inserts via a direct DB call, then our own attempt fails with a
+        // unique violation which is stored in lastException (DBDebug=false).
+        $model = new class ($this->db) extends UserModel {
+            protected function doInsert(array $row): bool
+            {
+                // Direct insert – bypasses the model so it won't interfere
+                // with the model's own builder state.
+                $this->db->table($this->table)->insert([
+                    'name'    => $row['name'],
+                    'email'   => $row['email'],
+                    'country' => $row['country'],
+                ]);
+
+                // The real insert now fails; the driver stores
+                // UniqueConstraintViolationException in lastException.
+                return parent::doInsert($row);
+            }
+        };
+
+        $row = $model->firstOrInsert(
+            ['email' => '[email protected]'],
+            ['name' => 'Race User', 'country' => 'US'],
+        );
+
+        $this->assertIsObject($row);
+        $this->assertSame('[email protected]', $row->email);
+        $this->seeNumRecords(1, 'user', ['email' => '[email protected]', 'deleted_at' => null]);
+    }
+
+    public function testReturnsFalseOnNonUniqueErrorWithDebugDisabled(): void
+    {
+        $this->disableDBDebug();
+
+        // Subclass that simulates a non-unique database error by placing
+        // a plain DatabaseException (not UniqueConstraintViolationException)
+        // into lastException and returning false.
+        $model = new class ($this->db) extends UserModel {
+            protected function doInsert(array $row): bool
+            {
+                $prop = new ReflectionProperty($this->db, 'lastException');
+                $prop->setValue($this->db, new DatabaseException('Connection error'));
+
+                return false;
+            }
+        };
+
+        $result = $model->firstOrInsert(
+            ['email' => '[email protected]'],
+            ['name' => 'Error User', 'country' => 'US'],
+        );
+
+        $this->assertFalse($result);
+        $this->dontSeeInDatabase('user', ['email' => '[email protected]']);
+    }
+
+    public function testReturnsFalseOnValidationFailure(): void
+    {
+        // Subclass with strict validation rules that the test data fails.
+        $model = new class ($this->db) extends UserModel {
+            protected $validationRules = [
+                'email' => 'required|valid_email',
+                'name'  => 'required|min_length[50]',
+            ];
+        };
+
+        $result = $model->firstOrInsert(
+            ['email' => 'not-a-valid-email'],
+            ['name' => 'Too Short'],
+        );
+
+        $this->assertFalse($result);
+        $this->dontSeeInDatabase('user', ['email' => 'not-a-valid-email']);
+        $this->assertNotEmpty($model->errors());
+    }
+}

user_guide_src/source/changelogs/v4.8.0.rst

@@ -168,6 +168,7 @@ Model
 =====
 
 - Added new ``chunkRows()`` method to ``CodeIgniter\Model`` for processing large datasets in smaller chunks.
+- Added new ``firstOrInsert()`` method to ``CodeIgniter\Model`` that finds the first row matching the given attributes or inserts a new one. See :ref:`model-first-or-insert`.
 
 Libraries
 =========