Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @kooksee, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors the dependency version resolution mechanism to use go mod graph instead of direct go.mod file parsing. This change aims to improve the accuracy and reliability of dependency version identification by leveraging Go's built-in module graph capabilities. It introduces new utility functions and external dependencies to support this new approach, along with minor code cleanup and a new test file for verification.
Highlights
- Dependency Resolution Strategy Change: The core mechanism for resolving Go module dependency versions has been updated. Instead of directly parsing the
go.modfile, the system now leverages the output of thego mod graphcommand. This change aims to provide a more accurate and robust way to determine the effective versions of dependencies, especially in scenarios involving complex module graphs or transitive dependencies. - New Module Graph Utility: A new function,
LoadVersionGraph(), has been introduced ininternal/modutil/util.go. This function is responsible for executinggo mod graph, parsing its output, and identifying the highest resolved version for each module, which is then used throughout the application. - External Dependency Additions: Several new external libraries have been added to support the enhanced module version parsing and comparison logic. These include
github.com/deckarep/golang-set/v2for set operations,github.com/hashicorp/go-versionfor robust version parsing, andgithub.com/samber/lofor utility functions. - Import Relocation and Cleanup: Some
_(blank) imports, specificallygithub.com/samber/loandgolang.org/x/mod/module, were moved fromcmd/protobuild/cmd.gotodocs/docs.go. This is a common Go practice to ensure these modules are included in thego.modfile and available forgo mod tidywithout being directly used in the main application logic. - Minor Pointer Helper Refactoring: An update was made in
cmd/protobuild/cmd.goto change the pointer dereferencing helper fromgeneric.DePtrtogeneric.FromPtrwhen handling optional dependency versions. - New Test/Analysis File: A new test file,
internal/modutil/util_test.go, has been added. It includes aTestNamefunction that demonstrates and verifies the parsing ofgo mod graphoutput and the logic for selecting maximum (and minimum) module versions.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the logic for determining dependency versions by switching from parsing go.mod directly to using the output of go mod graph. The core logic in internal/modutil/util.go is sound, but there are areas for improvement, particularly around robustness and testing. The test file, internal/modutil/util_test.go, currently doesn't function as a valid test and needs to be rewritten. There's also a potential panic in the new LoadVersionGraph function that should be addressed.
| func TestName(t *testing.T) { | ||
| pretty.Println(LoadVersions()) | ||
|
|
||
| modList := strings.Split(result.Wrap(shutil.GoModGraph()).Must(), "\n") | ||
| modSet := mapset.NewSet[string]() | ||
| for _, m := range modList { | ||
| for _, v := range strings.Split(m, " ") { | ||
| modSet.Add(strings.TrimSpace(v)) | ||
| } | ||
| } | ||
|
|
||
| var modMap = make(map[string][]*ver.Version) | ||
| modSet.Each(func(s string) bool { | ||
| ver2 := strings.Split(s, "@") | ||
| if len(ver2) != 2 { | ||
| return false | ||
| } | ||
|
|
||
| if !strings.HasPrefix(ver2[1], "v") { | ||
| return false | ||
| } | ||
|
|
||
| modMap[ver2[0]] = append(modMap[ver2[0]], ver.Must(ver.NewSemver(ver2[1]))) | ||
| return false | ||
| }) | ||
|
|
||
| for k, v := range modMap { | ||
| pretty.Println(k, maxVersion(v).String(), minVersion(v).String()) | ||
| } | ||
| } |
There was a problem hiding this comment.
The test function TestName has critical issues:
- It does not contain any assertions (e.g.,
t.Errorf,require.Equal) to verify behavior. It only prints values, so it can't detect regressions. - It duplicates the implementation of
LoadVersionGraphinstead of calling it. Tests should treat the function under test as a black box.
Please refactor this to be a proper unit test. It should call LoadVersionGraph and assert its results against expected values. To make the test deterministic, consider mocking shutil.GoModGraph to return a fixed go mod graph output.
| modSet.Each(func(s string) bool { | ||
| ver2 := strings.Split(s, "@") | ||
| if len(ver2) != 2 { | ||
| return false | ||
| } | ||
|
|
||
| if !strings.HasPrefix(ver2[1], "v") { | ||
| return false | ||
| } | ||
|
|
||
| modMap[ver2[0]] = append(modMap[ver2[0]], ver.Must(ver.NewSemver(ver2[1]))) | ||
| return false | ||
| }) |
There was a problem hiding this comment.
The use of ver.Must(...) can cause a panic if go mod graph provides a version string that cannot be parsed as a semantic version. Consider handling the error from ver.NewSemver gracefully, for example, by logging the error and skipping the invalid entry.
modSet.Each(func(s string) bool {
ver2 := strings.Split(s, "@")
if len(ver2) != 2 {
return false
}
if !strings.HasPrefix(ver2[1], "v") {
return false
}
v, err := ver.NewSemver(ver2[1])
if err != nil {
// Consider logging this error, e.g., slog.Warn("failed to parse version, skipping", "entry", s, "error", err)
return false
}
modMap[ver2[0]] = append(modMap[ver2[0]], v)
return false
})| func minVersion(versions []*ver.Version) *ver.Version { | ||
| return lo.MaxBy(versions, func(a *ver.Version, b *ver.Version) bool { return !a.GreaterThan(b) }) | ||
| } |
There was a problem hiding this comment.
The minVersion function is implemented using lo.MaxBy. While technically correct that using a <= comparison with MaxBy finds the minimum, this is confusing and unidiomatic. The lo library provides lo.MinBy, which should be used here for better readability and maintainability.
| func minVersion(versions []*ver.Version) *ver.Version { | |
| return lo.MaxBy(versions, func(a *ver.Version, b *ver.Version) bool { return !a.GreaterThan(b) }) | |
| } | |
| func minVersion(versions []*ver.Version) *ver.Version { | |
| return lo.MinBy(versions, func(a *ver.Version, b *ver.Version) bool { return a.LessThan(b) }) | |
| } |
1 participant
This pull request focuses on improving dependency version management and cleaning up imports across multiple files. The changes introduce a new method for determining the maximum version of dependencies using
go mod graph, replace deprecated functions, and add missing imports. Additionally, a test file has been added to validate the new functionality.Dependency Version Management Enhancements:
internal/modutil/util.go: Added a newLoadVersionGraphfunction to calculate the maximum version of each dependency usinggo mod graph. This replaces the previousLoadVersionsfunction in some parts of the code. Also introduced a helper functionmaxVersionfor determining the highest version from a list of versions. [1] [2]cmd/protobuild/cmd.go: Updated the logic inMain()to use the newLoadVersionGraphfunction instead ofLoadVersions. This ensures more accurate dependency version resolution.Code Cleanup:
cmd/protobuild/cmd.go: Removed unused imports (github.com/samber/loandgolang.org/x/mod/module).docs/docs.go: Added missing imports (github.com/samber/loandgolang.org/x/mod/module) to thedocspackage.Testing:
internal/modutil/util_test.go: Added a new test file to validate the functionality ofLoadVersionGraphand helper methods likemaxVersionandminVersion. This ensures the correctness of dependency version management logic.Function Replacement:
cmd/protobuild/cmd.go: Replaced the deprecatedgeneric.DePtrfunction withgeneric.FromPtrfor better readability and consistency.