Hi plugin creators,
Today we’re releasing Plugin API v4. All plugins that use server-side actions need to migrate to Plugin API v4 by January 4, 2024. We will begin to flag plugins that have not been updated to v4 as “deprecated” on November 1, 2023.
Changes in Plugin API v4 affect server-side actions only. AWS Lambda, which we use to run plugin server-side actions, announced that it will end support for Node 14 in January. Therefore, plugins that use server-side actions will be required to switch to Bubble Plugin API v4, which runs on Node 18, by January 4, 2024.
Updating to Plugin API v4 will likely require you to make code changes to your server-side actions. For an update guide, please see here!
What is the timeline for the API v4 upgrade?
All plugins using server-side actions need to migrate to Plugin API v4 by January 4, 2024. To make the update process as smooth as possible, we’ve split the migration period into three phases, outlined below. We recommend that you update your plugins during the first phase. In the second phase, we will display deprecation warnings in the editor notifying plugin users about plugins that have not yet been upgraded. In the third phase, we will officially deprecate server-side actions on Plugin versions <4.
Phase I: Today – November 1
- Plugin API v4 released
- We will start sending friendly email reminders to those who maintain plugins with server-side actions, nudging them to update.
- We recommend updating your plugins during this phase so that your users have ample time to upgrade their plugins to the latest version.
Phase II: November 1 – January 4
- We will begin to display warnings in the editor flagging plugins with server-side actions that haven’t updated to v4 yet.
- We will begin to send emails to plugin users encouraging them to update their plugins that use server-side actions to the latest version.
Phase III: January 4 - 10
- We will officially deprecate server-side actions on Plugin versions <4 on January 4, 2024.
- We will conduct two Plugin API <4 brownouts in January to help identify any plugins or apps that haven’t been upgraded yet. During these brownouts, all server-side plugin actions will run on Node 18. This means that, in practice, server-side actions on any plugin whose Plugin API version is < 4 will break.
- January 4: 2 hours
- January 8: 8 hours
- On January 10, 2024, we will stop supporting server-side actions on Plugin API Versions <4.
TL;DRs:
- How do I upgrade?
- Read our detailed upgrade guide here!
- When is the deadline to upgrade?
- We recommend upgrading your Plugin API version by November 1, 2023.
- Plugins that use server-side actions must be updated by January 4, 2024.
- How do I know if my plugin needs to be updated?
- If your plugin uses server-side actions, you will need to upgrade to Plugin API v4. Otherwise, the update is not mandatory.
- What exactly is the difference between Plugin API v3 and v4?
- Server-side actions run on Node 18 in Plugin API v4 (whereas v3 uses Node 14). This is a significant change because we run asynchronous functions in Node 14 using fibers, which is deprecated in Node 18. Plugin authors will need to switch over to using more modern async Javascript syntax.
- See the update guide for a detailed changelog.
- Will my plugin break if I don’t upgrade?
- Any server-side actions on plugins that do not update to Plugin API v4 by January 4, 2024 will likely break.
- The AWS announcement linked above says October 10 is the EOL deadline, but here you say January 4—what’s up with that?
- AWS was able to grant us a short extension to their EOL deadline, moving it to January, in order to allow plugin authors more time to migrate their plugins.