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

Jump to bottom

adding Unwatch function for file provider #245

Closed
wants to merge 6 commits into from
Closed

adding Unwatch function for file provider #245

wants to merge 6 commits into from

Conversation

prateek-narsinghani
Copy link

No description provided.

@prateek-narsinghani prateek-narsinghani mentioned this pull request Oct 31, 2023
Closed
rhnvrm
rhnvrm requested changes Nov 7, 2023
View reviewed changes
providers/file/file.go Outdated Show resolved Hide resolved
providers/file/file.go Outdated Show resolved Hide resolved
@prateek-narsinghani
Copy link
Author

prateek-narsinghani commented Nov 9, 2023 •
edited
Loading

@rhnvrm , I have made the following changes:

  1. Changed function name UnWatch -> Unwatch
  2. Added comment for the Unwatch function
  3. Using Close function for all the watchers
  4. Adding an array to the file structure as there can be multiple f.Watch() calls, hence an array would store all the watchers

@knadh
Copy link
Owner

knadh commented Nov 26, 2023

@prateek-narsinghani thanks for the PR. Could you please add tests for this as well?

@knadh knadh added the enhancement New feature or request label Nov 26, 2023
@prateek-narsinghani
Copy link
Author

prateek-narsinghani commented Dec 3, 2023 •
edited
Loading

@knadh I have added a test for the Unwatch function. Let me know if any further changes are required.

rhnvrm
rhnvrm reviewed Dec 4, 2023
View reviewed changes
providers/file/file.go Outdated Show resolved Hide resolved
rhnvrm
rhnvrm requested changes Mar 6, 2024
View reviewed changes
providers/file/file.go Show resolved Hide resolved
@gczuczy gczuczy mentioned this pull request May 10, 2024
Closed
@rhnvrm rhnvrm requested a review from knadh May 11, 2024 17:22
halturin
halturin reviewed May 27, 2024
View reviewed changes
providers/file/file.go
// Unwatch stops watching the files. It closes all the fsnotify watchers
// and event channels associated with them.
func (f *File) Unwatch() error {
return f.w.Close()
Copy link

Choose a reason for hiding this comment

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

f.w = nil is missing here for the case of restart watching (there is checking for f.w != nil

halturin
halturin reviewed May 27, 2024
View reviewed changes
tests/koanf_test.go
os.WriteFile(tmpFile, []byte(`{"parent": {"name": "name2"}}`), 0600)
wg.Wait()
}

Copy link

Choose a reason for hiding this comment

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

the sequence of Watch/Unwatch/Watch needs to be checked

@knadh
Copy link
Owner

knadh commented Jul 17, 2024

I finally got around to looking into this. Please take a look at: #306

It addresses a couple of issues in this PR:

  • Unwatch() triggers random channel closure errors (main channel or error channel) to the callback, which the caller is expected to handle. Unwatch() shouldn't trigger these errors.
  • The f.w == nil issue where once Unwatched(), the watcher couldn't be used again. Also, setting f.w to nil would require locking.

@knadh knadh mentioned this pull request Jul 17, 2024
Merged
@knadh knadh closed this Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@halturin halturin halturin left review comments

@rhnvrm rhnvrm rhnvrm approved these changes

@knadh knadh Awaiting requested review from knadh

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@prateek-narsinghani @knadh @halturin @rhnvrm @prateeknarsinghani