feat(admin): add settings editor tab to admin dashboard#706
Open
Ferryx349 wants to merge 9 commits into
Open
Conversation
Signed-off-by: ABHAY PANDEY <pandeyabhay967@gmail.com>
Signed-off-by: ABHAY PANDEY <pandeyabhay967@gmail.com>
Signed-off-by: ABHAY PANDEY <pandeyabhay967@gmail.com>
… backups Signed-off-by: ABHAY PANDEY <pandeyabhay967@gmail.com>
Reconcile merged UI-DASH and Settings PRs with the settings editor branch: keep settings editor/backup APIs, adopt upstream Grafana port 7777, fail-closed rate limiting, admin-health warnings, and Settings review refactors.
🦋 Changeset detectedLatest commit: 6c94844 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| adminRateLimitMiddleware, | ||
| adminAuthMiddleware, | ||
| withAdminController(createGetAdminSettingsSchemaController), | ||
| ) |
| // codeql[js/missing-rate-limiting] - adminRateLimitMiddleware applies Redis-backed admin rate limits | ||
| router.post( | ||
| '/settings/validate', | ||
| adminRateLimitMiddleware, |
| adminRateLimitMiddleware, | ||
| adminAuthMiddleware, | ||
| json(), | ||
| withAdminController(createPostAdminSettingsRestoreController), |
Collaborator
Author
|
This PR is on the top of #690 |
Collaborator
|
coverage: 69.694% (+1.0%) from 68.718% — Ferryx349:settings-UI into cameri:main |
This was referenced Jul 22, 2026
There was a problem hiding this comment.
Pull request overview
Adds a browser-based settings editor to the admin dashboard, backed by new authenticated admin settings endpoints. This extends the existing admin console beyond metrics/health by enabling operators to view merged config, stage edits, validate, apply updates atomically with backups, and restore prior versions.
Changes:
- Added admin settings API endpoints (get settings, schema, validate, patch/apply changes, list backups, restore) with audit logging and atomic writes + backups.
- Introduced settings redaction utilities and expanded the guided settings schema/categories exposed to the dashboard UI.
- Added the Settings tab UI (HTML/CSS/JS) with category-driven editor, staged diff preview, validation, apply/discard, reload, and restore flows, plus new unit tests.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/utils/settings-redaction.spec.ts | Unit tests for secret/path redaction utilities. |
| test/unit/utils/settings-config.spec.ts | Aligns imports for settings-config test coverage. |
| test/unit/routes/admin-settings.spec.ts | End-to-end unit tests for the new admin settings API routes (auth, patch, validate, backups/restore). |
| test/unit/app/maintenance-worker.spec.ts | Updates maintenance worker tests to stub new telemetry shutdown behavior. |
| src/utils/settings.ts | Adjusts settings file watching to watch the config directory for settings changes. |
| src/utils/settings-redaction.ts | Adds utilities to redact sensitive settings values and paths. |
| src/utils/settings-guided-schema.ts | Expands/adjusts guided schema categories and exposed editable settings. |
| src/utils/settings-config.ts | Adds backups + audit log support, atomic save, backup restore/listing, and schema validation tweaks. |
| src/schemas/admin-settings-schema.ts | Adds zod schemas for admin settings patch/restore request bodies. |
| src/routes/admin/index.ts | Registers new authenticated admin settings routes in the admin router. |
| src/factories/controllers/post-admin-settings-validate-controller-factory.ts | Factory wiring for validate controller. |
| src/factories/controllers/post-admin-settings-restore-controller-factory.ts | Factory wiring for restore controller. |
| src/factories/controllers/patch-admin-settings-controller-factory.ts | Factory wiring for patch controller. |
| src/factories/controllers/get-admin-settings-schema-controller-factory.ts | Factory wiring for schema controller. |
| src/factories/controllers/get-admin-settings-controller-factory.ts | Factory wiring for settings controller. |
| src/factories/controllers/get-admin-settings-backups-controller-factory.ts | Factory wiring for backups controller. |
| src/controllers/admin/post-settings-validate-controller.ts | Implements “validate merged settings” endpoint. |
| src/controllers/admin/post-settings-restore-controller.ts | Implements restore-from-backup endpoint + audit entry. |
| src/controllers/admin/patch-settings-controller.ts | Implements validated patch/apply flow + audit logging + redacted responses. |
| src/controllers/admin/get-settings-schema-controller.ts | Serves guided schema for UI editor. |
| src/controllers/admin/get-settings-controller.ts | Serves merged settings with secret redaction. |
| src/controllers/admin/get-settings-backups-controller.ts | Serves settings backup listing for restore UI. |
| resources/admin/dashboard.html | Adds Settings tab markup and UI layout containers. |
| resources/admin/assets/dashboard.js | Implements settings editor UX: load schema/settings, stage changes, diff preview, apply/discard/restore/reload, and validate-all. |
| resources/admin/assets/dashboard.css | Styles settings editor layout, diff preview, and toolbar controls. |
| .changeset/admin-settings-ui.md | Changeset for UI feature release notes. |
| .changeset/admin-settings-api.md | Changeset for API feature release notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+7
to
+9
| public async handleRequest(_request: Request, response: Response): Promise<void> { | ||
| response.status(200).setHeader('content-type', 'application/json').send({ categories: guidedSettingCategories }) | ||
| } |
Comment on lines
+651
to
+670
| const validateFieldInput = (field, rawValue) => { | ||
| if (field.type === 'number') { | ||
| const trimmed = String(rawValue).trim() | ||
| if (!trimmed) { | ||
| return 'Value is required' | ||
| } | ||
|
|
||
| if (!/^-?\d+(\.\d+)?$/.test(trimmed)) { | ||
| return 'Enter a valid number' | ||
| } | ||
| } | ||
|
|
||
| if (field.type === 'string' || field.type === 'select') { | ||
| if (!String(rawValue).trim()) { | ||
| return 'Value is required' | ||
| } | ||
| } | ||
|
|
||
| return undefined | ||
| } |
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
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.
Description
This PR adds a Settings tab to the admin dashboard so relay operators can review and edit configuration from the browser instead of only via CLI.
Test plan
settings.yamlupdatesRelated Issue
Fixes- #665
Screenshots (if appropriate):
Settings-ui.mov
This is how final UI looks.
Types of changes
Checklist: