moat-kv 0.70.19__tar.gz → 0.70.22__tar.gz

{moat-kv-0.70.19 → moat_kv-0.70.22}/.gitmodules

@@ -19,3 +19,6 @@
 [submodule "ext/wago"]
 	path = ext/wago
 	url = git://git.smurf.noris.de/moat-kv-wago.git
+[submodule "ext/cal"]
+	path = ext/cal
+	url = git://git.smurf.noris.de/moat-kv-cal.git

{moat-kv-0.70.19 → moat_kv-0.70.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moat-kv
-Version: 0.70.19
+Version: 0.70.22
 Summary: A distributed no-master key-value store
 Author-email: Matthias Urlichs <matthias@urlichs.de>
 Project-URL: homepage, https://m-o-a-t.org
@@ -21,10 +21,28 @@ Classifier: Topic :: Home Automation
 Classifier: Topic :: System :: Distributed Computing
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
-Provides-Extra: dev
 License-File: LICENSE
 License-File: LICENSE.APACHE2
 License-File: LICENSE.MIT
+Requires-Dist: asyncclick>7.99
+Requires-Dist: trio>=0.22
+Requires-Dist: anyio>=4
+Requires-Dist: range_set>=0.2
+Requires-Dist: attrs>=22
+Requires-Dist: asyncserf>=0.16
+Requires-Dist: asyncactor>=0.24
+Requires-Dist: asyncscope>=0.10.4
+Requires-Dist: jsonschema>=2.5
+Requires-Dist: ruyaml>=0.89
+Requires-Dist: PyNaCl>=1.3
+Requires-Dist: moat-lib-diffiehellman~=0.13.1.6
+Requires-Dist: psutil
+Requires-Dist: simpleeval>=0.9.10
+Requires-Dist: moat-mqtt~=0.39.4
+Requires-Dist: moat-util>=0.51.3
+Requires-Dist: exceptiongroup; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: moat-src>=0.5.0; extra == "dev"
 
 =======
 MoaT-KV

moat_kv-0.70.22/docs/source/v3.rst

@@ -0,0 +1,168 @@
+=================
+MoaT-KV Version 3
+=================
+
++++++++++
+Rationale
++++++++++
+
+The V2 servers worked, for the most part, but they had a couple of problems.
+
+* sometimes there are strange deadlocks
+
+* msgpack isn't that widely supported compared to CBOR
+
+* the initial client/server negotiation isn't versioned
+
+* the sync protocol is somewhat overengineered
+
+* speed of updates is limited by the client>server>MQTT>server>client
+  chain; two possibly-high-load servers in between cause too much delay
+
+* Messages tended to be more verbose than necessary
+
+++++++++++++++++++
+V3 design overview
+++++++++++++++++++
+
+Server start
+++++++++++++
+
+* connect to MQTT, listen to all MoaT messages,
+  update internal state as messages come in
+
+* ask for a server link on the Join/Actor topic
+
+* load the local backup if present
+
+* fetch full tree from designated server is replied
+
+* merge data
+
+* Join actor topic
+
+
+Client connection setup A
++++++++++++++++++++++++++
+
+* Client connects to MQTT and sends Query message
+* Designated server replies with connection data
+* Client connects to server
+
+* Server greets client
+* Client authenticates
+* Server sends MQTT connection information
+* Client connects to MQTT and sends Birth message
+* Server sees the client's message and sends ACK to the client
+
+Client connection setup B
++++++++++++++++++++++++++
+
+This method is slower; it can be used when the configured server doesn't work.
+
+* Client connects to MQTT and sends Query message
+* Designated server sends connection data
+
+Reading initial data
+++++++++++++++++++++
+
+* Client subscribes to MQTT topic
+* Client requests initial data from server
+* Server sends data, advises client that no data exist, or tells the client
+  that MQTT uses retaining (if so, which codec to use)
+
+Updates
++++++++
+
+The most notable pain point of the old design is the speed of updates.
+Thus in V3 all updates will be MQTT messages.
+
+This section does not apply if the MQTT server retains the data.
+
+MoaT update messages are CBOR maps. Keys are small integers for message brevity and
+decode speed.
+
+* 0: tock
+
+  The system-wide update counter. May be missing.
+
+* 1: value
+
+  Contents: Whatever is CBOR-encodeable. A missing value means that the
+  object shall be deleted.
+
+* 2: tick.
+
+  Update tracker. This is a ``((name, seq, counter), …)`` list of tuples.
+
+  * name
+    The server's name
+
+  * seq
+    Client connection. Zero is reserved for server-generated content.
+
+  * counter
+    A per-client update counter, managed by the client. Must start at 1 and
+    increment in steps of 1, in order to detect skipped updates.
+
+
+The server sees the update and sends an ACK message to the client, assuming
+that there was no conflict.
+
+
+Skipped updates
++++++++++++++++
+
+Servers listen to all messages. If there's a gap in a client's sequence
+numbers, the server will ask it to repeat the message.
+
+
+Update conflict resolution
+++++++++++++++++++++++++++
+
+If a client sends a message which the server determines
+
+
+MQTT topics
++++++++++++
+
+All are under a common configured prefix, the default is "moat/main".
+
+svc/act
+-------
+
+The Actor topic for server identification.
+
+The transmitted value contains the server's name, host and port.
+
+
+svc/query
+---------
+
+Connect requests from clients.
+
+svc/server
+----------
+
+Reply queue for messages to ``svc/query``. Contains the server value as
+above.
+
+
+d/*
+---
+
+Update messages.
+
+Topic translation
++++++++++++++++++
+
+Topics are encoded like MoaT paths, except for these differences:
+
+* The path separator is ``/``  instead of ``.``
+* Slashes are escaped as ``:_``.
+* Spaces in paths are never escaped: that would collide with the previous rule
+* Dots are not escaped, obviously.
+* `None` is encoded as "$NULL" when it's a top-level element.
+* The sequence ``:.`` is used to shield both wildcards and strings with a
+  leading ``$`` character. It translates back to an empty string, not a
+  dot, and may be treated as an illegal sequence otherwise.

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat/kv/client.py

@@ -246,7 +246,7 @@ class StreamedRequest:
     async def __anext__(self):
         try:
             res = await self.qr.get()
-        except (anyio.EndOfStream, anyio.ClosedResourceError):
+        except (anyio.EndOfStream, anyio.ClosedResourceError, EOFError):
             raise StopAsyncIteration
         except CancelledError:
             raise StopAsyncIteration  # just terminate
@@ -274,7 +274,7 @@ class StreamedRequest:
     async def cancel(self):
         try:
             await self.qr.put_error(CancelledError())
-        except (anyio.BrokenResourceError, anyio.ClosedResourceError):
+        except (anyio.BrokenResourceError, anyio.ClosedResourceError, EOFError):
             pass
         else:
             try:

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat/kv/command/job.py

@@ -70,7 +70,7 @@ async def at_cli(ctx, path):
 
     if ctx.invoked_subcommand is None:
         res = await obj.client.get(obj.path + path, nchain=obj.meta)
-        yprint(res if obj.meta else res.value, stream=obj.stdout)
+        yprint(res if obj.meta else res.value if 'value' in res else None, stream=obj.stdout)
 
 
 @cli.command("info")

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat/kv/runner.py

@@ -120,7 +120,6 @@ for _c in (
     CompleteState,
     ActorState,
     BrokenState,
-    NotGiven,
     TimerMsg,
     ReadyMsg,
     ChangeMsg,
@@ -130,6 +129,7 @@ for _c in (
 ):
     _CLASSES[_c.__name__] = _c
 
+_CLASSES["NotGiven"] = NotGiven  # ellipsis
 
 class CallAdmin:
     """

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat_kv.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moat-kv
-Version: 0.70.19
+Version: 0.70.22
 Summary: A distributed no-master key-value store
 Author-email: Matthias Urlichs <matthias@urlichs.de>
 Project-URL: homepage, https://m-o-a-t.org
@@ -21,10 +21,28 @@ Classifier: Topic :: Home Automation
 Classifier: Topic :: System :: Distributed Computing
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
-Provides-Extra: dev
 License-File: LICENSE
 License-File: LICENSE.APACHE2
 License-File: LICENSE.MIT
+Requires-Dist: asyncclick>7.99
+Requires-Dist: trio>=0.22
+Requires-Dist: anyio>=4
+Requires-Dist: range_set>=0.2
+Requires-Dist: attrs>=22
+Requires-Dist: asyncserf>=0.16
+Requires-Dist: asyncactor>=0.24
+Requires-Dist: asyncscope>=0.10.4
+Requires-Dist: jsonschema>=2.5
+Requires-Dist: ruyaml>=0.89
+Requires-Dist: PyNaCl>=1.3
+Requires-Dist: moat-lib-diffiehellman~=0.13.1.6
+Requires-Dist: psutil
+Requires-Dist: simpleeval>=0.9.10
+Requires-Dist: moat-mqtt~=0.39.4
+Requires-Dist: moat-util>=0.51.3
+Requires-Dist: exceptiongroup; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: moat-src>=0.5.0; extra == "dev"
 
 =======
 MoaT-KV

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat_kv.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ docs/source/server_protocol.rst
 docs/source/startup.rst
 docs/source/translator.rst
 docs/source/tutorial.rst
+docs/source/v3.rst
 docs/source/_static/.gitkeep
 examples/pathify.py
 examples/code/transform.scale.yml

{moat-kv-0.70.19 → moat_kv-0.70.22}/moat_kv.egg-info/requires.txt

@@ -8,7 +8,7 @@ attrs>=22
 jsonschema>=2.5
 moat-lib-diffiehellman~=0.13.1.6
 moat-mqtt~=0.39.4
-moat-util~=0.35.0
+moat-util>=0.51.3
 psutil
 range_set>=0.2
 ruyaml>=0.89

{moat-kv-0.70.19 → moat_kv-0.70.22}/pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
 	"psutil",
 	"simpleeval >= 0.9.10",                                            
 	"moat-mqtt ~= 0.39.4",
-	"moat-util ~= 0.35.0",
+	"moat-util >= 0.51.3",
 	"exceptiongroup; python_version<'3.11'",
 ]
 dynamic = [ "version",]

{moat-kv-0.70.19 → moat_kv-0.70.22}/tests/test_feature_error.py

@@ -45,6 +45,7 @@ async def test_81_basic(autojump_clock):  # pylint: disable=unused-argument
 @pytest.mark.trio
 @pytest.mark.xfail
 async def test_82_many(autojump_clock):  # pylint: disable=unused-argument
+    pytest.skip("broken")
     async with stdtest(args={"init": 123}, tocks=80) as st:
         assert st is not None
         async with st.client() as cx, st.client() as cy, st.client() as cz: