Upgrading Guide

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.

Upgrade Command

Important: The jets upgrade tool was removed out of Jets 5, and move to the jets-upgrade go tool. Jets 5 is a huge release and covered in this blog post: Ruby on Jets 5.0 Release: Improvements Galore.

A jets-upgrade go command helps 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. This usually can be done by committing any unsaved changes to git.

Upgrading Releases

The following table summarizes the releases and upgrade paths.

Upgrade Details

The following section provides a little more detail on each version upgrade. Note, not all versions required more details.

5.0.0

Jets 5 is a huge release and is covered in this blog post: Ruby on Jets 5.0 Release: Improvements Galore

Surprisingly, despite so many changes, a blue-green deployment is not required. This is because the lambda functions collapse into a single one without AWS resource conflicts. Also, the APIGW Resource Methods collapsing down would typically cause an AWS resource conflict, but Jets 5 Route Change detection is smart enough to detect this and provision a new APIGW REST API automatically. If, for some reason, this change detection does not work, you can also for a new APIGW to be created with JETS_API_REPLACE=1 jets deploy. However, I have found that it’s unnecessary. The docs note that a blue-green deployment is “Depends” just in case there is some scenario we haven’t tested for.

For the Jets 5 upgrade, you should use the new jets-upgrade tool. It should get you pretty far.

Also see Jets 5 Upgrading Notes

3.0.14

• 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.

1. Run yarn install @rubyonjets/ujs-compact
2. Add instead: import Jets from "@rubyonjets/ujs-compat" and Jets.start() at the bottom of app/javascript/packs/application.js

3.0.12

• Use @rails/ujs to handle basic CRUD.

For apps going from Jets 3.0.11 and below, you must make some manual changes.

1. Run yarn install @rails/ujs
2. Remove import '../src/jets/crud' from app/javascript/packs/application.js
3. Add instead: import Rails from "@rails/ujs" and Rails.start()
4. Delete app/javascript/src/jets/crud.js

This gets you on Rails UJS, which is has better support for javascript interactions.

3.0.0

• 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.
• The config.lambda.iam.policy option appends to the default Jets IAM policy, instead of overriding it. Use config.lambda.iam.default_policy to completely override.

2.0.0

• csrf forgery protection added. Need to add csrf_meta_tags to the layout for js based non-get calls. Also need to update the stock crud.js. And update the config/jets/deploy.rb and with default_protect_from_forgery = false when in api mode. The jets upgrade command does this for you.
• Note: The jets upgrade command does not update your form_tag to the newer form_with helper. The jets generate scaffold does, though. Recommend generating a scaffold, comparing the form tags and upgrading as it makes sense. The current form_tag though includes authenticity_token so you can leave your forms as-is if needed.
• The routes namespace behavior changed. Use the prefix method now if you prefer the old behavior. Otherwise, you must move your controllers to modules matching the namespace.

1.4.11

• Remove vendor/dynomite. Add dynomite to your Gemfile now if you are using app/models/application_item.rb. The jets new command has been updated to do this. Run jets upgrade to upgrade.

1.3.0

• 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_load option has been removed. You can use the jets upgrade to automatically remove the option from your config files.

1.2.0

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 multipart/form-data binary_media_types.
• 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.

1.0.1

The jets upgrade command was introduced here. You can use it to upgrade the code structure.

0.10.0

In this version, the managed Jets::WelcomeController was removed. This means you’ll have to update your config/routes.rb. Replace:

root "jets/welcome#index"

With:

root "jets/public#show"

You can use the jets upgrade command to automatically update the config/routes.rb file.

Reasons

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.

In-Place Deploy

Here’s a typical in-place deploy:

cd demo # your project
bundle update
jets deploy # in place deploy

Blue-Green Deployment

For a blue-green deployment, you use JETS_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_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 JETS_EXTRA=2 environment.

Gateway API Custom Domain

1. Test the new environment and make sure you’re happy with it.
2. Go to API Gateway Console.
3. Click on Custom Domains.
4. Find the Custom domain you are currently using and click on it.
5. Update the custom domain so it points to the newly created Jets environment.
6. 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.
7. Destroy the old environment.