Added Blacklisted Meta Keys

[BenQoder]

This PR bring Blacklist to Meta Keys

It is necessary in situations where you need to call relationships counts or aggregates when it is called with the loadCount method

$post = Post::find(1);

$post->loadCount(["likers"]);

Once you call the loadCount method, it throws an error.
After adding the likers_count to the blacklist, the problem is fixed

[marijoo]

Thanks for the PR. Calling loadCount() leads to an error? I have to check this, but I’m not sure this is the best way to go against it.

I will check the loadCount() problem and get back to you, okay?

[marijoo]

@BenQoder I wrote a simple test and it seems to work. Can you elaborate on what you did and what exactly happened?

it('works when using loadCount', function () {
    $user = User::factory()->create();
    Post::factory()->for($user)->count(3)->create();

    expect($user->posts_count)->toBeNull();

    $user->loadCount('posts');

    expect($user->posts_count)->toBe(3);
});

[BenQoder]

I added the meta trait to my model

use HasMeta;

and called the relationship count just like this

$business = Business::latest()->first();

 $business->bookings_count;

$business->loadCount([
    "bookings",
]);

dd($business);

Could you adjust your test to use queries like

Model::find();
// or 
Model::latest()->first()

Here's a screenshot below

[marijoo]

@BenQoder This also works as expected:

it('works when using loadCount', function () {
    Post::factory()->for(User::factory())->count(3)->create();

    $user = User::latest()->first();

    expect($user->posts_count)->toBeNull();

    $user->loadCount(['posts']);

    expect($user->posts_count)->toBe(3);
});

Would you mind providing the repository or the relevant files (the Business and Booking models at least)?

[BenQoder]

Alright... At this point, I am going to close my PR because.. I now believe there is some other package that may be causing this issue.

I have resolved this on my project by creating another trait that uses the HasMeta Trait and with my fixes

Incase anyone in future is here with the same error, here is what I did to fix my issue

<?php

namespace App\Traits;

use Illuminate\Support\Str;
use Kolossal\Multiplex\HasMeta;

trait HasMetaInternal
{
    use HasMeta;

    /**
     * Determine if the given key is blacklisted from being a meta key.
     */

    public function isBlacklistedMetaKey(string $key): bool
    {
        return in_array(
            $key,
            $this->blacklistedMetaKeys ?? [],
        );
    }

    /**
     * Determine if the given key is an allowed meta key.
     */
    public function isValidMetaKey(string $key): bool
    {
        if ($this->isMetaUnguarded()) {
            return true;
        }

        if ($this->isExplicitlyAllowedMetaKey($key)) {
            return true;
        }

        if ($this->isRelationshipAggregate($key)) {
            return false;
        }

        if ($this->isModelAttribute($key)) {
            return false;
        }

        if ($this->isBlacklistedMetaKey($key)) {
            return false;
        }

        return $this->isMetaWildcardSet();
    }

    /**
     * Determine if a given key is a relationship aggregate like count, sum, avg, min, max.
     */
    public function isRelationshipAggregate(string $key): bool
    {

        if (Str::endsWith($key, "_count")) {
            return $this->isRelation(
                Str::before($key, "_count")
            );
        }

        $keywords = ["_sum_", "_avg_", "_min_", "_max_"];


        if (!Str::contains($key, $keywords)) {
            return false;
        }

        $relationshipName = null;

        foreach ($keywords as $keyword) {
            if (Str::contains($key, $keyword)) {
                $relationshipName = Str::before($key, $keyword);
                break;
            }
        }

        if (!$relationshipName) {
            return false;
        }

        return $this->isRelation(
            $relationshipName
        );
    }
}

[marijoo]

Thanks! Maybe testing those models of yours in isolation (a fresh Laravel install) could clear things out.