agola/internal/services/gateway/action/org.go
Simone Gotti c1da3ab566 *: Improve error handling
* Create an APIError that should only be used for api returned errors.
  It'll wrap an error and can have different Kinds and optional code and
  message.
* The http handlers will use the first APIError available in the
  error chain and generate a json response body containing the code and
  the user message. The wrapped error is internal and is not sent in the
  response.
  If no api error is available in the chain a generic internal
  server error will be returned.
* Add a RemoteError type that will be created from remote services calls
  (runservice, configstore). It's similar to the APIError but a
  different type to not propagate to the caller response and it'll not
  contain any wrapped error.
* Gateway: when we call a remote service, by default, we'll create a
  APIError using the RemoteError Kind (omitting the code and the
  message that usually must not be propagated).
  This is done for all the remote service calls as a starting point, in
  future, if this default behavior is not the right one for a specific
  remote service call, a new api error with a different kind and/or
  augmented with the calling service error codes and user messages could
  be created.
* datamanager: Use a dedicated ErrNotExist (and converting objectstorage
  ErrNotExist).
2022-02-25 16:11:19 +01:00

196 lines
5.8 KiB
Go

// Copyright 2019 Sorint.lab
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied
// See the License for the specific language governing permissions and
// limitations under the License.
package action
import (
"context"
"agola.io/agola/internal/services/gateway/common"
"agola.io/agola/internal/util"
cstypes "agola.io/agola/services/configstore/types"
errors "golang.org/x/xerrors"
)
func (h *ActionHandler) GetOrg(ctx context.Context, orgRef string) (*cstypes.Organization, error) {
org, _, err := h.configstoreClient.GetOrg(ctx, orgRef)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
return org, nil
}
type GetOrgsRequest struct {
Start string
Limit int
Asc bool
}
func (h *ActionHandler) GetOrgs(ctx context.Context, req *GetOrgsRequest) ([]*cstypes.Organization, error) {
orgs, _, err := h.configstoreClient.GetOrgs(ctx, req.Start, req.Limit, req.Asc)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
return orgs, nil
}
type OrgMembersResponse struct {
Organization *cstypes.Organization
Members []*OrgMemberResponse
}
type OrgMemberResponse struct {
User *cstypes.User
Role cstypes.MemberRole
}
func (h *ActionHandler) GetOrgMembers(ctx context.Context, orgRef string) (*OrgMembersResponse, error) {
org, _, err := h.configstoreClient.GetOrg(ctx, orgRef)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
orgMembers, _, err := h.configstoreClient.GetOrgMembers(ctx, orgRef)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
res := &OrgMembersResponse{
Organization: org,
Members: make([]*OrgMemberResponse, len(orgMembers)),
}
for i, orgMember := range orgMembers {
res.Members[i] = &OrgMemberResponse{
User: orgMember.User,
Role: orgMember.Role,
}
}
return res, nil
}
type CreateOrgRequest struct {
Name string
Visibility cstypes.Visibility
CreatorUserID string
}
func (h *ActionHandler) CreateOrg(ctx context.Context, req *CreateOrgRequest) (*cstypes.Organization, error) {
if !common.IsUserLoggedOrAdmin(ctx) {
return nil, errors.Errorf("user not logged in")
}
if req.Name == "" {
return nil, util.NewAPIError(util.ErrBadRequest, errors.Errorf("organization name required"))
}
if !util.ValidateName(req.Name) {
return nil, util.NewAPIError(util.ErrBadRequest, errors.Errorf("invalid organization name %q", req.Name))
}
org := &cstypes.Organization{
Name: req.Name,
Visibility: req.Visibility,
}
if req.CreatorUserID != "" {
org.CreatorUserID = req.CreatorUserID
}
h.log.Infof("creating organization")
org, _, err := h.configstoreClient.CreateOrg(ctx, org)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), errors.Errorf("failed to create organization: %w", err))
}
h.log.Infof("organization %s created, ID: %s", org.Name, org.ID)
return org, nil
}
func (h *ActionHandler) DeleteOrg(ctx context.Context, orgRef string) error {
org, _, err := h.configstoreClient.GetOrg(ctx, orgRef)
if err != nil {
return util.NewAPIError(util.KindFromRemoteError(err), err)
}
isOrgOwner, err := h.IsOrgOwner(ctx, org.ID)
if err != nil {
return errors.Errorf("failed to determine ownership: %w", err)
}
if !isOrgOwner {
return util.NewAPIError(util.ErrForbidden, errors.Errorf("user not authorized"))
}
if _, err := h.configstoreClient.DeleteOrg(ctx, orgRef); err != nil {
return util.NewAPIError(util.KindFromRemoteError(err), errors.Errorf("failed to delete org: %w", err))
}
return nil
}
type AddOrgMemberResponse struct {
OrganizationMember *cstypes.OrganizationMember
Org *cstypes.Organization
User *cstypes.User
}
func (h *ActionHandler) AddOrgMember(ctx context.Context, orgRef, userRef string, role cstypes.MemberRole) (*AddOrgMemberResponse, error) {
org, _, err := h.configstoreClient.GetOrg(ctx, orgRef)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
user, _, err := h.configstoreClient.GetUser(ctx, userRef)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), err)
}
isOrgOwner, err := h.IsOrgOwner(ctx, org.ID)
if err != nil {
return nil, errors.Errorf("failed to determine ownership: %w", err)
}
if !isOrgOwner {
return nil, util.NewAPIError(util.ErrForbidden, errors.Errorf("user not authorized"))
}
orgmember, _, err := h.configstoreClient.AddOrgMember(ctx, orgRef, userRef, role)
if err != nil {
return nil, util.NewAPIError(util.KindFromRemoteError(err), errors.Errorf("failed to add/update organization member: %w", err))
}
return &AddOrgMemberResponse{
OrganizationMember: orgmember,
Org: org,
User: user,
}, nil
}
func (h *ActionHandler) RemoveOrgMember(ctx context.Context, orgRef, userRef string) error {
org, _, err := h.configstoreClient.GetOrg(ctx, orgRef)
if err != nil {
return util.NewAPIError(util.KindFromRemoteError(err), err)
}
isOrgOwner, err := h.IsOrgOwner(ctx, org.ID)
if err != nil {
return errors.Errorf("failed to determine ownership: %w", err)
}
if !isOrgOwner {
return util.NewAPIError(util.ErrForbidden, errors.Errorf("user not authorized"))
}
if _, err = h.configstoreClient.RemoveOrgMember(ctx, orgRef, userRef); err != nil {
return util.NewAPIError(util.KindFromRemoteError(err), errors.Errorf("failed to remove organization member: %w", err))
}
return nil
}