getExtraConditions Validation Undefined Offset: 1 Fault

[gofish543]

• Laravel Version: 5.8.19
• PHP Version: 7.3.6
• Database Driver & Version:

Description:

While running validation tests within FormRequests I kept receiving a "Undefined offset: 1".

ErrorException : Undefined offset: 1
 vendor/laravel/framework/src/Illuminate/Validation/Concerns/ValidatesAttributes.php:841

Steps To Reproduce:

RegisterRequest.php

<?php

namespace App\Http\Requests\Auth;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;

class RegisterRequest extends FormRequest {

    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize() {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules() {
        return [
//                        'recaptchaToken' => ['required', new CaptchaRule()],
            'username' => [
                'required',
                'string',
                'max:255',
                'unique:users,username',
            ],
            'password' => [
                'required',
                'string',
                'min:4',
                'max:255',
                'confirmed',
            ],
            'email' => [
                'required',
                'email',
                'max:255',
                'unique:users,email',
            ],
            'phone' => [
                'required',
                'string',
                'regex:/\d{3}-\d{3}-\d{4}/',
            ],
            'first' => [
                'required',
                'string',
                'max:255',
            ],
            'last' => [
                'required',
                'string',
                'max:255',
            ],
            'street' => [
                'sometimes',
                'string',
                'max:255',
            ],
            'street_2' => [
                'sometimes',
                'string',
                'max:255',
            ],
            'city' => [
                'sometimes',
                'string',
                'max:255',
            ],
            'state' => [
                'sometimes',
                'string',
                'max:255',
            ],
            'zip' => [
                'sometimes',
                'string',
                'max:5',
            ],

            'do_email' => [
                'required',
                'boolean',
                'max:1',
            ],
            'do_phone' => [
                'required',
                'boolean',
                'max:1',
            ],
            'registration_code' => [
                'required',
                'string',
                'size:8',
                'regex:/\d{4}-\d{3}/'
            ],
            'club_id' => [
                'required',
                Rule::exists('clubs', 'id')->where('registration_code', $this->input('registration_code', ''))
            ],
        ];
    }

    /**
     * @return array
     */
    protected function validationData() {
        $data = $this->all();

        $data['street'] = $data['street'] ?? '';
        $data['street_2'] = $data['street_2'] ?? '';
        $data['city'] = $data['city']?? '';
        $data['state'] = $data['state'] ?? '';
        $data['zip'] = $data['zip'] ?? '';

        $data['do_email'] = $data['do_email'] ?? false;
        $data['do_phone'] = $data['do_phone'] ?? false;

        return $data;
    }
}

TestCase

<?php

namespace Tests\Unit\Http\Requests\Auth;

use App\Http\Requests\Auth\RegisterRequest;
use App\Http\Requests\Resource\Club\ClubUpdateRequest;
use App\Role;
use Illuminate\Support\Arr;
use Tests\TestCase;

class RegisterRequestTest extends TestCase {

    /** @var string */
    protected $url;

    public function setUp(): void {
        parent::setUp();

        $this->url = route('register');
    }

    public function testSuccessfulValidation() {
        $this->post(route('register'), $this->getData());
        //$this->formRequest(RegisterRequest::class, $this->url, 'POST', null, $this->getData());
        //dd($this->errors);
//            ->assertValidationPassed()
//            ->assertAuthorized();
    }

