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 #1557

Merged
merged 17 commits into from
Apr 27, 2024
Merged

Laravel 11.x Shift #1557

merged 17 commits into from
Apr 27, 2024

Conversation

DariusIII
Copy link
Member

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

Before merging, you need to:

  • Checkout the shift-117502 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.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member Author

ℹ️ Laravel 9 moved the resources/lang folder to the top level of the project. While Shift moved and replaced references to this folder, you may have additional references to this folder which need to be updated.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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.

APP_NAME=NNTmux
ARGON_MEMORY=1024
ARGON_THREADS=2
ARGON_TIME=2
AUTH_PASSWORD_RESET_TOKEN_TABLE=password_resets
BCRYPT_ROUNDS=10
CACHE_STORE=file
DB_CHARSET=utf8
DB_COLLATION=utf8_unicode_ci
DB_CONNECTION=mysql
DB_DATABASE=nntmux
DB_USERNAME=nntmux
HASH_DRIVER=argon
LOG_DAILY_DAYS=7
MAIL_MAILER=smtp
QUEUE_CONNECTION=sync
REDIS_PREFIX="laravel'), '_"
SESSION_CONNECTION=session
SESSION_DRIVER=cookie
SESSION_HTTP_ONLY=false
SESSION_SECURE_COOKIE=false
SQS_QUEUE=your-queue-name

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

@DariusIII
Copy link
Member Author

ℹ️ Shift detected your application uses custom ENV variables for configuration options which have ENV variables in Laravel. Shift recommends renaming the following variables to use the one provided by Laravel:

  • APP_NAME to REDIS_PREFIX
  • APP_TZ to APP_TIMEZONE
  • AWS_KEY to AWS_ACCESS_KEY_ID
  • AWS_REGION to AWS_DEFAULT_REGION
  • AWS_SECRET to AWS_SECRET_ACCESS_KEY
  • FILESYSTEM_DRIVER to FILESYSTEM_DISK
  • PASSWORD_HASH to HASH_DRIVER
  • SES_KEY to AWS_ACCESS_KEY_ID
  • SES_REGION to AWS_DEFAULT_REGION
  • SES_SECRET to AWS_SECRET_ACCESS_KEY

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member Author

⚠️ Laravel 11 automatically discovers events by scanning your application's Listeners directory.

Shift detected event listeners registered with the listen property of your EventServiceProvider. If any of these listeners can not be automatically discovered, you may register them manually using Event::listen() in your AppServiceProvider.

@DariusIII
Copy link
Member 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);

@DariusIII
Copy link
Member Author

❌ Shift detected you are using laravelcollective/html. This package has been abandoned. They suggest using the spatie/laravel-html package instead. You may use Shift's HTML Converter to automate this conversion. However, if you are not using the laravelcollective/html package extensively, you may simply rewrite its uses to raw HTML.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member Author

ℹ️ Starting with Laravel 10, PHP type hints were added within classes included in a Laravel application. In an effort to modernize your code, Shift automated this change where Laravel strictly specifies a type. If you prefer not to type hint your code you may revert this commit by running: git revert fe642048

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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, and Telescope. You may run the following command to publish their migrations:

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

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member Author

ℹ️ 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/Providers/RouteServiceProvider.php

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member Author

⚠️ Laravel 11 has a nesbot/carbon dependency of ^2.72|^3.0. Carbon 3.0 contains some breaking changes, most notably to the diffIn* methods. Shift detected you are using these methods within your application. 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.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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.

@DariusIII
Copy link
Member 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.

@DariusIII DariusIII merged commit c4ea89c into laravel11 Apr 27, 2024
1 check failed
@DariusIII DariusIII deleted the shift-117502 branch April 27, 2024 08:35
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.

2 participants