Add ConfigSpec, PreferenceSpec, and RoleSpec typed classes#538
Merged
Add ConfigSpec, PreferenceSpec, and RoleSpec typed classes#538
Conversation
Replace untyped Map arguments in ensureRequiredConfigsCreated(), ensureRequiredPrefsCreated(), and ensureRequiredRolesCreated() with typed spec classes that provide IDE autocomplete and compile-time validation. Previous Map-based signatures remain as deprecated overloads targeted for removal in v40. Also fixes the legacy note/notes field name mismatch in the preference API — PreferenceSpec uses the correct `notes` (plural) matching the Preference domain, with the deprecated overload mapping singular `note` for backward compat. Adds v40 removal target to the previously un-targeted @access deprecation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 tasks
Member
Author
|
Hi @lbwexler - "real" Anselm here - had Claude do this after remembering we made that nice change for bootstrapping status monitors, wanted to get the same benefits and bwds-compat in place for more common configs and prefs. Opened as draft as I have not yet reviewed the code myself - I did look over the plan carefully and adjust it, and this seems likely to land in a clean state. I will post any updates when I have a chance to look over it myself, or if you are motivated to do so at any point... |
# Conflicts: # CHANGELOG.md
Member
Author
|
FYI — once this lands, the |
Reconciles the typed-config expansion shipped on develop (#545) with the new ConfigSpec/PreferenceSpec/RoleSpec API on this branch. Adds `typedClass` field to `ConfigSpec` so the typed-config registration shipped on develop can flow through the new typed API. `ConfigService.ensureRequiredConfigsCreated(List<ConfigSpec>)` now performs the typed-class registration + drift-check that develop added to the Map overload, keeping a single registration path for both the new and deprecated signatures. The deprecated `Map<String, Map>` overload continues to forward through `ConfigSpec` and inherits the typed-class wiring for free. BootStrap was reconciled to keep develop's tracing-aware init structure (`configService.initialize`, `traceService.startServerLoadSpan`, hoistInit span) while expressing every config + pref entry through the new typed `ConfigSpec`/`PreferenceSpec` literals — including the `typedClass:` references for all 12 newly typed framework configs and the `xhTraceConfig` shape change from develop (drop `alwaysSampleErrors`, add `jdbcTracingEnabled`). Moves the ConfigSpec/PreferenceSpec/RoleSpec changelog entry from the now-released v38 section to the v39.0-SNAPSHOT section, and notes `ConfigSpec.typedClass` as the supported entry point. Updates docs/configuration.md typed-config example to use `new ConfigSpec(...)` rather than the deprecated Map literal. 🤖 Generated with Claude Opus 4.7 (1M context)
…Class doc Bumps the removal target on the deprecated `ensureRequiredConfigsCreated(Map)` and `ensureRequiredPrefsCreated(Map)` overloads from v40 to v42, giving downstream apps more runway. Also condenses the `ConfigSpec.typedClass` Groovydoc to a one-line pointer to docs/configuration.md rather than restating the full feature description. 🤖 Generated with Claude Opus 4.7 (1M context)
lbwexler
reviewed
Apr 27, 2026
lbwexler
added a commit
to xh/toolbox
that referenced
this pull request
Apr 27, 2026
## Summary - Convert `ensureRequiredConfigsCreated()` and `ensureRequiredPrefsCreated()` calls in BootStrap from untyped Map literals to typed `ConfigSpec` and `PreferenceSpec` classes introduced in hoist-core. - Adopt corrected `notes` (plural) field name on `PreferenceSpec`, fixing the legacy `note` mismatch. Companion hoist-core PR: xh/hoist-core#538 ## Test plan - [ ] Run Toolbox with companion hoist-core branch — confirm configs/prefs seed without deprecation warnings - [ ] Verify Admin Console config and preference editors still load and function correctly 🤖 Generated with Claude Opus 4.6 Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: lbwexler <lbwexler@xh.io>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
ConfigSpec,PreferenceSpec, andRoleSpectyped classes with@MapConstructorfor use withensureRequiredConfigsCreated(),ensureRequiredPrefsCreated(), andensureRequiredRolesCreated(), replacing untypedMaparguments with classes that provide IDE autocomplete and compile-time validation.Map-based signatures remain as deprecated overloads targeted for removal in v40.note/notesfield name mismatch in the preference API —PreferenceSpecuses the correctnotes(plural) matching thePreferencedomain. The deprecated overload maps singularnotefor backward compat.@Accessannotation deprecation.Companion Toolbox PR: xh/toolbox#838
Test plan
./gradlew assemble🤖 Generated with Claude Opus 4.6