feat: Adds `nix` subcommand that uses the `fuel.nix` flake to manage binaries #461

eureka-cpu · 2023-07-20T19:32:38Z

Adds a fuelup nix subcommand that makes calls into the fuel.nix flake. This does not break the current fuelup, but will ease users into trying out the nix approach to managing toolchains and components.

Closes #457

Process for achieving completion of #457

JoshuaBatty · 2023-08-20T23:26:07Z

Leaving some more UX feedback.

After installing and running fuelup nix i get the following:

fuelup % fuelup nix
Use the fuel.nix flake to manage toolchains and components. Refer to the fuel.nix book for more info: https://github.com/FuelLabs/fuel.nix/blob/master/book/src/packages.md#packages

Usage: fuelup nix <COMMAND>

Commands:
  install  Install a distributable toolchain or component
  remove   Uninstall a toolchain or component by providing its index, unlocked attribute path or nix store path
  upgrade  Upgrade installed packages by index or unlocked attribute path with the latest version of the fuel.nix flake. Upgrades all installed packages if no index or path is provided
  list     Lists the installed packages by index, unlocked attribute path, locked attribute path and nix store path, respectively
  help     Print this message or the help of the given subcommand(s)

Can we remove this part below and just show the usage...

Use the fuel.nix flake to manage toolchains and components. Refer to the fuel.nix book for more info: https://github.com/FuelLabs/fuel.nix/blob/master/book/src/packages.md#packages

Also, can we keep the existing command descriptions instead of the ones from fuel.nix.

JoshuaBatty · 2023-08-20T23:34:58Z

I'm running fuelup nix install latest with the latest changes.

fuelup % fuelup nix install latest
downloading and installing fuel latest toolchain, this may take a while...
copying path '/nix/store/jskppgw1xjb1n7bkf6nmmqw6kk2a0c9z-sway-04a5970' from 'https://fuellabs.cachix.org'...
this derivation will be built:
  /nix/store/yds5gwpd5hhglxrzi3mh1pf6m43ipkyb-fuel-latest.drv
these 6 paths will be fetched (86.43 MiB download, 182.03 MiB unpacked):
  /nix/store/r1mwwpd3wjlwgs00h8pzngdwxk9ibl2m-forc-0.44.1
  /nix/store/161rs18wjmpx0vlvgzskc59c4lj8vwv7-forc-client-0.44.1
  /nix/store/wizcks47lf3zzdgfj94h0fs48qkn0bgh-forc-doc-0.44.1
  /nix/store/iagvlp5vlaycw9qgc89v75irr2xr2bb6-forc-fmt-0.44.1

Although I think printing every line to the console is useful, this should be behind a --verbose flag. By default, only one line is used for the installation status and subsequent messages overwrite the single line in the terminal.

JoshuaBatty · 2023-08-20T23:40:46Z

I also got this message printing to the console

building '/nix/store/yds5gwpd5hhglxrzi3mh1pf6m43ipkyb-fuel-latest.drv'...
error: An existing package already provides the following file:

         /nix/store/d2f5baagzqim9flchiswcpf7z8061h6p-fuel-latest/bin/forc-doc

       This is the conflicting file from the new package:

         /nix/store/ib3lyc87qikp98gx9djd2j6354vnjr7c-fuel-latest/bin/forc-doc

       To remove the existing package:

         nix profile remove github:fuellabs/fuel.nix

       The new package can also be installed next to the existing one by assigning a different priority.
       To prioritise the new package:

         nix profile install github:fuellabs/fuel.nix --priority 4

       To prioritise the existing package:

         nix profile install github:fuellabs/fuel.nix --priority 6

Not sure why this message still got through?

I then ran the command again and this time it just returned to the console with no status message if the installation was successful or had failed..

fuelup % fuelup nix install latest
downloading and installing fuel latest toolchain, this may take a while...
fuelup %

eureka-cpu · 2023-08-21T03:23:45Z

Leaving some more UX feedback.

After installing and running fuelup nix i get the following:

fuelup % fuelup nix
Use the fuel.nix flake to manage toolchains and components. Refer to the fuel.nix book for more info: https://github.com/FuelLabs/fuel.nix/blob/master/book/src/packages.md#packages

Usage: fuelup nix <COMMAND>

Commands:
  install  Install a distributable toolchain or component
  remove   Uninstall a toolchain or component by providing its index, unlocked attribute path or nix store path
  upgrade  Upgrade installed packages by index or unlocked attribute path with the latest version of the fuel.nix flake. Upgrades all installed packages if no index or path is provided
  list     Lists the installed packages by index, unlocked attribute path, locked attribute path and nix store path, respectively
  help     Print this message or the help of the given subcommand(s)

