Crash when API_POLL_FREQUENCY or API_POLL_TIMEOUT is set

[Fitzsimmons]

Version: 2.17.0

Crashes if API_POLL_FREQUENCY is set as an environment variable:

Traceback (most recent call last):
  File "/opt/venv/bin/edge-proxy-serve", line 8, in <module>
    sys.exit(serve())
             ^^^^^^^
  File "/app/src/edge_proxy/main.py", line 7, in serve
    settings = get_settings()
               ^^^^^^^^^^^^^^
  File "/app/src/edge_proxy/settings.py", line 152, in get_settings
    return AppConfig()
           ^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/pydantic_settings/main.py", line 84, in __init__
    super().__init__(
  File "/opt/venv/lib/python3.12/site-packages/pydantic/main.py", line 176, in __init__
    self.__pydantic_validator__.validate_python(data, self_instance=self)
pydantic_core._pydantic_core.ValidationError: 1 validation error for AppConfig
api_poll_frequency
  Extra inputs are not permitted [type=extra_forbidden, input_value='300', input_type=str]
    For further information visit https://errors.pydantic.dev/2.7/v/extra_forbidden

Steps to reproduce:

docker run --rm -e API_POLL_FREQUENCY=300 flagsmith/edge-proxy:2.17.0

or

docker run --rm -e API_POLL_TIMEOUT=300 flagsmith/edge-proxy:2.17.0

Additional information:

• Works when API_POLL_FREQUENCY_SECONDS is set instead, which I only discovered via reading the source code. Might want to update the documentation: https://docs.flagsmith.com/deployment/hosting/locally-edge-proxy#api_poll_frequency
• Works when api_poll_frequency_seconds is not supplied in the config file, e.g. a file containing only {} is mounted at /app/config.json

[rolodato]

Hi @Fitzsimmons - just to make sure I understood, this is only an issue with the docs? We can make that correction for sure, thanks for pointing it out.

[matthewelwell]

@rolodato I think there's also a (less important) improvement we can make to the code as per the PR here, although I can't work out why the implementation doesn't work... more pydantic investigation needed.

[rolodato]

Docs PR created Flagsmith/flagsmith#5034