|
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
|
|
|
|
|
|
package convert
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"fmt"
|
|
|
|
|
"net/url"
|
|
|
|
|
"strings"
|
|
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
|
|
|
"code.gitea.io/gitea/modules/label"
|
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func ToIssue(ctx context.Context, issue *issues_model.Issue) *api.Issue {
|
|
|
|
|
return toIssue(ctx, issue, WebAssetDownloadURL)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToAPIIssue converts an Issue to API format
|
|
|
|
|
// it assumes some fields assigned with values:
|
|
|
|
|
// Required - Poster, Labels,
|
|
|
|
|
// Optional - Milestone, Assignee, PullRequest
|
|
|
|
|
func ToAPIIssue(ctx context.Context, issue *issues_model.Issue) *api.Issue {
|
|
|
|
|
return toIssue(ctx, issue, APIAssetDownloadURL)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func toIssue(ctx context.Context, issue *issues_model.Issue, getDownloadURL func(repo *repo_model.Repository, attach *repo_model.Attachment) string) *api.Issue {
|
|
|
|
|
if err := issue.LoadLabels(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
if err := issue.LoadPoster(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
if err := issue.LoadRepo(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
apiIssue := &api.Issue{
|
|
|
|
|
ID: issue.ID,
|
|
|
|
|
Index: issue.Index,
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2 years ago
|
|
|
Poster: ToUser(ctx, issue.Poster, nil),
|
|
|
|
|
Title: issue.Title,
|
|
|
|
|
Body: issue.Content,
|
|
|
|
|
Attachments: toAttachments(issue.Repo, issue.Attachments, getDownloadURL),
|
|
|
|
|
Ref: issue.Ref,
|
|
|
|
|
State: issue.State(),
|
|
|
|
|
IsLocked: issue.IsLocked,
|
|
|
|
|
Comments: issue.NumComments,
|
|
|
|
|
Created: issue.CreatedUnix.AsTime(),
|
|
|
|
|
Updated: issue.UpdatedUnix.AsTime(),
|
|
|
|
|
PinOrder: issue.PinOrder,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if issue.Repo != nil {
|
|
|
|
|
if err := issue.Repo.LoadOwner(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
apiIssue.URL = issue.APIURL(ctx)
|
|
|
|
|
apiIssue.HTMLURL = issue.HTMLURL()
|
|
|
|
|
apiIssue.Labels = ToLabelList(issue.Labels, issue.Repo, issue.Repo.Owner)
|
|
|
|
|
apiIssue.Repo = &api.RepositoryMeta{
|
|
|
|
|
ID: issue.Repo.ID,
|
|
|
|
|
Name: issue.Repo.Name,
|
|
|
|
|
Owner: issue.Repo.OwnerName,
|
|
|
|
|
FullName: issue.Repo.FullName(),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if issue.ClosedUnix != 0 {
|
|
|
|
|
apiIssue.Closed = issue.ClosedUnix.AsTimePtr()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if err := issue.LoadMilestone(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
if issue.Milestone != nil {
|
|
|
|
|
apiIssue.Milestone = ToAPIMilestone(issue.Milestone)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if err := issue.LoadAssignees(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
if len(issue.Assignees) > 0 {
|
|
|
|
|
for _, assignee := range issue.Assignees {
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2 years ago
|
|
|
apiIssue.Assignees = append(apiIssue.Assignees, ToUser(ctx, assignee, nil))
|
|
|
|
|
}
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2 years ago
|
|
|
apiIssue.Assignee = ToUser(ctx, issue.Assignees[0], nil) // For compatibility, we're keeping the first assignee as `apiIssue.Assignee`
|
|
|
|
|
}
|
|
|
|
|
if issue.IsPull {
|
|
|
|
|
if err := issue.LoadPullRequest(ctx); err != nil {
|
|
|
|
|
return &api.Issue{}
|
|
|
|
|
}
|
|
|
|
|
if issue.PullRequest != nil {
|
|
|
|
|
apiIssue.PullRequest = &api.PullRequestMeta{
|
|
|
|
|
HasMerged: issue.PullRequest.HasMerged,
|
|
|
|
|
}
|
|
|
|
|
if issue.PullRequest.HasMerged {
|
|
|
|
|
apiIssue.PullRequest.Merged = issue.PullRequest.MergedUnix.AsTimePtr()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if issue.DeadlineUnix != 0 {
|
|
|
|
|
apiIssue.Deadline = issue.DeadlineUnix.AsTimePtr()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return apiIssue
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToIssueList converts an IssueList to API format
|
|
|
|
|
func ToIssueList(ctx context.Context, il issues_model.IssueList) []*api.Issue {
|
|
|
|
|
result := make([]*api.Issue, len(il))
|
|
|
|
|
for i := range il {
|
|
|
|
|
result[i] = ToIssue(ctx, il[i])
|
|
|
|
|
}
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToAPIIssueList converts an IssueList to API format
|
|
|
|
|
func ToAPIIssueList(ctx context.Context, il issues_model.IssueList) []*api.Issue {
|
|
|
|
|
result := make([]*api.Issue, len(il))
|
|
|
|
|
for i := range il {
|
|
|
|
|
result[i] = ToAPIIssue(ctx, il[i])
|
|
|
|
|
}
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToTrackedTime converts TrackedTime to API format
|
|
|
|
|
func ToTrackedTime(ctx context.Context, t *issues_model.TrackedTime) (apiT *api.TrackedTime) {
|
|
|
|
|
apiT = &api.TrackedTime{
|
|
|
|
|
ID: t.ID,
|
|
|
|
|
IssueID: t.IssueID,
|
|
|
|
|
UserID: t.UserID,
|
|
|
|
|
Time: t.Time,
|
|
|
|
|
Created: t.Created,
|
|
|
|
|
}
|
|
|
|
|
if t.Issue != nil {
|
|
|
|
|
apiT.Issue = ToAPIIssue(ctx, t.Issue)
|
|
|
|
|
}
|
|
|
|
|
if t.User != nil {
|
|
|
|
|
apiT.UserName = t.User.Name
|
|
|
|
|
}
|
|
|
|
|
return apiT
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToStopWatches convert Stopwatch list to api.StopWatches
|
|
|
|
|
func ToStopWatches(sws []*issues_model.Stopwatch) (api.StopWatches, error) {
|
|
|
|
|
result := api.StopWatches(make([]api.StopWatch, 0, len(sws)))
|
|
|
|
|
|
|
|
|
|
issueCache := make(map[int64]*issues_model.Issue)
|
|
|
|
|
repoCache := make(map[int64]*repo_model.Repository)
|
|
|
|
|
var (
|
|
|
|
|
issue *issues_model.Issue
|
|
|
|
|
repo *repo_model.Repository
|
|
|
|
|
ok bool
|
|
|
|
|
err error
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
for _, sw := range sws {
|
|
|
|
|
issue, ok = issueCache[sw.IssueID]
|
|
|
|
|
if !ok {
|
|
|
|
|
issue, err = issues_model.GetIssueByID(db.DefaultContext, sw.IssueID)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
repo, ok = repoCache[issue.RepoID]
|
|
|
|
|
if !ok {
|
|
|
|
|
repo, err = repo_model.GetRepositoryByID(db.DefaultContext, issue.RepoID)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
result = append(result, api.StopWatch{
|
|
|
|
|
Created: sw.CreatedUnix.AsTime(),
|
|
|
|
|
Seconds: sw.Seconds(),
|
|
|
|
|
Duration: sw.Duration(),
|
|
|
|
|
IssueIndex: issue.Index,
|
|
|
|
|
IssueTitle: issue.Title,
|
|
|
|
|
RepoOwnerName: repo.OwnerName,
|
|
|
|
|
RepoName: repo.Name,
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
return result, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToTrackedTimeList converts TrackedTimeList to API format
|
|
|
|
|
func ToTrackedTimeList(ctx context.Context, tl issues_model.TrackedTimeList) api.TrackedTimeList {
|
|
|
|
|
result := make([]*api.TrackedTime, 0, len(tl))
|
|
|
|
|
for _, t := range tl {
|
|
|
|
|
result = append(result, ToTrackedTime(ctx, t))
|
|
|
|
|
}
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToLabel converts Label to API format
|
|
|
|
|
func ToLabel(label *issues_model.Label, repo *repo_model.Repository, org *user_model.User) *api.Label {
|
|
|
|
|
result := &api.Label{
|
|
|
|
|
ID: label.ID,
|
|
|
|
|
Name: label.Name,
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2 years ago
|
|
|
Exclusive: label.Exclusive,
|
|
|
|
|
Color: strings.TrimLeft(label.Color, "#"),
|
|
|
|
|
Description: label.Description,
|
|
|
|
|
IsArchived: label.IsArchived(),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// calculate URL
|
|
|
|
|
if label.BelongsToRepo() && repo != nil {
|
|
|
|
|
if repo != nil {
|
|
|
|
|
result.URL = fmt.Sprintf("%s/labels/%d", repo.APIURL(), label.ID)
|
|
|
|
|
} else {
|
|
|
|
|
log.Error("ToLabel did not get repo to calculate url for label with id '%d'", label.ID)
|
|
|
|
|
}
|
|
|
|
|
} else { // BelongsToOrg
|
|
|
|
|
if org != nil {
|
|
|
|
|
result.URL = fmt.Sprintf("%sapi/v1/orgs/%s/labels/%d", setting.AppURL, url.PathEscape(org.Name), label.ID)
|
|
|
|
|
} else {
|
|
|
|
|
log.Error("ToLabel did not get org to calculate url for label with id '%d'", label.ID)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToLabelList converts list of Label to API format
|
|
|
|
|
func ToLabelList(labels []*issues_model.Label, repo *repo_model.Repository, org *user_model.User) []*api.Label {
|
|
|
|
|
result := make([]*api.Label, len(labels))
|
|
|
|
|
for i := range labels {
|
|
|
|
|
result[i] = ToLabel(labels[i], repo, org)
|
|
|
|
|
}
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToAPIMilestone converts Milestone into API Format
|
|
|
|
|
func ToAPIMilestone(m *issues_model.Milestone) *api.Milestone {
|
|
|
|
|
apiMilestone := &api.Milestone{
|
|
|
|
|
ID: m.ID,
|
|
|
|
|
State: m.State(),
|
|
|
|
|
Title: m.Name,
|
|
|
|
|
Description: m.Content,
|
|
|
|
|
OpenIssues: m.NumOpenIssues,
|
|
|
|
|
ClosedIssues: m.NumClosedIssues,
|
|
|
|
|
Created: m.CreatedUnix.AsTime(),
|
|
|
|
|
Updated: m.UpdatedUnix.AsTimePtr(),
|
|
|
|
|
}
|
|
|
|
|
if m.IsClosed {
|
|
|
|
|
apiMilestone.Closed = m.ClosedDateUnix.AsTimePtr()
|
|
|
|
|
}
|
|
|
|
|
if m.DeadlineUnix.Year() < 9999 {
|
|
|
|
|
apiMilestone.Deadline = m.DeadlineUnix.AsTimePtr()
|
|
|
|
|
}
|
|
|
|
|
return apiMilestone
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToLabelTemplate converts Label to API format
|
|
|
|
|
func ToLabelTemplate(label *label.Label) *api.LabelTemplate {
|
|
|
|
|
result := &api.LabelTemplate{
|
|
|
|
|
Name: label.Name,
|
|
|
|
|
Exclusive: label.Exclusive,
|
|
|
|
|
Color: strings.TrimLeft(label.Color, "#"),
|
|
|
|
|
Description: label.Description,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return result
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ToLabelTemplateList converts list of Label to API format
|
|
|
|
|
func ToLabelTemplateList(labels []*label.Label) []*api.LabelTemplate {
|
|
|
|
|
result := make([]*api.LabelTemplate, len(labels))
|
|
|
|
|
for i := range labels {
|
|
|
|
|
result[i] = ToLabelTemplate(labels[i])
|
|
|
|
|
}
|
|
|
|
|
return result
|
|
|
|
|
}
|