Can we remove this part below and just show the usage...

Use the fuel.nix flake to manage toolchains and components. Refer to the fuel.nix book for more info: https://github.com/FuelLabs/fuel.nix/blob/master/book/src/packages.md#packages

Also, can we keep the existing command descriptions instead of the ones from fuel.nix.

They aren't from the flake, I wrote those because they are accurate to the actual logic behind the command. I can remove them, but it will be less descriptive on how to actually use the commands in some cases

eureka-cpu · 2023-08-21T03:24:20Z

I also got this message printing to the console

building '/nix/store/yds5gwpd5hhglxrzi3mh1pf6m43ipkyb-fuel-latest.drv'...
error: An existing package already provides the following file:

         /nix/store/d2f5baagzqim9flchiswcpf7z8061h6p-fuel-latest/bin/forc-doc

       This is the conflicting file from the new package:

         /nix/store/ib3lyc87qikp98gx9djd2j6354vnjr7c-fuel-latest/bin/forc-doc

       To remove the existing package:

         nix profile remove github:fuellabs/fuel.nix

       The new package can also be installed next to the existing one by assigning a different priority.
       To prioritise the new package:

         nix profile install github:fuellabs/fuel.nix --priority 4

       To prioritise the existing package:

         nix profile install github:fuellabs/fuel.nix --priority 6

Not sure why this message still got through?

I then ran the command again and this time it just returned to the console with no status message if the installation was successful or had failed..

fuelup % fuelup nix install latest
downloading and installing fuel latest toolchain, this may take a while...
fuelup %

The reason the error was still showing up was because I accidentally removed a line that checked for "error:" in one of my commits where I was cleaning up

the reason you don't see it after if you run it again is because it went through the auto prioritize function

src/commands/nix/install.rs

kayagokalp

Just pointed out some stuff that got merged while this PR was cooking so that if we decide to merge this one we do not lose anything

kayagokalp · 2023-08-22T14:59:57Z

src/commands/nix/link_generator.rs

