Upgrading Jets to some releases might require some extra changes. For example, the Jets project structure can change. Or some version require a manual blue-green deployment. This page provides a summary of the releases requiring some upgrade work.
jets upgrade command is provided to help with upgrades. The command is designed to be idempotent. This means it is safe to run repeatedly and will only upgrade the files and structure if needed. Before running the command, it is recommended to back up your project first just in case though. This usually can be done by committing any unsaved changes to git.
The following table summarizes the releases and upgrade paths.
|Version||Notes||Blue-Green?||Run jets upgrade?|
|3.0.14||Using @rubyonjets/ujs-compat. Will need to make some manual changes. See details below. Manually changes are not needed for newly generated projects.||No||No|
|3.0.12||Using @rails/ujs. Will need to make some manual changes. See details below. Manually changes are not needed for newly generated projects.||No||No|
|3.0.0||Added Ruby 2.7 support. Use Serverless Gems for binary gems.||No||No|
|2.0.0||Add csrf forgery protection. The
|1.4.11||Removed vendor/dynomite gem. Must add dynomite to Gemfile now. New apps generated with
|1.3.0||Official AWS Ruby Support added. Removed longer needed
|0.10.0||Bug fix: CloudFormation routing logical ids changed to allow multiple routes to point to the same controller action. Also removed the managed
|0.9.0||CloudFormation Logical ids changed to be more concise.||Yes||No|
The following section provides a little more detail on each version upgrade. Note, not all versions required more details.
- Use @rubyonjets/ujs-compat to handle delete of CRUD.
For apps going from Jets 3.0.12 and below, you must make some manual changes.
yarn install @rubyonjets/ujs-compact
- Add instead:
import Jets from "@rubyonjets/ujs-compat"and
Jets.start()at the bottom of
- Use @rails/ujs to handle basic CRUD.
For apps going from Jets 3.0.11 and below, you must make some manual changes.
yarn install @rails/ujs
- Add instead:
import Rails from "@rails/ujs"and
- Ruby 2.7 support added. To use Ruby 2.7, just switch your current ruby version a 2.7.x variant and Jets will detect it.
- Serverless Gems is used for binary gems.
- App views are the underscored name of the controller. They are not pluralized. This was a bug and has been fixed.
config.iam_policyoption appends to the default Jets IAM policy, instead of overriding it. Use
config.default_iam_policyto completely override.
- csrf forgery protection added. Need to add
csrf_meta_tagsto the layout for js based non-get calls. Also need to update the stock
crud.js. And update the
default_protect_from_forgery = falsewhen in api mode. The
jets upgradecommand does this for you.
- Note: The
jets upgradecommand does not update your
form_tagto the newer
jets generate scaffolddoes, though. Recommend generating a scaffold, comparing the form tags and upgrading as it makes sense. The current
form_tagthough includes authenticity_token so you can leave your forms as-is if needed.
- The routes
namespacebehavior changed. Use the
prefixmethod now if you prefer the old behavior. Otherwise, you must move your controllers to modules matching the namespace.
- Remove vendor/dynomite. Add dynomite to your Gemfile now if you are using
jets newcommand has been updated to do this. Run
jets upgradeto upgrade.
- Use of Official AWS Ruby Support.
- Project gems are built as a Lambda Layer, removing the need to lazy load the gems. The
config.ruby.lazy_loadoption has been removed. You can use the
jets upgradeto automatically remove the option from your config files.
Some notable changes for version 1.2.0:
- For binary support, the API Gateway binary_media_types settings needs to have
multipart/form-data. With this version, automated blue-green deployments was introduced. So Jets will do an automated blue-green deployment as part of adding the
- Jets also added managed custom domains for vanity endpoints. This requires an additional minimal Route53 IAM permission. This is noted in Minimal Deploy IAM. You will have to add this permission to your IAM deploy permission.
jets upgrade command was introduced here. You can use it to upgrade the code structure.
In this version, the managed
Jets::WelcomeController was removed. This means you’ll have to update your
You can use the
jets upgrade command to automatically update the
The reason a blue-green deployment sometimes required is that enough of Jets has changed where a regular CloudFormation stack update rolls back. An example is in
v0.9.0, Jets changes a few of the CloudFormation logical ids. In this case, CloudFormation fails to create Lambda functions with the same name and switch over to them because the Lambda functions already exist with their old logical ids. If you’re seeing the CloudFormation stack rollback after upgrading, you might want to try a manual blue-green deployment. Below are some additional notes on blue-green deployments.
It is easy to do a blue-green deployment with Jets, and you will only need to do a blue-green deployment once after upgrading Jets for that version. Once done, you can normally deploy again.
Important: With blue-green deployments, the API Gateway endpoint will change. Any applications referencing the endpoint will need to be updated. For this reason, it is recommended to use an API Gateway Custom Domain, so you do not have to update the endpoint in the future.
Here’s a typical in-place deploy:
cd demo # your project bundle update jets deploy # in place deploy
For a blue-green deployment, you use
JETS_ENV_EXTRA to create a brand new Jets environment. You then switch to it and destroy the old environment. First, create the new environment:
cd demo # your project bundle update JETS_ENV_EXTRA=2 jets deploy # creates an additional jets environment for your app
Then update the Gateway API Custom Domain to point to the newly deployed
Gateway API Custom Domain
- Test the new environment and make sure you’re happy with it.
- Go to API Gateway Console.
- Click on Custom Domains.
- Find the Custom domain you are currently using and click on it.
- Update the custom domain so it points to the newly created Jets environment.
- Make sure there’s no traffic hitting the old Jets environment. You can do this by checking out the CloudWatch metrics. Nothing should be hitting it aside from the pre-warming requests. You can disable the pre-warming requests manually by using the CloudWatch console also.
- Destroy the old environment.