Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Laravel 11.x Shift #116

Merged
merged 25 commits into from
Nov 8, 2024
Merged

Laravel 11.x Shift #116

merged 25 commits into from
Nov 8, 2024

Conversation

ericwang401
Copy link
Collaborator

This pull request includes the changes for upgrading to Laravel 11.x. Feel free to commit any additional changes to the shift-130906 branch.

Before merging, you need to:

  • Checkout the shift-130906 branch
  • Review all pull request comments for additional changes
  • Run composer update (if the scripts fail, try with --no-scripts)
  • Clear any config, route, or view cache
  • Thoroughly test your application (no tests?, no CI?)

If you need help with your upgrade, check out the Human Shifts.

@ericwang401
Copy link
Collaborator Author

ℹ️ To slim down the Laravel installation, Laravel 11 no longer has most of the core files previously included in the default Laravel application. While you are welcome to publish and customize these files, they are no longer required.

Shift takes an iterative approach to removing core files which are not customized or where its customizations may be done elsewhere in a modern Laravel 11 application. As such, you may see some commits removing files and others re-registering your customizations.

@ericwang401
Copy link
Collaborator Author

⚠️ The application bootstrapping changed in Laravel 11. As a result, files like artisan and public/index.php were rewritten. Shift overwrote these files but detected yours may have contained customizations. You should review the diff to see if any of your customizations are still needed.

@ericwang401
Copy link
Collaborator Author

ℹ️ Laravel 11 no longer requires you to maintain the default configuration files. Your configuration now merges with framework defaults.

Shift streamlined your configuration files by removing options that matched the Laravel defaults and preserving your true customizations. These are values which are not changeable through ENV variables.

If you wish to keep the full set of configuration files, Shift recommends running artisan config:publish --all --force to get the latest configuration files from Laravel 11, then reapplying the customizations Shift streamlined.

@ericwang401
Copy link
Collaborator Author

ℹ️ Shift detected customized options within your configuration files which may be set with an ENV variable. To help keep your configuration files streamlined, you may set the following variables. Be sure adjust any values per environment.

BCRYPT_ROUNDS=10
CACHE_STORE=file
DB_CONNECTION=mysql
MAIL_MAILER=smtp
QUEUE_CONNECTION=sync
SESSION_DRIVER=file

Note: some of these may simply be values which changed between Laravel versions. You may ignore any ENV variables you do not need to customize.

@ericwang401
Copy link
Collaborator Author

⚠️ The BROADCAST_DRIVER, CACHE_DRIVER, and DATABASE_URL environment variables were renamed in Laravel 11 to BROADCAST_CONNECTION, CACHE_STORE, and DB_URL, respectively.

Shift automated this change for your committed files, but you should review any additional locations where your environment is configured and update to the new variable names.

@ericwang401
Copy link
Collaborator Author

❌ The bootstrap/app.php file has been completely rewritten in Laravel 11 to allow configuring your Laravel application in a single location. Shift overwrote your file, but detected it may have contained customizations. You should review the diff to see if any of your customizations are still needed.

@ericwang401
Copy link
Collaborator Author

⚠️ Shift detected a custom route registry in your RouteServiceProvider. In Laravel 11 you may quickly register web and api routes, as well as set the API prefix. If you need to register additional routes, you may do so with the then callback. If you need to customize all your routes, you may register your routes with the using callback.

You should review your custom routes to see if you need to use one of these callbacks or if your customizations may be done within the route file. You may reference the documentation on Route Customization for more details on these callbacks.

Route::middleware('web')->group(function () {
    Route::middleware('guest')->group(base_path('routes/auth.php'));

    Route::middleware(['auth.session'])
         ->group(base_path('routes/base.php'));

    Route::middleware(['auth'])->prefix('/api/client')
         ->as('client.')
         ->scopeBindings()
         ->group(base_path('routes/api-client.php'));

    Route::middleware(['auth', AdminAuthenticate::class])
         ->prefix('/api/admin')
         ->as('admin.')
         ->scopeBindings()
         ->group(base_path('routes/api-admin.php'));
});

Route::middleware(['api'])->group(function () {
    Route::middleware(['auth:sanctum'])
         ->prefix('/api/application')
         ->as('application.')
         ->scopeBindings()
         ->group(base_path('routes/api-application.php'));

    Route::middleware([CotermAuthenticate::class])
         ->prefix('/api/coterm')
         ->as('coterm.')
         ->scopeBindings()
         ->group(base_path('routes/api-coterm.php'));
});

@ericwang401
Copy link
Collaborator Author

⚠️ Shift was unable to re-register your exception handler. You may review the documentation to do so manually, or register your original exception handler by adding the following binding to the register method of your AppServiceProvider:

$this->app->bind(\Illuminate\Contracts\Debug\ExceptionHandler::class, \App\Exceptions\Handler::class);

@ericwang401
Copy link
Collaborator Author

❌ The app/Console/Kernel.php file has been removed in Laravel 11. Shift overwrote your file, but detected it may have contained customizations. You should review the diff to see if any of your customizations are still needed. If so, you may re-apply them to the routes/console.php file or the new bootstrap/app.php file. Review the documentation for additional details.

@ericwang401
Copy link
Collaborator Author

