Apply conditions/scopes to related model query

[mjauvin]

Fixes: octobercms/october#4952

This overrides the following method in Laravel:

https://github.com/laravel/framework/blob/8.x/src/Illuminate/Database/Eloquent/Relations/Concerns/InteractsWithPivotTable.php#L83

Specifically replaces the following lines to fetch the records that actually belongs to the relation (using the conditions/scopes of the relation):

https://github.com/laravel/framework/blob/8.x/src/Illuminate/Database/Eloquent/Relations/Concerns/InteractsWithPivotTable.php#L92-L93

[mjauvin]

@Flynsarmy can you confirm this fixes your problem?

[Flynsarmy]

This PR helps but there still appears to be a bug which you can replicate with my test plugin in octobercms/october#4952. Uncheck both Tag checkboxes but leave one or more Category checkboxes checked. Hit save and refresh. You'll notice the categories did not save correctly. A look in the DB confirms no categories were saved to the flynsarmy_relationtest_posts_terms table.

[mjauvin]

@Flynsarmy try this, I think I fixed the remaining bug.

[Flynsarmy]

@mjauvin Looks good! Fixed.

[mjauvin]

I and @Flynsarmy have tested this as a working fix.

[LukeTowers]

A unit test for the original issue would be helpful here @mjauvin

[mjauvin]

@LukeTowers there are tests in october/october for testing relations, would that make sense to improve on those tests instead of rewriting these in october/library?

[LukeTowers]

Might be, any thoughts @bennothommo?

[bennothommo]

@mjauvin @LukeTowers the test should really exist in here if the changed functionality is here - while it's likely that 99.9% of the time, this will be used in October CMS, it's still proper testing procedure for this sort of functionality to be tested in isolation.

I would simply port a couple of those relation tests back into this library and adjust as necessary.

[LukeTowers]

@bennothommo I think we might need your skills to setup database tests for this library then, I was having a heck of time trying to make it work for the guarded tests

[mjauvin]

@LukeTowers I found this:
https://github.com/octobercms/library/blob/1.1/tests/Database/Traits/EncryptableTest.php

    public function setUp(): void
    {
        $capsule = new Illuminate\Database\Capsule\Manager;
        $capsule->addConnection([
            'driver'   => 'sqlite',
            'database' => ':memory:',
            'prefix'   => ''
        ]);

        $capsule->setAsGlobal();
        $capsule->bootEloquent();

        $capsule->schema()->create('secrets', function ($table) {
            $table->increments('id');
            $table->string('secret');
            $table->timestamps();
        });
}

That should help

[bennothommo]

@LukeTowers what @mjauvin posted is the only way of testing database functions that I'm aware of with the library. Give that a try and let me know if it doesn't work - I'll have to port some of the functionality from October CMS back into the library.

I swear I did this originally with the L6 development, but had it reversed afterwards - c'est la vie :(.

[mjauvin]

Should be good now!

[bennothommo]

@mjauvin Just to eliminate any doubt, would you mind adding a couple more scenarios in the tests, namely:

• Syncing multiple records
• Detaching one record when multiple are attached

If those are covered, I'm happy to merge.

[bennothommo]

Also, I'm going to merge your DbTest changes manually into develop, as I need it for Luke's PR. When you do the above, you'll need to merge develop back into your branch - hopefully, it won't conflict but if it does, just accept any changes from develop.

[mjauvin]

The tests have been added @bennothommo

[mjauvin]

Anything else I need to do to here?