[api] web3 api debug_traceCall support javascript tracing #3931

millken · 2023-08-30T01:41:53Z

Description

as title

Type of change

Please delete options that are not relevant.

[] Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
[] Code refactor or improvement
[] Breaking change (fix or feature that would cause a new or changed behavior of existing functionality)
[] This change requires a documentation update

How Has This Been Tested?

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

make test
[] fullsync
[] Other test (please specify)

Test Configuration:

Firmware version:
Hardware:
Toolchain:
SDK:

Checklist:

[] My code follows the style guidelines of this project
[] I have performed a self-review of my code
[] I have commented my code, particularly in hard-to-understand areas
[] I have made corresponding changes to the documentation
[] My changes generate no new warnings
[] I have added tests that prove my fix is effective or that my feature works
[] New and existing unit tests pass locally with my changes
[] Any dependent changes have been merged and published in downstream modules

codecov · 2023-08-30T02:37:18Z

Codecov Report

Attention: 598 lines in your changes are missing coverage. Please review.

Comparison is base (e1f0636) 75.38% compared to head (df1dc3e) 76.02%.
Report is 144 commits behind head on master.

Files	Patch %	Lines
blockindex/contractstaking/event_handler.go	67.23%	45 Missing and 13 partials ⚠️
action/protocol/staking/staking_statereader.go	69.76%	35 Missing and 17 partials ⚠️
action/protocol/execution/evm/evm.go	48.38%	47 Missing and 1 partial ⚠️
api/coreservice.go	61.45%	32 Missing and 5 partials ⚠️
api/web3server.go	78.23%	29 Missing and 3 partials ⚠️
action/candidate_endorsement.go	0.00%	31 Missing ⚠️
action/protocol/staking/protocol.go	33.33%	28 Missing ⚠️
action/candidate_activate.go	0.00%	25 Missing ⚠️
...tion/protocol/staking/contractstake_bucket_type.go	0.00%	24 Missing ⚠️
blockindex/contractstaking/util.go	39.47%	22 Missing and 1 partial ⚠️
... and 31 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3931      +/-   ##
==========================================
+ Coverage   75.38%   76.02%   +0.64%     
==========================================
  Files         303      334      +31     
  Lines       25923    28431    +2508     
==========================================
+ Hits        19541    21615    +2074     
- Misses       5360     5716     +356     
- Partials     1022     1100      +78

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

Liuhaai · 2023-09-06T16:28:48Z

api/coreservice.go

@@ -59,9 +60,18 @@ import (
 	"github.com/iotexproject/iotex-core/server/itx/nodestats"
 	"github.com/iotexproject/iotex-core/state"
 	"github.com/iotexproject/iotex-core/state/factory"
+
+	// Force-load the tracer engines to trigger registration
+	_ "github.com/ethereum/go-ethereum/eth/tracers/js"


move to the line below L29

Liuhaai · 2023-09-06T16:40:15Z

api/coreservice.go

@@ -1731,3 +1733,45 @@ func (core *coreService) Track(ctx context.Context, start time.Time, method stri
 		Success:      success,
 	}, size)
 }
+
+func (core *coreService) traceTx(ctx context.Context, txctx *tracers.Context, config *tracers.TraceConfig, simulateFn func(ctx context.Context) ([]byte, *action.Receipt, error)) ([]byte, *action.Receipt, any, error) {


create a private func for context initialization instead of traceTx with simulateFn?

create a private func for context initialization instead of traceTx with simulateFn?

traceTx (js tracing) has timeout settings, need to put simulateFn into tractTx.

it seems no need to put simulateFn as param of traceTx, can just call core.SimulateExecution

it seems no need to put simulateFn as param of traceTx, can just call core.SimulateExecution

If do this, need to pass some core.SimulateExecution required arguments

Liuhaai · 2023-09-06T16:50:10Z

api/web3server.go

-		StructLogs:  fromLoggerStructLogs(traces.StructLogs()),
-		Gas:         receipt.GasConsumed,
-	}, nil
+	switch tracer := tracer.(type) {


can tracer's type be deduced from the cfg on L928?

yes, you can. but it is cleaner and safer to deduced from the result

sonarcloud · 2023-09-07T02:41:23Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
11.7% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

dustinxie · 2024-01-08T06:05:15Z

api/coreservice.go

+				t.Stop(errors.New("execution timeout"))
+			}
+		}()
+		defer cancel()


move to L1758

dustinxie · 2024-01-08T06:06:49Z

api/coreservice.go

