Skip to content
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.

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

Fix the issue of ignoring callback calls for removed keys. #2

Closed
wants to merge 1 commit into from

Conversation

oleksandrivantsiv
Copy link
Owner

@oleksandrivantsiv oleksandrivantsiv commented May 29, 2023

What I did
Fix the issue of ignoring callback calls for removed keys.

Why I did it
ConfigDBConnector.listen method has a caching mechanism (added in sonic-net#587 PR) that preloads the DB state before starting. When the notification about the changed key is received the listen method gets key data from the DB (in all cases when the key was added, updated, or removed) and compares the data with the cache. It fires the callback only if data differ from the cache. Otherwise, the callback is ignored.

If the client.hgetall(key) is called for the removed key it returns an empty dictionary ({}). This can be confused with the data of the key with no attributes. For example: {"TABLE": {"KEY": {}}}.

So if preloaded data contains a key with no attributes and the listener method receives a notification about the removal of such key the callback is not called. The listener will simply remove the key from the cache without calling the callback. This leads to the situation when the removal of the key is not handled.

The solution is to get data for the added or updated keys, and for the removed keys use None instead. This will ensure that the comparison with the cache will work as expected.

How I verified it
Compile the package and run the unit test. Unit tests are extended to cover the expected behavior.

Details if related

@oleksandrivantsiv oleksandrivantsiv changed the title Do not try to get data for deleted keys. Fix the issue with ignoring callbacks calls for removed keys. May 29, 2023
@oleksandrivantsiv oleksandrivantsiv changed the title Fix the issue with ignoring callbacks calls for removed keys. Fix the issue with ignoring callback calls for removed keys. May 29, 2023
@oleksandrivantsiv oleksandrivantsiv changed the title Fix the issue with ignoring callback calls for removed keys. Fix the issue of ignoring callback calls for removed keys. May 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants