Skip to content

[vtadmin] Tidy up /settings (née /debug) page#10218

Merged
doeg merged 3 commits intovitessio:mainfrom
tinyspeck:sarabee-debug-settings
May 5, 2022
Merged

[vtadmin] Tidy up /settings (née /debug) page#10218
doeg merged 3 commits intovitessio:mainfrom
tinyspeck:sarabee-debug-settings

Conversation

@doeg
Copy link
Copy Markdown
Contributor

@doeg doeg commented May 4, 2022

Signed-off-by: Sara Bee 855595+doeg@users.noreply.github.com

Description

Some tidying up before GA, but this is also (sort of) a prerequisite for single-component VTAdmin (#10118 and #10214).

Specifically, with single-component VTAdmin, the front- and back-end will (by definition) share the same "route space". (This is a downside, but not a big one.) vtadmin-api already defines several /debug routes. While it doesn't have a handler for the root /debug route, it just seemed weird and unnecessary to have vtadmin-web overlap when it doesn't really need to.

Here's what this PR does instead:

  • Avoids route overlap by moving the /debug view to the /settings route, since that's likely a route we will use ✨ someday ✨ for user preferences (dark mode, time formatting, etc.) and seems like a fair place for this kind of debug info, too.

  • Omits the """style guide""" (I use that term loosely, lol) for production builds, since it's only really useful in dev mode. It also makes the production build a lil smaller and simpler.

  • Removes the "Debug" link from the NavRail, since this "settings page" in current form (just a blob of NODE_ENV json) isn't relevant to anyone except those that already know about it. 🔮

Here's what it looks like now for a prod build (on my local machine):

Screen Shot 2022-05-04 at 3 18 40 PM

Related Issue(s)

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

N/A

doeg added 2 commits May 4, 2022 14:11
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 4, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has the correct release notes label. release notes none should only be used for PRs that are so trivial that they need not be included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

Copy link
Copy Markdown
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! my only question is if we should rename Debug.tsx to Settings.tsx to match the route, but i defer to you!

Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
@doeg
Copy link
Copy Markdown
Contributor Author

doeg commented May 5, 2022

my only question is if we should rename Debug.tsx to Settings.tsx to match the route

Oh thanks for catching that!

@doeg doeg merged commit 97299a1 into vitessio:main May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants