feat(network): divide compression algorithm support in three categories #150

nerodono · 2025-01-16T13:24:01Z

This PR introduces more flexibility in compression algorithm selection by dividing "support" in three categories:

supported - the algorithm can be used to communicate with the node
preferred - the algorithm should be selected to communicate with the node
disabled - the algorithm is not supported

Two nodes decide on the algorithm as follows:

If they both have preferred algorithms in common - select in [hard-coded] preference order
If first node prefers something that is supported by the second node - the algorithm is selected in the [hard-coded] preference order
Otherwise, no compression would be used

First of all, this algorithm implies there's node which "leads" in choice of algorithm ("first node"), in the current implementation, lead node is node that accepts the connection.

BREAKING CHANGES: compression algorithms in config expressed now as follows:

algorithms.lz4 = { preference = "Preferred" }
algorithms.zstd = { preference = "Disabled" }

elfo-network/src/socket/mod.rs

…ies: supported, preferred and disabled BREAKING CHANGES: Compression in algorithm configuration format is changed as follows: ```toml algorithms = { lz4 = "preferred" } ```

elfo-network/src/socket/mod.rs

elfo-network/src/config.rs

elfo-network/src/socket/mod.rs

elfo-network/src/config.rs

elfo-network/src/socket/handshake.rs

elfo-network/src/config.rs

elfo-network/src/socket/mod.rs

elfo-network/src/discovery/mod.rs

loyd · 2025-01-19T09:28:31Z

elfo-network/src/config.rs

    #[serde(default)]
-    pub algorithm: CompressionAlgorithm,
+    pub algorithms: CompressionPreference,


This is a breaking change (which is ok because we have alpha versions), but, in this case, I think we can revise it even more and use system.network.compression.lz4 = "Preferred". If other settings (e.g. compression level) will be available to configure in the future, it will support the second per-codec form system.network.compression.zstd = { preference = "Preferred", level = 6 } in a backward-compatible way. I don't see what common options can be added next to algorithms to have this additional nesting level.

Still "algorithms"

gonna fix on my own

…modules, get rid of `CompressionAlgorithm` type

…ence`, add `Disabled` option in it and make algorithms config more backward compatible

…iflow

loyd · 2025-01-27T06:46:02Z

elfo-network/src/socket/capabilities/compression.rs

+        Self(joined)
+    }
+
+    pub(crate) fn toggle(&mut self, algos: Algorithms, pref: Preference) {


Actually, It's not a "toggle", because this code does not work as expected for toggle(Preferred); toggle(Disabled) sequence.

loyd · 2025-01-27T06:52:01Z

First of all, this algorithm implies there's node which "leads" in choice of algorithm ("first node"), in the current implementation, lead node is node that accepts the connection.

What does it mean? Both peers perform the same intersection process.

nerodono force-pushed the feat/compression-preferences-in-network branch 2 times, most recently from 6b4872d to b05947d Compare January 16, 2025 13:29

nerodono commented Jan 16, 2025

View reviewed changes

elfo-network/src/socket/mod.rs Outdated Show resolved Hide resolved

nerodono force-pushed the feat/compression-preferences-in-network branch 2 times, most recently from ec329d1 to f91660f Compare January 16, 2025 13:51

loyd requested review from laplab and loyd January 16, 2025 13:51

nerodono force-pushed the feat/compression-preferences-in-network branch from f91660f to 575b557 Compare January 16, 2025 15:10

feat(network)!: divide compression algorithm support in three categor…

bd294b5

…ies: supported, preferred and disabled BREAKING CHANGES: Compression in algorithm configuration format is changed as follows: ```toml algorithms = { lz4 = "preferred" } ```

nerodono force-pushed the feat/compression-preferences-in-network branch from 575b557 to bd294b5 Compare January 16, 2025 20:43

nerodono commented Jan 17, 2025

View reviewed changes

elfo-network/src/socket/mod.rs Outdated Show resolved Hide resolved

loyd requested changes Jan 19, 2025

View reviewed changes