PHPORM-147 Make id an alias for _id

[GromNaN]

Fix PHPORM-147
Fix #3022 (PHPORM-201)
Fix #2489

Laravel and Eloquent uses id as conventional field name for models and various queries. MongoDB's primary key is called _id. The name is source of various issues with Laravel packages:

• DatabaseSessionHandler [Feature Request] SessionServiceProvider for database #3022 (comment)
• User email validation Support distinct PK for User model laravel/breeze#357

Breaking change: it is no longer possible to set a different value for id and _id. If you need a distinct ID field, use an other name.

Checklist

• Add tests and ensure they pass
• Add an entry to the CHANGELOG.md file
• Update documentation for new features

[bisht2050]

Should this target a major release?

[masterbater]

Seems like a minor breaking change, since id is already correlated with _id. Hopefully this get merged soon. This is a must update that can also unblock more laravel packages together with DocumentModel trait.
@GromNaN 🫡🙏🏻thanks for being thoughtful of the community

[alcaeus]

I'll admit, I'm not entirely convinced we want to break BC in a minor release, but given the state of the whole _id vs. id situation, it might be better to just get this over with.

Correct me if I'm wrong, but as I understand the current situation is:

• Models always have an _id field
• The value of _id is returned when fetching the id field
• Using id in the query builder is already changed to use _id

With this change, we're using the value of id for _id when saving models, but throw if there are different values for id and _id. This ensures that other libraries are able to query MongoDB models the same way they query relational models. Did I understand all of this correctly?

[GromNaN]

Using id in the query builder is already changed to use _id

_id was already used by the Query\Builder::find method. But a where('id', <value>) was not converted to { "_id": <value> }. With Eloquent models, there is already an alias when the attribute id is read

laravel-mongodb/src/Eloquent/DocumentModel.php

Lines 75 to 81 in f654b83

	public function getIdAttribute($value = null)
	{
	// If we don't have a value for 'id', we will use the MongoDB '_id' value.
	// This allows us to work with models in a more sql-like way.
	if (! $value && array_key_exists('_id', $this->attributes)) {
	$value = $this->attributes['_id'];
	}

[rustagir]

lgtm

[GromNaN]

I was on the fence about unsetting _id or not. That's why I left this comment:

laravel-mongodb/src/Query/Builder.php

Line 1662 in 7551f76

//unset($values['_id']);

It makes it impossible to work with _id in result as it would be natively, while _id or id can both be used in a query.

Thanks for your feedback. It seems that we should unset _id indead.

[masterbater]

I dont know if this an issue or anything that can be improved for now I made adjustment on my side by unsetting the _id field
Example

Address model
User with address field

$address = Address::find(objectIdhere);
  // unset($address ['_id']); Solution
$users = User::insert([
                        'name' => $user->fullname,
                        'username' => $user->username,
                        'address' => $address->toArray()])

Cannot have both "id" and "_id" fields. {"exception":"[object] (InvalidArgumentException(code: 0): Cannot have both "id" and "_id" fields. at /app/vendor/mongodb/laravel-mongodb/src/Query/Builder.php:1620)
It seems good that it can detect also nested documents that has both id and _id, but is there a way it only returns id or do we just need to keep unsettting the _id field

[GromNaN]

We can also detect when _id === id in a query and unset(id). That would solve your issue.

[masterbater]

I was on the fence about unsetting _id or not. That's why I left this comment:

laravel-mongodb/src/Query/Builder.php

Line 1662 in 7551f76

//unset($values['_id']);

It makes it impossible to work with _id in result as it would be natively, while _id or id can both be used in a query.

Thanks for your feedback. It seems that we should unset _id indeed.

Thanks for replying so fast, I edited my question now its below to the answer hahaha.

So the aliasIdForResult will just return the id field, but we cant access the native _id Objectid. This would be in line to Laravel behavior but probably needs to be documented. This is acceptable though just like prisma uses id for mongodb too.

[masterbater]

We can also detect when _id === id in a query and unset(id). That would solve your issue.

When using v5 I always assume that _id is non existent so I always use id both for saving data and retrieving it.