Skip to content

Releases: shuttle-hq/shuttle

v0.21.0

10 Jul 08:59
@chesedo chesedo
v0.21.0
c334a1c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.21.0

shuttle: v0.21.0 update

We're excited to release shuttle v0.21.0! 🚀

Bug fixes

  • Fixed a bug where deploying a project with an RDS database was reporting deployment failure in the CLI when the deployment was waiting for the RDS instance to be ready in #1068
  • Fixed a bug where trailing slashes were normalized away from the paths of requests to the gateway proxy in #1074

Contributions

  • @ShouvikGhosh2048 added a check for source-code archive size in the client to warn users from trying to deploy a project that is larger than the 50MB size limit in #1070
  • @beyarkay eased the getting started experience by including --allow-dirty in the suggestion for how to deploy following cargo shuttle init in #1076
  • @RobWalt updated the path to the examples submodule to match the updated repo name in #1049

Upgrading

After this update if your restart your project (restarting will automatically update your container) you will also need to upgrade your shuttle dependencies to 0.21.0 before you can deploy again.

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

New Contributors

Full Changelog: v0.20.0...v0.21.0

Contributors

RobWalt, oddgrd, and 2 other contributors
Assets 7
Loading

v0.20.0

28 Jun 11:40
@chesedo chesedo
v0.20.0
bf0365a
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.20.0

shuttle: v0.20.0 update

We're excited to release shuttle v0.20.0! 🚀

Turso integration

Turso is a new sqlite-based edge database and we’re excited to announce a Shuttle resource integration for it. This is the first iteration of this integration, so it comes with some caveats. The first one is that it is not yet possible for us to provision a Turso database for you, so you need to refer to their docs and do that yourself for now. It should also be noted that you can host a Turso database anywhere, but currently your Shuttle service can only be hosted in London.

Thanks to @Kazy from the Shuttle batch for this integration!

Deployment archive size limits

We have added a 50MB size limit to deployments, meaning the archive of your source code (which includes static folder) can not be larger than 50MB or deploy will fail with a 413 error. This measure is intended to defend against large request body DoS attacks, so if you have a normal project and encounter the 413 error please let us know and we will consider increasing the limit.

Git metadata for deployments

The cargo shuttle deployment --list command will now include git metadata like the commit message of the current commit at the time of deploy, as well as branch name etc. Thanks to @Fuzzicles for a great first contribution to Shuttle!

Bug fixes

  • Fixed a bug where many users were hitting the request body limit in deploy due to .git repositories being included in archive in #1036
  • Fixed a bug where users with a global target directory got a “file not found” error - #1039
  • Fixed a bug where windows users got a “file not found” error - #1039
  • Fixed a bug where timezones were incorrectly displayed in logs output - #1032

The eighth and final week of Shuttle Batch 2023

The Shuttle batch has reached its conclusion. We had a lot of great contributions in this last week, and we also have several larger pull requests from the batch in the pipeline. We’d like to express our appreciation to all the participants of this event, thank you all for being a part of this!

  • @jonaro00 fixed two bugs in #1039, one affecting users with a global target directory, and one affecting windows users.
  • @jonaro00 excluded the .git repository of projects from the deployment archive to avoid sending these large files that aren’t used, and that caused users with normal projects to encounter the 413 error in deployer in #1036
  • @jonaro00 made some improvements to the shuttle runtime in #1012
  • @jonaro00 cleaned up the shuttle-service dependencies and did some general clean up of code in #1013
  • @jonaro00 cleaned up our CI config and dockerfile in #989
  • @Kazy fixed some sporadically failing tests in the deployer in #980
  • @jonaro00 fixed some issues with windows local runs in #1054

