fix: remove import cycles

[n0izn0iz]

WIP

• add contribs/nocycles binary to detect import cycles in stdlibs and examples
• remove import cycles

Go never allows import cycles. Our stdlibs have a lot of import cycles, and some examples import self which is not allowed in golang either.
Keeping support for import cycles in stdlib and importing self will require a lot of hacky and weird logic in generic package loading code so I try to tackle this first.

NOTES:

• golang stdlibs tests make heavy use of dot import and we don't support it, meaning I have to make a lot of manual replace with careful reviewing of each case to not edit the wrong stuff like expected data, I'm considering making a tool that will work on the go ast to properly make the refacto
• biggest logic hurdle is that none of the libs imported by testing should have non-external tests to avoid a cycle on testing

TODO:

• fix tests
• check cycles with the test stdlibs overlay applied

[Gno2D2]

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):

• SKIP: Do not block the CI for this PR

Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 The pull request head branch must be up-to-date with its base (more info)

☑️ Contributor Actions:

1. Fix any issues flagged by automated checks.
2. Follow the Contributor Checklist to ensure your PR is ready for review.
   • Add new tests, or document why they are unnecessary.
   • Provide clear examples/screenshots, if necessary.
   • Update documentation, if required.
   • Ensure no breaking changes, or include BREAKING CHANGE notes.
   • Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

• Report a bug with the bot.
• View the bot’s configuration file.

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: n0izn0iz/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

The pull request head branch must be up-to-date with its base (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🟢 Requirement satisfied
└── 🟢 Head branch (n0izn0iz:forbid-import-cycle) is up to date with base (master): behind by 0 / ahead by 20

Manual Checks

**SKIP**: Do not block the CI for this PR

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

• Any user with comment edit permission

[codecov]

Codecov Report

Attention: Patch coverage is 45.71429% with 19 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
gnovm/pkg/packages/imports.go	0.00%	7 Missing ⚠️
misc/genstd/genstd.go	33.33%	4 Missing and 2 partials ⚠️
gnovm/pkg/gnomod/pkg.go	70.00%	2 Missing and 1 partial ⚠️
gnovm/stdlibs/testing/testing.go	62.50%	2 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

[thehowl]

these cases should be catchable already by the cyclic-import detector in the store; can you take a look at what's going on there?

[n0izn0iz]

I'm not sure what you mean by the cyclic-import detector in the store, the Store in gnovm/pkg/test/imports.go does not seem to have cycle detection

FYI the self-import in faucet had been there for 2 years

[thehowl]

yeah no apologies I thought about it for two seconds and you're right (because the import will not consider any _test.go files, correctly so)

the store has cyclic import detection, see pkg/gnolang/store.go:

gno/gnovm/pkg/gnolang/store.go

Lines 214 to 225 in 5c31552

	// Gets package from cache, or loads it from baseStore, or gets it from package getter.
	func (ds *defaultStore) GetPackage(pkgPath string, isImport bool) *PackageValue {
	// helper to detect circular imports
	if isImport {
	if slices.Contains(ds.current, pkgPath) {
	panic(fmt.Sprintf("import cycle detected: %q (through %v)", pkgPath, ds.current))
	}
	ds.current = append(ds.current, pkgPath)
	defer func() {
	ds.current = ds.current[:len(ds.current)-1]
	}()
	}

[thehowl]

for stdlibs, instead, i think you could change misc/genstd (note: this binary as well, if it were to stay, would also have to be misc/), by having its import order generator also consider test files

[n0izn0iz]

Indeed, when I cherry-pick c6728c5 on master, I get:

go run github.com/gnolang/gno/misc/genstd
panic: cyclical package initialization on "bytes" (bytes -> io -> bytes)

I like having code that is dedicated to detecting any cycles in stdlibs and examples though, I'll move the nocycles code into a test somewhere I think when I get to the polishing step on this PR