Inclusion of rename organization api #33303

bsofiato · 2025-01-16T13:56:53Z

This adds an endpoint (/orgs/{org}/rename) to rename organizations.

I've modeled the endpoint using the rename user endpoint -- /admin/users/{username}/rename -- as base.

It is the 1st time I wrote a new API endpoint (I've tried to follow the rename users endpoint code while writing it). So feel free to ping me if there is something wrong or missing.

Resolves #32995

Signed-off-by: Bruno Sofiato <[email protected]>

routers/api/v1/org/org.go

yp05327 · 2025-01-17T04:27:50Z

You can reference the implementation here:

gitea/routers/api/v1/admin/user.go

Lines 475 to 502 in 7582eb0

    
           	if ctx.ContextUser.IsOrganization() { 
        
           		ctx.Error(http.StatusUnprocessableEntity, "", fmt.Errorf("%s is an organization not a user", ctx.ContextUser.Name)) 
        
           		return 
        
           	} 
        
           	oldName := ctx.ContextUser.Name 
        
           	newName := web.GetForm(ctx).(*api.RenameUserOption).NewName 
        
           	// Check if user name has been changed 
        
           	if err := user_service.RenameUser(ctx, ctx.ContextUser, newName); err != nil { 
        
           		switch { 
        
           		case user_model.IsErrUserAlreadyExist(err): 
        
           			ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("form.username_been_taken")) 
        
           		case db.IsErrNameReserved(err): 
        
           			ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_reserved", newName)) 
        
           		case db.IsErrNamePatternNotAllowed(err): 
        
           			ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_pattern_not_allowed", newName)) 
        
           		case db.IsErrNameCharsNotAllowed(err): 
        
           			ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_chars_not_allowed", newName)) 
        
           		default: 
        
           			ctx.ServerError("ChangeUserName", err) 
        
           		} 
        
           		return 
        
           	} 
        
           	log.Trace("User name changed: %s -> %s", oldName, newName) 
        
           	ctx.Status(http.StatusNoContent) 
        
           }

lunny · 2025-01-17T04:36:02Z

It's better to have a test.

bsofiato · 2025-01-27T17:06:05Z

It's better to have a test.

Hey @lunny, I've written a integration test to check for the new api :)

routers/api/v1/org/org.go

Co-authored-by: delvh <[email protected]>

routers/api/v1/org/org.go

tests/integration/api_org_test.go

wxiaoguang · 2025-01-31T13:18:25Z

Made some changes:

use the same logic for RenameUser and RenameOrg
- the known errors already provide good messages, so just use the "err" (then no ctx.Tr)
remove the log.Trace from handlers
- the "trace" log is only used for debugging purpose, here we do not need that
remove all onGiteaRun from org tests
- just use PrepareTestEnv, it's faster and simpler
make RenameOrg to be a sub-test
- it is faster because no need to create a new org
by the way, found a buggy test case, added "FIXME" in code.
- old code tests nothing .......

Diff with ignoring spaces: https://github.com/go-gitea/gitea/pull/33303/files?diff=unified&w=1

