drone/internal/api/middleware/space/space.go
Johannes Batzill 1115a5083b Add Paths support and error improvements (#11)
This change is adding the concept of Paths.
A repository and space always have a Primary Path which always is represents the ancestry to the root space.
All access history / resource visibility / child listings / UI traversal / etc. is done via that path.

Additionally, repos and spaces can have Alias Paths, which as the name states are aliases. via the primary path.
They sole impact is that a space or repo can be reached via different paths from the UI / rest apis / git apis.
This fulfills two major purposes:
- Customers can rename or move projects and spaces without breaking any existing references from CI pipeliens / code bases / local repos / ...
- Customer can create shorter aliases for important repos when in harness embeded mode! (acc/org/proj/repo can be shortened to acc/repo, or acc/repo'

Apart from the path changes, this PR adds:

Improved User facing errors
Improved internal error handling and wrapping
update / rename operation for repo and space
path list / delete / create operation for repo and space
2022-09-08 21:39:15 -07:00

67 lines
1.9 KiB
Go

// Copyright 2021 Harness Inc. All rights reserved.
// Use of this source code is governed by the Polyform Free Trial License
// that can be found in the LICENSE.md file for this repository.
package space
import (
"errors"
"net/http"
"strconv"
"github.com/harness/gitness/internal/api/render"
"github.com/harness/gitness/internal/api/request"
"github.com/harness/gitness/internal/store"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/errs"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
/*
* Required returns an http.HandlerFunc middleware that resolves the
* space using the fqsn from the request and injects it into the request.
* In case the fqsn isn't found or the space doesn't exist an error is rendered.
*/
func Required(spaces store.SpaceStore) func(http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ref, err := request.GetSpaceRef(r)
if err != nil {
render.BadRequest(w, err)
return
}
ctx := r.Context()
var space *types.Space
// check if ref is spaceId - ASSUMPTION: digit only is no valid space name
id, err := strconv.ParseInt(ref, 10, 64)
if err == nil {
space, err = spaces.Find(ctx, id)
} else {
space, err = spaces.FindByPath(ctx, ref)
}
if errors.Is(err, errs.ResourceNotFound) {
render.NotFoundf(w, "Space not found.")
return
} else if err != nil {
log.Err(err).Msgf("Failed to get space using ref '%s'.", ref)
render.InternalError(w, errs.Internal)
return
}
// Update the logging context and inject repo in context
log.Ctx(ctx).UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Int64("space_id", space.ID).Str("space_path", space.Path)
})
next.ServeHTTP(w, r.WithContext(
request.WithSpace(ctx, space),
))
})
}
}