feat: Build Rover without `supergraph compose` for Alpine #538

EverlastingBugstopper · 2021-05-13T17:02:29Z

This PR satisfies the first steps checklist outlined in #537.

Adds a composition-js cargo feature to Rover (which is enabled by default)
In release.yml we compile for x86_64-unknown-linux-musl with the --no-default-features flag
In our test.yml we run an extra cargo check --workspace --locked --no-default-features to make sure it compiles OK
Both the npm installer and the curl installer now check for the existence of glibc >= 2.18 and downloads the musl binary if it does not exist. It will also print a warning to the user that their install is not fully-featured.

If a user installs the musl binary and attempts to run rover supergraph compose, they will get the following error:

$ rover supergraph compose
error: This version of Rover does not support this command.
        If the command `ldd --version` prints a `glibc` version >= 2.18, you can try installing the Rover binary built for `x86_64-unknown-linux-gnu`.

I... couldn't find a nice way to check the glibc version right in Rust. I think that error message should be good enough in that case? It's not perfect.

A few other things:

Installing on Alpine will give you the following warning message:

$  curl -sSL https://rover.apollo.dev/nix/latest | sh
This operating system does not support dynamic linking to glibc.
Downloading musl binary that does not include `rover supergraph compose`.
downloading rover from https://github.com/apollographql/rover/releases/download/v0.1.1/rover-v0.1.1-x86_64-unknown-linux-musl.tar.gz
Writing binary to /home/avery/.rover/bin/rover
rover was successfully installed. Great!

To get started you need Rover's bin directory (/home/avery/.rover/bin) in your PATH environment variable. Next time you log in this will be done automatically.

To configure your current shell, you can run:
exec /bin/ash -l
If you would like to disable Rover's anonymized usage collection, you can set APOLLO_TELEMETRY_DISABLED=1
You can check out our documentation at https://go.apollo.dev/r/docs.

I've added the -l flag to the exec $SHELL command that we recommend since Alpine will only re-source .profile on login shells. This flag also works on zsh and bash.

abernix

This was mostly not Rust, so I reviewed that more carefully. I did review the Rust, and didn't notice anything unexpected.

.github/workflows/release.yml

installers/binstall/scripts/nix/install.sh

installers/npm/binary.js

src/command/supergraph/compose/no_compose.rs

EverlastingBugstopper · 2021-05-13T18:22:29Z

maybe what we do is we check ldd --version for the string "musl" and base it on that since ldd exists on both alpine and non-alpine images?

abernix · 2021-05-13T18:46:59Z

I think that's a good approximation. Expanding on that I trust this implementation which uses that approach but expands on it a bit!

https://github.com/lovell/detect-libc

EverlastingBugstopper · 2021-05-13T19:21:24Z

oo look what i found

EverlastingBugstopper · 2021-05-13T21:25:30Z

Cargo.toml

@@ -57,7 +65,7 @@ strsim = "0.10"
 structopt = "0.3.21"
 toml = "0.5"
 tracing = "0.1.26"
-url = "2.2.2"


i think compiling with --no-default-features made this break, so had to add it explicitly so our no-composition-js would compile

EverlastingBugstopper · 2021-05-13T21:27:13Z

src/command/supergraph/compose/no_compose.rs

+    /// The relative path to the supergraph configuration file.
+    #[structopt(long = "config")]
+    #[serde(skip_serializing)]
+    config_path: Option<Utf8PathBuf>,


made this an option so folks wouldn't see an error message requiring this flag that, if provided, wouldn't do anything anyway

EverlastingBugstopper · 2021-05-13T21:27:31Z

src/command/supergraph/compose/no_compose.rs

+        let mut err = RoverError::new(anyhow!(
+            "This version of Rover does not support this command."
+        ));
+        err.set_suggestion(Suggestion::CheckGnuVersion);


we should be doing this in our command code waaayyy more often. i forgot i made the api like this.

EverlastingBugstopper · 2021-05-13T21:28:07Z

src/error/metadata/suggestion.rs

