refactor: simplify role.go route definitions to reduce duplication #80

kearen001 · 2025-09-12T06:22:49Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:
Refactor role.go route definitions to reduce code duplication and improve maintainability.

Extracted repeated Param, Writes, Reads into reusable helper functions.
Simplified route registration logic with a single addRoute method.
Code is easier to read, extend, and maintain.

Which issue(s) this PR fixes:

Fixes #
NONE

Special notes for your reviewer:

No functional changes, only code cleanup.
All existing routes and handlers remain the same.

Does this PR introduce a user-facing change?:

NONE

kubeedge-bot · 2025-09-12T06:22:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign shelley-baoyue after the PR has been reviewed.
You can assign the PR to them by writing /assign @shelley-baoyue in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kubeedge-bot · 2025-09-12T06:23:00Z

Welcome @kearen001! It looks like this is your first PR to kubeedge/dashboard 🎉

gemini-code-assist

Summary of Changes

Hello @kearen001, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the internal structure and clarity of the API route definitions related to roles. It introduces a more modular and less repetitive way to declare routes, making the codebase cleaner and more robust for future development without altering any existing functionality.

Highlights

Code Refactoring: The primary goal of this pull request is to refactor the route definitions within role.go to enhance maintainability and reduce code duplication. This is a cleanup effort with no functional changes.
Helper Functions for Route Options: Reusable helper functions (WithParam, WithReads, WithWrites, WithReturns, WithDoc) have been introduced to encapsulate common restful.RouteBuilder configurations, making route definitions more concise.
Centralized Route Registration: A new addRoute function has been implemented to centralize the logic for dynamically creating and registering routes based on HTTP method and a variadic list of options. This significantly simplifies the addRoleRoutes method.
Improved Readability and Maintainability: By abstracting common patterns into helper functions and a single registration method, the code for defining API routes is now easier to read, extend, and maintain.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request refactors the route definitions in role.go to reduce code duplication and improve maintainability by introducing a set of helper functions. The changes make the code cleaner and easier to read. My review includes one suggestion to improve the robustness of the new addRoute helper function by handling unsupported HTTP methods more strictly, preventing potential silent failures.

gemini-code-assist · 2025-09-12T06:23:46Z

modules/api/pkg/handler/role.go

+	default:
+		// 保守回退为 GET（或者根据需要 panic/返回 error）
+		rb = ws.GET(path).To(handler)


The default case in this switch statement silently falls back to creating a GET route for any unsupported HTTP method. This can lead to subtle bugs that are hard to track down if a developer accidentally provides an incorrect or unsupported method string. It's better to fail fast in such cases.

Since this function is part of the application setup, panicking is an appropriate way to signal a programming error immediately.

Suggested change

default:

// 保守回退为 GET（或者根据需要 panic/返回 error）

rb = ws.GET(path).To(handler)

default:

panic("unsupported HTTP method: " + method)

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

…ation

ghosind

/lgtm
cc @wbc6080 @Shelley-BaoYue

ghosind · 2025-09-12T06:40:39Z

modules/api/pkg/handler/role.go

 	"github.com/kubeedge/dashboard/errors"
 )

+// --- Route helper 定义 ---


Please write comments in English

ghosind · 2025-09-12T06:45:02Z

modules/api/pkg/handler/role.go

+		o(rb)
+	}
+	ws.Route(rb)
+}


I think we should move these functions to another file to make them reusable

kubeedge-bot · 2025-10-29T07:50:53Z

@kearen001: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

kubeedge-bot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Sep 12, 2025

kubeedge-bot requested review from kevin-wangzefeng and vincentgoat September 12, 2025 06:22

gemini-code-assist bot reviewed Sep 12, 2025

View reviewed changes

kubeedge-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 12, 2025

gemini-code-assist bot reviewed Sep 12, 2025

View reviewed changes

yeyetianbing and others added 2 commits September 12, 2025 14:32

add notice TO README

76a777d

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

role.go editting

56e5de8

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

kearen001 force-pushed the role_edit branch from ff4ea70 to 56e5de8 Compare September 12, 2025 06:32

kearen001 added 2 commits September 12, 2025 17:27

refactor: move helper methods into util.go and simplify route registr…

5a1bf39

…ation

refactor: move helper methods into util.go and simplify route registr…

8ba6923

…ation

ghosind reviewed Sep 12, 2025

View reviewed changes

kubeedge-bot assigned ghosind Sep 12, 2025

kubeedge-bot added the lgtm Indicates that a PR is ready to be merged. label Sep 12, 2025

kubeedge-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: simplify role.go route definitions to reduce duplication #80

refactor: simplify role.go route definitions to reduce duplication #80

Uh oh!

kearen001 commented Sep 12, 2025

Uh oh!

kubeedge-bot commented Sep 12, 2025

Uh oh!

kubeedge-bot commented Sep 12, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Sep 12, 2025

Uh oh!

ghosind left a comment

Uh oh!

ghosind Sep 12, 2025

Uh oh!

ghosind Sep 12, 2025

Uh oh!

kubeedge-bot commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

refactor: simplify role.go route definitions to reduce duplication #80

Are you sure you want to change the base?

refactor: simplify role.go route definitions to reduce duplication #80

Uh oh!

Conversation

kearen001 commented Sep 12, 2025

Uh oh!

kubeedge-bot commented Sep 12, 2025

Uh oh!

kubeedge-bot commented Sep 12, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

ghosind left a comment

Choose a reason for hiding this comment

Uh oh!

ghosind Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

ghosind Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

kubeedge-bot commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants