fix(gnovm): Improve Error Message in `evalStaticTypeOf` function #2695

notJoon · 2024-08-14T09:21:37Z

Description

Enhanced the error message in evalStaticTypeOf function to match with go's error message and provide more informative feeback.

Example of Errors

Sample code (taken from linked issue)

package main

func main() {
	n := f()
}

func f() {
	println("hello!")
}

Before

panic: evalStaticTypeOf() only supports *CallExpr with 1 result, got ()

After

panic: main/a.gno:3:1: f() (no value) used as value
Hint: Ensure the function returns a single value, or use multiple assignment

Go version (go playground)

./prog.go:4:2: declared and not used: n
./prog.go:4:7: f() (no value) used as value

Further Works

I think it would be good to fix getTypeOf function as well, but I can't think of a case where it would cause panic.

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2024-08-14T09:23:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

ltzmaxwell · 2024-08-15T09:07:10Z

gnovm/pkg/gnolang/preprocess.go

 	}
+	return "<unknown function>"


should this happen?

This shouldn't happend. I added it just in case.

ltzmaxwell · 2024-08-15T09:07:32Z

gnovm/pkg/gnolang/preprocess.go

+func getFunctionName(x Expr) string {
+	switch expr := x.(type) {
+	case *CallExpr:
+		if id, ok := expr.Func.(*NameExpr); ok {


another name other than id?

updated
e948f68

ltzmaxwell · 2024-08-15T09:13:14Z

gnovm/pkg/gnolang/preprocess.go

+				msg = fmt.Sprintf("%s: %s() (no value) used as value", loc, funcName)
+			} else {
+				msg = fmt.Sprintf("%s: %s() (%d values) used as single value", loc, funcName, valueCount)
+			}
+
+			panic(fmt.Errorf("%s\nHint: Ensure the function returns a single value, or use multiple assignment", msg))


This hint may not be very effective if it corresponds to one of the messages above, such as:

panic: main/func.gno:3:1: f() (no value) used as value
Hint: Ensure the function returns a single value, or use multiple assignment.

I mean in this case, "or use multiple assignment" is superfluous。

Or not, this check should be checked somewhere other than evalStaticTypeOf?

well I think this part feels odd to me(the original logic in evalStaticTypeOf:

if len(tt.Elts) != 1 { panic(fmt.Sprintf( "evalStaticTypeOf() only supports *CallExpr with 1 result, got %s", tt.String(), ))

at the very least for case like:

n := f2() func f2() (string, int) { return "hey", 0 }

the check can happened in *AssignStmt, to identify a mismatch on LHS and RHS.

Writing so much just for the sake of discussion.

Yes @ltzmaxwell I think this check should be done in AssignStmt and ValueDecl in trans_enter

deelawn

A few small suggestions, but looks good to me overall.

deelawn · 2024-08-20T13:14:32Z

gnovm/pkg/gnolang/preprocess.go

+
+// getFunctionName attempts to extract the function name from the expression
+func getFunctionName(x Expr) string {
+	switch expr := x.(type) {


This is a nitpick, but it is a bit strange to have a switch with only one case

deelawn · 2024-08-20T13:17:02Z

gnovm/pkg/gnolang/preprocess.go

+
+			var msg string
+			if valueCount == 0 {
+				msg = fmt.Sprintf("%s: %s() (no value) used as value", loc, funcName)


Maybe the message could be improved here. "no value" doesn't seem as clear as saying something like "function does not return a value".

zivkovicmilos · 2024-10-02T09:48:28Z

@notJoon

Did you get a chance to see @ltzmaxwell's comments? 🙏

ltzmaxwell · 2024-11-06T02:35:33Z

what is the status of this one?

notJoon · 2024-11-21T07:02:50Z

what is the status of this one?

@ltzmaxwell dust off now. sorry for the delay 🙏

Kouteki · 2024-11-21T09:14:34Z

Closing this PR in favor of #3049 to avoid duplicate work

…tion which does not return any value (#3049) This PR aims at resolving this issue: #1082 This depends on #3017 because it refactored the code to sync the logic/code between AssignStmt vs ValueDecl. Related #2695 <details><summary>Contributors' checklist...</summary> - [ ] Added new tests, or not needed, or not feasible - [ ] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [ ] Updated the official documentation or not needed - [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [ ] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests </details> --------- Co-authored-by: hieu.ha <hieu.ha@hsc.com.vn> Co-authored-by: Mikael VALLENET <mikael.vallenetpro@gmail.com>

…tion which does not return any value (gnolang#3049) This PR aims at resolving this issue: gnolang#1082 This depends on gnolang#3017 because it refactored the code to sync the logic/code between AssignStmt vs ValueDecl. Related gnolang#2695 <details><summary>Contributors' checklist...</summary> - [ ] Added new tests, or not needed, or not feasible - [ ] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [ ] Updated the official documentation or not needed - [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [ ] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests </details> --------- Co-authored-by: hieu.ha <hieu.ha@hsc.com.vn> Co-authored-by: Mikael VALLENET <mikael.vallenetpro@gmail.com>

decrypt error msg

cf9a3fd

notJoon requested review from jaekwon, moul, piux2 and deelawn as code owners August 14, 2024 09:21

github-actions bot assigned notJoon Aug 14, 2024

github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Aug 14, 2024

notJoon changed the title ~~feat(gnovm): Improve Error Message in evalStaticTypeOf function~~ fix(gnovm): Improve Error Message in evalStaticTypeOf function Aug 14, 2024

dongwon8247 mentioned this pull request Aug 14, 2024

Onbloc's Builder Journey gnolang/hackerspace#29

Open

ltzmaxwell requested changes Aug 15, 2024

View reviewed changes

deelawn approved these changes Aug 20, 2024

View reviewed changes

michelleellen mentioned this pull request Aug 21, 2024

Minutes: Public Dev Calls [every Wednesday] gnolang/meetings#37

Open

Kouteki mentioned this pull request Sep 2, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

ltzmaxwell referenced this pull request Sep 11, 2024

introduce concept of addressability not applicable

3f4f1b6

ltzmaxwell mentioned this pull request Sep 11, 2024

fix: addressability #2731

Open

7 tasks

Kouteki added review/triage-pending PRs opened by external contributors that are waiting for the 1st review and removed review/triage-pending PRs opened by external contributors that are waiting for the 1st review labels Oct 3, 2024

petar-dambovaliev approved these changes Oct 29, 2024

View reviewed changes

hthieu1110 mentioned this pull request Oct 30, 2024

feat(gnovm): returns error like in Golang when assignment with a function which does not return any value #3049

Merged

6 tasks

id -> funcName

e948f68

ltzmaxwell mentioned this pull request Nov 8, 2024

feat(gnovm): sync code AssignStmt - ValueDecl #3017

Merged

6 tasks

Merge branch 'master' into fix-1082

f352dfc

remopve hint

cb69f87

Kouteki closed this Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(gnovm): Improve Error Message in `evalStaticTypeOf` function #2695

fix(gnovm): Improve Error Message in `evalStaticTypeOf` function #2695

notJoon commented Aug 14, 2024

codecov bot commented Aug 14, 2024 •

edited

Loading

ltzmaxwell Aug 15, 2024

notJoon Aug 19, 2024

ltzmaxwell Aug 15, 2024

notJoon Nov 21, 2024

ltzmaxwell Aug 15, 2024

ltzmaxwell Aug 15, 2024 •

edited

Loading

ltzmaxwell Aug 15, 2024

ltzmaxwell Aug 15, 2024

omarsy Oct 18, 2024

deelawn left a comment

deelawn Aug 20, 2024

deelawn Aug 20, 2024

zivkovicmilos commented Oct 2, 2024

ltzmaxwell commented Nov 6, 2024

notJoon commented Nov 21, 2024

Kouteki commented Nov 21, 2024

fix(gnovm): Improve Error Message in evalStaticTypeOf function #2695

fix(gnovm): Improve Error Message in evalStaticTypeOf function #2695

Conversation

notJoon commented Aug 14, 2024

Description

Example of Errors

Further Works

codecov bot commented Aug 14, 2024 • edited Loading

Codecov Report

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

ltzmaxwell Aug 15, 2024 • 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

deelawn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zivkovicmilos commented Oct 2, 2024

ltzmaxwell commented Nov 6, 2024

notJoon commented Nov 21, 2024

Kouteki commented Nov 21, 2024

fix(gnovm): Improve Error Message in `evalStaticTypeOf` function #2695

fix(gnovm): Improve Error Message in `evalStaticTypeOf` function #2695

codecov bot commented Aug 14, 2024 •

edited

Loading

ltzmaxwell Aug 15, 2024 •

edited

Loading