2014-03-20 21:04:56 +01:00
// Copyright 2014 The Gogs Authors. All rights reserved.
2020-01-01 23:51:10 +01:00
// Copyright 2020 The Gitea Authors. All rights reserved.
2022-11-27 19:20:29 +01:00
// SPDX-License-Identifier: MIT
2014-03-20 21:04:56 +01:00
2022-06-13 11:37:59 +02:00
package issues
2014-03-20 21:04:56 +01:00
2014-03-22 18:50:50 +01:00
import (
2021-09-23 17:45:36 +02:00
"context"
2015-08-10 08:42:50 +02:00
"fmt"
2018-01-03 09:34:13 +01:00
"regexp"
2023-09-07 11:37:47 +02:00
"slices"
2014-05-07 22:51:14 +02:00
2021-09-19 13:49:59 +02:00
"code.gitea.io/gitea/models/db"
2022-03-29 16:16:31 +02:00
project_model "code.gitea.io/gitea/models/project"
2021-11-19 14:39:57 +01:00
repo_model "code.gitea.io/gitea/models/repo"
2021-11-24 10:49:20 +01:00
user_model "code.gitea.io/gitea/models/user"
Refactor and enhance issue indexer to support both searching, filtering and paging (#26012)
Fix #24662.
Replace #24822 and #25708 (although it has been merged)
## Background
In the past, Gitea supported issue searching with a keyword and
conditions in a less efficient way. It worked by searching for issues
with the keyword and obtaining limited IDs (as it is heavy to get all)
on the indexer (bleve/elasticsearch/meilisearch), and then querying with
conditions on the database to find a subset of the found IDs. This is
why the results could be incomplete.
To solve this issue, we need to store all fields that could be used as
conditions in the indexer and support both keyword and additional
conditions when searching with the indexer.
## Major changes
- Redefine `IndexerData` to include all fields that could be used as
filter conditions.
- Refactor `Search(ctx context.Context, kw string, repoIDs []int64,
limit, start int, state string)` to `Search(ctx context.Context, options
*SearchOptions)`, so it supports more conditions now.
- Change the data type stored in `issueIndexerQueue`. Use
`IndexerMetadata` instead of `IndexerData` in case the data has been
updated while it is in the queue. This also reduces the storage size of
the queue.
- Enhance searching with Bleve/Elasticsearch/Meilisearch, make them
fully support `SearchOptions`. Also, update the data versions.
- Keep most logic of database indexer, but remove
`issues.SearchIssueIDsByKeyword` in `models` to avoid confusion where is
the entry point to search issues.
- Start a Meilisearch instance to test it in unit tests.
- Add unit tests with almost full coverage to test
Bleve/Elasticsearch/Meilisearch indexer.
---------
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-07-31 08:28:53 +02:00
"code.gitea.io/gitea/modules/container"
2016-11-10 17:24:48 +01:00
"code.gitea.io/gitea/modules/log"
2023-05-25 15:17:19 +02:00
"code.gitea.io/gitea/modules/setting"
2019-05-11 12:21:34 +02:00
api "code.gitea.io/gitea/modules/structs"
2019-08-15 16:46:21 +02:00
"code.gitea.io/gitea/modules/timeutil"
2017-01-25 03:43:02 +01:00
"code.gitea.io/gitea/modules/util"
2017-12-26 00:25:16 +01:00
2019-06-23 17:22:43 +02:00
"xorm.io/builder"
2014-03-22 18:50:50 +01:00
)
2022-06-13 11:37:59 +02:00
// ErrIssueNotExist represents a "IssueNotExist" kind of error.
type ErrIssueNotExist struct {
ID int64
RepoID int64
Index int64
}
// IsErrIssueNotExist checks if an error is a ErrIssueNotExist.
func IsErrIssueNotExist ( err error ) bool {
_ , ok := err . ( ErrIssueNotExist )
return ok
}
func ( err ErrIssueNotExist ) Error ( ) string {
return fmt . Sprintf ( "issue does not exist [id: %d, repo_id: %d, index: %d]" , err . ID , err . RepoID , err . Index )
}
2022-10-18 07:50:37 +02:00
func ( err ErrIssueNotExist ) Unwrap ( ) error {
return util . ErrNotExist
}
2022-06-13 11:37:59 +02:00
// ErrIssueIsClosed represents a "IssueIsClosed" kind of error.
type ErrIssueIsClosed struct {
ID int64
RepoID int64
Index int64
}
// IsErrIssueIsClosed checks if an error is a ErrIssueNotExist.
func IsErrIssueIsClosed ( err error ) bool {
_ , ok := err . ( ErrIssueIsClosed )
return ok
}
func ( err ErrIssueIsClosed ) Error ( ) string {
return fmt . Sprintf ( "issue is closed [id: %d, repo_id: %d, index: %d]" , err . ID , err . RepoID , err . Index )
}
// ErrNewIssueInsert is used when the INSERT statement in newIssue fails
type ErrNewIssueInsert struct {
OriginalError error
}
// IsErrNewIssueInsert checks if an error is a ErrNewIssueInsert.
func IsErrNewIssueInsert ( err error ) bool {
_ , ok := err . ( ErrNewIssueInsert )
return ok
}
func ( err ErrNewIssueInsert ) Error ( ) string {
return err . OriginalError . Error ( )
}
// ErrIssueWasClosed is used when close a closed issue
type ErrIssueWasClosed struct {
ID int64
Index int64
}
// IsErrIssueWasClosed checks if an error is a ErrIssueWasClosed.
func IsErrIssueWasClosed ( err error ) bool {
_ , ok := err . ( ErrIssueWasClosed )
return ok
}
func ( err ErrIssueWasClosed ) Error ( ) string {
return fmt . Sprintf ( "Issue [%d] %d was already closed" , err . ID , err . Index )
}
2014-03-22 18:50:50 +01:00
// Issue represents an issue or pull request of repository.
2014-03-20 21:04:56 +01:00
type Issue struct {
2021-12-10 02:27:50 +01:00
ID int64 ` xorm:"pk autoincr" `
RepoID int64 ` xorm:"INDEX UNIQUE(repo_index)" `
Repo * repo_model . Repository ` xorm:"-" `
Index int64 ` xorm:"UNIQUE(repo_index)" ` // Index in one repository.
PosterID int64 ` xorm:"INDEX" `
Poster * user_model . User ` xorm:"-" `
2019-07-08 04:14:12 +02:00
OriginalAuthor string
2022-06-13 11:37:59 +02:00
OriginalAuthorID int64 ` xorm:"index" `
Title string ` xorm:"name" `
Content string ` xorm:"LONGTEXT" `
RenderedContent string ` xorm:"-" `
Labels [ ] * Label ` xorm:"-" `
MilestoneID int64 ` xorm:"INDEX" `
Milestone * Milestone ` xorm:"-" `
Project * project_model . Project ` xorm:"-" `
2019-07-08 04:14:12 +02:00
Priority int
2021-11-24 10:49:20 +01:00
AssigneeID int64 ` xorm:"-" `
Assignee * user_model . User ` xorm:"-" `
IsClosed bool ` xorm:"INDEX" `
IsRead bool ` xorm:"-" `
IsPull bool ` xorm:"INDEX" ` // Indicates whether is a pull request or not.
PullRequest * PullRequest ` xorm:"-" `
2019-07-08 04:14:12 +02:00
NumComments int
Ref string
2023-05-25 15:17:19 +02:00
PinOrder int ` xorm:"DEFAULT 0" `
2016-03-10 01:53:30 +01:00
2019-08-15 16:46:21 +02:00
DeadlineUnix timeutil . TimeStamp ` xorm:"INDEX" `
2018-05-01 21:05:28 +02:00
2019-08-15 16:46:21 +02:00
CreatedUnix timeutil . TimeStamp ` xorm:"INDEX created" `
UpdatedUnix timeutil . TimeStamp ` xorm:"INDEX updated" `
ClosedUnix timeutil . TimeStamp ` xorm:"INDEX" `
[FEAT] allow setting the update date on issues and comments
This field adds the possibility to set the update date when modifying
an issue through the API.
A 'NoAutoDate' in-memory field is added in the Issue struct.
If the update_at field is set, NoAutoDate is set to true and the
Issue's UpdatedUnix field is filled.
That information is passed down to the functions that actually updates
the database, which have been modified to not auto update dates if
requested.
A guard is added to the 'EditIssue' API call, to checks that the
udpate_at date is between the issue's creation date and the current
date (to avoid 'malicious' changes). It also limits the new feature
to project's owners and admins.
(cherry picked from commit c524d33402c76bc4cccea2806f289e08a009baae)
Add a SetIssueUpdateDate() function in services/issue.go
That function is used by some API calls to set the NoAutoDate and
UpdatedUnix fields of an Issue if an updated_at date is provided.
(cherry picked from commit f061caa6555e0c9e922ee1e73dd2e4337360e9fe)
Add an updated_at field to the API calls related to Issue's Labels.
The update date is applied to the issue's comment created to inform
about the modification of the issue's labels.
(cherry picked from commit ea36cf80f58f0ab20c565a8f5d063b90fd741f97)
Add an updated_at field to the API call for issue's attachment creation
The update date is applied to the issue's comment created to inform
about the modification of the issue's content, and is set as the
asset creation date.
(cherry picked from commit 96150971ca31b97e97e84d5f5eb95a177cc44e2e)
Checking Issue changes, with and without providing an updated_at date
Those unit tests are added:
- TestAPIEditIssueWithAutoDate
- TestAPIEditIssueWithNoAutoDate
- TestAPIAddIssueLabelsWithAutoDate
- TestAPIAddIssueLabelsWithNoAutoDate
- TestAPICreateIssueAttachmentWithAutoDate
- TestAPICreateIssueAttachmentWithNoAutoDate
(cherry picked from commit 4926a5d7a28581003545256632213bf4136b193d)
Add an updated_at field to the API call for issue's comment creation
The update date is used as the comment creation date, and is applied to
the issue as the update creation date.
(cherry picked from commit 76c8faecdc6cba48ca4fe07d1a916d1f1a4b37b4)
Add an updated_at field to the API call for issue's comment edition
The update date is used as the comment update date, and is applied to
the issue as an update date.
(cherry picked from commit cf787ad7fdb8e6273fdc35d7b5cc164b400207e9)
Add an updated_at field to the API call for comment's attachment creation
The update date is applied to the comment, and is set as the asset
creation date.
(cherry picked from commit 1e4ff424d39db7a4256cd9abf9c58b8d3e1b5c14)
Checking Comment changes, with and without providing an updated_at date
Those unit tests are added:
- TestAPICreateCommentWithAutoDate
- TestAPICreateCommentWithNoAutoDate
- TestAPIEditCommentWithAutoDate
- TestAPIEditCommentWithNoAutoDate
- TestAPICreateCommentAttachmentWithAutoDate
- TestAPICreateCommentAttachmentWithNoAutoDate
(cherry picked from commit da932152f1deb3039a399516a51c8b6757059c91)
Pettier code to set the update time of comments
Now uses sess.AllCols().NoAutoToime().SetExpr("updated_unix", ...)
XORM is smart enough to compose one single SQL UPDATE which all
columns + updated_unix.
(cherry picked from commit 1f6a42808dd739c0c2e49e6b7ae2967f120f43c2)
Issue edition: Keep the max of the milestone and issue update dates.
When editing an issue via the API, an updated_at date can be provided.
If the EditIssue call changes the issue's milestone, the milestone's
update date is to be changed accordingly, but only with a greater
value.
This ensures that a milestone's update date is the max of all issue's
update dates.
(cherry picked from commit 8f22ea182e6b49e933dc6534040160dd739ff18a)
Rewrite the 'AutoDate' tests using subtests
Also add a test to check the permissions to set a date, and a test
to check update dates on milestones.
The tests related to 'AutoDate' are:
- TestAPIEditIssueAutoDate
- TestAPIAddIssueLabelsAutoDate
- TestAPIEditIssueMilestoneAutoDate
- TestAPICreateIssueAttachmentAutoDate
- TestAPICreateCommentAutoDate
- TestAPIEditCommentWithDate
- TestAPICreateCommentAttachmentAutoDate
(cherry picked from commit 961fd13c551b3e50040acb7c914a00ead92de63f)
(cherry picked from commit d52f4eea44692ee773010cb66a69a603663947d5)
(cherry picked from commit 3540ea2a43155ca8cf5ab1a4a246babfb829db16)
Conflicts:
services/issue/issue.go
https://codeberg.org/forgejo/forgejo/pulls/1415
2023-05-30 18:42:58 +02:00
NoAutoTime bool ` xorm:"-" `
2015-08-12 11:04:23 +02:00
2022-12-23 12:35:43 +01:00
Attachments [ ] * repo_model . Attachment ` xorm:"-" `
2023-05-21 14:48:28 +02:00
Comments CommentList ` xorm:"-" `
2022-12-23 12:35:43 +01:00
Reactions ReactionList ` xorm:"-" `
TotalTrackedTime int64 ` xorm:"-" `
Assignees [ ] * user_model . User ` xorm:"-" `
2019-02-18 21:55:04 +01:00
// IsLocked limits commenting abilities to users on an issue
// with write access
IsLocked bool ` xorm:"NOT NULL DEFAULT false" `
2020-09-10 20:09:14 +02:00
// For view issue page.
2021-11-11 07:29:30 +01:00
ShowRole RoleDescriptor ` xorm:"-" `
2015-08-12 11:04:23 +02:00
}
2018-01-03 09:34:13 +01:00
var (
issueTasksPat * regexp . Regexp
issueTasksDonePat * regexp . Regexp
)
2021-03-14 19:52:12 +01:00
const (
2021-06-14 04:22:55 +02:00
issueTasksRegexpStr = ` (^\s*[-*]\s\[[\sxX]\]\s.)|(\n\s*[-*]\s\[[\sxX]\]\s.) `
issueTasksDoneRegexpStr = ` (^\s*[-*]\s\[[xX]\]\s.)|(\n\s*[-*]\s\[[xX]\]\s.) `
2021-03-14 19:52:12 +01:00
)
2018-01-03 09:34:13 +01:00
2021-09-19 13:49:59 +02:00
// IssueIndex represents the issue index table
type IssueIndex db . ResourceIndex
2018-01-03 09:34:13 +01:00
func init ( ) {
issueTasksPat = regexp . MustCompile ( issueTasksRegexpStr )
issueTasksDonePat = regexp . MustCompile ( issueTasksDoneRegexpStr )
2021-09-19 13:49:59 +02:00
db . RegisterModel ( new ( Issue ) )
db . RegisterModel ( new ( IssueIndex ) )
2018-01-03 09:34:13 +01:00
}
2022-06-13 11:37:59 +02:00
// LoadTotalTimes load total tracked time
func ( issue * Issue ) LoadTotalTimes ( ctx context . Context ) ( err error ) {
2018-04-29 07:58:47 +02:00
opts := FindTrackedTimesOptions { IssueID : issue . ID }
2022-05-20 16:08:52 +02:00
issue . TotalTrackedTime , err = opts . toSession ( db . GetEngine ( ctx ) ) . SumInt ( & TrackedTime { } , "time" )
2018-04-29 07:58:47 +02:00
if err != nil {
return err
}
return nil
}
2018-05-01 21:05:28 +02:00
// IsOverdue checks if the issue is overdue
func ( issue * Issue ) IsOverdue ( ) bool {
2021-03-08 02:55:57 +01:00
if issue . IsClosed {
return issue . ClosedUnix >= issue . DeadlineUnix
}
2019-08-15 16:46:21 +02:00
return timeutil . TimeStampNow ( ) >= issue . DeadlineUnix
2018-05-01 21:05:28 +02:00
}
2018-12-13 16:55:43 +01:00
// LoadRepo loads issue's repository
2022-04-08 11:11:15 +02:00
func ( issue * Issue ) LoadRepo ( ctx context . Context ) ( err error ) {
2023-03-28 19:23:25 +02:00
if issue . Repo == nil && issue . RepoID != 0 {
2022-12-03 03:48:26 +01:00
issue . Repo , err = repo_model . GetRepositoryByID ( ctx , issue . RepoID )
2016-03-14 04:20:22 +01:00
if err != nil {
2022-10-24 21:29:17 +02:00
return fmt . Errorf ( "getRepositoryByID [%d]: %w" , issue . RepoID , err )
2016-03-14 04:20:22 +01:00
}
2016-08-26 22:40:53 +02:00
}
2016-12-17 12:49:17 +01:00
return nil
}
2018-04-29 07:58:47 +02:00
// IsTimetrackerEnabled returns true if the repo enables timetracking
2022-12-10 03:46:31 +01:00
func ( issue * Issue ) IsTimetrackerEnabled ( ctx context . Context ) bool {
2022-04-08 11:11:15 +02:00
if err := issue . LoadRepo ( ctx ) ; err != nil {
2019-04-02 09:48:31 +02:00
log . Error ( fmt . Sprintf ( "loadRepo: %v" , err ) )
2018-04-29 07:58:47 +02:00
return false
}
2022-12-10 03:46:31 +01:00
return issue . Repo . IsTimetrackerEnabled ( ctx )
2018-04-29 07:58:47 +02:00
}
2017-01-28 17:01:07 +01:00
// GetPullRequest returns the issue pull request
func ( issue * Issue ) GetPullRequest ( ) ( pr * PullRequest , err error ) {
if ! issue . IsPull {
return nil , fmt . Errorf ( "Issue is not a pull request" )
}
2022-05-20 16:08:52 +02:00
pr , err = GetPullRequestByIssueID ( db . DefaultContext , issue . ID )
2018-10-18 13:23:05 +02:00
if err != nil {
return nil , err
}
pr . Issue = issue
2022-06-20 12:02:49 +02:00
return pr , err
2017-01-28 17:01:07 +01:00
}
2018-12-13 16:55:43 +01:00
// LoadPoster loads poster
2022-11-19 09:12:33 +01:00
func ( issue * Issue ) LoadPoster ( ctx context . Context ) ( err error ) {
2023-03-28 19:23:25 +02:00
if issue . Poster == nil && issue . PosterID != 0 {
Implement actions (#21937)
Close #13539.
Co-authored by: @lunny @appleboy @fuxiaohei and others.
Related projects:
- https://gitea.com/gitea/actions-proto-def
- https://gitea.com/gitea/actions-proto-go
- https://gitea.com/gitea/act
- https://gitea.com/gitea/act_runner
### Summary
The target of this PR is to bring a basic implementation of "Actions",
an internal CI/CD system of Gitea. That means even though it has been
merged, the state of the feature is **EXPERIMENTAL**, and please note
that:
- It is disabled by default;
- It shouldn't be used in a production environment currently;
- It shouldn't be used in a public Gitea instance currently;
- Breaking changes may be made before it's stable.
**Please comment on #13539 if you have any different product design
ideas**, all decisions reached there will be adopted here. But in this
PR, we don't talk about **naming, feature-creep or alternatives**.
### ⚠️ Breaking
`gitea-actions` will become a reserved user name. If a user with the
name already exists in the database, it is recommended to rename it.
### Some important reviews
- What is `DEFAULT_ACTIONS_URL` in `app.ini` for?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1055954954
- Why the api for runners is not under the normal `/api/v1` prefix?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061173592
- Why DBFS?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061301178
- Why ignore events triggered by `gitea-actions` bot?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1063254103
- Why there's no permission control for actions?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1090229868
### What it looks like
<details>
#### Manage runners
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205870657-c72f590e-2e08-4cd4-be7f-2e0abb299bbf.png">
#### List runs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872794-50fde990-2b45-48c1-a178-908e4ec5b627.png">
#### View logs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872501-9b7b9000-9542-4991-8f55-18ccdada77c3.png">
</details>
### How to try it
<details>
#### 1. Start Gitea
Clone this branch and [install from
source](https://docs.gitea.io/en-us/install-from-source).
Add additional configurations in `app.ini` to enable Actions:
```ini
[actions]
ENABLED = true
```
Start it.
If all is well, you'll see the management page of runners:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205877365-8e30a780-9b10-4154-b3e8-ee6c3cb35a59.png">
#### 2. Start runner
Clone the [act_runner](https://gitea.com/gitea/act_runner), and follow
the
[README](https://gitea.com/gitea/act_runner/src/branch/main/README.md)
to start it.
If all is well, you'll see a new runner has been added:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205878000-216f5937-e696-470d-b66c-8473987d91c3.png">
#### 3. Enable actions for a repo
Create a new repo or open an existing one, check the `Actions` checkbox
in settings and submit.
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879705-53e09208-73c0-4b3e-a123-2dcf9aba4b9c.png">
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879383-23f3d08f-1a85-41dd-a8b3-54e2ee6453e8.png">
If all is well, you'll see a new tab "Actions":
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205881648-a8072d8c-5803-4d76-b8a8-9b2fb49516c1.png">
#### 4. Upload workflow files
Upload some workflow files to `.gitea/workflows/xxx.yaml`, you can
follow the [quickstart](https://docs.github.com/en/actions/quickstart)
of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions
in most cases, you can use the same demo:
```yaml
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."
```
If all is well, you'll see a new run in `Actions` tab:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884473-79a874bc-171b-4aaf-acd5-0241a45c3b53.png">
#### 5. Check the logs of jobs
Click a run and you'll see the logs:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884800-994b0374-67f7-48ff-be9a-4c53f3141547.png">
#### 6. Go on
You can try more examples in [the
documents](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
of GitHub Actions, then you might find a lot of bugs.
Come on, PRs are welcome.
</details>
See also: [Feature Preview: Gitea
Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/)
---------
Co-authored-by: a1012112796 <1012112796@qq.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: ChristopherHX <christopher.homberger@web.de>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-01-31 02:45:19 +01:00
issue . Poster , err = user_model . GetPossibleUserByID ( ctx , issue . PosterID )
2016-03-14 04:20:22 +01:00
if err != nil {
2016-09-20 11:54:47 +02:00
issue . PosterID = - 1
2021-11-24 10:49:20 +01:00
issue . Poster = user_model . NewGhostUser ( )
if ! user_model . IsErrUserNotExist ( err ) {
2022-10-24 21:29:17 +02:00
return fmt . Errorf ( "getUserByID.(poster) [%d]: %w" , issue . PosterID , err )
2016-03-14 04:20:22 +01:00
}
2023-07-09 13:58:06 +02:00
return nil
2016-03-14 04:20:22 +01:00
}
2016-08-26 22:40:53 +02:00
}
2022-06-20 12:02:49 +02:00
return err
2017-01-30 13:46:45 +01:00
}
2016-03-14 04:20:22 +01:00
2022-11-19 09:12:33 +01:00
// LoadPullRequest loads pull request info
func ( issue * Issue ) LoadPullRequest ( ctx context . Context ) ( err error ) {
2023-02-21 01:15:49 +01:00
if issue . IsPull {
2023-03-28 19:23:25 +02:00
if issue . PullRequest == nil && issue . ID != 0 {
2023-02-21 01:15:49 +01:00
issue . PullRequest , err = GetPullRequestByIssueID ( ctx , issue . ID )
if err != nil {
if IsErrPullRequestNotExist ( err ) {
return err
}
return fmt . Errorf ( "getPullRequestByIssueID [%d]: %w" , issue . ID , err )
2017-07-26 09:16:45 +02:00
}
}
2023-03-28 19:23:25 +02:00
if issue . PullRequest != nil {
issue . PullRequest . Issue = issue
}
2017-07-26 09:16:45 +02:00
}
return nil
}
2022-05-20 16:08:52 +02:00
func ( issue * Issue ) loadComments ( ctx context . Context ) ( err error ) {
2023-04-20 08:39:44 +02:00
return issue . loadCommentsByType ( ctx , CommentTypeUndefined )
2019-02-19 15:39:39 +01:00
}
// LoadDiscussComments loads discuss comments
2022-11-19 09:12:33 +01:00
func ( issue * Issue ) LoadDiscussComments ( ctx context . Context ) error {
return issue . loadCommentsByType ( ctx , CommentTypeComment )
2019-02-19 15:39:39 +01:00
}
2022-05-20 16:08:52 +02:00
func ( issue * Issue ) loadCommentsByType ( ctx context . Context , tp CommentType ) ( err error ) {
2017-09-16 22:16:21 +02:00
if issue . Comments != nil {
return nil
}
2022-05-20 16:08:52 +02:00
issue . Comments , err = FindComments ( ctx , & FindCommentsOptions {
2017-09-16 22:16:21 +02:00
IssueID : issue . ID ,
2019-02-19 15:39:39 +01:00
Type : tp ,
2017-09-16 22:16:21 +02:00
} )
return err
}
2021-12-10 02:27:50 +01:00
func ( issue * Issue ) loadReactions ( ctx context . Context ) ( err error ) {
2017-12-04 00:14:26 +01:00
if issue . Reactions != nil {
return nil
}
2022-06-13 11:37:59 +02:00
reactions , _ , err := FindReactions ( ctx , FindReactionsOptions {
2017-12-04 00:14:26 +01:00
IssueID : issue . ID ,
} )
if err != nil {
return err
}
2022-04-08 11:11:15 +02:00
if err = issue . LoadRepo ( ctx ) ; err != nil {
2020-01-15 12:14:07 +01:00
return err
}
2017-12-04 00:14:26 +01:00
// Load reaction user data
2022-06-20 12:02:49 +02:00
if _ , err := reactions . LoadUsers ( ctx , issue . Repo ) ; err != nil {
2017-12-04 00:14:26 +01:00
return err
}
// Cache comments to map
comments := make ( map [ int64 ] * Comment )
for _ , comment := range issue . Comments {
comments [ comment . ID ] = comment
}
// Add reactions either to issue or comment
for _ , react := range reactions {
if react . CommentID == 0 {
issue . Reactions = append ( issue . Reactions , react )
} else if comment , ok := comments [ react . CommentID ] ; ok {
comment . Reactions = append ( comment . Reactions , react )
}
}
return nil
}
2022-11-19 09:12:33 +01:00
// LoadMilestone load milestone of this issue.
func ( issue * Issue ) LoadMilestone ( ctx context . Context ) ( err error ) {
2020-05-24 16:38:34 +02:00
if ( issue . Milestone == nil || issue . Milestone . ID != issue . MilestoneID ) && issue . MilestoneID > 0 {
2022-06-13 11:37:59 +02:00
issue . Milestone , err = GetMilestoneByRepoID ( ctx , issue . RepoID , issue . MilestoneID )
if err != nil && ! IsErrMilestoneNotExist ( err ) {
2022-10-24 21:29:17 +02:00
return fmt . Errorf ( "getMilestoneByRepoID [repo_id: %d, milestone_id: %d]: %w" , issue . RepoID , issue . MilestoneID , err )
2020-01-01 23:51:10 +01:00
}
}
return nil
}
2022-06-13 11:37:59 +02:00
// LoadAttributes loads the attribute of this issue.
func ( issue * Issue ) LoadAttributes ( ctx context . Context ) ( err error ) {
2022-04-08 11:11:15 +02:00
if err = issue . LoadRepo ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2017-01-30 13:46:45 +01:00
}
2022-11-19 09:12:33 +01:00
if err = issue . LoadPoster ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2017-01-30 13:46:45 +01:00
}
2022-04-28 13:48:48 +02:00
if err = issue . LoadLabels ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2016-08-26 22:40:53 +02:00
}
2015-08-10 15:47:23 +02:00
2022-11-19 09:12:33 +01:00
if err = issue . LoadMilestone ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2015-08-05 14:23:08 +02:00
}
2023-02-20 20:21:56 +01:00
if err = issue . LoadProject ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2020-08-17 05:07:38 +02:00
}
2022-05-20 16:08:52 +02:00
if err = issue . LoadAssignees ( ctx ) ; err != nil {
2023-07-09 13:58:06 +02:00
return err
2016-08-14 12:32:24 +02:00
}
2022-11-19 09:12:33 +01:00
if err = issue . LoadPullRequest ( ctx ) ; err != nil && ! IsErrPullRequestNotExist ( err ) {
2016-08-14 12:32:24 +02:00
// It is possible pull request is not yet created.
2017-07-26 09:16:45 +02:00
return err
2016-08-14 12:32:24 +02:00
}
2016-08-26 22:40:53 +02:00
if issue . Attachments == nil {
2022-05-20 16:08:52 +02:00
issue . Attachments , err = repo_model . GetAttachmentsByIssueID ( ctx , issue . ID )
2016-08-26 22:40:53 +02:00
if err != nil {
2022-10-24 21:29:17 +02:00
return fmt . Errorf ( "getAttachmentsByIssueID [%d]: %w" , issue . ID , err )
2016-08-26 22:40:53 +02:00
}
}
2022-05-20 16:08:52 +02:00
if err = issue . loadComments ( ctx ) ; err != nil {
2017-12-04 00:14:26 +01:00
return err
2016-08-26 22:40:53 +02:00
}
2019-04-18 07:00:03 +02:00
2023-07-22 16:14:27 +02:00
if err = issue . Comments . LoadAttributes ( ctx ) ; err != nil {
2019-04-18 07:00:03 +02:00
return err
}
2022-12-10 03:46:31 +01:00
if issue . IsTimetrackerEnabled ( ctx ) {
2022-06-13 11:37:59 +02:00
if err = issue . LoadTotalTimes ( ctx ) ; err != nil {
2018-04-29 07:58:47 +02:00
return err
}
}
2016-08-26 22:40:53 +02:00
2021-12-10 02:27:50 +01:00
return issue . loadReactions ( ctx )
2016-08-14 12:32:24 +02:00
}
2017-02-03 08:22:39 +01:00
// GetIsRead load the `IsRead` field of the issue
func ( issue * Issue ) GetIsRead ( userID int64 ) error {
issueUser := & IssueUser { IssueID : issue . ID , UID : userID }
2021-09-23 17:45:36 +02:00
if has , err := db . GetEngine ( db . DefaultContext ) . Get ( issueUser ) ; err != nil {
2017-02-03 08:22:39 +01:00
return err
} else if ! has {
2017-02-09 04:47:24 +01:00
issue . IsRead = false
return nil
2017-02-03 08:22:39 +01:00
}
issue . IsRead = issueUser . IsRead
return nil
}
2017-03-03 15:35:42 +01:00
// APIURL returns the absolute APIURL to this issue.
func ( issue * Issue ) APIURL ( ) string {
2020-04-21 15:48:53 +02:00
if issue . Repo == nil {
2022-04-08 11:11:15 +02:00
err := issue . LoadRepo ( db . DefaultContext )
2020-04-21 15:48:53 +02:00
if err != nil {
log . Error ( "Issue[%d].APIURL(): %v" , issue . ID , err )
return ""
}
}
2020-01-14 16:37:19 +01:00
return fmt . Sprintf ( "%s/issues/%d" , issue . Repo . APIURL ( ) , issue . Index )
2017-03-03 15:35:42 +01:00
}
2016-11-24 09:41:11 +01:00
// HTMLURL returns the absolute URL to this issue.
2016-08-16 19:19:09 +02:00
func ( issue * Issue ) HTMLURL ( ) string {
var path string
if issue . IsPull {
path = "pulls"
} else {
path = "issues"
}
return fmt . Sprintf ( "%s/%s/%d" , issue . Repo . HTMLURL ( ) , path , issue . Index )
}
2023-02-06 19:09:18 +01:00
// Link returns the issue's relative URL.
2021-11-16 19:18:25 +01:00
func ( issue * Issue ) Link ( ) string {
var path string
if issue . IsPull {
path = "pulls"
} else {
path = "issues"
}
return fmt . Sprintf ( "%s/%s/%d" , issue . Repo . Link ( ) , path , issue . Index )
}
2016-12-02 12:10:39 +01:00
// DiffURL returns the absolute URL to this diff
func ( issue * Issue ) DiffURL ( ) string {
if issue . IsPull {
return fmt . Sprintf ( "%s/pulls/%d.diff" , issue . Repo . HTMLURL ( ) , issue . Index )
}
return ""
}
// PatchURL returns the absolute URL to this patch
func ( issue * Issue ) PatchURL ( ) string {
if issue . IsPull {
return fmt . Sprintf ( "%s/pulls/%d.patch" , issue . Repo . HTMLURL ( ) , issue . Index )
}
return ""
}
2016-03-14 04:20:22 +01:00
// State returns string representation of issue status.
2016-11-22 12:24:39 +01:00
func ( issue * Issue ) State ( ) api . StateType {
if issue . IsClosed {
2016-11-29 09:25:47 +01:00
return api . StateClosed
2016-03-14 04:20:22 +01:00
}
2016-11-29 09:25:47 +01:00
return api . StateOpen
2016-08-14 12:32:24 +02:00
}
// HashTag returns unique hash tag for issue.
2016-11-22 12:24:39 +01:00
func ( issue * Issue ) HashTag ( ) string {
2020-12-25 10:59:32 +01:00
return fmt . Sprintf ( "issue-%d" , issue . ID )
2016-03-14 04:20:22 +01:00
}
2015-08-13 10:07:11 +02:00
// IsPoster returns true if given user by ID is the poster.
2016-11-22 12:24:39 +01:00
func ( issue * Issue ) IsPoster ( uid int64 ) bool {
2020-01-17 11:23:46 +01:00
return issue . OriginalAuthorID == 0 && issue . PosterID == uid
2015-08-13 10:07:11 +02:00
}
2018-01-03 09:34:13 +01:00
// GetTasks returns the amount of tasks in the issues content
func ( issue * Issue ) GetTasks ( ) int {
return len ( i ssueTasksPat . FindAllStringIndex ( issue . Content , - 1 ) )
}
// GetTasksDone returns the amount of completed tasks in the issues content
func ( issue * Issue ) GetTasksDone ( ) int {
return len ( issueTasksDonePat . FindAllStringIndex ( issue . Content , - 1 ) )
}
2023-05-18 12:45:25 +02:00
// GetLastEventTimestamp returns the last user visible event timestamp, either the creation of this issue or the close.
func ( issue * Issue ) GetLastEventTimestamp ( ) timeutil . TimeStamp {
if issue . IsClosed {
return issue . ClosedUnix
2015-09-02 22:18:09 +02:00
}
2023-05-18 12:45:25 +02:00
return issue . CreatedUnix
}
2015-09-02 22:18:09 +02:00
2023-05-18 12:45:25 +02:00
// GetLastEventLabel returns the localization label for the current issue.
func ( issue * Issue ) GetLastEventLabel ( ) string {
if issue . IsClosed {
if issue . IsPull && issue . PullRequest . HasMerged {
return "repo.pulls.merged_by"
}
return "repo.issues.closed_by"
2015-08-25 16:58:34 +02:00
}
2023-05-18 12:45:25 +02:00
return "repo.issues.opened_by"
2015-08-25 16:58:34 +02:00
}
2023-05-18 12:45:25 +02:00
// GetLastComment return last comment for the current issue.
func ( issue * Issue ) GetLastComment ( ) ( * Comment , error ) {
var c Comment
exist , err := db . GetEngine ( db . DefaultContext ) . Where ( "type = ?" , CommentTypeComment ) .
And ( "issue_id = ?" , issue . ID ) . Desc ( "created_unix" ) . Get ( & c )
2019-02-21 06:01:28 +01:00
if err != nil {
2023-05-18 12:45:25 +02:00
return nil , err
2019-02-21 06:01:28 +01:00
}
2023-05-18 12:45:25 +02:00
if ! exist {
return nil , nil
2021-03-06 16:11:12 +01:00
}
2023-05-18 12:45:25 +02:00
return & c , nil
}
2019-02-21 06:01:28 +01:00
2023-05-18 12:45:25 +02:00
// GetLastEventLabelFake returns the localization label for the current issue without providing a link in the username.
func ( issue * Issue ) GetLastEventLabelFake ( ) string {
if issue . IsClosed {
if issue . IsPull && issue . PullRequest . HasMerged {
return "repo.pulls.merged_by_fake"
}
return "repo.issues.closed_by_fake"
2019-02-21 06:01:28 +01:00
}
2023-05-18 12:45:25 +02:00
return "repo.issues.opened_by_fake"
2019-02-21 06:01:28 +01:00
}
2023-05-18 12:45:25 +02:00
// GetIssueByIndex returns raw issue without loading attributes by index in a repository.
2023-07-22 16:14:27 +02:00
func GetIssueByIndex ( ctx context . Context , repoID , index int64 ) ( * Issue , error ) {
2023-05-18 12:45:25 +02:00
if index < 1 {
return nil , ErrIssueNotExist { }
2020-05-16 23:05:19 +02:00
}
2023-05-18 12:45:25 +02:00
issue := & Issue {
RepoID : repoID ,
Index : index ,
2020-05-16 23:05:19 +02:00
}
2023-07-22 16:14:27 +02:00
has , err := db . GetEngine ( ctx ) . Get ( issue )
2020-05-16 23:05:19 +02:00
if err != nil {
2023-05-18 12:45:25 +02:00
return nil , err
} else if ! has {
return nil , ErrIssueNotExist { 0 , repoID , index }
2020-01-02 08:54:22 +01:00
}
2023-05-18 12:45:25 +02:00
return issue , nil
}
2020-01-02 08:54:22 +01:00
2023-05-18 12:45:25 +02:00
// GetIssueWithAttrsByIndex returns issue by index in a repository.
2023-07-22 16:14:27 +02:00
func GetIssueWithAttrsByIndex ( ctx context . Context , repoID , index int64 ) ( * Issue , error ) {
issue , err := GetIssueByIndex ( ctx , repoID , index )
2023-05-18 12:45:25 +02:00
if err != nil {
return nil , err
2019-09-20 07:45:38 +02:00
}
2023-07-22 16:14:27 +02:00
return issue , issue . LoadAttributes ( ctx )
2023-05-18 12:45:25 +02:00
}
2020-05-16 23:05:19 +02:00
2023-05-18 12:45:25 +02:00
// GetIssueByID returns an issue by given ID.
func GetIssueByID ( ctx context . Context , id int64 ) ( * Issue , error ) {
issue := new ( Issue )
has , err := db . GetEngine ( ctx ) . ID ( id ) . Get ( issue )
if err != nil {
return nil , err
} else if ! has {
return nil , ErrIssueNotExist { id , 0 , 0 }
2020-05-16 23:05:19 +02:00
}
2023-05-18 12:45:25 +02:00
return issue , nil
2015-10-24 09:36:47 +02:00
}
2018-05-01 21:05:28 +02:00
2023-05-18 12:45:25 +02:00
// GetIssueWithAttrsByID returns an issue with attributes by given ID.
func GetIssueWithAttrsByID ( id int64 ) ( * Issue , error ) {
issue , err := GetIssueByID ( db . DefaultContext , id )
2021-11-19 14:39:57 +01:00
if err != nil {
2023-05-18 12:45:25 +02:00
return nil , err
2018-05-01 21:05:28 +02:00
}
2023-05-18 12:45:25 +02:00
return issue , issue . LoadAttributes ( db . DefaultContext )
}
2018-05-01 21:05:28 +02:00
2023-05-18 12:45:25 +02:00
// GetIssuesByIDs return issues with the given IDs.
Refactor and enhance issue indexer to support both searching, filtering and paging (#26012)
Fix #24662.
Replace #24822 and #25708 (although it has been merged)
## Background
In the past, Gitea supported issue searching with a keyword and
conditions in a less efficient way. It worked by searching for issues
with the keyword and obtaining limited IDs (as it is heavy to get all)
on the indexer (bleve/elasticsearch/meilisearch), and then querying with
conditions on the database to find a subset of the found IDs. This is
why the results could be incomplete.
To solve this issue, we need to store all fields that could be used as
conditions in the indexer and support both keyword and additional
conditions when searching with the indexer.
## Major changes
- Redefine `IndexerData` to include all fields that could be used as
filter conditions.
- Refactor `Search(ctx context.Context, kw string, repoIDs []int64,
limit, start int, state string)` to `Search(ctx context.Context, options
*SearchOptions)`, so it supports more conditions now.
- Change the data type stored in `issueIndexerQueue`. Use
`IndexerMetadata` instead of `IndexerData` in case the data has been
updated while it is in the queue. This also reduces the storage size of
the queue.
- Enhance searching with Bleve/Elasticsearch/Meilisearch, make them
fully support `SearchOptions`. Also, update the data versions.
- Keep most logic of database indexer, but remove
`issues.SearchIssueIDsByKeyword` in `models` to avoid confusion where is
the entry point to search issues.
- Start a Meilisearch instance to test it in unit tests.
- Add unit tests with almost full coverage to test
Bleve/Elasticsearch/Meilisearch indexer.
---------
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-07-31 08:28:53 +02:00
// If keepOrder is true, the order of the returned issues will be the same as the given IDs.
func GetIssuesByIDs ( ctx context . Context , issueIDs [ ] int64 , keepOrder ... bool ) ( IssueList , error ) {
2023-07-20 09:18:52 +02:00
issues := make ( [ ] * Issue , 0 , len ( issueIDs ) )
Refactor and enhance issue indexer to support both searching, filtering and paging (#26012)
Fix #24662.
Replace #24822 and #25708 (although it has been merged)
## Background
In the past, Gitea supported issue searching with a keyword and
conditions in a less efficient way. It worked by searching for issues
with the keyword and obtaining limited IDs (as it is heavy to get all)
on the indexer (bleve/elasticsearch/meilisearch), and then querying with
conditions on the database to find a subset of the found IDs. This is
why the results could be incomplete.
To solve this issue, we need to store all fields that could be used as
conditions in the indexer and support both keyword and additional
conditions when searching with the indexer.
## Major changes
- Redefine `IndexerData` to include all fields that could be used as
filter conditions.
- Refactor `Search(ctx context.Context, kw string, repoIDs []int64,
limit, start int, state string)` to `Search(ctx context.Context, options
*SearchOptions)`, so it supports more conditions now.
- Change the data type stored in `issueIndexerQueue`. Use
`IndexerMetadata` instead of `IndexerData` in case the data has been
updated while it is in the queue. This also reduces the storage size of
the queue.
- Enhance searching with Bleve/Elasticsearch/Meilisearch, make them
fully support `SearchOptions`. Also, update the data versions.
- Keep most logic of database indexer, but remove
`issues.SearchIssueIDsByKeyword` in `models` to avoid confusion where is
the entry point to search issues.
- Start a Meilisearch instance to test it in unit tests.
- Add unit tests with almost full coverage to test
Bleve/Elasticsearch/Meilisearch indexer.
---------
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-07-31 08:28:53 +02:00
if err := db . GetEngine ( ctx ) . In ( "id" , issueIDs ) . Find ( & issues ) ; err != nil {
return nil , err
}
if len ( keepOrder ) > 0 && keepOrder [ 0 ] {
m := make ( map [ int64 ] * Issue , len ( issues ) )
appended := container . Set [ int64 ] { }
for _ , issue := range issues {
m [ issue . ID ] = issue
}
issues = issues [ : 0 ]
for _ , id := range issueIDs {
if issue , ok := m [ id ] ; ok && ! appended . Contains ( id ) { // make sure the id is existed and not appended
appended . Add ( id )
issues = append ( issues , issue )
}
}
}
return issues , nil
2023-05-18 12:45:25 +02:00
}
2018-05-01 21:05:28 +02:00
2023-05-18 12:45:25 +02:00
// GetIssueIDsByRepoID returns all issue ids by repo id
func GetIssueIDsByRepoID ( ctx context . Context , repoID int64 ) ( [ ] int64 , error ) {
ids := make ( [ ] int64 , 0 , 10 )
err := db . GetEngine ( ctx ) . Table ( "issue" ) . Cols ( "id" ) . Where ( "repo_id = ?" , repoID ) . Find ( & ids )
return ids , err
}
2018-05-01 21:05:28 +02:00
2023-05-18 12:45:25 +02:00
// GetParticipantsIDsByIssueID returns the IDs of all users who participated in comments of an issue,
// but skips joining with `user` for performance reasons.
// User permissions must be verified elsewhere if required.
func GetParticipantsIDsByIssueID ( ctx context . Context , issueID int64 ) ( [ ] int64 , error ) {
userIDs := make ( [ ] int64 , 0 , 5 )
return userIDs , db . GetEngine ( ctx ) .
Table ( "comment" ) .
Cols ( "poster_id" ) .
Where ( "issue_id = ?" , issueID ) .
And ( "type in (?,?,?)" , CommentTypeComment , CommentTypeCode , CommentTypeReview ) .
Distinct ( "poster_id" ) .
Find ( & userIDs )
2018-05-01 21:05:28 +02:00
}
2018-07-17 23:23:58 +02:00
2023-05-18 12:45:25 +02:00
// IsUserParticipantsOfIssue return true if user is participants of an issue
func IsUserParticipantsOfIssue ( user * user_model . User , issue * Issue ) bool {
userIDs , err := issue . GetParticipantIDsByIssue ( db . DefaultContext )
if err != nil {
log . Error ( err . Error ( ) )
return false
2022-03-01 01:20:15 +01:00
}
2023-09-07 11:37:47 +02:00
return slices . Contains ( userIDs , user . ID )
2022-03-01 01:20:15 +01:00
}
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 06:06:10 +01:00
// DependencyInfo represents high level information about an issue which is a dependency of another issue.
type DependencyInfo struct {
2021-12-10 02:27:50 +01:00
Issue ` xorm:"extends" `
repo_model . Repository ` xorm:"extends" `
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 06:06:10 +01:00
}
2022-06-13 11:37:59 +02:00
// GetParticipantIDsByIssue returns all userIDs who are participated in comments of an issue and issue author
func ( issue * Issue ) GetParticipantIDsByIssue ( ctx context . Context ) ( [ ] int64 , error ) {
2020-02-28 09:16:41 +01:00
if issue == nil {
return nil , nil
}
userIDs := make ( [ ] int64 , 0 , 5 )
2022-05-20 16:08:52 +02:00
if err := db . GetEngine ( ctx ) . Table ( "comment" ) . Cols ( "poster_id" ) .
2020-02-28 09:16:41 +01:00
Where ( "`comment`.issue_id = ?" , issue . ID ) .
And ( "`comment`.type in (?,?,?)" , CommentTypeComment , CommentTypeCode , CommentTypeReview ) .
And ( "`user`.is_active = ?" , true ) .
And ( "`user`.prohibit_login = ?" , false ) .
Join ( "INNER" , "`user`" , "`user`.id = `comment`.poster_id" ) .
Distinct ( "poster_id" ) .
Find ( & userIDs ) ; err != nil {
2022-10-24 21:29:17 +02:00
return nil , fmt . Errorf ( "get poster IDs: %w" , err )
2020-02-28 09:16:41 +01:00
}
2023-09-07 11:37:47 +02:00
if ! slices . Contains ( userIDs , issue . PosterID ) {
2020-02-28 09:16:41 +01:00
return append ( userIDs , issue . PosterID ) , nil
}
return userIDs , nil
}
2022-05-20 16:08:52 +02:00
// BlockedByDependencies finds all Dependencies an issue is blocked by
2023-03-28 19:23:25 +02:00
func ( issue * Issue ) BlockedByDependencies ( ctx context . Context , opts db . ListOptions ) ( issueDeps [ ] * DependencyInfo , err error ) {
sess := db . GetEngine ( ctx ) .
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 06:06:10 +01:00
Table ( "issue" ) .
Join ( "INNER" , "repository" , "repository.id = issue.repo_id" ) .
Join ( "INNER" , "issue_dependency" , "issue_dependency.dependency_id = issue.id" ) .
2018-07-17 23:23:58 +02:00
Where ( "issue_id = ?" , issue . ID ) .
2021-03-14 19:52:12 +01:00
// sort by repo id then created date, with the issues of the same repo at the beginning of the list
2023-03-28 19:23:25 +02:00
OrderBy ( "CASE WHEN issue.repo_id = ? THEN 0 ELSE issue.repo_id END, issue.created_unix DESC" , issue . RepoID )
if opts . Page != 0 {
sess = db . SetSessionPagination ( sess , & opts )
}
err = sess . Find ( & issueDeps )
2021-11-18 09:18:12 +01:00
for _ , depInfo := range issueDeps {
depInfo . Issue . Repo = & depInfo . Repository
}
return issueDeps , err
2018-07-17 23:23:58 +02:00
}
2022-05-20 16:08:52 +02:00
// BlockingDependencies returns all blocking dependencies, aka all other issues a given issue blocks
func ( issue * Issue ) BlockingDependencies ( ctx context . Context ) ( issueDeps [ ] * DependencyInfo , err error ) {
err = db . GetEngine ( ctx ) .
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 06:06:10 +01:00
Table ( "issue" ) .
Join ( "INNER" , "repository" , "repository.id = issue.repo_id" ) .
Join ( "INNER" , "issue_dependency" , "issue_dependency.issue_id = issue.id" ) .
2018-07-17 23:23:58 +02:00
Where ( "dependency_id = ?" , issue . ID ) .
2021-03-14 19:52:12 +01:00
// sort by repo id then created date, with the issues of the same repo at the beginning of the list
2022-06-04 21:18:50 +02:00
OrderBy ( "CASE WHEN issue.repo_id = ? THEN 0 ELSE issue.repo_id END, issue.created_unix DESC" , issue . RepoID ) .
2018-07-17 23:23:58 +02:00
Find ( & issueDeps )
2021-11-18 09:18:12 +01:00
for _ , depInfo := range issueDeps {
depInfo . Issue . Repo = & depInfo . Repository
}
return issueDeps , err
2018-07-17 23:23:58 +02:00
}
2022-06-13 11:37:59 +02:00
func migratedIssueCond ( tp api . GitServiceType ) builder . Cond {
return builder . In ( "issue_id" ,
builder . Select ( "issue.id" ) .
From ( "issue" ) .
InnerJoin ( "repository" , "issue.repo_id = repository.id" ) .
Where ( builder . Eq {
"repository.original_service_type" : tp ,
} ) ,
)
}
2022-02-01 19:20:28 +01:00
// RemapExternalUser ExternalUserRemappable interface
func ( issue * Issue ) RemapExternalUser ( externalName string , externalID , userID int64 ) error {
issue . OriginalAuthor = externalName
issue . OriginalAuthorID = externalID
issue . PosterID = userID
return nil
}
// GetUserID ExternalUserRemappable interface
func ( issue * Issue ) GetUserID ( ) int64 { return issue . PosterID }
// GetExternalName ExternalUserRemappable interface
func ( issue * Issue ) GetExternalName ( ) string { return issue . OriginalAuthor }
// GetExternalID ExternalUserRemappable interface
func ( issue * Issue ) GetExternalID ( ) int64 { return issue . OriginalAuthorID }
2022-06-13 11:37:59 +02:00
2023-02-15 18:29:13 +01:00
// HasOriginalAuthor returns if an issue was migrated and has an original author.
func ( issue * Issue ) HasOriginalAuthor ( ) bool {
return issue . OriginalAuthor != "" && issue . OriginalAuthorID != 0
}
2023-05-25 15:17:19 +02:00
2023-05-30 17:26:51 +02:00
var ErrIssueMaxPinReached = util . NewInvalidArgumentErrorf ( "the max number of pinned issues has been readched" )
2023-05-25 15:17:19 +02:00
// IsPinned returns if a Issue is pinned
func ( issue * Issue ) IsPinned ( ) bool {
return issue . PinOrder != 0
}
// Pin pins a Issue
func ( issue * Issue ) Pin ( ctx context . Context , user * user_model . User ) error {
// If the Issue is already pinned, we don't need to pin it twice
if issue . IsPinned ( ) {
return nil
}
var maxPin int
_ , err := db . GetEngine ( ctx ) . SQL ( "SELECT MAX(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ?" , issue . RepoID , issue . IsPull ) . Get ( & maxPin )
if err != nil {
return err
}
// Check if the maximum allowed Pins reached
if maxPin >= setting . Repository . Issue . MaxPinned {
2023-05-30 17:26:51 +02:00
return ErrIssueMaxPinReached
2023-05-25 15:17:19 +02:00
}
_ , err = db . GetEngine ( ctx ) . Table ( "issue" ) .
Where ( "id = ?" , issue . ID ) .
2023-07-04 20:36:08 +02:00
Update ( map [ string ] any {
2023-05-25 15:17:19 +02:00
"pin_order" : maxPin + 1 ,
} )
if err != nil {
return err
}
// Add the pin event to the history
opts := & CreateCommentOptions {
Type : CommentTypePin ,
Doer : user ,
Repo : issue . Repo ,
Issue : issue ,
}
if _ , err = CreateComment ( ctx , opts ) ; err != nil {
return err
}
return nil
}
// UnpinIssue unpins a Issue
func ( issue * Issue ) Unpin ( ctx context . Context , user * user_model . User ) error {
// If the Issue is not pinned, we don't need to unpin it
if ! issue . IsPinned ( ) {
return nil
}
// This sets the Pin for all Issues that come after the unpined Issue to the correct value
_ , err := db . GetEngine ( ctx ) . Exec ( "UPDATE issue SET pin_order = pin_order - 1 WHERE repo_id = ? AND is_pull = ? AND pin_order > ?" , issue . RepoID , issue . IsPull , issue . PinOrder )
if err != nil {
return err
}
_ , err = db . GetEngine ( ctx ) . Table ( "issue" ) .
Where ( "id = ?" , issue . ID ) .
2023-07-04 20:36:08 +02:00
Update ( map [ string ] any {
2023-05-25 15:17:19 +02:00
"pin_order" : 0 ,
} )
if err != nil {
return err
}
// Add the unpin event to the history
opts := & CreateCommentOptions {
Type : CommentTypeUnpin ,
Doer : user ,
Repo : issue . Repo ,
Issue : issue ,
}
if _ , err = CreateComment ( ctx , opts ) ; err != nil {
return err
}
return nil
}
// PinOrUnpin pins or unpins a Issue
func ( issue * Issue ) PinOrUnpin ( ctx context . Context , user * user_model . User ) error {
if ! issue . IsPinned ( ) {
return issue . Pin ( ctx , user )
}
return issue . Unpin ( ctx , user )
}
// MovePin moves a Pinned Issue to a new Position
func ( issue * Issue ) MovePin ( ctx context . Context , newPosition int ) error {
// If the Issue is not pinned, we can't move them
if ! issue . IsPinned ( ) {
return nil
}
if newPosition < 1 {
return fmt . Errorf ( "The Position can't be lower than 1" )
}
dbctx , committer , err := db . TxContext ( ctx )
if err != nil {
return err
}
defer committer . Close ( )
var maxPin int
_ , err = db . GetEngine ( dbctx ) . SQL ( "SELECT MAX(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ?" , issue . RepoID , issue . IsPull ) . Get ( & maxPin )
if err != nil {
return err
}
// If the new Position bigger than the current Maximum, set it to the Maximum
if newPosition > maxPin + 1 {
newPosition = maxPin + 1
}
// Lower the Position of all Pinned Issue that came after the current Position
_ , err = db . GetEngine ( dbctx ) . Exec ( "UPDATE issue SET pin_order = pin_order - 1 WHERE repo_id = ? AND is_pull = ? AND pin_order > ?" , issue . RepoID , issue . IsPull , issue . PinOrder )
if err != nil {
return err
}
// Higher the Position of all Pinned Issues that comes after the new Position
_ , err = db . GetEngine ( dbctx ) . Exec ( "UPDATE issue SET pin_order = pin_order + 1 WHERE repo_id = ? AND is_pull = ? AND pin_order >= ?" , issue . RepoID , issue . IsPull , newPosition )
if err != nil {
return err
}
_ , err = db . GetEngine ( dbctx ) . Table ( "issue" ) .
Where ( "id = ?" , issue . ID ) .
2023-07-04 20:36:08 +02:00
Update ( map [ string ] any {
2023-05-25 15:17:19 +02:00
"pin_order" : newPosition ,
} )
if err != nil {
return err
}
return committer . Commit ( )
}
// GetPinnedIssues returns the pinned Issues for the given Repo and type
2023-08-07 21:26:40 +02:00
func GetPinnedIssues ( ctx context . Context , repoID int64 , isPull bool ) ( IssueList , error ) {
issues := make ( IssueList , 0 )
2023-05-25 15:17:19 +02:00
err := db . GetEngine ( ctx ) .
Table ( "issue" ) .
Where ( "repo_id = ?" , repoID ) .
And ( "is_pull = ?" , isPull ) .
And ( "pin_order > 0" ) .
OrderBy ( "pin_order" ) .
Find ( & issues )
if err != nil {
return nil , err
}
2023-08-07 21:26:40 +02:00
err = issues . LoadAttributes ( ctx )
2023-05-25 15:17:19 +02:00
if err != nil {
return nil , err
}
return issues , nil
}
// IsNewPinnedAllowed returns if a new Issue or Pull request can be pinned
func IsNewPinAllowed ( ctx context . Context , repoID int64 , isPull bool ) ( bool , error ) {
var maxPin int
2023-05-30 17:26:51 +02:00
_ , err := db . GetEngine ( ctx ) . SQL ( "SELECT COUNT(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ? AND pin_order > 0" , repoID , isPull ) . Get ( & maxPin )
2023-05-25 15:17:19 +02:00
if err != nil {
return false , err
}
return maxPin < setting . Repository . Issue . MaxPinned , nil
}
2023-05-30 17:26:51 +02:00
// IsErrIssueMaxPinReached returns if the error is, that the User can't pin more Issues
func IsErrIssueMaxPinReached ( err error ) bool {
return err == ErrIssueMaxPinReached
}
2023-09-08 23:09:23 +02:00
// InsertIssues insert issues to database
func InsertIssues ( issues ... * Issue ) error {
ctx , committer , err := db . TxContext ( db . DefaultContext )
if err != nil {
return err
}
defer committer . Close ( )
for _ , issue := range issues {
if err := insertIssue ( ctx , issue ) ; err != nil {
return err
}
}
return committer . Commit ( )
}
func insertIssue ( ctx context . Context , issue * Issue ) error {
sess := db . GetEngine ( ctx )
if _ , err := sess . NoAutoTime ( ) . Insert ( issue ) ; err != nil {
return err
}
issueLabels := make ( [ ] IssueLabel , 0 , len ( issue . Labels ) )
for _ , label := range issue . Labels {
issueLabels = append ( issueLabels , IssueLabel {
IssueID : issue . ID ,
LabelID : label . ID ,
} )
}
if len ( issueLabels ) > 0 {
if _ , err := sess . Insert ( issueLabels ) ; err != nil {
return err
}
}
for _ , reaction := range issue . Reactions {
reaction . IssueID = issue . ID
}
if len ( issue . Reactions ) > 0 {
if _ , err := sess . Insert ( issue . Reactions ) ; err != nil {
return err
}
}
return nil
}