@@ -27,6 +28,10 @@ import (
 	"google.golang.org/protobuf/types/known/durationpb"
 	"google.golang.org/protobuf/types/known/timestamppb"

+	// Force-load the tracer engines to trigger registration
+	_ "github.com/ethereum/go-ethereum/eth/tracers/js"
+	_ "github.com/ethereum/go-ethereum/eth/tracers/native"


move to L19

api/coreservice.go

envestcc · 2024-01-08T06:42:17Z

api/web3server.go

-		DisableStack:     disableStack,
-		DisableStorage:   disableStorage,
-		EnableReturnData: enableReturnData,
+	cfg := &tracers.TraceConfig{


Why not set Tracer and Timeout, compared with tracCall?

If users have this requirement, they can add.

I mean, does it support tracer and timeout config in traceTransaction just like what we supporting in traceCall?

envestcc · 2024-01-08T06:46:51Z

api/coreservice.go

+const (
+	// defaultTraceTimeout is the amount of time a single transaction can execute
+	// by default before being forcefully aborted.
+	defaultTraceTimeout = 5 * time.Second


Why defaultTraceTimeout is only used in TraceTransaction, but not in TraceCall?

sonarcloud · 2024-01-11T03:15:48Z

Quality Gate failed

Failed conditions

12.3% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

web3 api debug_traceCall support javascript tracing

92d723e

millken requested review from CoderZhi, dustinxie, Liuhaai and a team as code owners August 30, 2023 01:41

fix golint

86f89c4

Liuhaai reviewed Sep 6, 2023

View reviewed changes

fix comments

3a784d7

dustinxie reviewed Jan 8, 2024

View reviewed changes

api/coreservice.go Outdated

t.Stop(errors.New("execution timeout"))

}

}()

defer cancel()

Copy link

Member

dustinxie Jan 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move to L1758

dustinxie reviewed Jan 8, 2024

View reviewed changes

dustinxie approved these changes Jan 8, 2024

View reviewed changes

envestcc reviewed Jan 8, 2024

View reviewed changes

api/coreservice.go Show resolved Hide resolved

envestcc reviewed Jan 8, 2024

View reviewed changes

millken added 6 commits January 8, 2024 15:41

update test

f562d88

Merge branch 'issue3930' of github.com:millken/iotex-core into issue3930

9ee2672

fix ci error

896a0d5

fix test

3d3ef8f

fix test

aed37c3

Merge branch 'master' into issue3930

df1dc3e

ququzone self-requested a review January 11, 2024 03:39

ququzone approved these changes Jan 11, 2024

View reviewed changes

millken merged commit e2be18f into iotexproject:master Jan 11, 2024
3 of 5 checks passed

dustinxie pushed a commit that referenced this pull request Jan 29, 2024

[api] web3 api debug_traceCall support javascript tracing (#3931)

e41c104

BrewTestBot mentioned this pull request Feb 7, 2024

ioctl 1.13.0 Homebrew/homebrew-core#161991

Merged

envestcc mentioned this pull request Apr 1, 2024

[api]Support for tracer and tracerConfig in debug_traceTransaction API #4216

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api] web3 api debug_traceCall support javascript tracing #3931

[api] web3 api debug_traceCall support javascript tracing #3931

millken commented Aug 30, 2023

codecov bot commented Aug 30, 2023 •

edited

Loading

Liuhaai Sep 6, 2023

Liuhaai Sep 6, 2023 •

edited

Loading

millken Sep 7, 2023

envestcc Jan 8, 2024

millken Jan 8, 2024

Liuhaai Sep 6, 2023

millken Sep 7, 2023

sonarcloud bot commented Sep 7, 2023

dustinxie Jan 8, 2024

dustinxie Jan 8, 2024

envestcc Jan 8, 2024

millken Jan 8, 2024

envestcc Jan 8, 2024

envestcc Jan 8, 2024 •

edited

Loading

sonarcloud bot commented Jan 11, 2024

[api] web3 api debug_traceCall support javascript tracing #3931

[api] web3 api debug_traceCall support javascript tracing #3931

Conversation

millken commented Aug 30, 2023

Description

Type of change

How Has This Been Tested?

Checklist:

codecov bot commented Aug 30, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Liuhaai Sep 6, 2023 • edited Loading

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

sonarcloud bot commented Sep 7, 2023

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

envestcc Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented Jan 11, 2024

Quality Gate failed

codecov bot commented Aug 30, 2023 •

edited

Loading

Liuhaai Sep 6, 2023 •

edited

Loading

envestcc Jan 8, 2024 •

edited

Loading