Add optional MorphPivot to HasRoles::roles() relation (teams active)

[Cyrille37]

Hi,

To automatically fill some pivot data, like team_id, with an Observer or Event, it miss the MorphPivot to the HasRoles::roles() relation.

To make it possible I add a config('permission.models.role_pivot')
like 'role_pivot' => \App\Models\Permission\ModelHasRole::class

Then override the HasRoles::roles() in case of teams is active :

...
        $relation->wherePivot($teamsKey, getPermissionsTeamId())
            ->where(fn ($q) => $q->whereNull($teamField)->orWhere($teamField, getPermissionsTeamId()));
        if( config('permission.models.role_pivot') )
        {
            $relation->using(config('permission.models.role_pivot'));
        }
        return $relation;

Then I can have an Observer or Event that automatically fill some role data :

static::saving(function (Model $model) {
	$key = config('permission.column_names.team_foreign_key');
	if( $model->{$key} == null )
	{
		$model->{$key} = getPermissionsTeamId() ;
	}
});

[Cyrille37]

If you agree with this idea I'm ready/hot to propose a pull request 😉

But ... I've no idea on which UnitTest to make ...

[drbyte]

@Cyrille37 Interestingly enough, I've been working on code to do very similar but not specifically in relation to teams.

This is the angle I've been working on, including the naming convention of the config key as it will probably become when finished:

    public function roles(): BelongsToMany
    {
        $relation = $this->morphToMany(
            config('permission.models.role'),
            'model',
            config('permission.table_names.model_has_roles'),
            config('permission.column_names.model_morph_key'),
            app(PermissionRegistrar::class)->pivotRole
             config('permission.table_names.model_has_roles'),
             config('permission.column_names.model_morph_key'),
             app(PermissionRegistrar::class)->pivotRole
-        );
+        )->using(config('permission.models.pivot_model_has_roles'));
...

(When using() contains a null value, it just does the default as it does today, so is backward-compatible.)

I think then you could add your team-specific pieces to that Pivot model, without having to add the using() clause where you had proposed a few lines later.

Also be aware that using the additional pivot model (instead of leaving it null) adds 1 more query to Eloquent's query chain.

Tests for something like this are indeed the bottleneck. Functionally it works. Simulating it for testing is where I'm hitting a wall.

[Cyrille37]

I'd just test, it works.

I don't have many knowledge on testing technology. The real code is a listener on model_has_roles saving event.

Because there are many models which depend on the tenant (here is company_id) I've put the event in a trait.

/*
 * config: 'pivot_model_has_roles' => \App\Models\Permission\ModelHasRole::class,
 */
class ModelHasRole extends MorphPivot implements BelongsToCompanyInterface {
	use BelongsToCompanyTrait ;
}
...

	/**
	 * Eloquent booting Trait with method boot<Trait>
	 * These follow the pattern boot{Trait} and initialize{Trait}, allowing you to reuse the same code in multiple models.
	 */
	public static function bootBelongsToCompanyTrait()
	{
		/**
		 * When not in a Filament resource must filter query on company_id
		 */
		static::addGlobalScope('company', function (Builder $query) {
			/** @var User $user */
			$user = Auth::user();
			if ($user) {
				$query->where((new static)->getTable() . '.company_id', $user->currentCompany->id);
			}
		});

		/**
		 * Listening on Model saving event to set the tenant property (aka company_id).
		 */
		static::saving(function (Model $model) {
			$key = config('permission.column_names.team_foreign_key');
			if ($model->{$key} == null) {
				$model->{$key} = getPermissionsTeamId();
			}
		});
	}