Skip to content

refactor(follower): use normal feed for one-off changes #795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2025
Merged

refactor(follower): use normal feed for one-off changes #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions ibmcloudant/features/changes_follower.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ def __init__(
) -> None:
self.options = kwargs
self.limit = self.options.get('limit')
self._set_defaults()
self._set_defaults(_Mode.FINITE)
self.service = service
self.error_tolerance = error_tolerance
self._iter = None
Expand Down Expand Up @@ -358,11 +358,16 @@ def options(self, value: Dict):
raise ValueError(error_fmt.format(invalid_opts_list, class_name))
self._options = value

def _set_defaults(self, limit: int = None):
defaults = {
'feed': PostChangesEnums.Feed.LONGPOLL,
'timeout': _LONGPOLL_TIMEOUT,
}
def _set_defaults(self, mode: _Mode, limit: int = None):
if mode == _Mode.FINITE:
defaults = {
'feed': PostChangesEnums.Feed.NORMAL
}
elif mode == _Mode.LISTEN:
defaults = {
'feed': PostChangesEnums.Feed.LONGPOLL,
'timeout': _LONGPOLL_TIMEOUT,
}
if limit is not None:
self.logger.debug(f'Applying changes limit {limit}')
defaults['limit'] = limit
Expand Down Expand Up @@ -445,7 +450,7 @@ def _run(self, mode: _Mode):
if self.limit is not None:
batch_size = self.limit if self.limit < batch_size else batch_size

self._set_defaults(batch_size)
self._set_defaults(mode, batch_size)
changes_caller = functools.partial(
self.service.post_changes, **self.options
)
Expand Down
25 changes: 23 additions & 2 deletions test/unit/features/test_changes_follower.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ def test_validate_options_multiple_invalid_cases(self):

def test_set_defaults(self):
follower = ChangesFollower(self.client, db="db", **self.kwarg_valid)
expected = {
"feed": PostChangesEnums.Feed.NORMAL,
"timeout": None,
}
for opt, val in expected.items():
self.assertEqual(follower.options.get(opt), val)

def test_set_defaults_listen(self):
follower = ChangesFollower(self.client, db="db", **self.kwarg_valid)
follower._set_defaults(_Mode.LISTEN)
expected = {
"feed": PostChangesEnums.Feed.LONGPOLL,
"timeout": _LONGPOLL_TIMEOUT,
Expand All @@ -121,7 +131,18 @@ def test_set_defaults(self):

def test_set_defaults_with_limit(self):
follower = ChangesFollower(self.client, db="db", **self.kwarg_valid)
follower._set_defaults(limit=12)
follower._set_defaults(_Mode.FINITE, limit=12)
expected = {
"feed": PostChangesEnums.Feed.NORMAL,
"timeout": None,
"limit": 12,
}
for opt, val in expected.items():
self.assertEqual(follower.options.get(opt), val)

def test_set_defaults_listen_with_limit(self):
follower = ChangesFollower(self.client, db="db", **self.kwarg_valid)
follower._set_defaults(_Mode.LISTEN, limit=12)
expected = {
"feed": PostChangesEnums.Feed.LONGPOLL,
"timeout": _LONGPOLL_TIMEOUT,
Expand All @@ -133,7 +154,7 @@ def test_set_defaults_with_limit(self):
def test_set_defaults_with_kwarg_limit(self):
kwarg = {**self.kwarg_valid, **{"limit": 24}}
follower = ChangesFollower(self.client, db="db", **kwarg)
follower._set_defaults(limit=12)
follower._set_defaults(_Mode.LISTEN, limit=12)
self.assertEqual(follower.options.get("limit"), 12)


Expand Down