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: Support for conclude txn and abandon age param #16834

Merged
merged 7 commits into from
Oct 9, 2024

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Sep 24, 2024

Description

  • Adds support for conclude transaction in VTAdmin.
  • Adds an optional dropdown for selecting abandonAge, if it's empty, we use the default abandon age.
  • The dropdown carries the following options: 5sec, 30sec, 1min, 5min, 15min and 1hr.

Related Issue(s)

Screenshots

Screenshot 2024-09-25 at 1 04 32 AM

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

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Sep 24, 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 24, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 24, 2024
@beingnoble03 beingnoble03 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTAdmin VTadmin interface and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 24, 2024
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 2.77778% with 35 lines in your changes missing coverage. Please review.

Project coverage is 69.41%. Comparing base (f40e076) to head (a8bea60).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtadmin/api.go 6.66% 14 Missing ⚠️
go/vt/vtadmin/http/transactions.go 0.00% 12 Missing ⚠️
go/vt/vtadmin/http/request.go 0.00% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16834      +/-   ##
==========================================
- Coverage   69.43%   69.41%   -0.03%     
==========================================
  Files        1570     1570              
  Lines      203812   203846      +34     
==========================================
- Hits       141517   141496      -21     
- Misses      62295    62350      +55     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -78,7 +78,7 @@ func (r Request) ParseQueryParamAsUint32(name string, defaultVal uint32) (uint32
}

// ParseQueryParamAsInt32 attempts to parse the query parameter of the given
// name into a uint32 value. If the parameter is not set, the provided default
// name into a int32 value. If the parameter is not set, the provided default
Copy link
Member Author

Choose a reason for hiding this comment

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

typo :)

@beingnoble03 beingnoble03 changed the title VTAdmin: Support for conclude unresolved transaction VTAdmin: Support for conclude txn and abandon age param Sep 24, 2024
@beingnoble03 beingnoble03 marked this pull request as ready for review September 24, 2024 19:41
Comment on lines 547 to 549
if !api.authz.IsAuthorized(ctx, c.ID, rbac.KeyspaceResource, rbac.GetAction) {
return nil, nil
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this would be better as a:

if !api.authz.IsAuthorized(ctx, c.ID, rbac.ClusterResource, rbac.GetAction) {
    return nil, nil
}

Before fetching the cluster on line 539 instead!

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@@ -23,13 +23,32 @@ import (
)

// GetUnresolvedTransactions implements the http wrapper for the
// /transactions/{cluster_id}/{keyspace} route.
// /transactions/{cluster_id}/{keyspace}[?abandon_age=] route.
Copy link
Contributor

Choose a reason for hiding this comment

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

🥳

transactionsQuery.refetch();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [params.abandonAge]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why wouldn't you want to update on params clusterID and keyspace changing too?

Copy link
Member Author

Choose a reason for hiding this comment

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

Already using params (which is a stateful value, contains keyspace, clusterID and abandonAge) while fetching transactions.

    const transactionsQuery = useTransactions(params, {
        enabled: !!params.keyspace,
    });

Infact, we don't even need useEffect here. 😃 Removing it.

@vitess-bot vitess-bot modified the milestones: v21.0.0, v22.0.0 Oct 8, 2024
Copy link
Member

@harshit-gangal harshit-gangal left a comment

Choose a reason for hiding this comment

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

Sorry this fall off my radar.
We should keep the default set for Abandon Age to 15 mins here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTAdmin VTadmin interface Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants