fix: Key construction in ExtractGoComments#9
Merged
candiduslynx merged 1 commit intocqmainfrom Oct 18, 2023
Merged
Conversation
kodiakhq bot
pushed a commit
to cloudquery/cloudquery
that referenced
this pull request
Oct 18, 2023
This was referenced Oct 18, 2023
hydratim
pushed a commit
to hydratim/cloudquery
that referenced
this pull request
Oct 20, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The intended (from README.md) usage of
ExtractGoComments(base, path string, commentMap map[string]string) errortreats the params as following:base– package import pathpath– package location on the filesystemcommentMapoutputIf we pass
"../"aspathparam the code will fail to load comments properly because of thepath.Joinused on the unverified input. Moreover, if thepathis the absolute path, the code will join it withbaseso we end up with keysbase + "/" + absPath(cleaned in thepath.Cleanfunc, but still).This PR fixes the behavior in the following way:
pathtorootPathfor better understanding the semantics & not allowing name clashes in the funcrootvariable equal to the absolute path of therootPathlocationrootpathrootprefix of the path prior to joining with thebasevalue