JanusGraph / JanusGraph/janusgraph
confusing error messages with root namespace
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
There have been a few instances where a bad configuration value shows a misleading error message regarding the key name.
- [root.graph](https://groups.google.com/d/msg/janusgraph-users/JCsnpHMnKeg/8NEnGuyoBwAJ)
- [root.index](https://groups.google.com/d/msg/janusgraph-users/JtJ0JONIyck/aDKt5fM_CwAJ)
- [root.attributes](https://groups.google.com/d/msg/janusgraph-users/dOpxRbi-ZQI/xWYv4T1MAgAJ)
For example:
```
gremlin> mgmt.set('graph.set-vertex-id', true)
Cannot change the fixed configuration option: root.graph.set-vertex-id
```
The actual property that the user would need to set in the properties is `graph.set-vertex-id`. Most of the config options in `GraphDatabaseConfiguration` ultimately extend from the [`ROOT_NS`](https://github.com/JanusGraph/janusgraph/blob/v0.1.1/janusgraph-core/src/main/java/org/janusgraph/graphdb/configuration/GraphDatabaseConfiguration.java#L99) namespace and the `toString()` method includes "root".
Contributor guide
Research direction
Start in janusgraph-core/src/main/java/org/janusgraph/graphdb/configuration/GraphDatabaseConfiguration.java, especially the ROOT_NS definition and configuration toString() behavior. Reproduce the graph.set-vertex-id example and inspect how configuration keys are rendered. Done means errors identify the user-facing property without the misleading root namespace.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- databases
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100