What you’ll learn
  • how to upgrade Webiny from 5.42.x to 5.43.x

Make sure to check out the 5.43.0 changelog to get familiar with the changes introduced in this release.

Step-by-Step Guide
anchor

1. Upgrade Webiny Packages
anchor

Upgrade all Webiny NPM packages by running the following command:

Once the upgrade has finished, running the yarn webiny --version command in your terminal should return 5.43.0.

2. Run the Upgrade Command
anchor

The next step is to run the project upgrade:

3. Breaking Changes❗
anchor

Amazon OpenSearch Service - VPC Configuration Issue (#4532external link)
anchor

Prior to this release, when deploying a Webiny project with the existing Amazon VPCexternal link configuration in place, the Amazon OpenSearch service that Webiny deploys would not get correctly attached to the specified Amazon VPC (related subnets and security groups).

For example, the following configuration would not work as expected. Contrary to the expectation, the deployed Amazon OpenSearch cluster would not be attached to the specified OPENSEARCH_PRIVATE_SUBNETS subnets and OPENSEARCH_SECURITY_GROUPS security groups:

apps/core/webiny.application.ts

With this release, the underlying issue should no longer occur, and the above configuration will work as expected—with one minor change: instead of using elasticSearchDomainVpcConfig, users should now use opensearchDomainVpcConfig. So, the above code should be updated to the following:

apps/core/webiny.application.ts

Once you have updated your Webiny project configuration, you will need to redeploy your project.

Note that, during deployment, the VPC configuration will now be correctly attached to the Amazon OpenSearch cluster. As a result, the previously deployed cluster will be DESTROYED and a new one created. This will result in the loss of all data from the previous cluster

Luckily, the data can be recreated. Once the new cluster is deployed, the recreation can be done via the Amazon OpenSearch - Reindexing Background Task, which can be triggered via the GraphQL API or via a custom plugin. This can also be done manually, or alternatively, via a post-deployment hookexternal link script that you can add to your Webiny project.

In case you need more help with this, especially when it comes to planning and executing the data migration, please reach out to us via our community Slackexternal link.

Folder Level Permissions - Editors Can Now Manage Folders (#4615external link)
anchor

Prior to this release, only users with Owner permissions could manage folders. With this update, users with Editor permissions can now also create, edit, and delete folders.

This change is a breaking one, as it modifies the existing permissions structure. If you have custom permissions set up, you may need to adjust them to accommodate this new functionality.

fastify4.29.0 (#4464external link)
anchor

While working on the TypeScript 5.3.3 upgrade, the fastifyexternal link NPM package was also updated to version 4.29.0.

In case your project contains custom code that directly interacts with fastify, you may need to update your code to be compatible with the new version. We recommend checking their official documentation for any breaking changes or updates that may affect your project.

4. Deploy Your Project
anchor

Proceed by redeploying your Webiny project:

Make sure you deploy the entire system using the command shown above! You have to deploy all apps before using the system. Partial deploys will cause the upgrade to be applied incorrectly.
As stated in the Upgrade Webiny section, we recommend that you first deploy your changes into one of your pre-production environments, like dev or staging.
Learn more about different deployment environments in the CI/CD / Environments key topic.