drone/types/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

43 lines
1.7 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 types
import (
"github.com/harness/gitness/types/enum"
)
/*
* Represents a space.
* There isn't a one-solves-all hierarchical data structure for DBs,
* so for now we are using a mix of materialized paths and adjacency list.
* Every space stores its parent, and a space's path is stored in a separate table.
* PRO: Quick lookup of childs, quick lookup based on fqdn (apis)
* CON: Changing a space name requires changing all its ancestors' Paths.
*
* Interesting reads:
* https://stackoverflow.com/questions/4048151/what-are-the-options-for-storing-hierarchical-data-in-a-relational-database
* https://www.slideshare.net/billkarwin/models-for-hierarchical-data
*/
type Space struct {
ID int64 `db:"space_id" json:"id"`
Name string `db:"space_name" json:"name"`
Path string `db:"space_path" json:"path"`
ParentId int64 `db:"space_parentId" json:"parentId"`
DisplayName string `db:"space_displayName" json:"displayName"`
Description string `db:"space_description" json:"description"`
IsPublic bool `db:"space_isPublic" json:"isPublic"`
CreatedBy int64 `db:"space_createdBy" json:"createdBy"`
Created int64 `db:"space_created" json:"created"`
Updated int64 `db:"space_updated" json:"updated"`
}
// Stores spaces query parameters.
type SpaceFilter struct {
Page int `json:"page"`
Size int `json:"size"`
Sort enum.SpaceAttr `json:"sort"`
Order enum.Order `json:"direction"`
}