* giteaofficial/main: (53 commits) [skip ci] Updated licenses and gitignores Correct bot label `vertical-align` (go-gitea#33477) chore: fix some trivial problems and TODOs (go-gitea#33473) Worktime tracking for the organization level (go-gitea#19808) Skip deletion error for action artifacts (go-gitea#33476) Update .changelog file to add performance label group (go-gitea#33472) actions view: move loading of task attributes etc... into own func (go-gitea#31494) [skip ci] Updated translations via Crowdin Update feishu icon (go-gitea#33470) Inclusion of rename organization api (go-gitea#33303) [skip ci] Updated translations via Crowdin Hide/disable unusable UI elements when a repository is archived (go-gitea#33459) Fix SSH LFS memory usage (go-gitea#33455) Revert empty lfs ref name (go-gitea#33454) Update `@github/text-expander-element`, adapt type imports (go-gitea#33449) Support choose email when creating a commit via web UI (more) (go-gitea#33445) Fix issue sidebar dropdown keyboard support (go-gitea#33447) Fix "redirect link" handling (go-gitea#33440) Refactor repository transfer (go-gitea#33211) Enable two more strict options in tsconfig (go-gitea#33438) ...

This adds an endpoint (`/orgs/{org}/rename`) to rename organizations. I've modeled the endpoint using the rename user endpoint -- `/admin/users/{username}/rename` -- as base. It is the 1st time I wrote a new API endpoint (I've tried to follow the rename users endpoint code while writing it). So feel free to ping me if there is something wrong or missing. Resolves go-gitea#32995 --------- Signed-off-by: Bruno Sofiato <[email protected]> Co-authored-by: delvh <[email protected]> Co-authored-by: wxiaoguang <[email protected]> (cherry picked from commit 040c830) Conflicts: routers/api/v1/admin/user.go ignore this unrelated change templates/swagger/v1_json.tmpl regenerate tests/integration/api_org_test.go port as a standalone test instead of refactoring the tests

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 16, 2025

pull-request-size bot added the size/L label Jan 16, 2025

github-actions bot added modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code labels Jan 16, 2025

bsofiato force-pushed the feature/rename-org-api branch from b14c5e7 to ff24828 Compare January 16, 2025 15:01

Inclusion of rename organization api

ff24828

Signed-off-by: Bruno Sofiato <[email protected]>

yp05327 reviewed Jan 17, 2025

View reviewed changes

routers/api/v1/org/org.go Show resolved Hide resolved

Return adjustments and integration test

1bab50f

bsofiato requested a review from yp05327 January 29, 2025 13:43

lunny approved these changes Jan 30, 2025

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 30, 2025

lunny added the type/enhancement An improvement of existing functionality label Jan 30, 2025

lunny added this to the 1.24.0 milestone Jan 30, 2025

delvh approved these changes Jan 30, 2025

View reviewed changes

routers/api/v1/org/org.go Outdated Show resolved Hide resolved

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 30, 2025

Changed the logging level org name change messsage

488ef75

Co-authored-by: delvh <[email protected]>

wxiaoguang reviewed Jan 30, 2025

View reviewed changes

routers/api/v1/org/org.go Outdated Show resolved Hide resolved

wxiaoguang reviewed Jan 30, 2025

View reviewed changes

tests/integration/api_org_test.go Outdated Show resolved Hide resolved

wxiaoguang marked this pull request as draft January 31, 2025 12:51

wxiaoguang self-assigned this Jan 31, 2025

wxiaoguang added 2 commits January 31, 2025 21:01

fix err handling

fde7447

fix tests

066d661

wxiaoguang marked this pull request as ready for review January 31, 2025 13:19

wxiaoguang removed their assignment Jan 31, 2025

lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Feb 1, 2025

Merge branch 'main' into feature/rename-org-api

47f49ad

lunny enabled auto-merge (squash) February 1, 2025 00:13

Merge branch 'main' into feature/rename-org-api

9bd1dcc

lunny merged commit 040c830 into go-gitea:main Feb 1, 2025
26 checks passed

GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Feb 1, 2025

go-gitea locked as resolved and limited conversation to collaborators May 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Inclusion of rename organization api #33303

Inclusion of rename organization api #33303

Uh oh!

bsofiato commented Jan 16, 2025

Uh oh!

Uh oh!

yp05327 commented Jan 17, 2025 •

edited

Loading

Uh oh!

lunny commented Jan 17, 2025

Uh oh!

bsofiato commented Jan 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wxiaoguang commented Jan 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Inclusion of rename organization api #33303

Inclusion of rename organization api #33303

Uh oh!

Conversation

bsofiato commented Jan 16, 2025

Uh oh!

Uh oh!

yp05327 commented Jan 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lunny commented Jan 17, 2025

Uh oh!

bsofiato commented Jan 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wxiaoguang commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

yp05327 commented Jan 17, 2025 •

edited

Loading

wxiaoguang commented Jan 31, 2025 •

edited

Loading