Skip to content

asthelpergen: add design documentation#18403

Merged
harshit-gangal merged 2 commits intovitessio:mainfrom
planetscale:asthelpergen-refactor
Jun 30, 2025
Merged

asthelpergen: add design documentation#18403
harshit-gangal merged 2 commits intovitessio:mainfrom
planetscale:asthelpergen-refactor

Conversation

@systay
Copy link
Collaborator

@systay systay commented Jun 27, 2025

Description

Adds a design doc to the asthelpergen package, and does small refactorings cleaning up code to make it easier to read and work with

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

systay and others added 2 commits June 27, 2025 08:40
@systay @claude
asthelpergen: add design documentation
902ef84 
Document the architecture and design patterns of the AST helper
generator including core components, type system integration,
and code generation process.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
@systay @claude
asthelpergen: refactor for improved readability and maintainability
1d67064 
Improve code organization and error handling while preserving
all functionality and generated output:

- Extract constants (visitableName, anyTypeName) to reduce duplication
- Replace log.Fatal() with proper error returns and context
- Break down complex createFiles() into focused helper functions
- Add comprehensive package and type documentation
- Remove unused imports and duplicate definitions

All tests pass and generated code remains identical.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
@systay systay requested a review from frouioui as a code owner June 27, 2025 07:47
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Jun 27, 2025

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 Jun 27, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Jun 27, 2025
@systay systay added Type: Internal Cleanup Component: Query Serving 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 Jun 27, 2025
@harshit-gangal harshit-gangal merged commit d003465 into vitessio:main Jun 30, 2025
107 of 114 checks passed
@harshit-gangal harshit-gangal deleted the asthelpergen-refactor branch June 30, 2025 08:42
morgo added a commit to morgo/vitess that referenced this pull request Jul 7, 2025
@morgo
Merge remote-tracking branch 'origin/master' into fix-topo-import-to-…
aa4be6e 
…tests

* origin/master: (32 commits)
  test: Fix race condition in TestStreamRowsHeartbeat (vitessio#18414)
  VReplication: Improve permission check logic on external tablets on SwitchTraffic (vitessio#18348)
  Perform post copy actions in atomic copy (vitessio#18411)
  Update `operator.yaml` (vitessio#18364)
  Feature(onlineddl): Add shard-specific completion to online ddl (vitessio#18331)
  Set parsed comments in operator for subqueries (vitessio#18369)
  `vtorc`: move shard primary timestamp to time type (vitessio#18401)
  `vtorc`: rename `isClusterWideRecovery` -> `isShardWideRecovery` (vitessio#18351)
  `vtorc`: remove dupe keyspace/shard in replication analysis (vitessio#18395)
  Topo: Add NamedLock test for zk2 and consul and get them passing (vitessio#18407)
  Handle MySQL 9.x as New Flavor in getFlavor() (vitessio#18399)
  Add support for sending grpc server backend metrics via ORCA (vitessio#18282)
  asthelpergen: add design documentation (vitessio#18403)
  `vtorc`: add keyspace/shard labels to recoveries stats (vitessio#18304)
  `vtorc`: cleanup `database_instance` location fields (vitessio#18339)
  avoid derived tables for UNION when possible (vitessio#18393)
  [Bugfix] Broken Heartbeat system in Row Streamer (vitessio#18390)
  Update MAINTAINERS.md (vitessio#18394)
  move vmg to emeritus (vitessio#18388)
  Make sure to check if the server is closed in etcd2topo (vitessio#18352)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@frouioui frouioui frouioui approved these changes

Assignees

No one assigned

Labels

Component: Query Serving Type: Internal Cleanup

Projects

None yet

Milestone

v23.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@systay @harshit-gangal @frouioui