[v0.47] [Util] Improve remote debugging tooling

[turbolent]

Port #8440 to v0.47, so we can compare v0.47 against v0.48

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f360b27c-237b-4f3b-aa9c-828625b41380

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

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch bastian/v0.47-debugging-improvements

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov-commenter]

Codecov Report

❌ Patch coverage is 5.56199% with 815 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
cmd/util/cmd/debug-tx/cmd.go	0.00%	272 Missing ⚠️
cmd/util/cmd/compare-debug-tx/cmd.go	0.00%	184 Missing ⚠️
utils/debug/remoteView.go	0.00%	69 Missing ⚠️
utils/debug/remoteDebugger.go	0.00%	50 Missing ⚠️
utils/debug/cadence.go	0.00%	37 Missing ⚠️
cmd/util/cmd/debug-script/cmd.go	0.00%	35 Missing ⚠️
utils/debug/api.go	0.00%	31 Missing ⚠️
utils/debug/remoteClient.go	0.00%	31 Missing ⚠️
utils/debug/result.go	0.00%	24 Missing ⚠️
fvm/environment/value_store.go	35.48%	17 Missing and 3 partials ⚠️
... and 11 more

📢 Thoughts on this report? Let us know!

[janezpodhostnik]

I would prefer to avoid having the if span.Tracer != nil check if possible.

We can add a SetAttributes to tracing.TracerSpan:

func (tracer TracerSpan) SetAttributes(kv ...attribute.KeyValue) {
	if tracer.IsTraceable() {
		tracer.Span.SetAttributes(kv...)
	}
}

And I think this instance can even be replaced with:

defer programs.tracer.StartChildSpan(
		trace.FVMEnvGetOrLoadProgram,
		otel.WithAttributes(attribute.String("location", location.ID())),
	).End()

[janezpodhostnik]

Suggested change

	Cmd.Flags().BoolVar(&flagUseExecutionDataAPI, "use-execution-data-api", true, "use the execution data API (default: true)")
	Cmd.Flags().BoolVar(&flagUseExecutionDataAPI, "use-execution-data-api", true, "use the execution data API")

cobra already states the defaults

[janezpodhostnik]

I think we are all trying to resolve the blockchain in one way or another...
Maybe a better naming would be getBlocksAfter.

Also, if I'm not mistaken, the method gets blocks before startBlockID, since it goes to the parent. Is that intentional? If it is, it is a bit counterintuitive and should definitely be documented.