feat: replace skipDuplicates with OnDuplicate enum (Fail/Skip/Upsert) #861
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ | |
| use Utopia\Database\Exception\Timeout as TimeoutException; | ||
| use Utopia\Database\Exception\Transaction as TransactionException; | ||
| use Utopia\Database\Exception\Type as TypeException; | ||
| use Utopia\Database\OnDuplicate; | ||
| use Utopia\Database\Query; | ||
| use Utopia\Database\Validator\Authorization; | ||
| use Utopia\Mongo\Client; | ||
|
|
@@ -123,7 +124,8 @@ public function withTransaction(callable $callback): mixed | |
| } | ||
|
|
||
| // upsert + $setOnInsert hits WriteConflict (E112) under txn snapshot isolation. | ||
| // Both Skip and Upsert modes use the no-transaction path. | ||
| if ($this->onDuplicate !== OnDuplicate::Fail) { | ||
| return $callback(); | ||
| } | ||
|
|
||
|
|
@@ -429,10 +431,12 @@ public function createCollection(string $name, array $attributes = [], array $in | |
| { | ||
| $id = $this->getNamespace() . '_' . $this->filter($name); | ||
|
|
||
| // In shared-tables mode or for metadata the physical collection may | ||
| // already exist. Return early to avoid "Collection Exists" from the | ||
| // client. | ||
| $tolerateExisting = $this->getSharedTables() || $name === Database::METADATA; | ||
|
|
||
| if (!$this->inTransaction && $tolerateExisting && $this->exists($this->getNamespace(), $name)) { | ||
| return true; | ||
| } | ||
|
|
||
|
|
@@ -443,14 +447,15 @@ public function createCollection(string $name, array $attributes = [], array $in | |
| } catch (MongoException $e) { | ||
| $e = $this->processException($e); | ||
| if ($e instanceof DuplicateException) { | ||
| // Keep existing shared-tables/metadata behavior — no-op there. | ||
| return true; | ||
|
Comment on lines
449
to
451
Contributor
There was a problem hiding this comment. Preserve After 🐛 Proposed fix if ($e instanceof DuplicateException) {
// Also tolerate client-reported duplicates in Skip/Upsert mode.
if ($tolerateExisting) {
return true;
}
- // Keep existing shared-tables/metadata behavior — no-op there.
- return true;
+ throw $e;
}🤖 Prompt for AI Agents |
||
| } | ||
| // Client throws code-0 "Collection Exists" when its pre-check | ||
| // finds the collection. Tolerated contexts no-op; otherwise re-throw | ||
| // as DuplicateException so Database::createCollection() can run | ||
| // orphan reconciliation. | ||
| if ($e->getCode() === 0 && stripos($e->getMessage(), 'Collection Exists') !== false) { | ||
| if ($tolerateExisting) { | ||
| return true; | ||
| } | ||
| throw new DuplicateException('Collection already exists', $e->getCode(), $e); | ||
|
|
@@ -1497,30 +1502,33 @@ public function createDocuments(Document $collection, array $documents): array | |
| $records[] = $record; | ||
| } | ||
|
|
||
| // insertMany aborts the txn on any duplicate; Mongo's upsert path handles | ||
| // both Skip ($setOnInsert: insert-only no-op) and Upsert ($set: overwrite). | ||
| if ($this->onDuplicate !== OnDuplicate::Fail) { | ||
| if (empty($records)) { | ||
| return []; | ||
| } | ||
|
|
||
| $operator = $this->onDuplicate === OnDuplicate::Upsert ? '$set' : '$setOnInsert'; | ||
|
|
||
| $operations = []; | ||
| foreach ($records as $record) { | ||
| $filter = ['_uid' => $record['_uid'] ?? '']; | ||
| if ($this->sharedTables) { | ||
| $filter['_tenant'] = $record['_tenant'] ?? $this->getTenant(); | ||
| } | ||
|
|
||
| // Filter fields can't reappear in $setOnInsert/$set (mongo path-conflict error). | ||
| $payload = $record; | ||
| unset($payload['_uid'], $payload['_tenant']); | ||
|
Comment on lines
+1521
to
+1523
There was a problem hiding this comment.
Every call to The $payload = $record;
unset($payload['_uid'], $payload['_tenant']);
$idValue = $payload['_id'] ?? null;
unset($payload['_id']);
$update = [$operator => $payload];
if ($operator === '$set' && $idValue !== null) {
$update['$setOnInsert'] = ['_id' => $idValue];
}
$operations[] = [
'filter' => $filter,
'update' => $update,
]; |
||
|
|
||
| if (empty($payload)) { | ||
| continue; | ||
| } | ||
|
|
||
| $operations[] = [ | ||
| 'filter' => $filter, | ||
| 'update' => [$operator => $payload], | ||
|
Comment on lines
+1521
to
+1531
Contributor
There was a problem hiding this comment. 🧩 Analysis chain🌐 Web query:
💡 Result: In MongoDB, the _id field is immutable and cannot be modified once a document exists. Attempting to use $set on _id in an update operation (with or without upsert) will fail with an error like "Performing an update on the path '_id' would modify the immutable field '_id'". For upsert operations (upsert: true), the _id is determined by the query filter if it specifies _id. For example: db.collection.updateOne( { _id: ObjectId("...") }, { $set: { field: "value" } }, { upsert: true } ) If no document matches, MongoDB inserts a new document using the _id from the query filter, applying the update operators (like $set). $setOnInsert operators are also applied only on insert. Do not include _id in $set or $setOnInsert in the update document, as MongoDB will reject attempts to set _id via update operators even with $setOnInsert (historical behavior confirmed in sources, fixed in later versions but still not recommended). Instead, specify _id in the query filter for controlled upserts. Example of correct upsert without setting _id in update: db.collection.updateOne( { _id: 123 }, { $set: { status: "active" }, $setOnInsert: { createdAt: new Date } }, { upsert: true } ) This sets _id: 123 on insert from the query, applies both $set and $setOnInsert on insert, or only $set on update. If the query doesn't specify _id, MongoDB auto-generates ObjectId for _id on insert. Citations:
🏁 Script executed: # Find and examine the upsert operation context in Mongo.php around lines 1527-1537
cd src/Database/Adapter && head -1560 Mongo.php | tail -50Repository: utopia-php/database Length of output: 1846 🏁 Script executed: # Get broader context of the upsert method to understand filter and payload construction
cd src/Database/Adapter && sed -n '1480,1560p' Mongo.phpRepository: utopia-php/database Length of output: 2845 Strip In 🔧 Suggested approachInclude $filter = ['_uid' => $record['_uid'] ?? ''];
+ if (\array_key_exists('_id', $record)) {
+ $filter['_id'] = $record['_id'];
+ }
if ($this->sharedTables) {
$filter['_tenant'] = $record['_tenant'] ?? $this->getTenant();
}
// Filter fields can't reappear in $setOnInsert/$set (mongo path-conflict error).
$payload = $record;
- unset($payload['_uid'], $payload['_tenant']);
+ unset($payload['_uid'], $payload['_tenant'], $payload['_id']);This way, 🤖 Prompt for AI Agents |
||
| ]; | ||
| } | ||
|
|
||
|
|
@@ -3590,8 +3598,8 @@ protected function processException(\Throwable $e): \Throwable | |
| return new DuplicateException('Collection already exists', $e->getCode(), $e); | ||
| } | ||
|
|
||
| // Index already exists (85 = IndexOptionsConflict, 86 = IndexKeySpecsConflict) | ||
| if ($e->getCode() === 85 || $e->getCode() === 86) { | ||
| return new DuplicateException('Index already exists', $e->getCode(), $e); | ||
| } | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.