Restrict configuration sources to ENV and YAML

[palkan]

Context

Recently, we found an issue with the combination of Sniffer, Anyway Config, and Doppler: a max call stack error occurs when we have an HTTP-backed configuration source available for Anyway Config.

Sniffer tries to load the configuration, and while it's still being loaded, we perform an HTTP request, which in its turn again tries to initializes the configuration—and the loop continues 'till it hits the max stack error.

Solution

We can limit the configuration sources for Sniffer to ENV and YAML. Those are safe to use (well, unless someone adds an HTTP call to YAML via ERB 😁).

Since we never mentioned that Sniffer can be configured in any way, keeping just ENV and YAML should be a good compromise.

Alternative solutions

I also considered making the config initialization two-phased: first, allocation and saving the @config variable, then doing the actual load (once). It's a bit more tricky because it would require to deal with the Anyway internals (we invoke #load right in the #initialize—not good) and handle the in-the-middle-of-loading state. Still worth exploring though.

Misc changes

Fixed some RuboCop issues.

Backporting

For those hitting the issue and waiting for a new release, the following snippet should help (make sure you use anyway_config >= 2.8.0):

require "sniffer/config"

Sniffer::Config.configuration_sources = [:env, :yml]

[palkan]

Only use this configuration if supported; so, no requirement on upgrading the anyway_config gem