search

varnish / varnish-modules

Collection of Varnish Cache modules (vmods) by Varnish Software
Other
182 stars 86 forks source link

Update saintmode configuration language for inclusivity #217

Open benzvan opened 11 months ago

benzvan commented 11 months ago

I was cleaning up some of the archaic language in our projects and discovered we're setting the saintmode.blacklist value on our varnish containers. This terminology should be updated to something more inclusive and more descriptive of its purpose. It would make sense to deprecate the configuration field and replace it with backend_sick_timer or similar descriptive language. Honestly the whole saint, grace, etc. metaphor could be more descriptive.

Instances in code: https://github.com/search?q=repo%3Avarnish%2Fvarnish-modules%20blacklist&type=code

More details: https://www.splunk.com/en_us/blog/learn/blacklist-whitelist-inclusivity.html

gquintard commented 11 months ago

I'm in favor, would you care opening a PR for it?

benzvan commented 11 months ago

I can give it a shot. It's been a while since I've worked in C, much less varnish.

gquintard commented 11 months ago

thankfully, you shouldn't have to do C, Varnish 7.1 introduced $Alias that should do your bidding. You can see it used in vmod-cookie

That will leave the old names around for a while, but I don't want to break users without notice

benzvan commented 11 months ago

Oh cool! It looks like I can just update the aliases and documentation and leave the code the same, so here's a draft PR doing that. Let me know if this is what you were thinking. Updating the code looks pretty straightforward but I'm not sure I can run the tests locally right now.

gquintard commented 6 months ago

cleaning, the associated PR has been merged