@@ -127,8 +128,7 @@ impl Display for Suggestion {
            Suggestion::Adhoc(msg) => msg.to_string(),
            Suggestion::CheckServerConnection => "Make sure the endpoint is accepting connections and is spelled correctly".to_string(),
            Suggestion::ConvertGraphToSubgraph => "If you are sure you want to convert a non-federated graph to a subgraph, you can re-run the same command with a `--convert` flag.".to_string(),
-
-
+            Suggestion::CheckGnuVersion => "If the command `ldd --version` prints a `glibc` version >= 2.18, you can try installing the Rover binary built for `x86_64-unknown-linux-gnu`.".to_string(),


don't love this messaging... lemme know if y'all have ideas

EverlastingBugstopper · 2021-05-14T20:39:22Z

Alright! I think this is good to go, I've tested everything out on my fork and installs work great on both Alpine and Ubuntu.

I made a few small small tweaks that I have kicked off a build for. By the time anybody sees this, hopefully the following command is good to go if you want to test everything yourself:

curl -sSL https://raw.githubusercontent.com/EverlastingBugstopper/rover/v0.1.1-test.10/installers/binstall/scripts/nix/install.sh | sh

Cargo.toml

src/error/metadata/suggestion.rs

Co-authored-by: Irina Shestak <[email protected]>

EverlastingBugstopper added the feature 🎉 new commands, flags, functionality, and improved error messages label May 13, 2021

EverlastingBugstopper added this to the May 25 milestone May 13, 2021

EverlastingBugstopper requested review from JakeDawkins, lrlna and StephenBarlow as code owners May 13, 2021 17:02

abernix approved these changes May 13, 2021

View reviewed changes

.github/workflows/release.yml Show resolved Hide resolved

installers/binstall/scripts/nix/install.sh Outdated Show resolved Hide resolved

installers/npm/binary.js Outdated Show resolved Hide resolved

src/command/supergraph/compose/no_compose.rs Outdated Show resolved Hide resolved

EverlastingBugstopper force-pushed the avery/alpine-build branch from 1e0c56f to cd3433b Compare May 13, 2021 18:54

EverlastingBugstopper force-pushed the avery/alpine-build branch 3 times, most recently from e27ee67 to 8bba2d9 Compare May 13, 2021 21:21

EverlastingBugstopper and others added 12 commits May 13, 2021 16:23

feat: add composition-js cargo feature

c305982

feat: compile for musl-linux in release.yml

ef1b19d

feat: adds musl platform detection to installers

a8f2efe

fix: fmt/lint

a780cf5

docs: updates Alpine docs

a5b09bd

chore: install musl-tools

524a9fd

chore: update asset path

3b8f43c

chore: correct bin path + require fs dont import

73b9cc0

feat: creates suggestions for libc errors

2e23c9c

chore: more intelligent glibc version checkers

b1a71e6

chore: tweak no-compose error message

539b5f7

chore: update install.sh error to match npm

86063a8

EverlastingBugstopper force-pushed the avery/alpine-build branch from 8bba2d9 to 86063a8 Compare May 13, 2021 21:24

EverlastingBugstopper commented May 13, 2021

View reviewed changes

EverlastingBugstopper added 3 commits May 13, 2021 16:34

chore: test that --no-default-features can compile

fa13eeb

fix: reverse 0+1 return status

df1064e

chore: escape backticks

4589a15

chore: add -l to exec instructions

eef8c0c

lrlna reviewed May 17, 2021

View reviewed changes

Cargo.toml Show resolved Hide resolved

src/error/metadata/suggestion.rs Outdated Show resolved Hide resolved

Update src/error/metadata/suggestion.rs

ca96069

Co-authored-by: Irina Shestak <[email protected]>

EverlastingBugstopper force-pushed the avery/alpine-build branch from 01452ce to ca96069 Compare May 17, 2021 14:41

chore: update to feature resolver v2

837d93b

EverlastingBugstopper merged commit ae7320d into main May 17, 2021

EverlastingBugstopper deleted the avery/alpine-build branch May 17, 2021 16:17

EverlastingBugstopper modified the milestones: May 25, May 19 May 19, 2021

tcarrio mentioned this pull request Aug 22, 2022

docs: remove note on unsupported Alpine command #1248

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Build Rover without `supergraph compose` for Alpine #538

feat: Build Rover without `supergraph compose` for Alpine #538

EverlastingBugstopper commented May 13, 2021 •

edited

Loading

abernix left a comment

EverlastingBugstopper commented May 13, 2021

abernix commented May 13, 2021

EverlastingBugstopper commented May 13, 2021

EverlastingBugstopper May 13, 2021

EverlastingBugstopper May 13, 2021

EverlastingBugstopper May 13, 2021

EverlastingBugstopper May 13, 2021

EverlastingBugstopper commented May 14, 2021 •

edited

Loading

feat: Build Rover without supergraph compose for Alpine #538

feat: Build Rover without supergraph compose for Alpine #538

Conversation

EverlastingBugstopper commented May 13, 2021 • edited Loading

abernix left a comment

Choose a reason for hiding this comment

EverlastingBugstopper commented May 13, 2021

abernix commented May 13, 2021

EverlastingBugstopper commented May 13, 2021

EverlastingBugstopper May 13, 2021

Choose a reason for hiding this comment

EverlastingBugstopper May 13, 2021

Choose a reason for hiding this comment

EverlastingBugstopper May 13, 2021

Choose a reason for hiding this comment

EverlastingBugstopper May 13, 2021

Choose a reason for hiding this comment

EverlastingBugstopper commented May 14, 2021 • edited Loading

feat: Build Rover without `supergraph compose` for Alpine #538

feat: Build Rover without `supergraph compose` for Alpine #538

EverlastingBugstopper commented May 13, 2021 •

edited

Loading

EverlastingBugstopper commented May 14, 2021 •

edited

Loading