refactor: add deprecation message to libp2p & ipfs flags #3966

frrist · 2024-05-01T16:08:06Z

closes Add deprecation notice to Libp2p flags and embedded IPFS Node Flags #3962

coderabbitai · 2024-05-01T16:08:15Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

aronchick

Just some thoughts

aronchick · 2024-05-01T16:53:43Z

cmd/util/flags/configflags/libp2p.go

@@ -10,11 +10,17 @@ var Libp2pFlags = []Definition{
 		Description: `A comma-separated list of libp2p multiaddress to connect to. ` +
 			`Use "none" to avoid connecting to any peer, ` +
 			`"env" to connect to the default peer list of your active environment (see BACALHAU_ENVIRONMENT env var).`,
+		Deprecated: true,
+		DeprecatedMessage: "The libp2p transport will be deprecated in a future version in favour of using " +
+			"--orchestrators to specify a requester node to connect to.",


"... Unless you specifically use the features of libp2p (which ones?), you should not have to change anything."

I don't think there are any features we are losing due to deprecation of libp2p. In general users will need to change very little, and I'd prefer to describe what they do need to change in a changelog/release-notes/blog-post rather than the CLI help message.

Perhaps we should create a github discussion to talk about this more and provide a link to the discussion post in the deprecation message for these flags?

Yeah we need to start communicating this with users and collect feedback, whether through github discussions or slack channels. cc @seanmtracey

aronchick · 2024-05-01T16:54:32Z

cmd/util/flags/configflags/libp2p.go

 	},
 	{
 		FlagName:     "swarm-port",
 		ConfigPath:   types.NodeLibp2pSwarmPort,
 		DefaultValue: Default.Node.Libp2p.SwarmPort,
 		Description:  `The port to listen on for swarm connections.`,
+		Deprecated:   true,
+		DeprecatedMessage: "The libp2p transport will be deprecated in a future version in favour of using " +


isn't it better to not have a line break delimiter? E.g. use ``? Just coding style i guess.

Yeah probably should have done that. Adding this line break (+) is what my editor does when I go over the row length limit.

aronchick · 2024-05-01T16:55:17Z

cmd/util/flags/configflags/ipfs.go

@@ -21,6 +21,8 @@ var IPFSFlags = []Definition{
 		DefaultValue:         Default.Node.IPFS.SwarmKeyPath,
 		Description:          "Optional IPFS swarm key required to connect to a private IPFS swarm",
 		EnvironmentVariables: []string{"BACALHAU_IPFS_SWARM_KEY"},
+		Deprecated:           true,
+		DeprecatedMessage:    ipfsEmbeddedDeprecationMessage,


Where's this message?

line 5 of the file. It's not in the diff as it was added by Ross a while back when he was part way through some of the deprecation work.

aronchick · 2024-05-01T16:55:46Z

cmd/util/flags/configflags/network.go

+		FlagName:          "network",
+		ConfigPath:        types.NodeNetworkType,
+		DefaultValue:      Default.Node.Network.Type,
+		Description:       `Inter-node network layer type (e.g. nats, libp2p).`,


Shouldn't we remove "libp2p" here?

We will remove this entire flag when we remove libp2p since specifying a network will no longer be an option.

aronchick · 2024-05-01T16:56:13Z

cmd/util/flags/configflags/network.go

+		DefaultValue:      Default.Node.Network.Type,
+		Description:       `Inter-node network layer type (e.g. nats, libp2p).`,
+		Deprecated:        true,
+		DeprecatedMessage: "The libp2p transport will be deprecated in a future version in favor of NATS",


It's weird that we are deprecating this flag - will we just remove it in the future? (since there is no "changing your network"?

#3966 (comment) Yup will remove the flag when we remove libp2p

wdbaruni · 2024-05-02T11:43:02Z

cmd/util/flags/configflags/libp2p.go

@@ -10,11 +10,17 @@ var Libp2pFlags = []Definition{
 		Description: `A comma-separated list of libp2p multiaddress to connect to. ` +
 			`Use "none" to avoid connecting to any peer, ` +
 			`"env" to connect to the default peer list of your active environment (see BACALHAU_ENVIRONMENT env var).`,
+		Deprecated: true,
+		DeprecatedMessage: "The libp2p transport will be deprecated in a future version in favour of using " +
+			"--orchestrators to specify a requester node to connect to.",


Yeah we need to start communicating this with users and collect feedback, whether through github discussions or slack channels. cc @seanmtracey

- closes #3962

frrist requested review from wdbaruni and aronchick May 1, 2024 16:09

aronchick reviewed May 1, 2024

View reviewed changes

wdbaruni approved these changes May 2, 2024

View reviewed changes

frrist force-pushed the frrist/cli/deprecation-notice-libp2p-ipfs branch from 7e46f77 to c251c65 Compare May 2, 2024 17:15

frrist enabled auto-merge (rebase) May 6, 2024 14:31

refactor: add deprecation message to libp2p & ipfs flags

ccc0954

- closes #3962

frrist force-pushed the frrist/cli/deprecation-notice-libp2p-ipfs branch from c251c65 to ccc0954 Compare May 8, 2024 21:41

frrist merged commit 2f062b1 into main May 8, 2024
12 checks passed

frrist deleted the frrist/cli/deprecation-notice-libp2p-ipfs branch May 8, 2024 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add deprecation message to libp2p & ipfs flags #3966

refactor: add deprecation message to libp2p & ipfs flags #3966

frrist commented May 1, 2024

coderabbitai bot commented May 1, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

aronchick left a comment

aronchick May 1, 2024

frrist May 2, 2024

wdbaruni May 2, 2024

aronchick May 1, 2024

frrist May 2, 2024

aronchick May 1, 2024

frrist May 2, 2024

aronchick May 1, 2024

frrist May 2, 2024

aronchick May 1, 2024

frrist May 2, 2024

wdbaruni May 2, 2024

refactor: add deprecation message to libp2p & ipfs flags #3966

refactor: add deprecation message to libp2p & ipfs flags #3966

Conversation

frrist commented May 1, 2024

coderabbitai bot commented May 1, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

aronchick left a 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

CodeRabbit Configration File (`.coderabbit.yaml`)