bitflicker64 opened a new pull request, #2944:
URL: https://github.com/apache/incubator-hugegraph/pull/2944
<!--
Thank you very much for contributing to Apache HugeGraph, we are happy
that you want to help us improve it!
Here are some tips for you:
1. If this is your first time, please read the [contributing
guidelines](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md)
2. If a PR fix/close an issue, type the message "close xxx" (xxx is the
link of related
issue) in the content, GitHub will auto link it (Required)
3. Name the PR title in "Google Commit Format", start with "feat | fix |
perf | refactor | doc | chore",
such like: "feat(core): support the PageRank algorithm" or "fix: wrong
break in the compute loop" (module is optional)
skip it if you are unsure about which is the best component.
4. One PR address one issue, better not to mix up multiple issues.
5. Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]` (or click
it directly after
published)
-->
## Purpose of the PR
- close #2942 <!-- or use "fix #xxx", "xxx" is the ID-link of related issue,
e.g: close #1024 -->
- Some server URL configs currently require an explicit scheme (`http://` /
`https://`). If a user sets something like `127.0.0.1:8080`, it can fail to
parse or behave inconsistently compared to other modules that already default
the scheme.
This PR fixes that by normalizing **only the relevant server URL options**:
if the scheme is missing, we auto-prefix a sensible default, while leaving
explicitly provided schemes untouched.
Also covered the review corner case: `server.k8s_url` should default to
**`https://`** (so we don’t accidentally downgrade it to `http://`).
<!--
Please explain more context in this section, clarify why the changes are
needed.
e.g:
- If you propose a new API, clarify the use case for a new API.
- If you fix a bug, you can clarify why it is a bug, and should be
associated with an issue.
-->
## Main Changes
<!-- Please clarify what changes you are proposing. The purpose of this
section is to outline the changes and how this PR fixes the issue. These change
logs are helpful for better and faster reviews.)
For example:
- If you introduce a new feature, please show detailed design here or add
the link of design documentation.
- If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
- If there is a discussion in the mailing list, please add the link. -->
`HugeConfig.get(...)` now applies URL normalization for a small allowlist of
keys:
* `restserver.url` → default `http://`
* `gremlinserver.url` → default `http://`
* `server.urls_to_pd` → default `http://`
* `server.k8s_url` → default `https://`
Normalization only triggers when:
* the config key is in the allowlist, **and**
* the value is a `String`, **and**
* the value has **no scheme**
If the value already starts with `http://` or `https://`, it’s left as-is.
Non-string config values are untouched.
## Verifying these changes
<!-- Please pick the proper options below -->
- [ ] Trivial rework / code cleanup without any test coverage. (No Need)
- [ ] Already covered by existing tests, such as *(please modify tests
here)*.
- [x] Need tests and can be verified as follows:
Tests are included and you can verify the behavior like this:
* Added unit tests in `HugeConfigTest` covering:
* missing scheme → default prefix is added
* existing scheme → preserved as-is
* `server.k8s_url` missing scheme → becomes `https://...` (no accidental
downgrade)
## Does this PR potentially affect the following parts?
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] Dependencies ([add/update
license](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/#321-check-licenses)
info &
[regenerate_known_dependencies.sh](../install-dist/scripts/dependency/regenerate_known_dependencies.sh))
<!-- Don't forget to add/update the info in "LICENSE" & "NOTICE" files (both
in root & dist module) -->
- [x] Modify configurations
- [ ] The public API
- [ ] Other affects (typed here)
- [ ] Nope
## Documentation Status
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `Doc - TODO` <!-- Your PR changes impact docs and you will update
later -->
- [ ] `Doc - Done` <!-- Related docs have been already added or updated -->
- [x] `Doc - No Need` <!-- Your PR changes don't impact/need docs -->
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
