feat: normalize path for creation rules #1523
Conversation
Signed-off-by: Sizhe Zhao <prc.zhao@outlook.com>
Signed-off-by: Sizhe Zhao <prc.zhao@outlook.com>
Prince213
force-pushed
the
feat-path-normalization
branch
from
535c0df
to
1aabe5c
Compare
| @@ -368,6 +368,8 @@ func parseCreationRuleForFile(conf *configFile, confPath, filePath string, kmsEn | |||
|
|
|||
| // compare file path relative to path of config file | |||
| filePath = strings.TrimPrefix(filePath, configDir+string(filepath.Separator)) | |||
| // replace \ with / | |||
| filePath = filepath.ToSlash(filePath) | |||
There was a problem hiding this comment.
For everyone using regexes that support both Windows and Unix paths, this is not a breaking change. But for users that use Windows paths exclusively and wrote their regexes that way, it's a breaking change since their regexes won't work anymore.
To avoid breaking changes, we'll have to (for some time) keep the old behavior, but warn the user if it will change in the future. So better do something like:
| filePath = filepath.ToSlash(filePath) | |
| filePathAlt := filepath.ToSlash(filePath) |
here, and below before calling reg.MatchString(filePath) do newMatch := reg.MatchString(filePathAlt) and then emit a warning if it's value is different from reg.MatchString(filePath).
There was a problem hiding this comment.
Let's also add a option to silence that warning (by opting in to the new behavior).
There was a problem hiding this comment.
In Ansible we usually proceed as follows:
- Add a new option that allows to select the behavior. The default is the old behavior.
- A version later, deprecate the option's default value - i.e. start warning the user if they didn't specify a value for that option and if the change to the new default would produce a change. Then users have time to figure out whether they prefer the old or new behavior, and can explicitly set the option to the value they prefer (and as soon as it has a value, there will be no more warnings).
- Eventually flip the default of the option to the new value.
@getsops/maintainers what do you think, and what would you prefer?
Fixes #1036.
This may be a breaking change. 🤔