FergusMok opened a new pull request, #4304:
URL: https://github.com/apache/iggy/pull/4304

   ## Which issue does this PR address?
   
   <!--
   We generally require a GitHub issue for all bug fixes and enhancements. Link 
it with GitHub syntax, keep the line that applies and delete the other:
   - `Closes #123` auto-closes the issue when this PR merges (full fix).
   - `Relates to #123` links without closing (partial or related work).
   -->
   
   Closes #4210
   
   ## Rationale
   
   Currently the different transport protocols (TCP QUIC and Websocket) use 
different keys to refer to the same thing.
   Standardize the configuration connection keys between them.
   
   | Option | Current TCP key | Current QUIC key | Current WebSocket key | 
Post-Standardization key |
   |---|---|---|---|---|
   | Reconnection attempts | `reconnection_retries` | 
`reconnection_max_retries` | `reconnection_retries` | 
`reconnection_max_retries` |
   | Reconnection cooldown | `reestablish_after` | 
`reconnection_reestablish_after` | `reestablish_after` | `reestablish_after` |
   | Certificate validation | none | `validate_certificate` | 
`tls_validate_certificate` | `tls_validate_certificate` |
   
   ## What changed?
   
   1. Changed the connection keys among the different clients. Deprecated 
connection keys will still work, albeit with a warn log.
   The deprecated keys will be removed in a future release, as mentioned in the 
issue.
   Current behavior is that if both the new and deprecated keys are passed into 
connection, the latter will be used.
   
   2. Updated the relevant documentation and tests
   
   <!--
   2-4 sentences. Problem first (before), then solution (after).
   
   GOOD:
   
   "Messages were unavailable when background message_saver committed the
   journal and started async disk I/O before completion. Polling during
   this window found neither journal nor disk data.
   
   The fix freezes journal batches in the in-flight buffer before async 
persist."
   
   GOOD:
   
   "When many small messages accumulate in the journal, the flush passes
   thousands of IO vectors to writev(), exceeding IOV_MAX (1024 on Linux)."
   
   BAD:
   - Walls of text
   - "This PR adds..." (we can see the diff)
   -->
   
   ## Local Execution
   
   - Pre-commit hooks ran 
   
   <!--
   You must run your code locally before submitting.
   "Relying on CI" is not acceptable - PRs from authors who haven't run the 
code will be closed.
   
   Did you have `prek` installed? It runs automatically on commit and covers 
all project languages. See 
[CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
   -->
   
   AI Usage:
   
   For the addition of docs and tests


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to