Other contributions

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

  • fix: remove vendored-openssl from CI and broken axum test by @oddgrd in #1021
  • fix: cargo-generate needs openssl by @oddgrd in #1023
  • fix: increase body size limit for deploy by @oddgrd in #1031
  • fix: Don't deploy .git folder to save space by @jonaro00 in #1036
  • chore: cargo-shuttle v0.19.1 by @oddgrd in #1037
  • Fix(common): format logs in correct local timezone by @timonv in #1032
  • fix: Target directory from config, Windows .exe suffix by @jonaro00 in #1039
  • feat: add new deployment metadata to table by @Fuzzicles in #987
  • build(shell.nix): add openssl package to the build dependencies by @timonv in #1040
  • fix(runtime): Remove 2s startup sleep by @jonaro00 in #1012
  • chore: move codegen::main from service to runtime by @jonaro00 in #1013
  • fix: dockerfile and ci improvements by @jonaro00 in #989
  • fix: windows local run + log clarifications by @jonaro00 in #1054
  • Attempt at fixing sporadic failures of shuttle-deployer by @Kazy in #980
  • gateway: status check includes info about auth & provisioner by @iulianbarbu in #1056
  • feat(resources): add support for turso client w/o provisioning by @Kazy in #996
  • Chore/v0.20.0 by @oddgrd in #1057

Full Changelog: v0.19.0...v0.20.0

Contributors

timonv, Kazy, and 6 other contributors
Assets 7
Loading

v0.19.0

20 Jun 12:13
@chesedo chesedo
v0.19.0
183a81e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.19.0

shuttle: v0.19.0 update

We're excited to release shuttle v0.19.0! 🚀

Upgraded to Rust 1.70

Our deployers (the containers in which your service will be built and ran) have a pinned version of Rust. This has now been upgraded to 1.70, thanks @iamwacko from the Shuttle batch!

Init from any template

Our cargo shuttle init command has been refactored to now clone templates from github repositories. To get a hello world example from our repository, you can simply run:
cargo shuttle init -t axum.

You can also initialize a project from any template by passing in the url of any repository and the sub-folder you want to clone. Below is an example of how you would init an axum project from our websocket example.

cargo shuttle init --from https://github.com/shuttle-hq/shuttle-examples.git --subfolder axum/websocket

Thanks to @paulotten and @jonaro00 from the Shuttle batch for this great new functionality!

The sixth and seventh weeks of Shuttle Batch 2023

The Shuttle batch is nearing the end, but their contributions are still forming the majority of this release. We also have several large batch contributions implementing new features like DynamoDB, Turso and Sqlite in the pipeline.

  • @iamwacko updated our pinned version of Rust to 1.70 and fixed some new clippy lints in #967
  • @iamwacko removed the cargo dependency of the builder #922
  • @jonaro00 fixed a bug where the cargo shuttle logs --latest was returning the oldest deployment’s logs due to the order being flipped in the recent pagination PR in #982
  • @hseeberger and @jonaro00 added some relevant git data to the metadata of deployments, in #943. This will be very useful in our upcoming console!
  • @iamwacko refactored the Shuttle codebase to use rustls rather than native-tls with openssl in #879
  • @paulotten refactored our init code to rather clone examples from our repository using the cargo-generate crate under the hood in #888
  • @jonaro00 implemented IntoIter for our secretstore in #1006

Other contributions

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits in this release

New Contributors

  • @lecoqjacob made their first contribution in #993

Full Changelog: v0.18.0...v0.19.0

Contributors

hseeberger, paulotten, and 6 other contributors
Assets 7
Loading

v0.18.0

05 Jun 10:44
@chesedo chesedo
v0.18.0
f2a3c4d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.18.0

shuttle: v0.18.0 update

We're excited to release shuttle v0.18.0! 🚀

Removal of protoc requirement

With the last of our upstream crates upgraded to no longer need protoc available at compile-time, installingprotoc will no longer be required to install or use Shuttle! 🥳

Pagination of list commands

Two of our list commands can now be paginated, namely project list and deployment list. These commands will now by default fetch the 10 latest deployments, a --page 2 flag can then be passed to fetch the next 10 deployments, and so on. The limit of how many to fetch per page can also be configured with the --limit flag.

Thanks to @AlphaKeks and @Kazy from the Shuttle batch for this feature! PR: #862

Sanitizing paths in our proxy layer

@chesedo developed and published a new crate, [tower-sanitize-path](https://crates.io/crates/tower-sanitize-path), for sanitizing paths with tower, and implemented it in our proxy layer to protect users against path traversals in #946

The fourth and fifth weeks of Shuttle Batch 2023

The Shuttle batch continues with a lot of great contributions! We’ve also seen tremendous progress on larger tickets, so keep your eyes peeled for some larger new features in the next releases! Here are the batch contributions for the last two weeks:

Other contributions

  • @orhun updated our lockfile in #942
  • @beyarkay improved the panic message in the event where the shuttle-runtime port is already taken in #950
  • @imor fixed an issue where cargo-shuttle commands that were passed --name could not be ran outside a cargo project in #929
  • @imor added a tracing::debug! call to cargo-shuttle to output which files are archived for deployment in #931

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

  • feat(shuttle-axum) Make AxumService generic to be able to use state by @morlinbrot in #924
  • docs: Update links and commands by @jonaro00 in #948
  • misc: Update GitHub templates by @jonaro00 in #945
  • Update Cargo.lock by @orhun in #942
  • Add helpful error if port cannot be used by @beyarkay in #950
  • fix: --name was ignored when not running from cargo folder by @imor in #929
  • chore: bump otel crates and remove protoc dep by @oddgrd in #956
  • fix: log files packed in archive by @imor in #931
  • refactor: sanitize all path on the user's proxy by @chesedo in #946
  • feat(gateway, cargo-shuttle): implement pagination for project list by @AlphaKeks in #862
  • fix: crossterm/comfytable conflict by @oddgrd in #959
  • feat: pre-installed build environment in deployer by @jonaro00 in #960
  • refactor: un-tangle crossterm/comfytable by @oddgrd in #961
  • fix: Ignore span logs below WARN by @jonaro00 in #958
  • fix: remove cargo-sort from CONTRIBUTING.md by @paulotten in #966
  • fix/release(prod): unstable AWS creds clashed with prod by @iulianbarbu in #970
  • chore: v0.18.0 by @oddgrd in #972

New Contributors

Full Changelog: v0.17.0...v0.18.0

Contributors

Kazy, paulotten, and 9 other contributors
Assets 7
Loading

v0.17.0

23 May 07:46
@chesedo chesedo
v0.17.0
5b9885c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.17.0

shuttle: v0.17.0 update

We're excited to release shuttle v0.17.0! 🚀

Second and third week of Shuttle Batch 2023

We are extremely excited to see how the batch participants progress on the small and medium-sized projects. We had all round contributions and enjoyed seeing the participants taking the lead and clarifying their projects with the maintainer team, seeking the biggest impact. We are very happy to see the help they offer to each other, the encouraging words, and the team spirit that makes them push through. Thanks to everyone and we’re looking forward to seeing more of this!

As for the contributions, here is the list:

  • @iamwacko added an optional flag to allow not running our local development environment in detached mode in #878
  • @XaviFP fixed a broken link in our codegen errors in #885
  • @utterstep added a feature-flag to shuttle-shared-db to allow users to use rustls rather than native-tls if they want to in #870
  • @SyedFasiuddin upgraded our codegen to syn 2.0 in #880
  • @paulotten upgraded our aws sdk crates in #897
  • @piewhat removed the cargo dependency from deployer, and also refactored the test run on deploys to show the output of failed tests in #907
  • @jonaro00 and @hseeberge1r implemented a new feature that allows users to reset their api-keys, which is useful if you leaked your key, in #857
  • @SyedFasiuddin contributed to adding next logical suggestions for various cargo-shuttle commands: #915.

Other contributions

  • @arturaz improved the performance of our JwtAuthentication layer by manually implementing Future for it in #868
  • @kierendavies removed the clap dependency from shuttle-runtime, replacing it with a declarative macro, ensuring we don’t leak the clap dependency to users projects in #822
  • @figsoda added hyper-reverse-proxy as a workspace dependency ****used by both the deployer and gateway in #921
  • @merlinbrot added an awesome request-scheduler example showcasing how to do cron-like schedules for accessing a URL in shuttle-hq/shuttle-examples#47
  • @joshua-mo-143 added a SaaS full-stack application powered by Next.js and Shuttle: shuttle-hq/shuttle-examples#50.

cargo-shuttle is now packaged for Arch Linux

@orhun has packaged cargo-shuttle for Arch Linux, and he has graciously volunteered to keep the package updated. He added installation instructions to our readme in #902 Thanks!

You can now install cargo-shuttle on Arch Linux with pacman:

pacman -S cargo-shuttle

Shuttle Salvo integration version bump

shuttle-salvo has been upgraded to v0.41, this means that to use version 0.17.0 of shuttle-salvo you’ll also need to update your project to use the new version.

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Contributors

arturaz, utterstep, and 10 other contributors
Assets 7
Loading

v0.16.0

08 May 10:21
@chesedo chesedo
v0.16.0
62a21c1
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.16.0

shuttle: v0.16.0 update

We're excited to release shuttle v0.16.0! 🚀

First week of Shuttle Batch 2023

This marks the first release since the start of this year’s batch, bringing a lot of new contributors to Shuttle. We’ve already had several pull requests, solving a lot of long-standing issues.

  • @piewhat and @pedromfedricci fixed a bug where panic messages from users services that were owned strings were not captured in the runtime logs in #854
  • @vroussea and @utterstep fixed a bug were some tracing data was lost due to a missing on_new_span impl on our Logger in #864
  • @paulotten and @mikegin refactored our examples to serve “Hello, world!” at / and updated our relevant tests in #863
  • @paulotten fixed our end to end tests in #858
  • @AlphaKeks added an .editorconfig in #855
  • @morlinbrot changed the default port for the provisioner to make contributing easier for contributors with AirPlay receivers in #852
  • @iamwacko improved the efficiency of our CI in #859
  • @jonaro00 cleaned up some dead code in #832

Updated init command

@jonar00, also from the shuttle batch, made a series of improvement to our init command, making it a lot easier to implement for new service implementations. He also made some changes to the API, to initialize with a certain framework you now first need to pass the new --template (or -t) flag.

# before
cargo shuttle init --axum

# now
cargo shuttle init --template axum
# or
cargo shuttle init -t axum

In the future we intend to refactor init to initialize from any template by passing in a URL, for example a link to one of our examples.

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

All commits for this release

New Contributors

Full Changelog: v0.15.0...v0.16.0

Contributors

utterstep, paulotten, and 10 other contributors
Assets 7
Loading

v0.15.0

27 Apr 15:00
@chesedo chesedo
v0.15.0
b626bf0
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.15.0

shuttle: v0.15.0 update

We're excited to release shuttle v0.15.0! 🚀

Improving our pre-release QA

To prevent regressions we need to do thorough QA of the changes we make for new releases. To prevent this from slowing down releases and development, for this release we have started implementing automated QA in our CI. For this first iteration we will do an end-to-end test of installing cargo-shuttle, doing a local run and a deploy on macOS and Linux (a workflow for windows should be ready for the next release).

Updated CLI command and first bounty 💎

For this release we had our first approved bounty contribution, congratulations to @jonaro00!

To claim the bounty they submitted an implementation of a new flag for the logs command in the CLI:

cargo shuttle logs —latest

This command is a convenient way to get the logs of the last deployment, so you will not need to do a deployment list, get the ID and then a cargo shuttle logs <id> to get the latest one. All the existing functionality of the command remains the same.

Error message improvements

For this release we have addressed some poor or missing error messages:

  • Updated the error messages on commands that 404 when a deployment and/or service is missing with more information and a tip to resolve it.
  • Validate the input in the interactive login from cargo shuttle login, to ensure incorrectly pasted keys will prompt the user to re-submit.

Bug fixes

  • Fixed a bug where cancelling a local run or a local run crashing would not free the port bound by the service, leading to crashes on subsequent runs #805
  • Fixed a bug where we were inadvertently logging secrets in the deployer #814

Contributions

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

Full Changelog: v0.14.0...v0.15.0

Contributors

chesedo, jhawkesworth, and 4 other contributors
Assets 7
Loading

v0.14.0

12 Apr 15:07
@chesedo chesedo
v0.14.0
1db4ae7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.14.0

shuttle: v0.14.0 update

We're excited to release shuttle v0.14.0! 🚀

Workspace support

We now have full support for cargo workspaces! We have had limited support in the past, where only a workspace where the shuttle project was the root crate was deployable. Following this release, you will be able to have a regular workspace. We will search the workspace for shuttle projects, and in this first iteration we will start all of them for local runs, but only the first one we find for deployments.

We intend to allow starting several services in deployment too. The long term plan is to have one central service that routes to the other services in the project, sharing resources amongst them. Any feedback on what people would like to see in this area is most welcome.

Note: When deploying a workspace where the shuttle service uses shuttle-static-folder, the static folder must be placed in the workspace root.

Changes to the project commands

We have a new project command: cargo shuttle project restart. This command will replace the old flow of project rm → project new to restart a project.

In addition to that, the following cargo shuttle project commands have been renamed:

  • new has been renamed to start
  • rm has been renamed to stop

Their functionality remains the same, they will start and stop your project’s container.

Thanks to @jonaro00 for suggesting, implementing and documenting these changes!

Removing the protoc requirement for cargo-shuttle

We have removed the need for protoc to install cargo-shuttle, but protoc will still be required to build, run and deploy shuttle services. We intend to remove the protoc requirement entirely in the next release.

Bug fixes

  • Fixed a bug where a deployment might return an error due to not waiting on the deployment state to update, thanks @jonaro00! #744
  • Fixed a bug on windows where the path to the static folder was incorrect for local runs: #762
  • Fixed a bug where setting the local_uri for databases would cause deployments to fail: #786

Contributions

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the restart project command. This will not delete any databases, and you will keep your project name:

cargo shuttle project restart

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

Full Changelog: v0.13.0...v0.14.0

Contributors

kierendavies, chesedo, and 6 other contributors
Assets 7
Loading

v0.13.0

27 Mar 15:23
@chesedo chesedo
v0.13.0
99accab
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.13.0

shuttle: v0.13.0 update

We're excited to release shuttle v0.13.0! 🚀

Changes to the cargo-shuttle CLI

We added a new command to list all the provisioned resources for your project, like databases and secrets: cargo shuttle resource list. With the addition of the new resource command, the cargo shuttle status command will no longer list resources.

Note: Due to the changes to the deployer API required for the resource list command, if you do a project rm and project new after this release you will also need to upgrade your CLI.

Upgrading our pinned Rust version

In this release we bump our pinned version of Rust to 1.68, previously 1.65, allowing users to use the new language features introduced in these updates. To be able to take advantage of this, you will need to update your project container by running cargo shuttle project rm followed by cargo shuttle project new.

Contributions

Upgrading

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the rm and new project commands. This will not delete any databases, and you will keep your project name:

cargo shuttle project rm
cargo shuttle project new

Finally, redeploy your shuttle service:

cargo shuttle deploy

Commits for this release

Full Changelog: v0.12.0...v0.13.0

Contributors

chesedo, meskill, and 5 other contributors
Assets 7
Loading

v0.12.0

20 Mar 16:24
@chesedo chesedo
v0.12.0
b6d7b6f
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.12.0

shuttle: v0.12.0 update

We're excited to release shuttle v0.12.0! 🚀

Removing our unsafe FFI

As of this release Shuttle will no longer rely on compiling users projects as dynamic libraries, we have refactored the codegen to embed the required code to configure and add resources to a users project binary. This means we can get rid of the unsafe FFI needed to load the dynamic libraries, which was a big source of memory issues (especially for local runs). As a result of the refactor, we’ll be able to:

  • Get rid of the Sync requirement for services.
  • Get rid of the extra tokio::Runtime that is currently required for shuttle resources to be started on the correct side of the FFI (e.g. shuttle_shared_db, shuttle_secrets).
  • Correctly stop deployments.
  • Remove the version pin on tokio (as of writing it is pinned to 1.22).

Shuttle-next framework

Shuttle-next is a brand new WASM web-framework based on axum and hyper. There are many benefits to using WASM for a backend web-framework, but one of the key features is the isolation it offers. Since WASM modules have no notion of a file system, a shuttle-next project can only interact with the host through resources explicitly declared by us. In this first iteration, the only resource available is an HTTP stream to and from a project.

Shuttle-next is very much a work in progress, and we're releasing this iteration without some of the
features that make shuttle a pleasure to use, for example the ability to effortlessly deploy and connect to a database. It's also not currently possible to use any middleware. We're planning to implement this functionality, and more, in the near future. We're also hoping that the feedback we get from this release will help us see which features we should prioritize, and which areas of the framework's design need the most attention going forward.

Below is a small example of shuttle-next, see the example in our docs for more information.

Note: shuttle-next does not currently work on Windows, it only works on unix systems (i.e mac, Linux and Windows Subsystem for Linux). We aim to resolve this in future releases.

// lib.rs
shuttle_next::app! {
    #[shuttle_next::endpoint(method = get, route = "/hello")]
    async fn hello() -> &'static str {
        "Hello, World!"
    }
}

Extracting the service integrations

The service implementations for frameworks like Axum, Rocket, Serenity etc., have now been extracted into separate crates. You will now need to depend on that crate, e.g shuttle_axum = "0.12.0", rather than shuttle-service = { version = "0.12.0", features = ["web-axum"] }.

Bug fixes

  • Fixed a bug where windows users had to do a cargo build before they could cargo shuttle run: #721
  • Fixed a bug where the file contents of static assets in the shuttle_static_files directory were deleted in local runs: #717
  • Fixed a bug where passing a path to cargo shuttle init would return an error: #706

Protoc requirement

Due to new dependencies we can’t go without users will now need to install protoc to install and use cargo-shuttle and our other crates. We tried to find a way around this requirement, but it came at the cost of significantly increased build times. We know this extra step required before being able to use shuttle is far from ideal, and we’ll try to find a good way around it in the future.

Mac and Linux

To install protoc from the distributed binary, you can use this script:

# replace <arch> with your architecture, for example for linux x86_64 replace <arch> with: linux-x86_64
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v21.9/protoc-21.9-<arch>.zip &&\
        sudo unzip -o protoc-21.9-<arch>.zip -d /usr/local bin/protoc &&\
        sudo unzip -o protoc-21.9-<arch>.zip -d /usr/local 'include/*' &&\
        rm -f protoc-21.9-<arch>.zip

