Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Disable unused import check to prevent false positives in init function #3929

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

notJoon
Copy link
Member

@notJoon notJoon commented Mar 13, 2025

Description

There is a tendency for an unused error to occur when calling a package in the init function, even though it is actually being used. This issue appears to arise during the type-checking process performed by the go/types' Config.Check method.

Cause Analysis

It is suspected that this occurs because the types.Info structure is not provided (passed as nil) when calling Check, preventing the collection of detailed usage information.

Temporary Solution

The DisableUnusedImportCheck: true option has been added to types.Config to disable the unused import check. This serves as a temporary solution to prevent the unused error.

Future Improvements

  1. Collecting detailed usage information using the types.Info structure:
    e.g.,
info := &types.Info{
    Uses: make(map[*ast.Ident]types.Object),
    Defs: make(map[*ast.Ident]types.Object),
}
  1. Implementing a dedicated processing logic for tracking dependencies in the init function:
    • Special marking for packages or variables used in the init function.
    • Explicitly including init function dependencies when constructing the dependency graph.

These fundamental improvements must be addressed in the future.

Call Stack

lintTypeCheck -> TypeCheckMemPackageTest -> typeCheckMemPackage -> gnoImporter.parseCheckMemPackage -> types/config.Check

Related Issue

@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Mar 13, 2025
@Gno2D2 Gno2D2 requested a review from a team March 13, 2025 03:39
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Mar 13, 2025

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
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)
🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ 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:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: notJoon/gno-core)

Then

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

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Copy link

codecov bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@notJoon notJoon changed the title investigate: False-positive unused package lint error when using the Realm package fix: Disable unused import check to prevent false positives in init function Mar 18, 2025
@notJoon notJoon marked this pull request as ready for review March 18, 2025 09:03
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Mar 18, 2025
@jefft0
Copy link
Contributor

jefft0 commented Mar 20, 2025

@notJoon , please fix the failed CI checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🤖 gnovm Issues or PRs gnovm related review/triage-pending PRs opened by external contributors that are waiting for the 1st review
Projects
Status: No status
Status: Triage
Development

Successfully merging this pull request may close these issues.

3 participants