Skip to content

graysonhyc/lww_elements_set_py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LWW Elements Set - Python

A Last-Writer-Wins (LWW) Element set data structure, an operation-based Conflict-Free Replicated Data Type (CDRT) was implemented in Python. A test suite was also included to test various CDRT properties, i.e., communtativity, associativity and idempotence.

Operations

The conceptual idea is referenced from this wiki page.

Operations on CRDTs need to adhere to the following rules:

  • Associativity (a+(b+c)=(a+b)+c), so that grouping doesn't matter.
  • Commutativity (a+b=b+a), so that order of application doesn't matter.
  • Idempotence (a+a=a), so that duplication doesn't matter.

To determine if an element exists in the LWW element set, the following rules are applied:

  • Exists if the element is present in the add set but not in the remove set (trivial)
  • Does not exist if the element is present in the remove set but not in the add set (trivial)
  • Exists if the element's most recent operation is an "add"
  • Does not exist if the element's most recent operation is a "remove"
  • If the timestamp of add and remove are the same, it is biased towards "add"

This implementation provides the following APIs (check the code for more details):

  • add(element, timestamp) : Add an element with the timestamp to the add set
  • remove(element, timestamp) : Add an element with the timestamp to the remove set
  • contains(element) : Check if an element exists in the LWW element set using the rules above
  • get_all() : Return all existing elements in the LWW element set

Testing

Test for Idempotence

It is required that duplication or re-delivery of operations does not affect the final result. The following tests attempt to repeat the "add" / "remove" operations with different timestamps.

Original state Operation Resulting state Final result
A(a,1) R() add(a,0) A(a,1) R() ['a']
A(a,1) R() add(a,1) A(a,1) R() ['a']
A(a,1) R() add(a,2) A(a,2) R() ['a']
A() R(a,1) remove(a,0) A() R(a,1) [ ]
A() R(a,1) remove(a,1) A() R(a,1) [ ]
A() R(a,1) remove(a,2) A() R(a,2) [ ]

Test for Commutativity

It is required that the order of operations does not affect the final result. The following tests attempt to reverse the order of "add" and "remove" operations with different timestamps.

Original state Operation Resulting state Final result
A(a,1) R() remove(a,1) A(a,1) R(a,1) ['a']
A() R(a,1) add(a,1) A(a,1) R(a,1) ['a']
A(a,1) R() remove(a,0) A(a,1) R(a,0) ['a']
A() R(a,0) add(a,1) A(a,1) R(a,0) ['a']
A(a,1) R() remove(a,2) A(a,1) R(a,2) [ ]
A() R(a,2) add(a,1) A(a,1) R(a,2) [ ]

Test for Associativity

It is required that the grouping of operations does not affect the final result. The following tests attempt to group several operations with different timestamps.

Original state Operation Resulting state Final result
A(a,1; b,2) R() remove(b,3) A(a,1; b,2) R(b,3) ['a']
A(b,2) R(b,3) add(a,1) A(a,1; b,2) R(b,3) ['a']

In fact, proving full commutativity is sufficient for proving associativity, since grouping in this context refers to re-ordering certain operations. The resulting state is just a collection of all element operations.

Future Development

  • Garbage collection : elements should be removed from the sets from time to time when they are no longer useful. In fact, only the most-recent operation (add/remove) is needed.

References

About

CRDT Implementation in Python

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages