Limit a queries select to the model's table

[JasonTheAdams]

Describe the bug

I have the following type:

type User @modelClass(class: "App\\Models\\User") {
    id: ID!
    donations(
        type: String = "charge" @where(key: "donations.type")
        status: String = "complete" @where(key: "donations.status")
        teamId: ID @scope(name: "byTeam")
    ): [Donation!]
        @hasMany(type: "connection")
}

User.donations is a hasManyThrough relationship. So in order to limit by teamId an additional join is applied during the scope:

    public function scopeByTeam(Builder $query, int $teamId): Builder
    {
        $table = $this->getTable();

        $query
            ->join('campaigns', "$table.campaign_id", '=', 'campaigns.id')
            ->where('campaigns.team_id', '=', $teamId);

        return $query;
    }

This is where things break. The resulting donations have much of the correct data but the wrong ID. The reason for this is actually pretty simple. By default selects in Laravel are *, which means that all columns including the joined table columns are included. Since the joined table also has an ID column and it comes later in the results the ID of the joined table item is returned instead of the correct table's ID.

Expected behavior/Solution

Since Lighthouse has the model and is building the query, all we should really need to do here is to apply the table to the query select. Something like $query->select("{$model->getTable()}.*").

I don't believe this would cause backwards-incompatibility as the GraphQL object is expecting to only be a single model, anyway. The only scenarios I'm not sure of is how Lighthouse handles sub-models and eager loading.

Environment

Lighthouse Version: 5.9
Laravel Version: 6.x

[JasonTheAdams]

If anyone else runs into this scenario I ended up working around it by using a sub-query and applying an alias to the joined table's ID:

    public function scopeByTeam(Builder $query, int $teamId): Builder
    {
        $subQuery = Campaign::query()->select('id as campaignId')->where('team_id', '=', $teamId);

        $query->joinSub(
            $subQuery,
            'team_campaigns',
            function (JoinClause $join) {
                $join->on('donations.campaign_id', '=', 'team_campaigns.campaignId');
            }
        );

        return $query;
    }

[spawnia]

Thanks for the detailed report. Can you add a PR with a failing test case?

[omacranger]

I've been running into this issue quite a bit too, so placed together a failing test in PR #1253. In the instance of attempting to select users with ID 1 & 2, joining the team table (with ID 1) will change all users in the query to id => 1 since they share that column unless specifying the table in the select or performing a sub join like Jason did above.

[JasonTheAdams]

Thanks for putting that together, @omacranger! I hadn't quite found the time, yet.

[spawnia]

This issue is caused by Eloquent, Lighthouse does not do anything extraordinary with the query builder. See laravel/framework#4962 for more information.

The proposed fix/workaround can only be done if the user is able to control the select() call. Since Lighthouse takes care of that, we could fix it there.

[spawnia]

I did try my hand at fixing this within Eloquent itself, not quite there yet: https://github.com/spawnia/laravel-framework/tree/prefer-original-table-columns-on-join

Fixing this within Lighthouse seems to have it's own set of problems. Subqueries for relationships seem to not work correctly yet, see #1253