If you'd like to do this yourself without the above script, see instructions here: https://grpc.io/docs/protoc-installation/#install-pre-compiled-binaries-any-os

On mac you can also install protoc with brew: brew install protobuf.

Note: installing protoc on Linux with apt-get install protobuf-compiler will not be enough, since it will install an old version of protoc (v3.12) but it needs to be at least v3.19. Installing on mac using brew works.

Windows

On Windows the simplest way to install protoc is to first install chocolatey, and then simply run: choco install protoc

Upgrading

Due to the nature of these changes, all projects will be stopped and forced to upgrade. Please see instructions here for how to upgrade, as well as our updated examples and updated docs

First, since your project will now be compiled as a binary and no longer a library, you need to convert it to a binary. That means renaming the lib.rs file where your shuttle_service::main function currently is to main.rs, and you’ll also need to remove the [lib] field from your Cargo.toml.

We have also made some changes to the imports, you’ll now need to import shuttle-runtime and tokio, as well as the service integration for your framework. See the example below.

# Before for axum apps
axum = "0.6"
shuttle-service = { version = "0.11.0", features = ["web-axum"] }
sync_wrapper = "0.1.1"

# After for axum apps
axum = "0.6"
shuttle-axum = "0.12.0"
shuttle-runtime = "0.12.0"
tokio = "1.26.0"

