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.

Sign up for GitHub

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 path in file changed detected message #11271

Merged
merged 3 commits into from
Apr 19, 2024
Merged

fix path in file changed detected message #11271

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d6768b
fix path in file changed detected message
kd7lxl Apr 17, 2024
c826eeb
fix typo in log message
kd7lxl Apr 17, 2024
4a1e3c4
explain code per review comments
kd7lxl Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion internal/ingress/controller/nginx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,11 @@ func NewNGINXController(config *Configuration, mc metric.Collector) *NGINXContro
}

for _, f := range filesToWatch {
// This redeclaration is necessary for the closure to get the correct value for the iteration in go versions <1.22
// See https://go.dev/blog/loopvar-preview
f := f
Copy link
Member

@Gacko Gacko Apr 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Based on the fact that it took me some time to understand the root cause and the fix, I'd recommend adding a few lines of docs here. That's probably an easy one for devs deeper into that project and Go in general, but others might drop or refactor that line without further context. Maybe also reference this PR in your comment. Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a link to a doc in the PR description.

Copy link
Member

Choose a reason for hiding this comment

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

Sure, but nobody will find that if they are not git blameing and walking through history. So please add some words next to your code addition. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a description of the code to the code.

_, err = file.NewFileWatcher(f, func() {
klog.InfoS("File changed detected. Reloading NGINX", "path", f)
klog.InfoS("File change detected. Reloading NGINX", "path", f)
n.syncQueue.EnqueueTask(task.GetDummyObject("file-change"))
})
if err != nil {
Expand Down