hsync-common 1.0.2__tar.gz → 1.0.4__tar.gz

{hsync_common-1.0.2 → hsync_common-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hsync-common
-Version: 1.0.2
+Version: 1.0.4
 Summary: HSYNC Common - shared models, constants, and compression utilities
 License-Expression: BSD-3-Clause
 License-File: LICENSE

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/constants.py

@@ -18,7 +18,7 @@ from typing import Final, Literal
 # Single source of truth for the HSYNC application version, shared by client,
 # server, desktop and Android. The wire-protocol versions live separately in
 # hsync_common.protocol.handshake (PROTOCOL_VERSION_*).
-HSYNC_VERSION = "1.0.2"
+HSYNC_VERSION = "1.0.4"
 
 # =============================================================================
 # HTTP Headers (wire protocol)

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/bootnode.py

@@ -21,7 +21,7 @@ malformed fields without partially accepting them (the same strictness the
 bootnode's ``extra="forbid"`` models provide).
 
 Besides the advisory ``capacity`` hint, ``register`` and ``peers[]`` carry the
-**election advertisement** (``server_ready``/``force_master``/``never_master``/
+**election advertisement** (``server_ready``/``prefer_master``/``never_master``/
 ``startup_time``/``sync_direction``) — the same values the mDNS TXT record
 carries, relayed verbatim by the bootnode so both discovery plans feed the one
 shared election algorithm in :mod:`hsync_common.protocol.p2p`. The bootnode never
@@ -192,7 +192,7 @@ class BootRegister(TypedDict):
     (``0`` = not a seeder). The bootnode relays it in ``query`` responses; the
     authoritative value is the authenticated ``serve_slots`` (ADR-0030).
 
-    ``server_ready``/``force_master``/``never_master``/``startup_time``/
+    ``server_ready``/``prefer_master``/``never_master``/``startup_time``/
     ``sync_direction`` are the **election advertisement**, the same values the
     mDNS TXT record carries. The bootnode relays them verbatim in ``query``
     responses so a bootnode-discovered peer ranks exactly like an mDNS one; it
@@ -214,7 +214,7 @@ class BootRegister(TypedDict):
     bucket_token: NotRequired[str]
     connected: NotRequired[int]
     server_ready: NotRequired[bool]
-    force_master: NotRequired[bool]
+    prefer_master: NotRequired[bool]
     never_master: NotRequired[bool]
     startup_time: NotRequired[float]
     sync_direction: NotRequired[str]
@@ -279,7 +279,7 @@ class BootPeer(TypedDict):
 
     The election-advertisement fields are relayed verbatim from the peer's
     ``register`` (defaults when it advertised none): ``server_ready`` (it is
-    currently serving as master), ``force_master``/``never_master`` (operator
+    currently serving as master), ``prefer_master``/``never_master`` (operator
     pins), ``startup_time`` (unix seconds, ``0.0`` = unknown) and
     ``sync_direction``. They feed the shared election algorithm exactly like
     the mDNS TXT values; none of them is authenticated.
@@ -293,7 +293,7 @@ class BootPeer(TypedDict):
     capacity: int
     reachable: bool
     server_ready: bool
-    force_master: bool
+    prefer_master: bool
     never_master: bool
     startup_time: float
     sync_direction: str
@@ -326,7 +326,7 @@ _REGISTER_OPTIONAL = frozenset(
         "capacity",
         "endpoints",
         "server_ready",
-        "force_master",
+        "prefer_master",
         "never_master",
         "startup_time",
         "sync_direction",
@@ -352,7 +352,7 @@ _PEER_REQUIRED = frozenset(
         "capacity",
         "reachable",
         "server_ready",
-        "force_master",
+        "prefer_master",
         "never_master",
         "startup_time",
         "sync_direction",
@@ -480,7 +480,7 @@ def _read_election_advert(value: Mapping, clean: dict, *, optional: bool) -> boo
     ``peers[]`` side (every key is required, the bootnode always relays them).
     Returns False on any malformed value so the caller rejects the whole frame.
     """
-    for key in ("server_ready", "force_master", "never_master"):
+    for key in ("server_ready", "prefer_master", "never_master"):
         if key not in value:
             if optional:
                 clean[key] = False

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/events.py

@@ -114,6 +114,9 @@ class UiEventDict(TypedDict):
     conflict_copy: NotRequired[str]  # path of the preserved local copy (conflict_resolved)
     winner: NotRequired[str]  # which side won: "remote" (master) or "local"
     source_cid: NotRequired[str]  # verified peer source for a successful full-file transfer
+    reason: NotRequired[str]  # sync_paused: human-readable guard reason
+    deletes: NotRequired[int]  # sync_paused: deletions blocked this cycle
+    local: NotRequired[int]  # sync_paused: local files considered by the guard
     plan: NotRequired[str]  # discovery event: "mdns" | "mdns+bootnode"
     bootnode: NotRequired[str]  # discovery event: bootnode host (empty without one)
 

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/fixtures/bootnode-register.json

@@ -12,7 +12,7 @@
   ],
   "connected": 3,
   "server_ready": true,
-  "force_master": false,
+  "prefer_master": false,
   "never_master": false,
   "startup_time": 1760000000.0,
   "sync_direction": "bidirectional"

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/fixtures/bootnode-response.json

@@ -18,7 +18,7 @@
       "capacity": 20,
       "reachable": true,
       "server_ready": true,
-      "force_master": false,
+      "prefer_master": false,
       "never_master": false,
       "startup_time": 1760000000.0,
       "sync_direction": "bidirectional"

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/fixtures/p2p-election-scenarios.json

@@ -4,60 +4,60 @@
       "candidates": [
         {
           "cid": "local",
-          "force_master": true,
           "never_master": false,
+          "prefer_master": true,
           "server_ready": false,
           "startup_time": 10.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "incumbent",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": true,
           "startup_time": 200.0,
           "sync_direction": "bidirectional"
         }
       ],
       "expected_master": "incumbent",
-      "name": "incumbent-server-ready-wins-over-force-master"
+      "name": "incumbent-server-ready-wins-over-prefer-master"
     },
     {
       "candidates": [
         {
           "cid": "plain",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 50.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "forced",
-          "force_master": true,
           "never_master": false,
+          "prefer_master": true,
           "server_ready": false,
           "startup_time": 300.0,
           "sync_direction": "bidirectional"
         }
       ],
       "expected_master": "forced",
-      "name": "force-master-wins-over-plain-peer"
+      "name": "prefer-master-wins-over-plain-peer"
     },
     {
       "candidates": [
         {
           "cid": "aaa",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "upload-only"
         },
         {
           "cid": "bbb",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
@@ -70,16 +70,16 @@
       "candidates": [
         {
           "cid": "late",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 200.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "early",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
@@ -92,16 +92,16 @@
       "candidates": [
         {
           "cid": "zzz",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "aaa",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
@@ -114,16 +114,16 @@
       "candidates": [
         {
           "cid": "early",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "later",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 200.0,
           "sync_direction": "bidirectional"
@@ -136,16 +136,16 @@
       "candidates": [
         {
           "cid": "never",
-          "force_master": false,
           "never_master": true,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "eligible",
-          "force_master": false,
           "never_master": false,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 200.0,
           "sync_direction": "bidirectional"
@@ -158,16 +158,16 @@
       "candidates": [
         {
           "cid": "a",
-          "force_master": false,
           "never_master": true,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 100.0,
           "sync_direction": "bidirectional"
         },
         {
           "cid": "b",
-          "force_master": false,
           "never_master": true,
+          "prefer_master": false,
           "server_ready": false,
           "startup_time": 200.0,
           "sync_direction": "bidirectional"

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/fixtures.py

@@ -206,17 +206,17 @@ def _p2p_inventory_delta_delete() -> dict[str, Any]:
 # Android parity test replay these exact inputs and must reach the same outcome.
 _ELECTION_SCENARIOS: tuple[tuple[str, tuple[ElectionCandidate, ...]], ...] = (
     (
-        "incumbent-server-ready-wins-over-force-master",
+        "incumbent-server-ready-wins-over-prefer-master",
         (
-            ElectionCandidate(cid="local", force_master=True, startup_time=10.0),
+            ElectionCandidate(cid="local", prefer_master=True, startup_time=10.0),
             ElectionCandidate(cid="incumbent", startup_time=200.0, server_ready=True),
         ),
     ),
     (
-        "force-master-wins-over-plain-peer",
+        "prefer-master-wins-over-plain-peer",
         (
             ElectionCandidate(cid="plain", startup_time=50.0),
-            ElectionCandidate(cid="forced", force_master=True, startup_time=300.0),
+            ElectionCandidate(cid="forced", prefer_master=True, startup_time=300.0),
         ),
     ),
     (

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/p2p/txt-schema.json

@@ -31,12 +31,6 @@
       ],
       "type": "string"
     },
-    "force_master": {
-      "enum": [
-        "true"
-      ],
-      "type": "string"
-    },
     "group": {
       "type": "string"
     },
@@ -64,6 +58,12 @@
       ],
       "type": "string"
     },
+    "prefer_master": {
+      "enum": [
+        "true"
+      ],
+      "type": "string"
+    },
     "protocol": {
       "const": "p2p/1"
     },

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/p2p.py

@@ -14,7 +14,7 @@ Ordering (highest priority first):
 
 1. ``server_ready`` — an already-serving incumbent wins, so a newcomer never
    triggers a takeover/split-brain for the same bucket.
-2. ``force_master`` — an operator-pinned master wins over ordinary peers.
+2. ``prefer_master`` — an operator-preferred master wins over ordinary peers.
 3. bidirectional ``sync_direction`` — a fully bidirectional peer is preferred
    over an upload-only/download-only one (it can serve every other peer).
 4. earliest ``startup_time`` — the node that started first wins.
@@ -79,7 +79,7 @@ class ElectionCandidate:
     """
 
     cid: str
-    force_master: bool = False
+    prefer_master: bool = False
     startup_time: float = 0.0
     sync_direction: str = SYNC_DIRECTION_BIDIRECTIONAL
     server_ready: bool = False
@@ -94,7 +94,7 @@ def election_sort_key(candidate: ElectionCandidate) -> tuple[bool, bool, bool, f
     """
     return (
         not candidate.server_ready,
-        not candidate.force_master,
+        not candidate.prefer_master,
         candidate.sync_direction != SYNC_DIRECTION_BIDIRECTIONAL,
         candidate.startup_time,
         candidate.cid,
@@ -108,7 +108,7 @@ def rank_election_candidates(
 
     ``never_master`` nodes are filtered out first. Callers that need more than
     the winner (e.g. the client's pre-computed successor, or the ranked
-    ``force_master`` subset for conflict reporting) must use this function so
+    ``prefer_master`` subset for conflict reporting) must use this function so
     the ranking itself lives only here; :func:`elect_master` is its
     winner-only projection.
     """

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/rest/openapi.json

@@ -386,7 +386,7 @@
   },
   "info": {
     "title": "HSYNC - HTTP Sync file server",
-    "version": "1.0.2"
+    "version": "1.0.4"
   },
   "openapi": "3.1.0",
   "paths": {

{hsync_common-1.0.2 → hsync_common-1.0.4}/hsync_common/protocol/schemas.py

@@ -74,7 +74,7 @@ P2P_TXT_OPTIONAL_KEYS: tuple[str, ...] = (
     "compression",
     "delta",
     "server_ready",
-    "force_master",
+    "prefer_master",
     "never_master",
     "connected",
     "heartbeat",
@@ -770,7 +770,7 @@ def build_p2p_txt_schema() -> dict[str, Any]:
         "compression": _TXT_BOOL_FLAG,
         "delta": _TXT_BOOL_FLAG,
         "server_ready": _TXT_BOOL_FLAG,
-        "force_master": _TXT_BOOL_FLAG,
+        "prefer_master": _TXT_BOOL_FLAG,
         "never_master": _TXT_BOOL_FLAG,
         "peer_download": {
             **_TXT_BOOL_FLAG,

{hsync_common-1.0.2 → hsync_common-1.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hsync-common"
-version = "1.0.2"
+version = "1.0.4"
 description = "HSYNC Common - shared models, constants, and compression utilities"
 authors = [{name = "Alberto Basso", email = "17047798+albertsdk@users.noreply.github.com"}]
 license = "BSD-3-Clause"
@@ -43,7 +43,7 @@ packages = [{include = "hsync_common"}]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^9.1.1"
-ruff = "0.16.10"
+ruff = "0.17.0"
 pre-commit = "^4.6.2"
 pytest-cov = "^7.1.0"