Add support for multiple or alternately named auth providers

[miken32]

Summary

When determining return value for functions like Auth::user(), only the hardcoded path auth.providers.users.model is checked in the configuration. In the case of multiple guards (or a guard not named "users") the resulting return type is incomplete. This fix checks every entry in the auth.providers array to build an intersection type (e.g. App\User|App\Admin) for use as return.

I considered adding more checks (e.g. make sure class_exists() and it implements Authenticatable) but if you have invalid class names as part of your application config, that's not this tool's problem.

Type of change

• [x] New feature (non-breaking change which adds functionality)

Checklist

• [ n/a ] Existing tests have been adapted and/or new tests have been added
• [x] Add a CHANGELOG.md entry
• [ n/a ] Update the README.md
• [x] Code style has been fixed via composer fix-style

[miken32]

I wasn’t sure how to do a test based on the generator command, looks like I'd be starting from scratch. If you’ve got any suggestions where to start, I’m happy to create a test.

[jonnywilliamson]

I grabed this code change and did a very quick test with it. I got the following generated output in the ide_helper.php

         /**
         * Get the currently authenticated user.
         *
         * @return \App\Models\User|App\Models\IalpaMember|null
         * @static 
         */ 
        public static function user()
        {
                        /** @var \Illuminate\Auth\SessionGuard $instance */
                        return $instance->user();
        }

Note the missing \ at the start of the second User model. My IDE throws up an error.

Not sure if it's this PR or another section of the code that's causing the issue.

[miken32]

@jonnywilliamson it just looks at what’s in your auth config file. Did you check that?

[jonnywilliamson]

@jonnywilliamson it just looks at what’s in your auth config file. Did you check that?

So the original auth.php file, fresh in a new install looks like this:

https://github.com/laravel/laravel/blob/8.x/config/auth.php#L62-L66

With no leading \,

So I had copied that like follows (unintentionally):

So both of them had missing \ at the start but it seems to add it for the first one when generating the ide_helper.php file.

I can of course add it myself manually, no biggie but i wonder why it's done automatically for the first provider?

[miken32]

@jonnywilliamson I'd bet what's happening is somewhere the code is assuming this is a single class name, and it's sticking a leading backslash at the beginning to make it absolute. But of course with a union type only the first class in the list will be absolute. I just pushed out a change on the branch that will resolve the issue by making sure all the classes in the list are absolute.

[jonnywilliamson]

@miken32 Thank you michael for looking into it. I'd say you are spot on with that analysis.

Either way, I appreciate you addressing it so quickly. I hope this gets merged soon! Thanks.