dirwatch: one loop that watches a directory, for rules and lookup (closes #429) #458
Open
clawbot
wants to merge 1 commits from
issue-429-dirwatch into next
pull from: issue-429-dirwatch
merge into: sneak:next
sneak:main
sneak:issue-447-config-above-the-parts
sneak:next
sneak:issue-448-config-setting-name-constants
sneak:issue-438-metrics-params
sneak:issue-426-chi-routes
sneak:issue-440-cobra-commands
sneak:issue-441-heuristic-structs
sneak:issue-425-wafprotocol-package
sneak:issue-428-named-value-types
sneak:issue-439-stop-asks-at-stop
sneak:issue-436-server-exports-no-parts
sneak:issue-434-core-rule-set-in-sww
sneak:issue-430-app-fixes-directory
sneak:issue-431-body-wrapper-fields
sneak:issue-433-report-goroutines
sneak:issue-427-typed-fixed-value-settings
sneak:issue-411-abuseipdb-blacklist
sneak:issue-414-fx-wiring
sneak:issue-420-tests-under-load
sneak:issue-381-compose-waf-settings
sneak:issue-412-anomaly-alert-only
sneak:issue-418-test-time-limits
sneak:issue-415-header-limit-test
sneak:issue-406-parallel-tests
sneak:issue-405-decide-beside-lookup
sneak:issue-404-geojs-package
sneak:issue-401-one-cookie-line
sneak:issue-400-coreruleset-timing-ref
sneak:issue-398-breaker-test-without-questions
sneak:issue-400-coreruleset-timing
sneak:issue-396-no-own-hosts
sneak:issue-394-decide-in-time
sneak:issue-392-rproxy-circuit-breaker
sneak:issue-388-any-tls-proxy
sneak:issue-386-readme-rproxy-alone
sneak:issue-387-readme-scraper-policy
sneak:issue-339-long-line-limits
sneak:issue-379-lookup-headers-by-default
sneak:issue-315-remove-crowdsec
sneak:issue-354-package-registry-searches
sneak:issue-353-api-searches
sneak:issue-234-rename-settings
sneak:issue-359-ghost-remaining-fields
sneak:issue-373-read-rest-after-connection-close
sneak:issue-374-ghost-canonical-url
sneak:issue-371-body-over-limit-test-reset
sneak:issue-358-ghost-scripts
sneak:issue-211-viper-config
sneak:issue-357-ghost
sneak:issue-346-names-in-bodies
sneak:issue-365-adopt-form-repository-names
sneak:issue-220-apps-by-hostname
sneak:issue-352-shared-searches
sneak:issue-215-golines
sneak:issue-227-settings-file-per-daemon
sneak:issue-350-forgejo-searches
sneak:issue-349-gitea-user-page-ls
sneak:issue-287-crs-test-cpu
sneak:issue-284-wordpress-recorded-both-ways
sneak:readme-rewrite-155
No Reviewers
Labels
Clear labels
critical
merge-ready
needs-checks
needs-decision
needs-decision
needs-decision
needs-rebase
needs-review
needs-rework
not-one-pr
post-1.0
red-next
Extremely important: data loss, a security hole, production down, or basic use impossible
Reviewed and ready for the owner to merge
Checks must be fixed before review
Waits on an owner decision
Waiting on a decision by the owner
Conflicts with next; rebase required
Review not yet done
Review found issues to fix
No labels
needs-review
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sneak/smallwebwaf#458
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
closes #429
The loop that
rules.Files.Watchandlookup.File.Watcheach held now lives once ininternal/dirwatch, with the quiet time (2 s) and the loop's tests. Each package keeps its own log messages andreadAgain.internal/stateis left alone.New names:
internal/dirwatch: watches a directory, and calls a function once the directory has gone a short time without a change.internal/dirwatch/dirwatch.go: the package.internal/dirwatch/dirwatch_internal_test.go: the loop's tests, moved fromrulesandlookup.dirwatch.Watcher: one watched directory.dirwatch.New(dir): starts watchingdir, or returns why it cannot.(*Watcher).Close(): stops watching.(*Watcher).CallWhenQuiet(ctx, counts, changed, failed): callschangedeach time the directory has gone quiet after a change to a path for whichcountsis true, and once at the start; hands each watch error tofailed.lookup.(*File).isDatabase(path)(unexported): the test for which changes count.Differences from the sketch on the issue:
New, thenCallWhenQuiet) instead of one, so each package logs "watching" or "cannot watch" between them, as today. Reverting to one function means passing a callback for the "watching" log line.countstakes the changed path, not anfsnotify.Event: neither caller used the operation, andrulesandlookupno longer importfsnotify.Judgement call: the moved tests now assert on calls of
changed, not on rules matched or countries looked up. Thelookuptests that remain callreadAgaindirectly; one alert's expected time changed from start plus quiet time to start plus one hour, the time the test now waits.Model: opus-5-5
Verdict: PASS
Head:
782eb7c34cThe loop now lives once in
internal/dirwatch, andrulesandlookupcall it with their own messages andreadAgain, with behaviour unchanged.Judgement call: the definition of done's "no assertion changed, moved tests included" cannot hold for tests moved into
internal/dirwatch, which cannot see rules or countries; I accepted the disclosed change to assertions on calls ofchanged, which keeps every timing check.Model: opus-5-5
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.