feat: Added the ability to use the TEACH-ME mode #221

FroVolod · 2024-09-13T08:44:48Z

./cargo-near --teach-me near new test

./cargo-near --teach-me near build --manifest-path /Users/frovolod/Documents/NEAR/neardevhub-contract-1/Cargo.toml

./cargo-near --teach-me near deploy --manifest-path /Users/frovolod/Documents/NEAR/neardevhub-contract-1/Cargo.toml

Screen.Recording.2024-10-04.at.08.16.08.mov

FroVolod · 2024-10-04T09:14:43Z

@race-of-sloths

race-of-sloths-bot · 2024-10-04T14:17:17Z

@FroVolod Thank you for your contribution! Your pull request is now a part of the Race of Sloths!

Current status: waiting for scoring

We're waiting for maintainer to score this pull request with @race-of-sloths score [0,1,2,3,5,8,13] command. Alternatively, autoscoring [1,2] will be applied for this pull request

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

Tag @race-of-sloths inside your pull requests
Wait for the maintainer to review and score your pull request
Check out your position in the Leaderboard
Keep weekly and monthly streaks to reach higher positions
Boast your contributions with a dynamic picture of your Profile

For maintainers:

Score pull requests that participate in the Race of Sloths
Engage contributors with fair scoring and fast responses so they keep their streaks
Promote the Race to the point where the Race starts promoting you
Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands

For contributors
- Include a PR: @race-of-sloths include to enter the Race with your PR
For maintainers:
- Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
- Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
- Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
- Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

FroVolod · 2024-10-07T12:52:08Z

FroVolod · 2024-10-11T13:07:12Z

Three alternative commands were tested:

cargo near --teach-me new test

./cargo-near  near --teach-me new test

./cargo-near --teach-me near new test

The execution of the program is the same:

cargo-near/src/commands/new/mod.rs

FroVolod · 2024-11-10T21:17:35Z

Screen.Recording.2024-11-10.at.23.06.23.mov

cargo-near-build/src/types/cargo/metadata.rs

cargo-near/src/lib.rs

cargo-near/src/main.rs

cargo-near-build/src/cargo_native/compile.rs

cargo-near-build/src/near/abi/generate/dylib.rs

cargo-near/src/main.rs

cargo-near-build/src/types/cargo/metadata.rs

dj8yfo · 2024-11-12T18:55:08Z

cargo-near/src/main.rs

+    if env::var("RUST_LOG").is_ok() {
+        let environment = if std::env::var(env_keys::nep330::BUILD_ENVIRONMENT).is_ok() {
+            "container".cyan()
+        } else {
+            "host".purple()
+        };
+        let my_formatter =
+            cargo_near::types::my_formatter::MyFormatter::from_environment(environment);

-    let env_filter = EnvFilter::from_default_env();
+        let format = format::debug_fn(move |writer, _field, value| write!(writer, "{:?}", value));

-    tracing_subscriber::registry()
-        .with(
-            tracing_subscriber::fmt::layer()
-                .event_format(my_formatter)
-                .fmt_fields(format)
-                .with_filter(env_filter),
-        )
-        .init();
+        tracing_subscriber::registry()
+            .with(
+                tracing_subscriber::fmt::layer()
+                    .event_format(my_formatter)
+                    .fmt_fields(format)
+                    .with_filter(EnvFilter::from_default_env()),
+            )
+            .init();
+    } else if cli_cmd.teach_me || cli_near_args.teach_me {
+        let env_filter = EnvFilter::from_default_env()
+            .add_directive(tracing::Level::WARN.into())
+            .add_directive("near_teach_me=info".parse()?)
+            .add_directive("near_cli_rs=info".parse()?)
+            .add_directive("tracing_instrument=info".parse()?);
+        tracing_subscriber::registry()
+            .with(
+                tracing_subscriber::fmt::layer()
+                    .without_time()
+                    .with_target(false),
+            )
+            .with(env_filter)
+            .init();
+    } else {
+        let indicatif_layer = IndicatifLayer::new()
+            .with_progress_style(
+                ProgressStyle::with_template(
+                    "{spinner:.blue}{span_child_prefix} {span_name} {msg} {span_fields}",
+                )
+                .unwrap()
+                .tick_strings(&[
+                    "▹▹▹▹▹",
+                    "▸▹▹▹▹",
+                    "▹▸▹▹▹",
+                    "▹▹▸▹▹",
+                    "▹▹▹▸▹",
+                    "▹▹▹▹▸",
+                    "▪▪▪▪▪",
+                ]),
+            )
+            .with_span_child_prefix_symbol("↳ ");
+        let env_filter = EnvFilter::from_default_env()
+            .add_directive(tracing::Level::WARN.into())
+            .add_directive("near_cli_rs=info".parse()?)
+            .add_directive("tracing_instrument=info".parse()?);
+        tracing_subscriber::registry()
+            .with(
+                tracing_subscriber::fmt::layer()
+                    .without_time()
+                    .with_writer(indicatif_layer.get_stderr_writer()),
+            )
+            .with(indicatif_layer)
+            .with(env_filter)
+            .init();
+    };


i strongly suggest

making these blocks a function with following signature

pub fn setup_tracing(rust_log_env_is_set: bool, teach_me_flag_is_set: bool) { .... }

putting it and related tracing-* imports into cargo-near/src/lib.rs

then this function https://github.com/near/cargo-near/blob/main/integration-tests/src/lib.rs#L11-L32 can be replaced with

pub fn setup_tracing() { cargo_near::setup_tracing(true, false); }

dj8yfo · 2024-11-12T19:10:11Z

cargo-near/src/commands/new/mod.rs

+    skip_all
+)]
+fn execute_git_commands(project_dir: &std::path::Path) -> near_cli_rs::CliResult {
+    tracing::Span::current().pb_set_message("`git` commands ...");


this one doesn't get displayed on --teach-me, but we probably can figure this out in subsequent prs

cargo-near-build/src/env_keys.rs

dj8yfo · 2024-11-12T19:51:35Z

@race-of-sloths score 13

race-of-sloths · 2024-11-12T19:53:21Z

@FroVolod Thank you for your contribution! Your pull request is now a part of the Race of Sloths!

Current status: executed

Reviewer	Score
@dj8yfo	13

Your contribution is much appreciated with a final score of 13!
You have received 147 (130 base + 10 weekly bonus + 5% lifetime bonus) Sloth points for this contribution

@dj8yfo received 25 Sloth Points for reviewing and scoring this pull request.

Another weekly streak completed, well done @FroVolod! To keep your weekly streak and get another bonus make pull request next week! Looking forward to see you in race-of-sloths

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

Tag @race-of-sloths inside your pull requests
Wait for the maintainer to review and score your pull request
Check out your position in the Leaderboard
Keep weekly and monthly streaks to reach higher positions
Boast your contributions with a dynamic picture of your Profile

For maintainers:

Score pull requests that participate in the Race of Sloths and receive a reward
Engage contributors with fair scoring and fast responses so they keep their streaks
Promote the Race to the point where the Race starts promoting you
Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands

For contributors
- Include a PR: @race-of-sloths include to enter the Race with your PR
For maintainers:
- Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
- Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
- Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
- Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

…dant

## 🤖 New release * `cargo-near`: 0.11.0 -> 0.12.0 (⚠️ API breaking changes) * `cargo-near-build`: 0.3.0 -> 0.3.1 (✓ API compatible changes) ### ⚠️ `cargo-near` breaking changes ``` --- failure constructible_struct_adds_field: externally-constructible struct adds field --- Description: A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field. ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/constructible_struct_adds_field.ron Failed in: field CliNearArgs.teach_me in /tmp/.tmp06Ielo/cargo-near/cargo-near/src/lib.rs:30 field InteractiveClapContextScopeForNearArgs.teach_me in /tmp/.tmp06Ielo/cargo-near/cargo-near/src/lib.rs:30 --- failure constructible_struct_adds_private_field: struct no longer constructible due to new private field --- Description: A struct constructible with a struct literal has a new non-public field. It can no longer be constructed using a struct literal outside of its crate. ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/constructible_struct_adds_private_field.ron Failed in: field NearArgs.teach_me in /tmp/.tmp06Ielo/cargo-near/cargo-near/src/lib.rs:35 ``` <details><summary>Changelog</summary> ## `cargo-near` <blockquote> ## [0.12.0](cargo-near-v0.11.0...cargo-near-v0.12.0) - 2024-11-14 ### Added - Added the ability to use the TEACH-ME mode ([#221](#221)) ### Other - Gracefully handle missing `git` on `cargo near new` ([#246](#246)) - update `cargo near new` template `image` and `image_digest` ([#244](#244)) </blockquote> ## `cargo-near-build` <blockquote> ## [0.3.1](cargo-near-build-v0.3.0...cargo-near-build-v0.3.1) - 2024-11-14 ### Added - Added the ability to use the TEACH-ME mode ([#221](#221)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

FroVolod marked this pull request as ready for review October 4, 2024 05:23

FroVolod marked this pull request as draft October 7, 2024 12:49

FroVolod force-pushed the teach-me branch from 392a877 to 53b3f97 Compare October 23, 2024 07:16

FroVolod and others added 17 commits November 6, 2024 08:54

start

596ad4f

added a visual indicator for creating a new project

c90db6b

added filter to "RUST_LOG" trace

77efc98

added "--teach-me" to execute_git_commands()

1b14663

fixed filter for indicatif_layer

7586a1a

refactored

1d8c66c

added "--teach-me" to track_usage()

2580b70

reverted a fix for track_usage()

286e48f

added "--teach-me" to BuildCommand

e1fa0d0

fixed

f17072c

added "--teach-me" to subprocess_step

fa7ed9f

formatted "Invoking cargo"

68159a6

refactored indent_payload()

5cc4135

added --teach-me to NearArgs

101cbcc

refactored tracing

c8ed557

updated README

6efd6d7

Update README.md

dbcf698

FroVolod force-pushed the teach-me branch from 4cab6dd to dbcf698 Compare November 6, 2024 07:14

fixed

537d774

dj8yfo reviewed Nov 6, 2024

View reviewed changes

cargo-near/src/commands/new/mod.rs Outdated Show resolved Hide resolved

FroVolod added 2 commits November 7, 2024 08:42

returned the fragment lost during the merge operation

ec5a804

fixed

3eb0d03

dj8yfo reviewed Nov 8, 2024

View reviewed changes

cargo-near/src/commands/new/mod.rs Outdated Show resolved Hide resolved

FroVolod and others added 4 commits November 8, 2024 13:48

updated to main fa934ed

e2b74f3

Merge branch 'main' into teach-me

7b1ee9e

fixed CI

7936c4b

updated near-cli-rs (request-payload-for-broadcast-tx-commit)

39e6582

reverted stable version of near-cli-rs

da48e23

FroVolod marked this pull request as ready for review November 11, 2024 06:24

dj8yfo previously approved these changes Nov 12, 2024

View reviewed changes

corrected spelling errors

8981d79

FroVolod dismissed dj8yfo’s stale review via 8981d79 November 13, 2024 07:19

FroVolod added 8 commits November 13, 2024 09:21

removed duplicate --teach-me flag

e2b3dad

fixed output console command

1c4d219

deleted information about "Setting cargo working dir to ..." as redun…

f69b78c

…dant

reverted to tracing::debug!

6d19ed5

changed "RUST_LOG=cargo_near=info" to "RUST_LOG=info"

c0a48a2

reverted to {:#?} format for cargo_command

7ffa162

refactored print_env()

323a439

refactored setup_tracing()

b718450

dj8yfo mentioned this pull request Nov 14, 2024

replace --teach-me print of docker_args with docker_cmd #247

Closed

dj8yfo approved these changes Nov 14, 2024

View reviewed changes

dj8yfo merged commit 175aaeb into main Nov 14, 2024
17 checks passed

dj8yfo deleted the teach-me branch November 14, 2024 12:33

frol mentioned this pull request Nov 8, 2024

chore: release #245

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Added the ability to use the TEACH-ME mode #221

feat: Added the ability to use the TEACH-ME mode #221

FroVolod commented Sep 13, 2024 •

edited

Loading

FroVolod commented Oct 4, 2024

race-of-sloths-bot commented Oct 4, 2024

FroVolod commented Oct 7, 2024

FroVolod commented Oct 11, 2024 •

edited

Loading

FroVolod commented Nov 10, 2024

dj8yfo Nov 12, 2024

FroVolod Nov 14, 2024

dj8yfo Nov 12, 2024

dj8yfo commented Nov 12, 2024

race-of-sloths commented Nov 12, 2024 •

edited

Loading

feat: Added the ability to use the TEACH-ME mode #221

feat: Added the ability to use the TEACH-ME mode #221

Conversation

FroVolod commented Sep 13, 2024 • edited Loading

FroVolod commented Oct 4, 2024

race-of-sloths-bot commented Oct 4, 2024

FroVolod commented Oct 7, 2024

FroVolod commented Oct 11, 2024 • edited Loading

FroVolod commented Nov 10, 2024

dj8yfo Nov 12, 2024

Choose a reason for hiding this comment

FroVolod Nov 14, 2024

Choose a reason for hiding this comment

dj8yfo Nov 12, 2024

Choose a reason for hiding this comment

dj8yfo commented Nov 12, 2024

race-of-sloths commented Nov 12, 2024 • edited Loading

FroVolod commented Sep 13, 2024 •

edited

Loading

FroVolod commented Oct 11, 2024 •

edited

Loading

race-of-sloths commented Nov 12, 2024 •

edited

Loading