docs: add info on migration from tymon's package

[leon0399]

Close #54

[mfn]

Thanks, was looking for this!

Will give the steps a try and report back!

[mfn]

Quick first impression of the guide:

• after running composer update I got this in the end; still need to check if this is specific to my setup or not:

  > Illuminate\Foundation\ComposerScripts::postAutoloadDump
  > @php artisan package:discover
  
  In LaravelServiceProvider.php line 7:
  
    Class 'Tymon\JWTAuth\Providers\LaravelServiceProvider' not found
  
  
  Script @php artisan package:discover handling the post-autoload-dump event returned with error code 1
  

• I've a custom implementation of JWTGuard and need a) extend and b) override it via a custom serviceprovider:

  class LaravelServiceProvider extends BaseLaravelServiceProvider
  {
      /**
       * Override parent so we can use our own JWTGuard class
       * Extend Laravel's Auth.
       */
      protected function extendAuthGuard(): void
      {
          $this->app['auth']->extend('jwt', function ($app, $name, array $config) {
              $guard = new JWTGuard(
                  $app['tymon.jwt'],
                  $app['auth']->createUserProvider($config['provider']),
                  $app['request']
              );
  
              $app->refresh('request', $guard, 'setRequest');
  
              return $guard;
          });
      }
  }

  This fails because the constructor arguments are not compatible anymore (the Dispatcher was recently added)

[mfn]

One downside of running composer update this way is that it will upgrade all packages. This may be undesired if one just wants to replace this one.

[mfn]

One downside of running composer update this way is that it will upgrade all packages

I did some tests to figure out what would have the least amount of impact on existing packages:

1. composer update works, but updates all packages which may not be desired
2. Running first composer remove tymon/jwt-auth and then composer require php-open-source-saver/jwt-auth seems to work nicely, one does not even have to manually touch the composer.json
3. Keeping manually changing the composer.json but still avoiding updating unrelated packages, this also worked in my test: composer update php-open-source-saver/jwt-auth --with-dependencies
   Since tymon/jwt-auth is not referenced in composer.json, this will remove it too

My preference would be 2): even though it's not as nice looking and is essentially two commands, it does not require manually changing anything and will automatically chose the best version to install (^1.2 currently) so is "maintenance free" insofar we don't need to update the reference in the README regarding the version number:

Suggested change

	1) Replace `"tymon/jwt-auth": "^1.0"` with `"php-open-source-saver/jwt-auth": "^1.2"` in your `composer.json`
	2) Run `composer update`
	1) Run `composer remove tymon/jwt-auth`
	2) Run `composer require php-open-source-saver/jwt-auth`

WDYT?

[leon0399]

I'll re-check once again, might be possile, that it is needed to add --no-scripts, since if composer will trigger package discovery, it can throw an error about non-existing classes

[mfn]

In my case, special snowflake scenario, I've actually disabled the auto-discovery for the (previous name of the) package because I register my own serviceprovider, which extends the one from the package.

[eschricker]

Looks good to me 👍

[mfn]

It LGTM but since this adds a "Migration" chapter, we should mention the incompatibility of the constructor I pointed out in #56 (comment) and we should probably strive to make the 1.* series not less compatible

[Messhias]

Look good for me too.

[mfn]

❤️

Thank you 🙏🏼