Skip to content

client: config: expose try_from_* methods#457

Draft
kp-antonio-yang wants to merge 12 commits into
mainfrom
feat/client-substrate
Draft

client: config: expose try_from_* methods#457
kp-antonio-yang wants to merge 12 commits into
mainfrom
feat/client-substrate

Conversation

@kp-antonio-yang

@kp-antonio-yang kp-antonio-yang commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Description

  • add validation on sndbuf, rcvbuf wintun device guid, pmtud, wintun ring capacity
  • add try_from_reload_sig_and_config of ClientConfig
  • add try_from_event_handler_and_connection_config of ClientConnectionConfig
  • simplify server dn

Motivation and Context

Provide reusable methods, including validations and casting for Config and ConnectionConfig, such that these method can easier to reused by any downstream projects.

How Has This Been Tested?

  • testcases for new validation functions

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • The correct base branch is being used, if not main

@kp-antonio-yang kp-antonio-yang force-pushed the feat/client-substrate branch from eb37bbe to 85c745e Compare June 19, 2026 08:37
@kp-antonio-yang
client: config: expose Config, ConnectionConfig as substrate
f0f3440 
In order to ease integration from downstream, `Config` and `ConnectionConfig `
of client are exposed as substrate.
@kp-antonio-yang
client: config: add validate method
e6716ac 
Define a validation method of the client configuration.
@kp-antonio-yang kp-antonio-yang force-pushed the feat/client-substrate branch from 85c745e to 9faed56 Compare June 19, 2026 08:41
@github-actions

github-actions Bot commented Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Code coverage summary for b34decd:

Filename                                                          Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
lightway-app-utils/src/args/cipher.rs                                   5                 5     0.00%           1                 1     0.00%           5                 5     0.00%           0                 0         -
lightway-app-utils/src/args/connection_type.rs                          8                 5    37.50%           2                 1    50.00%           8                 5    37.50%           0                 0         -
lightway-app-utils/src/args/duration.rs                               121                22    81.82%          11                 5    54.55%          64                15    76.56%           0                 0         -
lightway-app-utils/src/args/ip_map.rs                                  27                27     0.00%           5                 5     0.00%          19                19     0.00%           0                 0         -
lightway-app-utils/src/args/keyshare.rs                                 5                 5     0.00%           1                 1     0.00%           5                 5     0.00%           0                 0         -
lightway-app-utils/src/args/logging.rs                                 37                37     0.00%           3                 3     0.00%          31                31     0.00%           0                 0         -
lightway-app-utils/src/args/nonzero_duration.rs                       128                24    81.25%          10                 4    60.00%          68                16    76.47%           0                 0         -
lightway-app-utils/src/connection_ticker.rs                           229                17    92.58%          28                 4    85.71%         126                15    88.10%           0                 0         -
lightway-app-utils/src/dplpmtud_timer.rs                              209                13    93.78%          22                 4    81.82%         117                11    90.60%           0                 0         -
lightway-app-utils/src/event_stream.rs                                 19                 0   100.00%           3                 0   100.00%          11                 0   100.00%           0                 0         -
lightway-app-utils/src/metrics.rs                                       4                 4     0.00%           2                 2     0.00%           4                 4     0.00%           0                 0         -
lightway-app-utils/src/network_change_monitor.rs                       72                72     0.00%           6                 6     0.00%          49                49     0.00%           0                 0         -
lightway-app-utils/src/packet_codec.rs                                  2                 2     0.00%           1                 1     0.00%           1                 1     0.00%           0                 0         -
lightway-app-utils/src/sockopt/ip_mtu_discover.rs                      81                81     0.00%           6                 6     0.00%          72                72     0.00%           0                 0         -
lightway-app-utils/src/sockopt/ip_pktinfo.rs                           14                 1    92.86%           1                 0   100.00%          16                 1    93.75%           0                 0         -
lightway-app-utils/src/tun.rs                                         366               366     0.00%          36                36     0.00%         231               231     0.00%           0                 0         -
lightway-app-utils/src/utils.rs                                        21                21     0.00%           1                 1     0.00%          11                11     0.00%           0                 0         -
lightway-client/src/config.rs                                         342                99    71.05%          19                 7    63.16%         239                63    73.64%           0                 0         -
lightway-client/src/dns_manager.rs                                     18                18     0.00%           4                 4     0.00%          16                16     0.00%           0                 0         -
lightway-client/src/io/inside/tun.rs                                   82                82     0.00%          12                12     0.00%          60                60     0.00%           0                 0         -
lightway-client/src/io/outside.rs                                      14                14     0.00%           2                 2     0.00%          12                12     0.00%           0                 0         -
lightway-client/src/io/outside/tcp.rs                                  92                92     0.00%          13                13     0.00%          59                59     0.00%           0                 0         -
lightway-client/src/io/outside/udp.rs                                 170               170     0.00%          18                18     0.00%         111               111     0.00%           0                 0         -
lightway-client/src/io/outside/udp/batch_receive.rs                    99                13    86.87%          11                 1    90.91%          84                13    84.52%           0                 0         -
lightway-client/src/keepalive.rs                                      615                44    92.85%          55                 6    89.09%         330                25    92.42%           0                 0         -
lightway-client/src/lib.rs                                           1352               776    42.60%         107                58    45.79%         938               592    36.89%           0                 0         -
lightway-client/src/main.rs                                           277               277     0.00%          17                17     0.00%         157               157     0.00%           0                 0         -
lightway-client/src/platform/linux/dns_manager.rs                     118                91    22.88%          14                 9    35.71%          87                62    28.74%           0                 0         -
lightway-client/src/platform/linux/dns_manager/direct_file.rs         106                42    60.38%          12                 6    50.00%          65                29    55.38%           0                 0         -
lightway-client/src/platform/linux/dns_manager/resolvconf.rs           61                61     0.00%           8                 8     0.00%          52                52     0.00%           0                 0         -
lightway-client/src/platform/linux/dns_manager/resolvectl.rs           41                41     0.00%           5                 5     0.00%          34                34     0.00%           0                 0         -
lightway-client/src/route_manager.rs                                 1148               166    85.54%          75                 6    92.00%         636                84    86.79%           0                 0         -
lightway-core/src/borrowed_bytesmut.rs                                373                 0   100.00%          24                 0   100.00%         185                 0   100.00%           0                 0         -
lightway-core/src/builder_predicates.rs                                24                12    50.00%           4                 2    50.00%          24                12    50.00%           0                 0         -
lightway-core/src/cipher.rs                                            13                 0   100.00%           2                 0   100.00%          10                 0   100.00%           0                 0         -
lightway-core/src/connection.rs                                      1795               958    46.63%          74                29    60.81%        1276               655    48.67%           0                 0         -
lightway-core/src/connection/builders.rs                              252                46    81.75%          22                 8    63.64%         260                53    79.62%           0                 0         -
lightway-core/src/connection/dplpmtud.rs                             1741                81    95.35%          63                 0   100.00%         830                 7    99.16%           0                 0         -
lightway-core/src/connection/expresslane.rs                            27                11    59.26%           4                 1    75.00%          36                 7    80.56%           0                 0         -
lightway-core/src/connection/fragment_map.rs                          366                 6    98.36%          25                 0   100.00%         254                 3    98.82%           0                 0         -
lightway-core/src/connection/io_adapter.rs                            877               149    83.01%          55                 8    85.45%         467                95    79.66%           0                 0         -
lightway-core/src/connection/key_update.rs                             34                13    61.76%           5                 0   100.00%          38                19    50.00%           0                 0         -
lightway-core/src/context.rs                                          214                51    76.17%          28                11    60.71%         235                64    72.77%           0                 0         -
lightway-core/src/context/ip_pool.rs                                    8                 3    62.50%           1                 0   100.00%           5                 0   100.00%           0                 0         -
lightway-core/src/context/server_auth.rs                               37                37     0.00%           4                 4     0.00%          26                26     0.00%           0                 0         -
lightway-core/src/encoding_request_states.rs                            3                 0   100.00%           1                 0   100.00%           3                 0   100.00%           0                 0         -
lightway-core/src/gso.rs                                              900               143    84.11%          29                 6    79.31%         424                92    78.30%           0                 0         -
lightway-core/src/io.rs                                                10                10     0.00%           3                 3     0.00%           9                 9     0.00%           0                 0         -
lightway-core/src/keyshare.rs                                           5                 0   100.00%           1                 0   100.00%           5                 0   100.00%           0                 0         -
lightway-core/src/lib.rs                                                9                 0   100.00%           3                 0   100.00%           9                 0   100.00%           0                 0         -
lightway-core/src/metrics.rs                                           81                71    12.35%          33                29    12.12%          73                63    13.70%           0                 0         -
lightway-core/src/packet.rs                                            38                10    73.68%           4                 1    75.00%          30                 6    80.00%           0                 0         -
lightway-core/src/plugin.rs                                           307                17    94.46%          22                 4    81.82%         148                10    93.24%           0                 0         -
lightway-core/src/tls/mod.rs                                            4                 4     0.00%           1                 1     0.00%           3                 3     0.00%           0                 0         -
lightway-core/src/utils.rs                                            334                26    92.22%          22                 2    90.91%         165                17    89.70%           0                 0         -
lightway-core/src/version.rs                                           93                 0   100.00%          17                 0   100.00%          82                 0   100.00%           0                 0         -
lightway-core/src/wire.rs                                             438                42    90.41%          29                 1    96.55%         235                12    94.89%           0                 0         -
lightway-core/src/wire/auth_failure.rs                                 27                 1    96.30%           3                 0   100.00%          17                 0   100.00%           0                 0         -
lightway-core/src/wire/auth_request.rs                                684                57    91.67%          34                 1    97.06%         351                24    93.16%           0                 0         -
lightway-core/src/wire/auth_success_with_config_ipv4.rs               222                 3    98.65%          11                 0   100.00%         124                 0   100.00%           0                 0         -
lightway-core/src/wire/data.rs                                         51                 1    98.04%           5                 0   100.00%          33                 0   100.00%           0                 0         -
lightway-core/src/wire/data_frag.rs                                   127                 1    99.21%          14                 0   100.00%          80                 0   100.00%           0                 0         -
lightway-core/src/wire/encoding_request.rs                             82                 2    97.56%           6                 0   100.00%          42                 1    97.62%           0                 0         -
lightway-core/src/wire/encoding_response.rs                            82                 2    97.56%           6                 0   100.00%          42                 1    97.62%           0                 0         -
lightway-core/src/wire/expresslane_config.rs                          192                 1    99.48%          10                 0   100.00%         110                 0   100.00%           0                 0         -
lightway-core/src/wire/expresslane_data.rs                           1330                69    94.81%          48                 5    89.58%         679                37    94.55%           0                 0         -
lightway-core/src/wire/ping.rs                                         95                 2    97.89%           7                 0   100.00%          59                 0   100.00%           0                 0         -
lightway-core/src/wire/pong.rs                                        109                 2    98.17%           8                 0   100.00%          72                 0   100.00%           0                 0         -
lightway-core/src/wire/server_config.rs                                69                 2    97.10%           4                 0   100.00%          37                 0   100.00%           0                 0         -
lightway-server/src/auth.rs                                           273                49    82.05%          22                 6    72.73%         171                28    83.63%           0                 0         -
lightway-server/src/config.rs                                          26                26     0.00%           1                 1     0.00%          46                46     0.00%           0                 0         -
lightway-server/src/connection.rs                                     137               137     0.00%          11                11     0.00%         110               110     0.00%           0                 0         -
lightway-server/src/connection_manager.rs                             339               339     0.00%          40                40     0.00%         294               294     0.00%           0                 0         -
lightway-server/src/connection_manager/connection_map.rs              407                20    95.09%          21                 1    95.24%         228                 8    96.49%           0                 0         -
lightway-server/src/io/inside/tun.rs                                   46                46     0.00%          10                10     0.00%          32                32     0.00%           0                 0         -
lightway-server/src/io/outside/tcp.rs                                  93                93     0.00%          10                10     0.00%          68                68     0.00%           0                 0         -
lightway-server/src/io/outside/udp.rs                                 458               458     0.00%          25                25     0.00%         317               317     0.00%           0                 0         -
lightway-server/src/io/outside/udp/batch_receive.rs                   467                19    95.93%          20                 1    95.00%         265                15    94.34%           0                 0         -
lightway-server/src/io/outside/udp/cmsg.rs                            208                48    76.92%          16                 3    81.25%         171                43    74.85%           0                 0         -
lightway-server/src/ip_manager.rs                                     542                50    90.77%          22                 4    81.82%         242                23    90.50%           0                 0         -
lightway-server/src/ip_manager/ip_pool.rs                             545                 0   100.00%          28                 0   100.00%         257                 0   100.00%           0                 0         -
lightway-server/src/lib.rs                                            375               375     0.00%          18                18     0.00%         251               251     0.00%           0                 0         -
lightway-server/src/main.rs                                           248               248     0.00%          10                10     0.00%         131               131     0.00%           0                 0         -
lightway-server/src/metrics.rs                                        254               250     1.57%          85                83     2.35%         215               211     1.86%           0                 0         -
lightway-server/src/statistics.rs                                     132                59    55.30%           8                 4    50.00%          90                39    56.67%           0                 0         -
uniffi-bindgen/src/uniffi-bindgen.rs                                    3                 3     0.00%           1                 1     0.00%           3                 3     0.00%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                               21489              6741    68.63%        1491               596    60.03%       13087              4695    64.12%           0                 0         -

✅ Region coverage 68% passes
✅ Line coverage 64% passes

@kp-antonio-yang kp-antonio-yang force-pushed the feat/client-substrate branch from 8d437ba to e6cd3be Compare June 19, 2026 09:23
@kp-antonio-yang kp-antonio-yang changed the title Feat/client substrate client: config: expose try_from_* methods Jun 19, 2026
@kp-antonio-yang
client: config: validate sndbuf
1daea5b 
Ensure sndbuf is valid and raise an error based on the target if this
isn't allowed to set using TCP.
@kp-antonio-yang kp-antonio-yang force-pushed the feat/client-substrate branch from e6cd3be to f9e84b7 Compare June 19, 2026 09:41
@kp-antonio-yang
fixup! client: config: validate sndbuf
cae520b
@kp-antonio-yang
client: config: validate rcvbuf
8438071 
Ensure rcvbuf is valid and raise an error based on the target if this
isn't allowed to set using TCP.
@kp-antonio-yang
client: config: validate wintun device guid
0ba9502 
Ensure device guild is valid.
@kp-antonio-yang
client: config: validate pmtud
530a35f 
Ensure pmtud only enabled with udp mode
@kp-antonio-yang
client: config: validate wintun_ring_capacity
c05048c 
Ensure wintun_ring_capacity setting is a power of two between 128KiB and 64MiB
@kp-antonio-yang
client: add try_from_reload_sig_and_config of ClientConfig
a0ddb84 
Downstream implementing can easier to resue method of ClientConfig.
@kp-antonio-yang
client: add try_from_event_handler_and_connection_config of ClientCon…
aa81734 
…nectionConfig

Downstream implementing can easier to resue method of ClientConnectionConfig.
@kp-antonio-yang
client: config: use String for server_dn
33edf6f 
Use String type for server_dn, and emtpy string for none setting
@kp-antonio-yang
ci: run-tcp-single-threaded-test without pmtud
c08444b 
pmtud is not supported with tcp, remove `--enable-pmtud` to avoid error.
@kp-antonio-yang kp-antonio-yang force-pushed the feat/client-substrate branch from f9e84b7 to c08444b Compare June 19, 2026 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@kp-antonio-yang