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.

Sign up for GitHub

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

docs/openapi/v2.yamlにbotを弾くクエリパラメータの記述を追加 #1103

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

docs/openapi/v2.yamlにbotを弾くクエリパラメータの記述を追加 #1103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
edb7deb
v2.yamlにbotを弾くクエリパラメータの記述を追加
w4mally Jan 13, 2025
47b0649
デフォルトをtrueに指定
w4mally Jan 13, 2025
218560b
users.goにbotクエリパラメータ取得ロジックを追加
w4mally Jan 25, 2025
906c51a
v1/service/src/user.goでbotユーザーを弾くようなフィルタリングを実装
w4mally Mar 3, 2025
69c03bd
testの修正とuserAuth.GetAllActiveUsersにbotを弾くフィルタリングを実装
w4mally Mar 17, 2025
b67fc1b
冗長な書き方を修正
w4mally Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/openapi/v2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,16 @@ paths:
get:
tags:
- user
parameters:
- name: bot
in: query
required: false
schema:
type: boolean
default: true
description: |
falseの場合botを除外します。
デフォルトではbotも含めます。
security:
- TrapMemberAuth: []
operationId: getUsers
Expand Down
10 changes: 9 additions & 1 deletion src/auth/traQ/user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
ID uuid.UUID `json:"id"`
Name string `json:"name"`
State int `json:"state"`
Bot bool `json:"bot"`
}

func (u *User) GetMe(ctx context.Context, session *domain.OIDCSession) (*service.UserInfo, error) {
Expand Down Expand Up @@ -87,17 +88,21 @@
return nil, fmt.Errorf("unexpected state: %d", response.State)
}

var bot bool = response.Bot

Check failure on line 91 in src/auth/traQ/user.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] src/auth/traQ/user.go#L91 

var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
Raw output 
src/auth/traQ/user.go:91:10: var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
	var bot bool = response.Bot
	        ^

return service.NewUserInfo(
values.NewTrapMemberID(response.ID),
values.NewTrapMemberName(response.Name),
status,
bot,
), nil
}

type getUsersResponse struct {
ID uuid.UUID `json:"id"`
Name string `json:"name"`
State int `json:"state"`
Bot bool `json:"bot"`
}

// GetAllActiveUsers
Expand Down Expand Up @@ -147,11 +152,12 @@
default:
return nil, fmt.Errorf("unexpected state: %d", user.State)
}

var bot bool = user.Bot

Check failure on line 155 in src/auth/traQ/user.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] src/auth/traQ/user.go#L155 

var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
Raw output 
src/auth/traQ/user.go:155:11: var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
		var bot bool = user.Bot
		        ^
users = append(users, service.NewUserInfo(
values.NewTrapMemberID(user.ID),
values.NewTrapMemberName(user.Name),
status,
bot,
))
}

Expand Down Expand Up @@ -203,11 +209,13 @@
default:
return nil, fmt.Errorf("unexpected state: %d", user.State)
}
var bot bool = user.Bot

Check failure on line 212 in src/auth/traQ/user.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] src/auth/traQ/user.go#L212 

var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
Raw output 
src/auth/traQ/user.go:212:11: var-declaration: should omit type bool from declaration of var bot; it will be inferred from the right-hand side (revive)
		var bot bool = user.Bot
		        ^

users = append(users, service.NewUserInfo(
values.NewTrapMemberID(user.ID),
values.NewTrapMemberName(user.Name),
status,
bot,
))
}

Expand Down
13 changes: 13 additions & 0 deletions src/auth/traQ/user_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ func TestGetMe(t *testing.T) {
values.NewTrapMemberID(id),
"mazrean",
values.TrapMemberStatusActive,
false,
),
},
{
Expand Down Expand Up @@ -187,6 +188,7 @@ func TestGetMe(t *testing.T) {
values.NewTrapMemberID(id),
"mazrean",
values.TrapMemberStatusDeactivated,
false,
),
},
{
Expand All @@ -206,6 +208,7 @@ func TestGetMe(t *testing.T) {
values.NewTrapMemberID(id),
"mazrean",
values.TrapMemberStatusSuspended,
false,
),
},
{
Expand Down Expand Up @@ -395,6 +398,7 @@ func TestGetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down Expand Up @@ -439,6 +443,7 @@ func TestGetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusDeactivated,
false,
),
},
},
Expand All @@ -462,6 +467,7 @@ func TestGetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusSuspended,
false,
),
},
},
Expand Down Expand Up @@ -518,11 +524,13 @@ func TestGetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusActive,
false,
),
service.NewUserInfo(
values.NewTrapMemberID(id2),
"mazrean2",
values.TrapMemberStatusDeactivated,
false,
),
},
},
Expand Down Expand Up @@ -701,6 +709,7 @@ func TestGetActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down Expand Up @@ -745,6 +754,7 @@ func TestGetActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusDeactivated,
false,
),
},
},
Expand All @@ -768,6 +778,7 @@ func TestGetActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusSuspended,
false,
),
},
},
Expand Down Expand Up @@ -824,11 +835,13 @@ func TestGetActiveUsers(t *testing.T) {
values.NewTrapMemberID(id1),
"mazrean",
values.TrapMemberStatusActive,
false,
),
service.NewUserInfo(
values.NewTrapMemberID(id2),
"mazrean2",
values.TrapMemberStatusDeactivated,
false,
),
},
},
Expand Down
12 changes: 12 additions & 0 deletions src/cache/ristretto/user_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ func TestGetMe(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
{
Expand Down Expand Up @@ -128,6 +129,7 @@ func TestSetMe(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
{
Expand All @@ -137,12 +139,14 @@ func TestSetMe(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
accessToken: values.NewOIDCAccessToken("access token2"),
userInfo: service.NewUserInfo(
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
}
Expand Down Expand Up @@ -241,6 +245,7 @@ func TestGetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down Expand Up @@ -333,6 +338,7 @@ func TestSetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand All @@ -348,13 +354,15 @@ func TestSetAllActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
users: []*service.UserInfo{
service.NewUserInfo(
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down Expand Up @@ -439,6 +447,7 @@ func TestGetActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down Expand Up @@ -531,6 +540,7 @@ func TestSetActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand All @@ -546,13 +556,15 @@ func TestSetActiveUsers(t *testing.T) {
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
users: []*service.UserInfo{
service.NewUserInfo(
values.NewTrapMemberID(uuid.New()),
values.NewTrapMemberName("mazrean"),
values.TrapMemberStatusActive,
false,
),
},
},
Expand Down
18 changes: 9 additions & 9 deletions src/handler/v2/admin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func TestGetAdmins(t *testing.T) {
),
executeGetAdmins: true,
adminInfos: []*service.UserInfo{
service.NewUserInfo(adminID1, "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(adminID1, "ikura-hamu", values.TrapMemberStatusActive, false),
},
GetAdminsErr: nil,
apiAdmins: []*openapi.User{
Expand Down Expand Up @@ -122,8 +122,8 @@ func TestGetAdmins(t *testing.T) {
executeGetAdmins: true,
GetAdminsErr: nil,
adminInfos: []*service.UserInfo{
service.NewUserInfo(adminID1, "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(adminID2, "mazrean", values.TrapMemberStatusActive),
service.NewUserInfo(adminID1, "ikura-hamu", values.TrapMemberStatusActive, false),
service.NewUserInfo(adminID2, "mazrean", values.TrapMemberStatusActive, false),
},
apiAdmins: []*openapi.User{
{Id: uuid.UUID(adminID1), Name: "ikura-hamu"},
Expand Down Expand Up @@ -270,7 +270,7 @@ func TestPostAdmins(t *testing.T) {
),
executeAddAdmin: true,
adminInfos: []*service.UserInfo{
service.NewUserInfo(userID1, "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(userID1, "ikura-hamu", values.TrapMemberStatusActive, false),
},
apiAdmins: []*openapi.User{
{Id: uuid.UUID(userID1), Name: "ikura-hamu"},
Expand Down Expand Up @@ -348,8 +348,8 @@ func TestPostAdmins(t *testing.T) {
),
executeAddAdmin: true,
adminInfos: []*service.UserInfo{
service.NewUserInfo(userID2, "mazrean", values.TrapMemberStatusActive),
service.NewUserInfo(userID1, "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(userID2, "mazrean", values.TrapMemberStatusActive, false),
service.NewUserInfo(userID1, "ikura-hamu", values.TrapMemberStatusActive, false),
},
apiAdmins: []*openapi.User{
{Id: uuid.UUID(userID2), Name: "mazrean"},
Expand Down Expand Up @@ -506,7 +506,7 @@ func TestDeleteAdmin(t *testing.T) {
),
executeDeleteAdmin: true,
adminInfos: []*service.UserInfo{
service.NewUserInfo(values.TraPMemberID(userID2), "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(values.TraPMemberID(userID2), "ikura-hamu", values.TrapMemberStatusActive, false),
},
apiAdmins: []*openapi.User{
{Id: userID2, Name: "ikura-hamu"},
Expand Down Expand Up @@ -586,8 +586,8 @@ func TestDeleteAdmin(t *testing.T) {
adminID: userID1,
executeDeleteAdmin: true,
adminInfos: []*service.UserInfo{
service.NewUserInfo(values.TraPMemberID(userID2), "ikura-hamu", values.TrapMemberStatusActive),
service.NewUserInfo(values.TraPMemberID(userID3), "mazrean", values.TrapMemberStatusActive),
service.NewUserInfo(values.TraPMemberID(userID2), "ikura-hamu", values.TrapMemberStatusActive, false),
service.NewUserInfo(values.TraPMemberID(userID3), "mazrean", values.TrapMemberStatusActive, false),
},
apiAdmins: []*openapi.User{
{Id: userID2, Name: "ikura-hamu"},
Expand Down
4 changes: 2 additions & 2 deletions src/handler/v2/game_genre_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,8 @@ func TestPutGameGenres(t *testing.T) {

userNameStr1 := "ikura-hamu"
userNameStr2 := "mazrean"
user1 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), values.NewTrapMemberName(userNameStr1), values.TrapMemberStatusActive)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), values.NewTrapMemberName(userNameStr2), values.TrapMemberStatusActive)
user1 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), values.NewTrapMemberName(userNameStr1), values.TrapMemberStatusActive, false)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), values.NewTrapMemberName(userNameStr2), values.TrapMemberStatusActive, false)

testCases := map[string]test{
"特に問題ないのでエラー無し": {
Expand Down
8 changes: 4 additions & 4 deletions src/handler/v2/game_role_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ func TestPatchGameRole(t *testing.T) {
defer ctrl.Finish()

game := domain.NewGame(values.NewGameID(), "game1", "game1 description", values.GameVisibilityTypePrivate, time.Now())
user := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user1", values.TrapMemberStatusActive)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user2", values.TrapMemberStatusActive)
user := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user1", values.TrapMemberStatusActive, false)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user2", values.TrapMemberStatusActive, false)
genre := domain.NewGameGenre(values.NewGameGenreID(), "genre1", time.Now())

var (
Expand Down Expand Up @@ -442,8 +442,8 @@ func TestDeleteGameRole(t *testing.T) {
defer ctrl.Finish()

game := domain.NewGame(values.NewGameID(), "game1", "game1 description", values.GameVisibilityTypePrivate, time.Now())
user := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user1", values.TrapMemberStatusActive)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user2", values.TrapMemberStatusActive)
user := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user1", values.TrapMemberStatusActive, false)
user2 := service.NewUserInfo(values.NewTrapMemberID(uuid.New()), "user2", values.TrapMemberStatusActive, false)
genre1 := domain.NewGameGenre(values.NewGameGenreID(), "genre1", time.Now())

validAuthSession := domain.NewOIDCSession(values.NewOIDCAccessToken("token"), time.Now().Add(time.Hour))
Expand Down
Loading
Loading