Cli integration #380

petarjuki7 · 2024-06-17T10:55:31Z

CLI short description

A new CLI to use for setting up and running nodes.

Summary

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (Add Jira tickets related to this change)

Test plan

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration. Add screenshots or videos for changes in the user-interface.

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have added a test plan that prove my fix is effective or that my feature works
I squashed all commits and provided a meaningful commit message
I have made corresponding changes to the documentation
My changes generate no new warnings
New and existing unit tests pass locally with my changes

Summary by CodeRabbit

New Features
- Added a new cli module with various commands (InitCommand, LinkCommand, RunCommand, SetupCommand) for node configuration and management.
Refactor
- Updated command structures and configurations in the cli module for improved functionality.
- Renamed and adjusted constants, introduced new structs, traits, and functionalities in the config.rs file.
- Reorganized and introduced a new module named config in the main.rs file.
Chores
- Removed the config module from the public scope in the lib.rs file.

coderabbitai · 2024-06-17T10:55:40Z

Walkthrough

The project underwent significant restructuring with the introduction of new CLI modules cli, init, link, run, and setup. Changes involve refactoring command structures, configuration handling, and module organization. Notable updates include transitioning from #[clap] annotations to #[command], introducing new command functionalities, and enhancing configuration management.

Changes

Files	Change Summaries
Cargo.toml	Added `./crates/cli` module
crates/cli/src/cli.rs	Updated command structure using `#[command]`, added `SetupCommand`
crates/cli/src/cli/init.rs	Introduced `InitCommand` for node configuration initialization
crates/cli/src/cli/link.rs	Added `LinkCommand` for symlink setup and configurations
crates/cli/src/cli/run.rs	Modified `RunCommand` with `node_name` field for configuration loading
crates/cli/src/cli/setup.rs	Defined `SetupCommand` for comprehensive node configuration setup
crates/cli/src/config.rs	Renamed constants, introduced `InitFile` struct, implemented `ConfigImpl` trait
crates/cli/src/main.rs	Added warnings for unused crates, introduced `config` module
crates/node/src/lib.rs	Removed `config` module from public scope

Poem

In code's embrace, changes bloom,
Rabbit scurries, in the CLI room.
Commands revamped, configurations anew,
A dance of code, a whimsical brew.
The path unfolds, in lines and rhyme,
CodeRabbit hops, in binary chime.

Note

Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://coderabbit.ai

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

crates/cli/Cargo.toml

fbozic · 2024-06-17T14:04:26Z

crates/cli/Cargo.toml

+calimero-node = { path = "../node" }
+calimero-network = { path = "../network" }
+calimero-application = { path = "../application" }
+calimero-node-primitives = { path = "../node-primitives" }
+calimero-primitives = { path = "../primitives" }
+calimero-server = { path = "../server", features = ["jsonrpc", "websocket", "admin"] }
+calimero-store = { path = "../store" }


We shouldn't depend on all these crates IMO. CLI should be as small as possible and know as little as possible.

Some of them are unneeded probably, will clean up.

When I'm constructing the config struct to run the node (NodeConfig), I am using other structs from these crates.

Is there a way to get around that?

fbozic · 2024-06-17T14:05:29Z

crates/cli/src/cli/run.rs

        }

-        let config = ConfigFile::load(&root_args.home)?;
+        let config = ConfigFile::load(&path)?;

        calimero_node::start(calimero_node::NodeConfig {


CLI should start a node binary, not invoke the start method.

Also CLI should keep track of all started binaries, so the user can stop/interact with any of the running nodes.

MatejVukosav · 2024-06-18T10:33:06Z

crates/cli/src/cli/init.rs

+
+    /// Force initialization even if the directory already exists
+    #[clap(short, long)]
+    pub force: bool,


Why would the user want to init node again?

Someone mentioned that it would be nice to restart the node, so Xabi mentioned that deleting the keys would block users to rejoin the context. So I kept it like this.
Can remove if needed

crates/cli/src/cli/init.rs

crates/cli/src/mama.txt

…uki7/cli

miraclx · 2024-06-19T05:25:00Z

crates/cli/src/cli/init.rs

+    /// Name of node
+    #[arg(short, long, value_name = "NAME")]
+    pub node_name: camino::Utf8PathBuf,


shouldn't this also need to be part of the RootArgs to prevent duplication?

miraclx · 2024-06-19T05:27:43Z

crates/cli/src/config.rs

+pub struct InitFile {
+    #[serde(with = "calimero_primitives::identity::serde_identity")]
+    pub identity: identity::Keypair,
+}


this seems mostly useless imo

init will happen once, in the lifetime of a node

this will be a file with one thing.. identity

if you want to define your own custom keypair, then init with the random one and change it

not convinced we need a special file just for initialization

and if we need to provide some way to dynamically rotate keys, consider how IPFS's kubo has it implemented

$ jq '.Identity' ~/.ipfs/config { "PeerID": "12D3KooWLJmoNJAbxeMW6uX7VPAmNSEUhXzNmxyk1DbFvFkS9oVB", "PrivKey": "CAESQFPkkrc3fZvD2FQC0ek4QyAAI/v20C1AeSdCUdNxp1lnm9vaIWptv079wdl8tYgDzMWmGr6rdXpeiKlDEm4Kooo=" } $ ipfs key rotate generating ED25519 keypair...done peer identity: 12D3KooWQ1WCd1To5qN7QYxjYbawPuEfqQaejkRF7kskATmsw2Z8 $ jq '.Identity' ~/.ipfs/config { "PeerID": "12D3KooWQ1WCd1To5qN7QYxjYbawPuEfqQaejkRF7kskATmsw2Z8", "PrivKey": "CAESQG4zbb2YW2chk+NgNu0Ag0CdzG76V5qAeh3NuaN6jtWk0t4WjUgdE3nAhYRF+TH0IkZquffMtOL/hqkxGqAouXs=" }

miraclx · 2024-06-19T05:39:32Z

crates/cli/src/cli.rs

    pub home: camino::Utf8PathBuf,
 }

 impl RootCommand {
    pub async fn run(self) -> eyre::Result<()> {
+        let _c = RootCommand::parse();


Suggested change

let _c = RootCommand::parse();

miraclx · 2024-06-19T05:40:59Z

crates/cli/src/cli/link.rs

+    pub version: String,
+}
+
+fn validate_version(v: &str) -> Result<String, String> {


semver::Version didn't work?

miraclx · 2024-06-19T06:05:34Z

crates/cli/src/cli/link.rs

+
+/// Setup symlink to application in the node
+#[derive(Debug, Parser)]
+pub struct LinkCommand {


This should be simple and we want to override the application for the context, not the application itself:

And I believe it makes sense to scope things out under an initial context subcommand:

$ calimero context <context-id> install <resource>

where

resource := (application-spec[@version]) {OR} (file-path) application-spec := (scoped-spec) {OR} (unique-spec) scoped-spec := (<user-name>/<package-name>) unique-spec := (bs58-encoded-unique-32-byte-application-id) file-path := (relative-path) {OR} (absolute-path)

for example:

Download the latest version of the application from the registry

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install petar/only-peers

Download version 0.2.0 of the application from the registry

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install petar/[email protected]

Download the latest version of the application from the registry

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install 4TdrU3ruw6VquHforZ1ojjQ46dmnRwSP3faKB8evjviB

Download version 0.3.4 of the application from the registry

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install [email protected]

Installs the specified wasm file (copied to the apps folder)

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install ./path/to/binary.wasm

Installs the specified wasm file (linked into the apps folder)

$ calimero context 33ovekjBBk2GxfZUueMPKMUe5ofqfp2AoEcXpAM71aAQ install --link ./path/to/binary.wasm

miraclx · 2024-06-19T06:06:23Z

crates/cli/src/cli/link.rs

+                    match symlink(self.path, app_path.join("binary.wasm")) {
+                        Ok(_) => {}
+                        Err(err) => eyre::bail!("Symlinking failed: {}", err),
+                    }


Suggested change

match symlink(self.path, app_path.join("binary.wasm")) {

Ok(_) => {}

Err(err) => eyre::bail!("Symlinking failed: {}", err),

}

if let Err(err) = symlink(self.path, app_path.join("binary.wasm")) {

eyre::bail!("Symlinking failed: {}", err);

}

miraclx · 2024-06-19T06:07:05Z

crates/cli/src/cli/link.rs

+                        self.node_name,
+                        app_path.join("binary.wasm")
+                    );
+                    return Ok(());


move this to the end of the function

miraclx · 2024-06-19T06:08:55Z

crates/cli/src/cli/link.rs

+        } else {
+            eyre::bail!("You have to initialize the node first \nRun command node init -n <NAME>");
+        }


move this to the top

if !ConfigFile::exists(..) { eyre::bail!(..); } // at this point the file exists

should help flatten out the indentation

miraclx · 2024-06-19T06:13:28Z

crates/cli/src/cli/setup.rs

+        calimero_store::Store::open(&calimero_store::config::StoreConfig {
+            path: path.join(config_new.store.path),
+        })?;


the db should've been initialized on init

miraclx · 2024-06-19T06:15:52Z

crates/cli/src/cli/setup.rs

+
+/// Initialize node configuration
+#[derive(Debug, Parser)]
+pub struct SetupCommand {


this pattern was supposed to go away, since we can't exhaustively define all the options

core/crates/node/src/cli/init.rs

Lines 16 to 19 in 25a6cf5

// todo! simplify this, by splitting the steps

// todo! $ calimero node init

// todo! $ calimero node config 'swarm.listen:=["", ""]' discovery.mdns:=false

// todo! $ calimero node config discovery.mdns

IPFS's kubo uses this design, we can learn from it

petarjuki7 requested review from xilosada, miraclx, fbozic and frdomovic June 17, 2024 10:55

petarjuki7 self-assigned this Jun 17, 2024

fbozic requested changes Jun 17, 2024

View reviewed changes

MatejVukosav reviewed Jun 18, 2024

View reviewed changes

crates/cli/src/cli/init.rs Show resolved Hide resolved

MatejVukosav reviewed Jun 18, 2024

View reviewed changes

crates/cli/src/mama.txt Outdated Show resolved Hide resolved

xilosada added 2 commits June 18, 2024 13:50

test: replace branch

e557202

fix: conditionally run linux create_release

f7cb785

petarjuki7 force-pushed the petarjuki7/cli branch 2 times, most recently from dad0c20 to 8548123 Compare June 18, 2024 15:12

petarjuki7 and others added 16 commits June 18, 2024 17:12

Cli crate init

6993fb6

Cli crate init

f476fc2

git pull

44c4a15

Finished init

f697e06

Testing changes

9626f15

Added config file

4a97340

Deleted old cli from node

9225c7a

Added print of setup

cc158c4

Remove warnings

b18a737

Logic fix

734d5a9

Added symlinking

b421153

Added app version to linking

2fada00

Deleted unnecessary files

0c9b1b1

Removed duplication of identity

c1312c4

Update README.mdx (#388)

08ba17f

fix: set inital value with use effects (#389)

f3afedc

Merge branch 'master' of github.com:calimero-network/core into petarj…

8fc5f48

…uki7/cli

petarjuki7 force-pushed the petarjuki7/cli branch from 8548123 to 8fc5f48 Compare June 18, 2024 15:21

miraclx reviewed Jun 19, 2024

View reviewed changes

petarjuki7 closed this Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cli integration #380

Cli integration #380

petarjuki7 commented Jun 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

fbozic Jun 17, 2024

petarjuki7 Jun 17, 2024

petarjuki7 Jun 18, 2024

fbozic Jun 17, 2024

fbozic Jun 17, 2024

MatejVukosav Jun 18, 2024

petarjuki7 Jun 18, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

miraclx Jun 19, 2024

	// todo! simplify this, by splitting the steps
	// todo! $ calimero node init
	// todo! $ calimero node config 'swarm.listen:=["", ""]' discovery.mdns:=false
	// todo! $ calimero node config discovery.mdns

Cli integration #380

Cli integration #380

Conversation

petarjuki7 commented Jun 17, 2024 • edited by coderabbitai bot Loading

CLI short description

Summary

Test plan

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jun 17, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petarjuki7 commented Jun 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 17, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)