align connection options and allow override of protocol from env #305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
duncdrum
requested changes
Oct 18, 2023
There was a problem hiding this comment.
If its necessary it should be mentioned here https://github.com/eXist-db/node-exist#rest . Having both environmentOptions.secure and environmentOptions.protocol isn't self-evident
This is needed to allow REST connections using `http:` to override the default (`https:`).
line-o
force-pushed
the
fix/options-from-env
branch
from
6993c4b
to
a7076a9
Compare
|
@duncdrum I just re-read the section explaining the REST endpoint and agree that it should include a section how to configure that connection - by hand - and also point out that the options returned from |
Both REST and XML-RPC now have the same set of default options. The boolean option `secure` can still be used to control XMLRPC client, but `protocol` is the preferred way. This allows to use the same set of options for both client constructors. Add test to ensure legacy option is still working.
- fix TOC - rename and improve Configuration section to Connection Options - clarify wording in Use - REST - clarify that Components is using XML-RPC
|
@duncdrum your demand to better document connection options lead to a serious quality of life improvement :) |
line-o
changed the title
duncdrum
approved these changes
Oct 21, 2023
|
🎉 This PR is included in version 5.5.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Features
aligned connection options allows to use the same options for both APIs, REST and XML-RPC
The legacy option
{ secure: true|false }will now work for both APIs as setting the protocol does.{ protocol: "https:"|"http:" }is now the preferred way to switch between encrypted and unencryptedconnections and works for both APIs.
Fixes
REST connection options read from environment can override default protocol (
https:)Documentation
clarify connection options and usage - fixes #240