feat: ✨ client connection options

[iwpnd]

@alxwrd

using options pattern redis client connection options. options pattern doesn't seem to be too widely used, yet it allows me to abstract away any of the redis retry and backoff implementations. the final version might look a little different, but I think you can test run this one to see if that suffices to close #529.

closes #529

UPDATE:

run

docker-compose up -d

start this in one terminal

import asyncio

from pyle38 import Tile38
from pyle38.client_options import WithRetryExponentialBackoff, WithRetryOnError
from pyle38.errors import (
    Pyle38ConnectionError,
    Pyle38TimeoutError,
)

tile38 = Tile38(
    url="redis://localhost:9851",
    options=[
        WithRetryExponentialBackoff(30),
        WithRetryOnError(Pyle38TimeoutError, Pyle38ConnectionError),
    ]
)


async def main():
    while True:
        try:
            res = await tile38.set("fleet", "truck").point(1, 1).exec()
            print(res.dict())
        except Exception as e:
            print(e)

        await asyncio.sleep(1)


asyncio.run(main())

in another terminal restart the tile38 leader

docker-compose restart tile38-leader

as long as the leader comes back on within those 25 retries, the ConnectionError will not be raised.

[alxwrd]

Yes works great ✨!

I've added a suggestion for the Tile38 interface, but either way works for me.

[alxwrd]

Having the options as *args makes the client interface a bit clunky as you can no longer use the key word args for url and follower_url and pass a list of options.

# Doesn't work
tile38 = Tile38(
    url="redis://localhost:9851",
    WithRetryExponentialBackoff(30),
    WithRetryOnError(Pyle38TimeoutError, Pyle38ConnectionError),
)

You can of course expand them inline,

tile38 = Tile38(
    url="redis://localhost:9851",
    *[
        WithRetryExponentialBackoff(30),
        WithRetryOnError(Pyle38TimeoutError, Pyle38ConnectionError),
    ]
)

but I think having another key word argument feels nicer?

Suggested change

	*opts: Callable[..., ClientOptions],
	options: List[Callable[..., ClientOptions]] = None,

And then of course:

    def __init__(
        self,
        url=os.getenv("TILE38_LEADER_URI"),
        follower_url=os.getenv("TILE38_FOLLOWER_URI"),
        options: List[Callable[..., ClientOptions]] = None,
    ):
        if not url:
            raise Tile38Error("No Tile38 url set")

        if options is None:
            options = []

[iwpnd]

Yeah my thoughts exactly. The way it is now is a little too golang’ish. Although I don’t like array as inputs either. .. unless I’m changing that follower_url as well. 😈

[iwpnd]

im going for a less disruptive option. ill take on the follower refactor when I add the option for multiple follower instances.