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

Vm slack 15.0 #16035

Closed
wants to merge 239 commits into from
Closed

Vm slack 15.0 #16035

wants to merge 239 commits into from

Conversation

vmogilev
Copy link
Contributor

@vmogilev vmogilev commented Jun 1, 2024

Description

forward ports slack specific PRS fix from v14 to v15: slackhq#177

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

Deployment Notes

rsajwani and others added 30 commits October 4, 2022 12:17
Signed-off-by: Rameez Sajwani <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>
* Release notes for 15.0.0-rc1

Signed-off-by: Rameez Sajwani <[email protected]>

* Release commit for 15.0.0-rc1

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
vitessio#11448)

* feat: call the logic for waiting for shard locks on synchronous on-term hooks and add tests for it

Signed-off-by: Manan Gupta <[email protected]>

* feat: fix comment for acceptSighupSignal function

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: Manan Gupta <[email protected]>
… creation (vitessio#11415) (vitessio#11447)

* Testing....

Signed-off-by: Matt Lord <[email protected]>

* Setup reverse routing rules at the start of the first partial movetables. Enhance e2e test to test for this as well as switch the remaining shard so that all shards are switched

Signed-off-by: Rohit Nayak <[email protected]>

* Update display representation of state for partially moved keyspaces

Signed-off-by: Rohit Nayak <[email protected]>

* Test improvements

Signed-off-by: Matt Lord <[email protected]>

* Cleanup shard routing rules on cancel/complete

Signed-off-by: Matt Lord <[email protected]>

* Cleanup intermediate changes

Signed-off-by: Matt Lord <[email protected]>

* Fix DryRun TrafficSwitcher and its tests

Signed-off-by: Matt Lord <[email protected]>

* Support concurrent partial movetables for N keyspaces

And other minor changes after self review

Signed-off-by: Matt Lord <[email protected]>

* Avoid unnecessary save + rebuild steps

Signed-off-by: Matt Lord <[email protected]>

* Add secondary ordering for shard routing rules on to_keyspace

Signed-off-by: Matt Lord <[email protected]>

* Minor changes after self review

Signed-off-by: Matt Lord <[email protected]>

Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>

Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>
…e correct binary. (vitessio#11450)

Signed-off-by: Rohit Nayak <[email protected]>

Signed-off-by: Rohit Nayak <[email protected]>
* Use JSON for plan tests

Signed-off-by: Florent Poinsard <[email protected]>

* move vschemas into single directory

Signed-off-by: Andres Taylor <[email protected]>

* indentation

Signed-off-by: Andres Taylor <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Andres Taylor <[email protected]>
Co-authored-by: Andres Taylor <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Andres Taylor <[email protected]>
Co-authored-by: FlorentP <[email protected]>
…ssio#11469)

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>
This is to pick up the fix for golang/go#56152.

Signed-off-by: Andrew Mason <[email protected]>

Signed-off-by: Andrew Mason <[email protected]>
Co-authored-by: Andrew Mason <[email protected]>
…nShard`, `GetFullStatus` (vitessio#11438) (vitessio#11452)

* Add validate

Signed-off-by: notfelineit <[email protected]>

* Add validate to cluster page

Signed-off-by: notfelineit <[email protected]>

* Run lint prettier fix

Signed-off-by: notfelineit <[email protected]>

* Add UI for validate shard

Signed-off-by: notfelineit <[email protected]>

* Add validateShard

Signed-off-by: notfelineit <[email protected]>

* Run make web proto

Signed-off-by: notfelineit <[email protected]>

* Refactor validation results and implement validateShard

Signed-off-by: notfelineit <[email protected]>

* add http shards

Signed-off-by: notfelineit <[email protected]>

* Add GetFullStatus

Signed-off-by: notfelineit <[email protected]>

* Add keys and comment

Signed-off-by: notfelineit <[email protected]>

* Run lint prettier fix

Signed-off-by: notfelineit <[email protected]>

* Add ValidateVersionShard to vtctldclient

Signed-off-by: notfelineit <[email protected]>

* Add ValidateVersionShard

Signed-off-by: notfelineit <[email protected]>

* Update test for vtctldclient

Signed-off-by: notfelineit <[email protected]>

* Add test for ValidateVersionShard

Signed-off-by: notfelineit <[email protected]>

* run lint prettier fix again

Signed-off-by: notfelineit <[email protected]>

* Modify during 1:1 with gomez

Signed-off-by: notfelineit <[email protected]>

* Run lint prettier fix

Signed-off-by: notfelineit <[email protected]>

* Address PR review comments

Signed-off-by: notfelineit <[email protected]>

* Update indentation

Signed-off-by: notfelineit <[email protected]>

Signed-off-by: notfelineit <[email protected]>
Co-authored-by: notfelineit <[email protected]>
* Fix check_make_sizegen

Signed-off-by: Florent Poinsard <[email protected]>

* Apply review suggestion

Signed-off-by: Florent Poinsard <[email protected]>

* Fail the static_check_etc workflow when a script fails

Signed-off-by: Florent Poinsard <[email protected]>

* Remove test code

Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
…1483)

* feat: add replacer and code to always print semi-sync fields and decode the io and sql state from integers to strings

Signed-off-by: Manan Gupta <[email protected]>

* refactor: prettify the changed file

Signed-off-by: Manan Gupta <[email protected]>

* feat: fix replication state strings and simplify code

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>
Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: Manan Gupta <[email protected]>
Signed-off-by: Harshit Gangal <[email protected]>
* Plan order by Count()

Signed-off-by: Florent Poinsard <[email protected]>

* Clean up the new aggregation E2E test

Signed-off-by: Florent Poinsard <[email protected]>

* Push more order by needs to the select list

Signed-off-by: Florent Poinsard <[email protected]>

* Remove unrequired code in TestOrderByCount

Signed-off-by: Florent Poinsard <[email protected]>

* remove unwanted directory

Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
…k overflow (vitessio#11499)

Signed-off-by: Andres Taylor <[email protected]>

Signed-off-by: Andres Taylor <[email protected]>
* test: added failing e2e test

Signed-off-by: Harshit Gangal <[email protected]>

* log txID and reserveID in stream execute

Signed-off-by: Harshit Gangal <[email protected]>

* fix: maintain list of qd per key on the map and check for current connection id while removing

Signed-off-by: Harshit Gangal <[email protected]>

* added additional comments

Signed-off-by: Harshit Gangal <[email protected]>

Signed-off-by: Harshit Gangal <[email protected]>
Signed-off-by: Harshit Gangal <[email protected]>
…ease-15.0

[release-15.0] fix: reserve connection to follow query timeout when outside of transaction (vitessio#11490)
* feat: added test for vtorc not being able to handle mutliple failures and fix it

Signed-off-by: Manan Gupta <[email protected]>

* test: fix code to delete rdonly tablet from the correct list

Signed-off-by: Manan Gupta <[email protected]>

Signed-off-by: Manan Gupta <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>

Signed-off-by: Florent Poinsard <[email protected]>
* Adding deprecate message to backup hooks

Signed-off-by: Rameez Sajwani <[email protected]>

* adding markdeprecated

Signed-off-by: Rameez Sajwani <[email protected]>

* fixing deprecation message

Signed-off-by: Rameez Sajwani <[email protected]>

* fixing messaging

Signed-off-by: Rameez Sajwani <[email protected]>

* fix flag name

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: Manan Gupta <[email protected]>
* removing unncessary flags across binaries

Signed-off-by: Rameez Sajwani <[email protected]>

* code review feedback

Signed-off-by: Rameez Sajwani <[email protected]>

* fixing blank space

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
[15.0] Fix query list override issue on mysql restart (vitessio#11309)
* remove excessive logging

Signed-off-by: Rameez Sajwani <[email protected]>

* code feeback

Signed-off-by: Rameez Sajwani <[email protected]>

* fixing typo

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
…io#11493)

* Move CI to mysql80

Signed-off-by: Rameez Sajwani <[email protected]>

* fix typo

Signed-off-by: Rameez Sajwani <[email protected]>

* fixing typo

Signed-off-by: Rameez Sajwani <[email protected]>

* moving to apt-config 8.2

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
I accidentally stumbled over the behavior outlined in
`flag.PrintDefaults` [1], which `pflag` replicates, specifically:

> The listed type, here int, can be changed by placing a back-quoted
> name in the flag's usage string; the first such item in the message is
> taken to be a parameter name to show in the message and the back quotes
> are stripped from the message when displayed.

[1]: https://pkg.go.dev/flag#PrintDefaults.

Signed-off-by: Andrew Mason <[email protected]>

Signed-off-by: Andrew Mason <[email protected]>
Co-authored-by: Andrew Mason <[email protected]>
…th transaction (vitessio#11527)

* fix: stream exec once in case of transactional connection

Signed-off-by: Harshit Gangal <[email protected]>

* test: added e2e test

Signed-off-by: Harshit Gangal <[email protected]>

* generate ci worflow

Signed-off-by: Harshit Gangal <[email protected]>

Signed-off-by: Harshit Gangal <[email protected]>
timvaillancourt and others added 11 commits May 24, 2024 01:45
* Skip recalculating the rate in MaxReplicationLagModule when it can't be done (vitessio#12620)

* Skip recalculating the rate in MaxReplicationLagModule when it can't be done

This defends against lag records with nil stats which can lead to segfaults.
See vitessio#12619

Signed-off-by: Eduardo J. Ortega U <[email protected]>

* Address PR comments.

Signed-off-by: Eduardo J. Ortega U <[email protected]>

* Make linter happy

Signed-off-by: Eduardo J. Ortega U <[email protected]>

---------

Signed-off-by: Eduardo J. Ortega U <[email protected]>

* Throttled transactions return MySQL error code 1041 ER_OUT_OF_RESOURCES (vitessio#12949)

This error code seems better suited to represent the fact that transactions are
being throttled by the server due to some form of resource contention than the
current code 1203 ER_TOO_MANY_USER_CONNECTIONS.

Signed-off-by: Eduardo J. Ortega U <[email protected]>

* MaxReplicationLagModule.recalculateRate no longer fills the log (vitessio#14875)

Signed-off-by: Eduardo J. Ortega U <[email protected]>

---------

Signed-off-by: Eduardo J. Ortega U <[email protected]>
Co-authored-by: Eduardo J. Ortega U <[email protected]>
* Fallback to poller replication lag if heartbeat lag fails



* Try to make CI pipeline happy



* Address PR comments



* Fix typo




---------

Signed-off-by: Eduardo J. Ortega U <[email protected]>
Signed-off-by: Eduardo J. Ortega U. <[email protected]>
Co-authored-by: Eduardo J. Ortega U <[email protected]>
* bugfix: fix nil pointer in vtgate on topo connection error (vitessio#13010)

* fix nil pointer in vtgate on topo connection error

Signed-off-by: Olga Shestopalova <[email protected]>

* add test

Signed-off-by: Olga Shestopalova <[email protected]>

* fix year

Signed-off-by: Olga Shestopalova <[email protected]>

---------

Signed-off-by: Olga Shestopalova <[email protected]>
Co-authored-by: Olga Shestopalova <[email protected]>

* VTGate Buffering: Use a more accurate heuristic for determining if we're doing a reshard (vitessio#13856)

Signed-off-by: Matt Lord <[email protected]>

---------

Signed-off-by: Olga Shestopalova <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: Olga Shestopalova <[email protected]>
Co-authored-by: Olga Shestopalova <[email protected]>
Co-authored-by: Matt Lord <[email protected]>
* add vtgate flag that explicitly allows vstream copy (#125)

* fix fs.BoolVar

Signed-off-by: Tim Vaillancourt <[email protected]>

* VSCopy: Resume the copy phase consistently from given GTID and lastpk (vitessio#11103)

* VSCopy: Demonstrate to fail a test case on which the vstream API is supposed to resume the copy phase consistently

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Resume the copy phase consistently from given GTID and lastpk

Signed-off-by: yoheimuta <[email protected]>

* Build out the unit test some more

Signed-off-by: Matt Lord <[email protected]>

* Update tests for new behavior

Signed-off-by: Matt Lord <[email protected]>

* Improve comments

Signed-off-by: Matt Lord <[email protected]>

* Limit uvstreamer changes and update test

Signed-off-by: Matt Lord <[email protected]>

* Revert uvstreamer test changes

Signed-off-by: Matt Lord <[email protected]>

* Revert all uvstream changes

Signed-off-by: Matt Lord <[email protected]>

* VCopy: Revert the last three commits

Signed-off-by: yoheimuta <[email protected]>

* VCopy: Add a new vstream type that allows picking up where we left off

Signed-off-by: yoheimuta <[email protected]>

* VCopy: Revert the unit test change

Signed-off-by: yoheimuta <[email protected]>

* VCopy: Fix the end-to-end CI test

Signed-off-by: yoheimuta <[email protected]>

* Update logic for setting up uvstreamer based on input vgtid/tablepks. Add more catchup events to test

Signed-off-by: Rohit Nayak <[email protected]>

* Refactor logic to decide if event is to be sent. Enhance unit and e2e tests.

Signed-off-by: Rohit Nayak <[email protected]>

* Don't send events for tables which we can identify as ones we haven't started copy for

Signed-off-by: Rohit Nayak <[email protected]>

* Minor changes after self-review

Signed-off-by: Rohit Nayak <[email protected]>

* Add vstream copy resume to release notes

Signed-off-by: Matt Lord <[email protected]>

* Address review comments

Signed-off-by: Matt Lord <[email protected]>

Signed-off-by: yoheimuta <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Matt Lord <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>

* VSCopy: Send COPY_COMPLETED events when the copy operation is done (vitessio#11740)

* VSCopy: Demonstrate to fail a test case on which the vstream API sends new events showing copy completed

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Send new events when the copy operation is done

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Fix typo

Signed-off-by: yoheimuta <[email protected]>

* Initialize new map for the 'vstream * from' vtgate sql interface. Make vtadmin web protos

Signed-off-by: Rohit Nayak <[email protected]>

* VSCopy: Make TestVStreamCopyBasic fail fast to avoid the end2end timeout out

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: stop sharing the 't1' table among multiple test cases running concurrently

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: refactor the function signature to be clearer

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: refactor the VEvents sorter to be simpler

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: refactor to stop the sorter from including a fully copied event

Signed-off-by: yoheimuta <[email protected]>

Signed-off-by: yoheimuta <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>

* VSCopy: Enable to copy from all shards in either a specified keyspace or all keyspaces (vitessio#11909)

* VSCopy: Demonstrate to fail a test case on which the vstream API request doesn't include keyspace and shard

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Copy from all shards in all keyspaces by specifying only an empty gtid

Signed-off-by: yoheimuta <[email protected]>

* tests: Make TestRowCount stable regardless of the number of keyspaces

Signed-off-by: yoheimuta <[email protected]>

* tests: Cleanup TestCreateAndDropDatabase correctly to stop TestVStreamCopyWithoutKeyspaceShard from failing when running tests together

Signed-off-by: yoheimuta <[email protected]>

* tests: Tweak to fix a comment

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: fix the unit tests when the input vgtid with an empty gtid lacks either keyspace or shard

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Keyspace wildcard selection lines up with the table wildcard selection

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Tests the VCopy with multiple keyspaces and resharding

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Make TestVStreamCopyMultiKeyspaceReshard clearer to check if the streaming two keyspaces works even after reshard

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Return an invalid argument error if shards are unspecified and gtid is neither 'current' nor empty

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Add a test description about its purpose and target

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Remove duplicate literals in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Retain defaultReplicas variable in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Explain why we are setting Match to 'customer.*' in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Remove an unused VStreamFlag for the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Use sentence capitalization in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Verify that we didn't lose any events or get duplicates of the keyspace being reshareded in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Return a value instead of a pointer because there is no need to modify the value

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Add a comment describing what TestVStreamCopyFromAllKeyspacesAndAllShards is doing and why

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Add a comment describing why we expect these specific numbers of events from VStream API

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Tweak the test case name

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Make a utility function to sort COPY_COMPLETED events in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Replace the matcher with a simpler one in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Move the print debug call to the FailNow section in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Use require.NoError in new tests

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Use require instead of t.Fatalf in the test

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Apply the reviewer's suggestion to make the error message easier to read

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Add a comment noting what we're actually testing

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Correct the test comment and elaborate the special-case

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Tweak an error message and a comment

Signed-off-by: yoheimuta <[email protected]>

* VSCopy: Adjust to a change in the signature of a test function that was introduced in the main repository

Signed-off-by: yoheimuta <[email protected]>

---------

Signed-off-by: yoheimuta <[email protected]>

* attempt unit test fix

Signed-off-by: Tim Vaillancourt <[email protected]>

* update test error expected

Signed-off-by: Tim Vaillancourt <[email protected]>

---------

Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: yoheimuta <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: pbibra <[email protected]>
Co-authored-by: yohei yoshimuta <[email protected]>
Co-authored-by: Matt Lord <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>
* `slack-15.0`: basic go.mod updates

Signed-off-by: Tim Vaillancourt <[email protected]>

* fix signature in `go/vt/mysqlctl/azblobbackupstorage/azblob.go`

Signed-off-by: Tim Vaillancourt <[email protected]>

* update expected error for new mysql driver

Signed-off-by: Tim Vaillancourt <[email protected]>

* more go.mod updates

Signed-off-by: Tim Vaillancourt <[email protected]>

* steal statsd fix from vitessio#11741

Signed-off-by: Tim Vaillancourt <[email protected]>

* go mod tidy

Signed-off-by: Tim Vaillancourt <[email protected]>

* update flag e2e tests

Signed-off-by: Tim Vaillancourt <[email protected]>

* update flag e2e tests

Signed-off-by: Tim Vaillancourt <[email protected]>

* update flag e2e tests

Signed-off-by: Tim Vaillancourt <[email protected]>

---------

Signed-off-by: Tim Vaillancourt <[email protected]>
* [release-17.0] VReplication: Take replication lag into account in VStreamManager healthcheck result processing (vitessio#15761) (vitessio#15772)

Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <[email protected]>

* fix signature

Signed-off-by: Tim Vaillancourt <[email protected]>

---------

Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <[email protected]>
Copy link
Contributor

vitess-bot bot commented Jun 1, 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 labels Jun 1, 2024
@vmogilev vmogilev requested a review from GuptaManan100 as a code owner June 1, 2024 01:01
@vitess-bot vitess-bot bot added the NeedsWebsiteDocsUpdate What it says label Jun 1, 2024
@vmogilev vmogilev closed this Jun 1, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.