feat(neard): print all enabled features in neard --version

[jancionear]

Print all of the build time features enabled using the --features flag in the output of neard --version

Examples:

$ cargo run -p neard -- --version
...
neard (release trunk) (build 1.36.1-489-gdf22f90b9) (rustc 1.77.0) (protocol 67) (db 39)
features: [default, json_rpc, rosetta_rpc]

$ cargo run -p neard --features statelessnet_protocol,new_epoch_sync -- --version
...
neard (release trunk) (build 1.36.1-489-gdf22f90b9) (rustc 1.77.0) (protocol 85) (db 39)
features: [default, json_rpc, near_epoch_sync_tool, new_epoch_sync, rosetta_rpc, statelessnet_protocol]

$ cargo run -p neard --features nightly -- --version
...
neard (release trunk) (build 1.36.1-489-gdf22f90b9) (rustc 1.77.0) (protocol 140) (db 39)
features: [default, json_rpc, nightly, nightly_protocol, protocol_feature_fix_staking_threshold, protocol_feature_nonrefundable_transfer_nep491, rosetta_rpc, yield_resume]

$ ./neard --version
neard (release trunk) (build 1.36.1-489-gdf22f90b9) (rustc 1.77.0) (protocol 67) (db 39)
features: [default, json_rpc, rosetta_rpc]

Sometimes I have a neard binary, but I'm not sure which features were enabled during the build. It would be nice to be able to get this information somehow.
I can get the git commit from --version, but it didn't print the features, so now I added the feature of printing features.

We can can get the features from environment variables available to the build.rs script (e.g build-rs-env.txt). Then build.rs exposes an environment variable in a way that's visible from the neard crate (e.g. cargo-run-env.txt)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.22%. Comparing base (3b7b82a) to head (df22f90).

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #11166      +/-   ##
==========================================
- Coverage   71.22%   71.22%   -0.01%     
==========================================
  Files         773      773              
  Lines      153862   153862              
  Branches   153862   153862              
==========================================
- Hits       109595   109586       -9     
- Misses      39839    39844       +5     
- Partials     4428     4432       +4     

Flag	Coverage Δ
backward-compatibility	0.24% <0.00%> (ø)
db-migration	0.24% <0.00%> (ø)
genesis-check	1.42% <100.00%> (ø)
integration-tests	36.99% <0.00%> (+0.01%)	⬆️
linux	69.59% <100.00%> (-0.04%)	⬇️
linux-nightly	70.70% <100.00%> (-0.02%)	⬇️
macos	54.39% <100.00%> (+0.01%)	⬆️
pytests	1.65% <100.00%> (ø)
sanity-checks	1.44% <100.00%> (ø)
unittests	66.85% <100.00%> (-0.02%)	⬇️
upgradability	0.29% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wacban]

I love the idea it's definitely worth adding.

Is it a foolproof way to get all the features? For example would it work in the recent case where new_epoch_sync was getting enabled unintentionally? If there are some known or suspected cases where this would break perhaps you can add a comment or even short message in the logs that this can happen.

[Ekleog-NEAR]

AFAIK this should work for all the features that are defined on the neard itself. However, it will not list features defined and enabled in other crates, and eg. new_epoch_sync is IIRC defined in a few crates. So we could still have a case of it being enabled in an upstream crate, but not in neard itself, as the dependency is directional.

This being said, I do think this change makes sense :)

[jancionear]

AFAIK this should work for all the features that are defined on the neard itself. However, it will not list features defined and enabled in other crates, and eg. new_epoch_sync is IIRC defined in a few crates. So we could still have a case of it being enabled in an upstream crate, but not in neard itself, as the dependency is directional.

👍, it works only with direct neard features, it wouldn't print the nearcore/new_epoch_sync from the recent issue.

As a test I reverted Waclaw's fix (400bdf1) and compiled neard with cargo build --bin neard. It didn't print nearcore/new_epoch_sync, even though afaiu it's enabled:

$ ./target/debug/neard --version
neard (release trunk) (build 1.36.1-490-g85c823b84) (rustc 1.77.0) (protocol 67) (db 39)
features: [default, json_rpc, rosetta_rpc]

Printing features of all dependencies is much harder, I'm not sure how to do it. For now I'll merge this PR, and open an issue about printing features of all dependencies.

[jancionear]

open an issue about printing features of all dependencies.

Opened: #11176