# Before for serenity bots
serenity = { version = "0.11.5", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
shuttle-secrets = "0.11.0"
shuttle-service = { version = "0.11.0", features = ["bot-serenity"] }

# After for serenity bots
serenity = { version = "0.11.5", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
shuttle-runtime = "0.12.0"
shuttle-serenity = "0.12.0"
shuttle-secrets = "0.12.0"
tokio = "1.26.0"

Since the service integrations now live in a different crate from where the Service trait is defined, they need to be wrapped in a new-type for us to be able to implement Service for them. This means you need to wrap the return type from your shuttle_runtime::main function in this type, but he have implemented From from for all the integrations, so you can simply return Ok(router.into()). See an example of upgrading an axum app below, and see our updated examples for other integrations:

// Before in src/lib.rs
use axum::{routing::get, Router};
use sync_wrapper::SyncWrapper;

async fn hello_world() -> &'static str {
    "Hello, world!"
}

#[shuttle_service::main]
async fn axum() -> shuttle_service::ShuttleAxum {
    let router = Router::new().route("/hello", get(hello_world));
    let sync_wrapper = SyncWrapper::new(router);

    Ok(sync_wrapper)
}

// After in src/main.rs
use axum::{routing::get, Router};

async fn hello_world() -> &'static str {
    "Hello, world!"
}