ℹ️ Shift updated your dependencies for Laravel 11. While many of the popular packages are reviewed, you may have to update additional packages in order for your application to be compatible with Laravel 11. Watch dealing with dependencies for tips on handling any Composer issues.

The following dependencies were updated by a major version and may have their own changes. You may check their changelog for any additional upgrade steps.

@ericwang401
Copy link
Collaborator Author

ℹ️ The base Controller class has been marked as abstract in Laravel 11, with its traits and inheritance removed. This is to prevent using this base controller directly and to use facades instead of the trait methods.

Shift detected your base controller did not have any public methods, so it was safe to mark as abstract. However, since you may be using trait methods within your controllers, Shift did not remove them. If you know you are not using any trait methods or want to refactor to facades, you may remove them manually.

@ericwang401
Copy link
Collaborator Author

⚠️ In Laravel 11, changing a column now requires you to include all the modifiers you want to keep on the column definition after it is changed. Any missing attributes will be dropped. This change may cause unexpected behavior if you were to run pending or old migrations.

Shift detected potential uses of the change method within your migrations. While you may go back and update these migrations, you may wish to simply squash your old migrations. This will not only avoid rework, but may also improve the performance of your test suite.

@CLAassistant
Copy link

CLAassistant commented Oct 15, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ericwang401
❌ laravel-shift
You have signed the CLA already but the status is still pending? Let us recheck it.

@ericwang401
Copy link
Collaborator Author

⚠️ Many first-party Laravel packages no longer load their migrations automatically. Instead, you may need to publish their migrations to your application if you have not already done so. Shift detected you are using Sanctum. You may run the following command to publish their migrations:

php artisan vendor:publish --tag=sanctum-migrations

@ericwang401
Copy link
Collaborator Author

ericwang401 commented Oct 15, 2024

⚠️ Laravel 11 has a nesbot/carbon dependency of ^2.72|^3.0. Carbon 3.0 made some breaking changes. Most notably to the diffIn* methods and the removal of the setUtf8, formatLocalized, setWeekStartsAt, setWeekEndsAt methods. While you may try to downgrade to Carbon 2, Shift recommends you review the Carbon migration notes and complete the upgrade to Carbon 3.0.

Shift detected uses of these methods in the following files:

@ericwang401
Copy link
Collaborator Author

ℹ️ Laravel 11 now updates the timestamp when publishing vendor migrations. This may cause problems in existing applications when these migrations were previously published and ran with their default timestamp.

To preserve the original behavior, Shift disabled this feature in your database.php configuration file. If you do not have any vendor migrations or have squashed all of your existing migrations, you may re-enable the update_date_on_publish option. If this is the only customization within database.php, you may remove this configuration file.

@ericwang401
Copy link
Collaborator Author

ericwang401 commented Oct 15, 2024

ℹ️ The following files previously included in a Laravel application appeared to be customized and were not removed. Shift encourages you to review your customizations to see if they are still needed or may be done elsewhere in a modern Laravel application. Removing these files will keep your application modern and make future maintenance easier.

  • app/Http/Middleware/Authenticate.php

@ericwang401
Copy link
Collaborator Author

⚠️ Previously, Laravel would append a colon (:) to any cache key prefix for DynamoDB, Memcache, or Redis. Laravel 11 no longer appends a colon to your cache key prefix. If you are using one of these stores, you should append a colon to your prefix to avoid invalidating your cache.

@ericwang401
Copy link
Collaborator Author

⚠️ Many of the default drivers changed in Laravel 11. For example, the default database driver is sqlite and the default cache store is database. If you experience errors setting up your environment, be sure you have properly set your ENV variables for these drivers. If you wish to adopt the new defaults, you may follow the documentation to set them up for your application.

@ericwang401
Copy link
Collaborator Author

ℹ️ All of the underlying Symfony components used by Laravel have been upgraded to Symfony 7.0. Shift detected references to Symfony classes within your application. These are most likely type hints and can safely be ignored. If you are using Symfony classes directly or experience issues relating to Symfony, you should review the Symfony change log for any additional changes.

@ericwang401
Copy link
Collaborator Author

⚠️ Laravel 11 now includes a database driver for MariaDB. Previously the MySQL driver offered parity with MariaDB. However, with MariaDB 10.1, there are more database specific features available. If you are using MariaDB, you may want to evaluate this new mariadb driver after completing your upgrade to Laravel 11.

@ericwang401
Copy link
Collaborator Author

⚠️ Shift detected you are using a Laravel package like Horizon or Nova which may need to have its published assets regenerated after upgrading. Be sure to use artisan to republish these assets as well as php artisan view:clear to avoid any errors.

@ericwang401
Copy link
Collaborator Author

🎉 Congratulations, you're now running the latest version of Laravel!

Next, you may optionally run the following Shifts to ensure your application is fully upgraded, adopts the latest Laravel conventions, and easier to maintain in the future:

  • Laravel Fixer automatically updates your code to the latest Laravel conventions.
  • Tests Generator intelligently generates model factories, HTTP Tests, and configuration for your application.
  • CI Generator intelligently generates CI jobs to lint PHP, check code style, and run tests, including Dusk.

You may also use the Shift Workbench to automate common tasks for maintaining your Laravel application.

@ericwang401 ericwang401 merged commit 01f601d into next Nov 8, 2024
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants