Chore: Moves common and response into separate packages (#30298)

* Chore: moves common and response into separate packages

* Chore: moves common and response into separate packages

* Update pkg/api/utils/common.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Chore: changes after PR comments

* Chore: move wrap to routing package

* Chore: move functions in common to response package

* Chore: move functions in common to response package

* Chore: formats imports

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
Hugo Häggmark
2021-01-15 14:43:20 +01:00
committed by GitHub
co-authored by Arve Knudsen
parent a94c256516
commit 3d41267fc4
51 changed files with 1321 additions and 1248 deletions
+34 -33
View File
@@ -4,6 +4,7 @@ import (
"errors"
"github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/bus"
"github.com/grafana/grafana/pkg/infra/metrics"
"github.com/grafana/grafana/pkg/models"
@@ -12,24 +13,24 @@ import (
)
// GET /api/org
func GetOrgCurrent(c *models.ReqContext) Response {
func GetOrgCurrent(c *models.ReqContext) response.Response {
return getOrgHelper(c.OrgId)
}
// GET /api/orgs/:orgId
func GetOrgByID(c *models.ReqContext) Response {
func GetOrgByID(c *models.ReqContext) response.Response {
return getOrgHelper(c.ParamsInt64(":orgId"))
}
// Get /api/orgs/name/:name
func (hs *HTTPServer) GetOrgByName(c *models.ReqContext) Response {
func (hs *HTTPServer) GetOrgByName(c *models.ReqContext) response.Response {
org, err := hs.SQLStore.GetOrgByName(c.Params(":name"))
if err != nil {
if errors.Is(err, models.ErrOrgNotFound) {
return Error(404, "Organization not found", err)
return response.Error(404, "Organization not found", err)
}
return Error(500, "Failed to get organization", err)
return response.Error(500, "Failed to get organization", err)
}
result := models.OrgDetailsDTO{
Id: org.Id,
@@ -44,18 +45,18 @@ func (hs *HTTPServer) GetOrgByName(c *models.ReqContext) Response {
},
}
return JSON(200, &result)
return response.JSON(200, &result)
}
func getOrgHelper(orgID int64) Response {
func getOrgHelper(orgID int64) response.Response {
query := models.GetOrgByIdQuery{Id: orgID}
if err := bus.Dispatch(&query); err != nil {
if errors.Is(err, models.ErrOrgNotFound) {
return Error(404, "Organization not found", err)
return response.Error(404, "Organization not found", err)
}
return Error(500, "Failed to get organization", err)
return response.Error(500, "Failed to get organization", err)
}
org := query.Result
@@ -72,64 +73,64 @@ func getOrgHelper(orgID int64) Response {
},
}
return JSON(200, &result)
return response.JSON(200, &result)
}
// POST /api/orgs
func CreateOrg(c *models.ReqContext, cmd models.CreateOrgCommand) Response {
func CreateOrg(c *models.ReqContext, cmd models.CreateOrgCommand) response.Response {
if !c.IsSignedIn || (!setting.AllowUserOrgCreate && !c.IsGrafanaAdmin) {
return Error(403, "Access denied", nil)
return response.Error(403, "Access denied", nil)
}
cmd.UserId = c.UserId
if err := bus.Dispatch(&cmd); err != nil {
if errors.Is(err, models.ErrOrgNameTaken) {
return Error(409, "Organization name taken", err)
return response.Error(409, "Organization name taken", err)
}
return Error(500, "Failed to create organization", err)
return response.Error(500, "Failed to create organization", err)
}
metrics.MApiOrgCreate.Inc()
return JSON(200, &util.DynMap{
return response.JSON(200, &util.DynMap{
"orgId": cmd.Result.Id,
"message": "Organization created",
})
}
// PUT /api/org
func UpdateOrgCurrent(c *models.ReqContext, form dtos.UpdateOrgForm) Response {
func UpdateOrgCurrent(c *models.ReqContext, form dtos.UpdateOrgForm) response.Response {
return updateOrgHelper(form, c.OrgId)
}
// PUT /api/orgs/:orgId
func UpdateOrg(c *models.ReqContext, form dtos.UpdateOrgForm) Response {
func UpdateOrg(c *models.ReqContext, form dtos.UpdateOrgForm) response.Response {
return updateOrgHelper(form, c.ParamsInt64(":orgId"))
}
func updateOrgHelper(form dtos.UpdateOrgForm, orgID int64) Response {
func updateOrgHelper(form dtos.UpdateOrgForm, orgID int64) response.Response {
cmd := models.UpdateOrgCommand{Name: form.Name, OrgId: orgID}
if err := bus.Dispatch(&cmd); err != nil {
if errors.Is(err, models.ErrOrgNameTaken) {
return Error(400, "Organization name taken", err)
return response.Error(400, "Organization name taken", err)
}
return Error(500, "Failed to update organization", err)
return response.Error(500, "Failed to update organization", err)
}
return Success("Organization updated")
return response.Success("Organization updated")
}
// PUT /api/org/address
func UpdateOrgAddressCurrent(c *models.ReqContext, form dtos.UpdateOrgAddressForm) Response {
func UpdateOrgAddressCurrent(c *models.ReqContext, form dtos.UpdateOrgAddressForm) response.Response {
return updateOrgAddressHelper(form, c.OrgId)
}
// PUT /api/orgs/:orgId/address
func UpdateOrgAddress(c *models.ReqContext, form dtos.UpdateOrgAddressForm) Response {
func UpdateOrgAddress(c *models.ReqContext, form dtos.UpdateOrgAddressForm) response.Response {
return updateOrgAddressHelper(form, c.ParamsInt64(":orgId"))
}
func updateOrgAddressHelper(form dtos.UpdateOrgAddressForm, orgID int64) Response {
func updateOrgAddressHelper(form dtos.UpdateOrgAddressForm, orgID int64) response.Response {
cmd := models.UpdateOrgAddressCommand{
OrgId: orgID,
Address: models.Address{
@@ -143,24 +144,24 @@ func updateOrgAddressHelper(form dtos.UpdateOrgAddressForm, orgID int64) Respons
}
if err := bus.Dispatch(&cmd); err != nil {
return Error(500, "Failed to update org address", err)
return response.Error(500, "Failed to update org address", err)
}
return Success("Address updated")
return response.Success("Address updated")
}
// GET /api/orgs/:orgId
func DeleteOrgByID(c *models.ReqContext) Response {
func DeleteOrgByID(c *models.ReqContext) response.Response {
if err := bus.Dispatch(&models.DeleteOrgCommand{Id: c.ParamsInt64(":orgId")}); err != nil {
if errors.Is(err, models.ErrOrgNotFound) {
return Error(404, "Failed to delete organization. ID not found", nil)
return response.Error(404, "Failed to delete organization. ID not found", nil)
}
return Error(500, "Failed to update organization", err)
return response.Error(500, "Failed to update organization", err)
}
return Success("Organization deleted")
return response.Success("Organization deleted")
}
func SearchOrgs(c *models.ReqContext) Response {
func SearchOrgs(c *models.ReqContext) response.Response {
perPage := c.QueryInt("perpage")
if perPage <= 0 {
perPage = 1000
@@ -176,8 +177,8 @@ func SearchOrgs(c *models.ReqContext) Response {
}
if err := bus.Dispatch(&query); err != nil {
return Error(500, "Failed to search orgs", err)
return response.Error(500, "Failed to search orgs", err)
}
return JSON(200, query.Result)
return response.JSON(200, query.Result)
}