#[shuttle_runtime::main]
async fn axum() -> shuttle_axum::ShuttleAxum {
    let router = Router::new().route("/hello", get(hello_world));

    Ok(router.into())
}

To upgrade your shuttle CLI, run: cargo install cargo-shuttle, or if you’re using cargo-binstall, cargo binstall cargo-shuttle.

If you’d like to upgrade your project container, run the rm and new project commands. This will not delete any databases, and you will keep your project name:

cargo shuttle project rm 
cargo shuttle project new

Finally, redeploy your shuttle service:

cargo shuttle deploy

Contributions

  • @kierendavies made their first contribution to shuttle by fixing a nefarious cyclical dependency bug in #700
  • @blixus made some great improvements to our CLI docs in shuttle-hq/shuttle-docs#48
  • @HexPanda made their first contribution to shuttle by fixing the indentation of the poise init code in #687
  • @stavares843 made their first contribution to shuttle by fixing some typos in our repo in #682

Commits for this release

  • feat: shuttle-serenity initial commit poc by @brokad in #429
  • shuttle next wrapper POC by @oddgrd in #431
  • refactor: create runtimes workspace by @chesedo in #432
  • feat: add --provisioner-address arg to both runtimes by @chesedo in #433
  • feat: create a control plane interface (part 1) by @chesedo in #436
  • refactor: combine runtimes into one by @chesedo in #438
  • feat(deployer): add support for building wasm projects by @akrantz01 in #437
  • feat: move factory to runtime by @oddgrd in #444
  • WIP feat: start runtime from deployer by @oddgrd in #450
  • feat: get logs from runtime by @chesedo in #459
  • [WI...
Read more

Contributors

kierendavies, chesedo, and 6 other contributors
Assets 7
Loading