    private function getData($except = []) {
        $password = $this->faker->password;

        return Arr::except([
            '_token' => csrf_token(),

            'username' => $this->faker->userName,
            'password' => $password,
            'password_confirmation' => $password,
            'email' => $this->faker->email,
            'phone' => $this->faker->numerify('###-###-####'),
            'first' => $this->faker->firstName,
            'last' => $this->faker->lastName,
            'role_id' => Role::NO_ROLE,

            'do_email' => true,
            'do_phone' => true,

            'club_id' => $this->club->id,
//            'registration_code' => $this->club->registration_code,
        ], $except);
    }
}

StackTrace

Testing started at 10:46 PM ...
[ssh://gofish543@localhost:22]:/usr/bin/php /mnt/d/TrapStats/vendor/phpunit/phpunit/phpunit --configuration /mnt/d/TrapStats/phpunit.xml --filter "/(::testSuccessfulValidation)( .*)?$/" Tests\\Unit\\Http\\Requests\\Auth\\RegisterRequestTest /mnt/d/TrapStats/tests/Unit/Http/Requests/Auth/RegisterRequestTest.php --teamcity
PHPUnit 8.1.6 by Sebastian Bergmann and contributors.

http://trapstats.local/register 2019-06-02 03:46:10 POST 302 Symfony

ErrorException : Undefined offset: 1
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Concerns/ValidatesAttributes.php:841
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Concerns/ValidatesAttributes.php:677
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Concerns/ValidatesAttributes.php:658
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Validator.php:398
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Validator.php:277
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/Validator.php:302
 /mnt/d/TrapStats/vendor/laravel/framework/src/Illuminate/Validation/ValidatesWhenResolvedTrait.php:25
 /mnt/d/TrapStats/tests/Assertions/FormRequestAssertionTrait.php:69
 /mnt/d/TrapStats/tests/Assertions/FormRequestAssertionTrait.php:57
 /mnt/d/TrapStats/tests/Unit/Http/Requests/Auth/RegisterRequestTest.php:24
 


Time: 880 ms, Memory: 30.00 MB


ERRORS!
Tests: 1, Assertions: 5, Errors: 1.

Process finished with exit code 2

I've identified the error to be here, but as I do not have a firm grasp of the laravel core and it's inner workings I'll leave the further fixing to the pros

    /**
     * Get the extra conditions for a unique / exists rule.
     *
     * @param  array  $segments
     * @return array
     */
    protected function getExtraConditions(array $segments)
    {
        $extra = [];

        $count = count($segments);

        for ($i = 0; $i < $count; $i += 2) {
            $extra[$segments[$i]] = $segments[$i + 1];
        }

        return $extra;
    }

[staudenmeir]

Please provide a minimal example.

[gofish543]

For the example, I will enumerate the code above.

A user comes to the application and goes to the registration page. They type in their username, password, which club they want to join, and that club's unique registration code. All is well, the club with the code exists and their account is created.

But now let's say that while registering the user forgets to type in the registration_code and leaves it blank. Laravel's validation should return and say "The registration code field is required" and return action to the user, but instead the application is raising an exception and erroring out with a "Undefined Offset: 1" exception.

Is that a good enough example?

[laurencei]

@gofish543 - what @staudenmeir means is can you please cut out all the excess code, until we have the very minimal amount of code that generates the error.

There's way too much stuff there to work through.

For example - work out exactly which validation rule is causing the error. Then we can take it from there.

[gofish543]

Oh, my apologizes

RegisterRequest.php

<?php

namespace App\Http\Requests\Auth;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;

class RegisterRequest extends FormRequest {

    public function authorize() {
        return true;
    }

    public function rules() {
        return [
            'username' => [
                'required',
                'string',
                'max:255',
                'unique:users,username',
            ],
            'registration_code' => [
                'required',
                'string',
                'size:8',
                'regex:/\d{4}-\d{3}/'
            ],
            'club_id' => [
                'required',
                Rule::exists('clubs', 'id')->where('registration_code', $this->input('registration_code', ''))
            ],
        ];
    }
}

TestCase

<?php

namespace Tests\Unit\Http\Requests\Auth;

use Tests\TestCase;

class RegisterRequestTest extends TestCase {

    public function testSuccessfulValidation() {
        $this->post(route('register'), $this->getData()); // Works, no issues
    }

    public function testMissingRegistrationCode() {
        $data = $this->getData();
        unset($data['registration_code']);

        $this->post(route('register'), $data); // <-- Undefined Offset: 1 Exception
    }

    private function getData() {
        return [
            'username' => $this->faker->userName,
            'club_id' => $this->club->id,
            'registration_code' => $this->club->registration_code,
        ];
    }
}

[staudenmeir]

This is caused by rtrim() in Exists::__toString(). The same goes for Unique.

Short example:

Validator::make(
    ['id' => 1],
    ['id' => Rule::exists('users')->where('name', '')]
)->passes();

[gofish543]

Is that intended behavior? (I.E something I should change in my code) Or is that something that needs to be changed in the underlying framework?

[staudenmeir]

This is a bug in Laravel.