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

Do not duplicate packages when running gazelle-update-repos #47

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

GuillaumeGen
Copy link
Contributor

This addresses #46

gazelle_cabal/dependency_resolution.go Show resolved Hide resolved
Comment on lines 424 to 434
if equiv(s[first_free_position-1], s[curr]) {
// If the last added element is equivalent is considered one,
// then we move the cursor back so that the currently considered element
// replace the previously added one.
// This function is only keeping the last representative of the equivalence class
// because it is used to deal with packages having or not a version number,
// and in case both option are available, the version number should be kept.
first_free_position--
}
s[first_free_position] = s[curr]
first_free_position++
Copy link
Member

Choose a reason for hiding this comment

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

I find easier to follow the loop when not mutating the index.

Suggested change
if equiv(s[first_free_position-1], s[curr]) {
// If the last added element is equivalent is considered one,
// then we move the cursor back so that the currently considered element
// replace the previously added one.
// This function is only keeping the last representative of the equivalence class
// because it is used to deal with packages having or not a version number,
// and in case both option are available, the version number should be kept.
first_free_position--
}
s[first_free_position] = s[curr]
first_free_position++
if equiv(s[first_free_position-1], s[curr]) {
s[first_free_position-1] = s[curr]
} else {
s[first_free_position] = s[curr]
first_free_position++
}

gazelle_cabal/dependency_resolution.go Show resolved Hide resolved
gazelle_cabal/dependency_resolution.go Show resolved Hide resolved
n := len(l)
// strconv.Atoi converts a string to an integer,
// and potentially outputs an error message.
_, err := strconv.Atoi(strings.ReplaceAll(l[n-1], ".", ""))
Copy link
Member

Choose a reason for hiding this comment

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

There is a low risk of overflow here. Would it be straighter to check that all characters are either digits or dots instead?

Copy link
Member

@facundominguez facundominguez left a comment

Choose a reason for hiding this comment

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

LGTM.
Does it solve #46, though? Existing entries in packages aren't fed to mapSortedStringKeys, I think. It is gazelle the piece that merges the old and the new lists.

Also, I think, gazelle_cabal would be less puzzling on error if it rejected package identifiers when they specify conflicting versions for the same package. The current behavior would be to ignore the identifier with the lexicographically smaller version.

_, err := strconv.Atoi(strings.ReplaceAll(l[n-1], ".", ""))
// If the conversion succeeded, the error is 'nil'.
if err == nil {
matched, _ := regexp.MatchString(`^[0-9]+(\.[0-9]+)*$`, l[n-1])
Copy link
Member

Choose a reason for hiding this comment

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

Maybe the regex can be compiled only once instead of doing it once per call?
Also, looks like regexp allows to implement all of this function with FindStringIndex.

e.g.

regexp.Regexp chopVersionNumberRegexp = regexp.Compile(`-[0-9]+(\.[0-9]+)*$`)
func chopVersionNumber(s string) string {
    loc := chopVersionNumberRegexp.FindStringIndex(s)
    if loc == nil {
        return s
    } else {
        return s[:loc[0]]
    }
} 

default:
panic("Packages should be a list!")
}
print(list)
Copy link
Member

Choose a reason for hiding this comment

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

There are a few print statements that should be removed.

case *bzl.StringExpr:
list = append(list, exprElem.Value)
default:
panic("Elements of packages should be string!")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
panic("Elements of packages should be string!")
panic("Elements of packages should be strings!")

print("Case accessed")
var list []string
pack := r.Attr("packages")
switch expr := pack.(type) {
Copy link
Member

Choose a reason for hiding this comment

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

This code is probably better put in a function that extracts an array of strings from an attribute value. gazelle_haskell_modules has such a function.

panic("Packages should be a list!")
}
print(list)
r.SetAttr("packages", listSortedStringKeys(list))
Copy link
Member

Choose a reason for hiding this comment

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

Is reordering the strings necessary? If so, perhaps it should be mentioned in the README.

@avdv avdv self-requested a review as a code owner August 17, 2023 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants