Model::updateOrInsert not return a bool but is a Builder

[HotHat]

Laravel Version

11.29.0

PHP Version

8.2.12

Database Driver & Version

No response

Description

$bool = Model
           ::query()
           ->updateOrInsert($condition, $data);
  

   source file: vendor/laravel/framework/src/Illuminate/Database/Query/Builder.php: 3898
   /**
    * Insert or update a record matching the attributes, and fill it with values.
    *
    * @param  array  $attributes
    * @param  array|callable  $values
    * @return bool
    */
   public function updateOrInsert(array $attributes, array|callable $values = []){}

$bool is not a bool but is a \Illuminate\Database\Eloquent\Builder Object

Steps To Reproduce

#0 \vendor\laravel\framework\src\Illuminate\Support\Traits\ForwardsCalls.php(23): Illuminate\Database\Query\Builder->updateOrInsert(Array, Array)
#1 \vendor\laravel\framework\src\Illuminate\Database\Eloquent\Builder.php(2041): Illuminate\Database\Eloquent\Builder->forwardCallTo(Object(Illuminate\Database\Query\Builder), 'updateOrInsert', Array)
#2 \app\Domain\QuarterlyCompServiceFee\Repositories\QuarterlyRepo.php(150): Illuminate\Database\Eloquent\Builder->__call('updateOrInsert', Array)
#3 \app\Domain\QuarterlyCompServiceFee\Services\QuarterlyService.php(49): App\Domain\QuarterlyCompServiceFee\Repositories\QuarterlyRepo->addorupdate(Array, Array)

\Illuminate\Database\Eloquent\Builder::__call
public function __call($method, $parameters)
{
    ....
    $this->forwardCallTo($this->query, $method, $parameters);

    return $this;
}

[HotHat]

DB::table('xxx')->updateOrInsert($condition, $data);
return a bool

[crynobone]

__call() return $this and that's the correct output. If you have a suggestion on how to improve this feel free to send a PR.

[macropay-solutions]

@HotHat We stumbled upon this also.
You can use

$bool = Model
           ::query()->getQuery() // or toBase() if you want to apply global scopes
           ->updateOrInsert($condition, $data);

The forward to is just Laravel developer convenience.

Changing the return of __call would be a breaking change.
$this is returned for convenience again for chaining methods.

It would had been best to return the actual return from the forwarded to function but...

The model's __call returns the actual return from the forwarded to method.

Update see #56664 (comment)

[macropay-solutions]

@crynobone using forwardDecoratedCallTo instead of forwardCallTo was not considered?

    /**
     * Forward a method call to the given object, returning $this if the forwarded call returned itself.
     *
     * @param mixed $object
     * @param string $method
     * @param array $parameters
     * @return mixed
     *
     * @throws \BadMethodCallException
     */
    protected function forwardDecoratedCallTo($object, $method, $parameters)
    {
        $result = $this->forwardCallTo($object, $method, $parameters);

        return $result === $object ? $this : $result;
    }

update see #56664 (comment)

[macropay-solutions]

@HotHat @crynobone
These are a 'hack' of returning the real return type so maybe adding updateOrInsert in here is a fix for this if the forwardDecoratedCallTo has some impediments in replacing this passthru.

    protected $passthru = [
        'aggregate',
        'average',
        'avg',
        'count',
        'dd',
        'ddrawsql',
        'doesntexist',
        'doesntexistor',
        'dump',
        'dumprawsql',
        'exists',
        'existsor',
        'explain',
        'getbindings',
        'getconnection',
        'getgrammar',
        'getrawbindings',
        'implode',
        'insert',
        'insertgetid',
        'insertorignore',
        'insertusing',
        'insertorignoreusing',
        'max',
        'min',
        'raw',
        'rawvalue',
        'sum',
        'tosql',
        'torawsql',
    ];

update see #56664 (comment)

[macropay-solutions]

We opened a discussion here #56680 @HotHat

[macropay-solutions]

@crynobone @HotHat
the only solution for this is to add updateOrInsert into passthru ONLY IF it needs also global scopes to be applied on the query.

Current behavior does not apply the Eloquent builder global scopes

see:
#56680 (reply in thread)

If this is not accepted as a solution then IT SHOULD BE DOCUMENTED and this approach should be used #56664 (comment)

[macropay-solutions]

Or
#56680 (comment)