+        Ok((match comp.as_str() {
+            "fuel-core" => Self::FuelCore,
+            "fuel-core-client" => Self::FuelCoreClient,
+            "fuel-indexer" => Self::FuelIndexer,
+            "forc" => Self::Forc,
+            "forc-client" => Self::ForcClient,
+            "forc-doc" => Self::ForcDoc,
+            "forc-explore" => Self::ForcExplore,
+            "forc-fmt" => Self::ForcFmt,
+            "forc-index" => Self::ForcIndex,
+            "forc-lsp" => Self::ForcLsp,
+            "forc-tx" => Self::ForcTx,
+            "forc-wallet" => Self::ForcWallet,
+            "sway-vim" => Self::SwayVim,
+            _ => bail!(
+                "available distrubuted components:\n  -fuel-core\n  -fuel-core-client\n  -fuel-indexer\n  -forc\n  -forc-client\n  -forc-doc\n  -forc-explore\n  -forc-fmt\n  -forc-index\n  -forc-lsp\n  -forc-tx\n  -forc-wallet\n  -sway-vim\n
+available distributed toolchains:\n  -latest\n  -nightly\n  -beta-1\n  -beta-2\n  -beta-3\n  -beta-4-rc


We also started to distribute fuel-core-keygen as of #472

kayagokalp · 2023-08-22T15:00:57Z

src/commands/nix/link_generator.rs

+        let tool = match tool {
+            FuelToolchain::Latest => "",
+            FuelToolchain::Nightly => "-nightly",
+            FuelToolchain::Beta1 => "-beta-1",
+            FuelToolchain::Beta2 => "-beta-2",
+            FuelToolchain::Beta3 => "-beta-3",
+            FuelToolchain::Beta4rc => "-beta-4-rc",
+            FuelToolchain::Unknown => bail!("available distributed toolchains:\n  -latest\n  -nightly\n  -beta-1\n  -beta-2\n  -beta-3\n  -beta-4-rc") 


We also have beta-4-rc.2 as of #467

kayagokalp · 2023-08-22T15:01:46Z

src/commands/nix/link_generator.rs

+#[derive(Eq, PartialEq, Debug)]
+pub(crate) enum FuelToolchain {
+    Latest,
+    Nightly,
+    Beta1,
+    Beta2,
+    Beta3,
+    Beta4rc,
+    Unknown,
+}


^ I guess we should also add Beta4Rc2 to this list as well.

eureka-cpu · 2023-08-23T04:11:11Z

Thanks @kayagokalp I'll update those soon

eureka-cpu · 2023-10-30T17:36:55Z

Closing since we are not using this approach as discussed in #457

add process for fuelup deprecation

98b549d

eureka-cpu added enhancement enhancement to a current feature fuelup-init Issues related to the Shell script, fuelup-init breaking labels Jul 20, 2023

eureka-cpu self-assigned this Jul 20, 2023

eureka-cpu requested a review from eightfilms July 20, 2023 19:34

eureka-cpu changed the title ~~feat: Use fuel.nix flake as the underlying installation method~~ feat: Use fuel.nix flake as the fuelup backend Jul 20, 2023

eureka-cpu added 23 commits July 20, 2023 15:08

wip add check_cmd nix

185335d

fix accidental change

530d00b

fix spacing

88a2a55

test CI & nix

fa4b52b

fix legacy wrap

c7dcccc

wrap curl command in function

ee02880

test check_cmd nix

bef8881

rm nix -v from ci check

47fa38d

wrap curl cmd, add nix -v back to ci

e6a5215

test fuel nix fn

d159bab

add --no-confirm to accept default nix installation

ee77239

add --no-confirm to accept default nix installation v2

8f18c7b

add init nix after install

e75eca1

try running daemon on new line

bc19339

try direct use

ce74266

try opening new shell

e88169e

rm need_cmd nix

fce2e22

remove failing nix check for now

0c96b83

handle found nix

575c1ce

fix spacing

c3005a9

rm unused readonly

3d4ef1e

fix check_cmd nix

3002d80

add links for configuring nix

dc0ccf6

eureka-cpu added 11 commits August 17, 2023 14:04

update info message for upgrade command

1bf2b04

Merge branch 'master' into eureka-cpu/457

568cddb

fix stdout and add handling message for auto prioritization

8489142

Merge branch 'master' into eureka-cpu/457

8b27520

wip remove error from log

f3ef82a

Merge branch 'master' into eureka-cpu/457

54eccc2

finalize auto prioritize pkgs, fix stderr output

0156f2c

abstract command filter function

ea29b85

rename prio msg consts

0613918

update docstring for filter_command

c5100db

clippy

d46db1e

eureka-cpu added 2 commits August 21, 2023 01:31

fix error handling of install, wip list

70b84ff

more wip list

854278b

sdankel reviewed Aug 22, 2023

View reviewed changes

src/commands/nix/install.rs Outdated Show resolved Hide resolved

kayagokalp reviewed Aug 22, 2023

View reviewed changes

JoshuaBatty mentioned this pull request Aug 22, 2023

Use fuel.nix internally and deprecate current work. #457

Closed

list command debug internals are more concise

abdfa24

eureka-cpu added 5 commits August 23, 2023 23:54

update docs, adjust naming conventions, refactor comp err msg

7cdd51e

remove unused impl

7c520b4

clean up stray comments

90f4966

update all err msgs

b24e74e

make utils available to crate

9a92823

eureka-cpu closed this Oct 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adds `nix` subcommand that uses the `fuel.nix` flake to manage binaries #461

feat: Adds `nix` subcommand that uses the `fuel.nix` flake to manage binaries #461

eureka-cpu commented Jul 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading

eureka-cpu commented Aug 21, 2023

eureka-cpu commented Aug 21, 2023

kayagokalp left a comment

kayagokalp Aug 22, 2023

kayagokalp Aug 22, 2023

kayagokalp Aug 22, 2023

eureka-cpu commented Aug 23, 2023

eureka-cpu commented Oct 30, 2023

feat: Adds nix subcommand that uses the fuel.nix flake to manage binaries #461

feat: Adds nix subcommand that uses the fuel.nix flake to manage binaries #461

Conversation

eureka-cpu commented Jul 20, 2023 • edited Loading

Process for achieving completion of #457

JoshuaBatty commented Aug 20, 2023 • edited Loading

JoshuaBatty commented Aug 20, 2023 • edited Loading

JoshuaBatty commented Aug 20, 2023 • edited Loading

eureka-cpu commented Aug 21, 2023

eureka-cpu commented Aug 21, 2023

kayagokalp left a comment

Choose a reason for hiding this comment

kayagokalp Aug 22, 2023

Choose a reason for hiding this comment

kayagokalp Aug 22, 2023

Choose a reason for hiding this comment

kayagokalp Aug 22, 2023

Choose a reason for hiding this comment

eureka-cpu commented Aug 23, 2023

eureka-cpu commented Oct 30, 2023

feat: Adds `nix` subcommand that uses the `fuel.nix` flake to manage binaries #461

feat: Adds `nix` subcommand that uses the `fuel.nix` flake to manage binaries #461

eureka-cpu commented Jul 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading

JoshuaBatty commented Aug 20, 2023 •

edited

Loading