Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VTAdmin: Fix serve-handler's path-to-regexp dep and add default schema refresh #16778

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Sep 13, 2024

Description

Firstly, this is a follow-up to #16770 and corrects the path-to-regexp dependency for serve-handler (the core HTTP request handler in vtadmin-web) — it should have been upgraded to 3.3.0 there rather than 8.0.0. Without this fix it failed to handle incoming requests after starting up:

git checkout main && make build

cd examples/local

./101_initial_cluster.sh; mysql < ../common/insert_commerce_data.sql

curl localhost:14201

❯ cat ${VTDATAROOT}/tmp/vtadmin-web.out
 INFO  Accepting connections at http://localhost:14201/
 HTTP  9/13/2024 8:26:32 AM 127.0.0.1 GET /

 INFO  Gracefully shutting down. Please wait...
/Users/matt/git/vitess/web/vtadmin/node_modules/serve-handler/src/index.js:47
		const expression = pathToRegExp(normalized, keys);
		                   ^

TypeError: pathToRegExp is not a function
    at sourceMatches (/Users/matt/git/vitess/web/vtadmin/node_modules/serve-handler/src/index.js:47:22)
    at toTarget (/Users/matt/git/vitess/web/vtadmin/node_modules/serve-handler/src/index.js:70:18)
    at applyRewrites (/Users/matt/git/vitess/web/vtadmin/node_modules/serve-handler/src/index.js:105:18)
    at module.exports (/Users/matt/git/vitess/web/vtadmin/node_modules/serve-handler/src/index.js:618:24)
    at run (file:///Users/matt/git/vitess/web/vtadmin/node_modules/serve/build/main.js:181:13)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

We need to backport this all the way to v18 as #16770 was backported to v18.

We also add a default schema cache expiration time to the local examples. Users have previously asked why the schema display in VTAdmin does not appear to refresh, and they've asked HOW they can change that behavior (w/o any value specified it never refreshes). This change addresses both issues.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

… refresh

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord added Component: VTAdmin VTadmin interface Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 labels Sep 13, 2024
Copy link
Contributor

vitess-bot bot commented Sep 13, 2024

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Sep 13, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 13, 2024
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 13, 2024
@mattlord mattlord added Type: Bug and removed NeedsIssue A linked issue is missing for this Pull Request labels Sep 13, 2024
@mattlord mattlord requested review from frouioui and removed request for ajm188 September 13, 2024 13:26
@@ -43,7 +43,7 @@ vtadmin \
--alsologtostderr \
--rbac \
--rbac-config="${script_dir}/../vtadmin/rbac.yaml" \
--cluster "id=${cluster_name},name=${cluster_name},discovery=staticfile,discovery-staticfile-path=${script_dir}/../vtadmin/discovery.json,tablet-fqdn-tmpl=http://{{ .Tablet.Hostname }}:15{{ .Tablet.Alias.Uid }}" \
--cluster "id=${cluster_name},name=${cluster_name},discovery=staticfile,discovery-staticfile-path=${script_dir}/../vtadmin/discovery.json,tablet-fqdn-tmpl=http://{{ .Tablet.Hostname }}:15{{ .Tablet.Alias.Uid }},schema-cache-default-expiration=1m" \
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

@mattlord mattlord merged commit 03af0cd into vitessio:main Sep 13, 2024
100 of 113 checks passed
@mattlord mattlord deleted the vtadmin_schema_refresh branch September 13, 2024 18:54
vitess-bot pushed a commit that referenced this pull request Sep 13, 2024
…a refresh (#16778)

Signed-off-by: Matt Lord <mattalord@gmail.com>
frouioui pushed a commit that referenced this pull request Sep 13, 2024
…d default schema refresh (#16778) (#16784)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
rohit-nayak-ps pushed a commit that referenced this pull request Sep 15, 2024
…d default schema refresh (#16778) (#16782)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
rohit-nayak-ps pushed a commit that referenced this pull request Sep 15, 2024
…d default schema refresh (#16778) (#16783)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Component: VTAdmin VTadmin interface Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: VTAdmin not usable in local examples
3 participants