Added issue search via api #3612

kolaente · 2018-03-02T16:34:42Z

This PR adds the ability to search for issues via the api. The code is taken from the normal issue search in the GUI.

codecov-io · 2018-03-02T16:50:19Z

Codecov Report

Merging #3612 into master will increase coverage by 0.01%.
The diff coverage is 75%.

@@            Coverage Diff            @@
##           master   #3612      +/-   ##
=========================================
+ Coverage   35.88%   35.9%   +0.01%     
=========================================
  Files         286     286              
  Lines       41294   41312      +18     
=========================================
+ Hits        14820   14832      +12     
- Misses      24294   24299       +5     
- Partials     2180    2181       +1

Impacted Files	Coverage Δ
routers/api/v1/repo/issue.go	`37.83% <75%> (+2.15%)`	⬆️
models/repo_indexer.go	`48.3% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d71f510...34918c6. Read the comment docs.

sapk · 2018-03-02T16:48:30Z

public/swagger.v1.json

@@ -1819,6 +1819,12 @@
            "in": "path",
            "required": true
          },
+          {


This should not be edited manually but generated base on code comments at start of ListIssues func.
Once the comments are added. Use make generate-swagger to re-generate this file.

Ah ok, I didn't know that. I'll do ASAP

sapk · 2018-03-02T16:51:59Z

routers/api/v1/repo/issue.go

@@ -5,13 +5,15 @@
 package repo

 import (
+	"bytes"


You allready done it.

…-search

…e/gitea into feature/api-issue-search

Morlinest · 2018-03-02T18:06:14Z

routers/api/v1/repo/issue.go

+	}
+	var issueIDs []int64
+	var err error
+	if len(keyword) > 0 {


I think you can do something like this:

if len(keyword) > 0 { issueIDs, err = indexer.SearchIssuesByKeyword(ctx.Repo.Repository.ID, keyword) } if len(keyword) == 0 || len(issueIDs) > 0 { issues, err = models.Issues(&models.IssuesOptions{ RepoIDs: []int64{ctx.Repo.Repository.ID}, Page: ctx.QueryInt("page"), PageSize: setting.UI.IssuePagingNum, IsClosed: isClosed, IssueIDs: issueIDs, }) }

(simple search function call where you can immediately return empty array instead of doing "if" would be cleaner...)

Looks good, thanks

Morlinest · 2018-03-02T19:01:46Z

routers/api/v1/repo/issue.go

+		}
+	}
+
+	// Show the results if we either dont have a keyword or the issues found by said keyword are > 0


nit: This comment is not needed, its obvious from code

Oh yeah you're right, I removed it.

Morlinest · 2018-03-02T19:07:16Z

routers/api/v1/repo/issue.go

+		issueIDs, err = indexer.SearchIssuesByKeyword(ctx.Repo.Repository.ID, keyword)
+
+		// Didn't found anything
+		if len(issueIDs) == 0 {


Not needed, issues is already empty

But if I don't define it there, I cannot access it in line 83 and 89

It is defined on line 65

I am talking about variable issues and if block.

Ups, I though you were talking about defining the issues variable in line 65 😁

Morlinest · 2018-03-02T19:20:36Z

routers/api/v1/repo/issue.go

-		PageSize: setting.UI.IssuePagingNum,
-		IsClosed: isClosed,
-	})
+	// Define issues var


Remove comment pls

Morlinest · 2018-03-02T19:20:45Z

routers/api/v1/repo/issue.go

+	// Define issues var
+	var issues []*models.Issue
+
+	// Check for search


Remove comment pls

I think its obvious from code

Yeah probably 🤔

…-search

…e/gitea into feature/api-issue-search

lunny · 2018-03-03T14:50:11Z

routers/api/v1/repo/issue.go

+		issueIDs, err = indexer.SearchIssuesByKeyword(ctx.Repo.Repository.ID, keyword)
+	}
+
+	if len(keyword) == 0 || len(issueIDs) > 0 {


It seems this line is unnecessary.

No, it's necessary, but a comment should be added to explain it. At this point, three outcomes are possible:

No keywords were given

Keywords were given, returned no results

Keywords were given, returned some results.

This condition guards against condition 2, because otherwise models.Issues would just be called and would return all the issues as if no keyword was passed.

So, add comment:

// We don't fetch any issue if we have keywords, but SearchIssuesByKeyword returned no issue IDs. // (In other words, we don't fetch issues if no issue matches our keywords)

I'll add a comment.

@thehowl you are right, but we should avoid using another function names (it can be changed and you can not track changes in comments) in comment, just explain "why" that code is needed. IMO your last part is enough:

// Don't fetch issues if no issue matches keyword

@Morlinest I've added a comment explaining it.

thehowl

Minor changes.

thehowl · 2018-03-03T15:25:22Z

routers/api/v1/repo/issue.go

+	var issues []*models.Issue
+
+	keyword := strings.Trim(ctx.Query("q"), " ")
+	if bytes.Contains([]byte(keyword), []byte{0x00}) {


strings.IndexByte(keyword, 0)

thehowl · 2018-03-03T15:40:19Z

routers/api/v1/repo/issue.go

+		issueIDs, err = indexer.SearchIssuesByKeyword(ctx.Repo.Repository.ID, keyword)
+	}
+
+	if len(keyword) == 0 || len(issueIDs) > 0 {


No, it's necessary, but a comment should be added to explain it. At this point, three outcomes are possible:

No keywords were given

Keywords were given, returned no results

Keywords were given, returned some results.

This condition guards against condition 2, because otherwise models.Issues would just be called and would return all the issues as if no keyword was passed.

So, add comment:

// We don't fetch any issue if we have keywords, but SearchIssuesByKeyword returned no issue IDs. // (In other words, we don't fetch issues if no issue matches our keywords)

thehowl · 2018-03-03T16:00:33Z

routers/api/v1/repo/issue.go

+	var issues []*models.Issue
+
+	keyword := strings.Trim(ctx.Query("q"), " ")
+	if strings.IndexByte(keyword, 0) > 0 {


Change to >= or != -1 (Doesn't guard against \x00 being the first byte)

ok thanks, I didn't know about that.

thehowl

LGTM

lunny · 2018-03-04T02:41:39Z

need @Morlinest and @sapk 's approvals.

sapk

Thanks for the PR.

sapk · 2018-03-07T09:21:36Z

@lafriks CI fail is because Drone fail to pull the repo.

lunny · 2018-03-07T09:43:14Z

@sapk restarted.

kolaente · 2018-03-07T21:30:54Z

Thanks!

* SECURITY * Limit uploaded avatar image-size to 4096x3072 by default (go-gitea#4353) * Do not allow to reuse TOTP passcode (go-gitea#3878) * FEATURE * Add cli commands to regen hooks & keys (go-gitea#3979) * Add support for FIDO U2F (go-gitea#3971) * Added user language setting (go-gitea#3875) * LDAP Public SSH Keys synchronization (go-gitea#1844) * Add topic support (go-gitea#3711) * Multiple assignees (go-gitea#3705) * Add protected branch whitelists for merging (go-gitea#3689) * Global code search support (go-gitea#3664) * Add label descriptions (go-gitea#3662) * Add issue search via API (go-gitea#3612) * Add repository setting to enable/disable health checks (go-gitea#3607) * Emoji Autocomplete (go-gitea#3433) * Implements generator cli for secrets (go-gitea#3531) * ENHANCEMENT * Add more webhooks support and refactor webhook templates directory (go-gitea#3929) * Add new option to allow only OAuth2/OpenID user registration (go-gitea#3910) * Add option to use paged LDAP search when synchronizing users (go-gitea#3895) * Symlink icons (go-gitea#1416) * Improve release page UI (go-gitea#3693) * Add admin dashboard option to run health checks (go-gitea#3606) * Add branch link in branch list (go-gitea#3576) * Reduce sql query times in retrieveFeeds (go-gitea#3547) * Option to enable or disable swagger endpoints (go-gitea#3502) * Add missing licenses (go-gitea#3497) * Reduce repo indexer disk usage (go-gitea#3452) * Enable caching on assets and avatars (go-gitea#3376) * Add repository search ordered by stars/forks. Forks column in admin repo list (go-gitea#3969) * Add Environment Variables to Docker template (go-gitea#4012) * LFS: make HTTP auth period configurable (go-gitea#4035) * Add config path as an optionial flag when changing pass via CLI (go-gitea#4184) * Refactor User Settings sections (go-gitea#3900) * Allow square brackets in external issue patterns (go-gitea#3408) * Add Attachment API (go-gitea#3478) * Add EnableTimetracking option to app settings (go-gitea#3719) * Add config option to enable or disable log executed SQL (go-gitea#3726) * Shows total tracked time in issue and milestone list (go-gitea#3341) * TRANSLATION * Improve English grammar and consistency (go-gitea#3614) * DEPLOYMENT * Allow Gitea to run as different USER in Docker (go-gitea#3961) * Provide compressed release binaries (go-gitea#3991) * Sign release binaries (go-gitea#4188)

kolaente added 4 commits March 1, 2018 23:44

Started implementing issue api search

7a54205

Implemented issue search via api

5bc4f3f

Added search to swagger.json

f3870bf

Removed todo

bfd61f9

kolaente mentioned this pull request Mar 2, 2018

Added dependencies for issues (#2196) #2531

Merged

kolaente and others added 2 commits March 2, 2018 17:36

fmt

752d5b5

Merge branch 'master' into feature/api-issue-search

b01f5a7

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 2, 2018

sapk suggested changes Mar 2, 2018

View reviewed changes

kolaente and others added 3 commits March 2, 2018 18:03

Added comment to generate swagger json via "generate-swagger"

c2542eb

Merge remote-tracking branch 'upstream/master' into feature/api-issue…

a1211c0

…-search

Merge branch 'feature/api-issue-search' of https://github.com/kolaent…

3755d09

…e/gitea into feature/api-issue-search

Morlinest reviewed Mar 2, 2018

View reviewed changes

kolaente added 2 commits March 2, 2018 19:47

Simplified search

7818adc

fmt

1bfcb04

Morlinest reviewed Mar 2, 2018

View reviewed changes

Removed unessecary comment

38cbfd9

Morlinest reviewed Mar 2, 2018

View reviewed changes

Morlinest suggested changes Mar 2, 2018

View reviewed changes

kolaente added 3 commits March 2, 2018 20:21

Removed unessecary declaration of the issues-variable

7b08c92

Removed unessecary comment

533e1aa

Removed unessecary comment

b598149

lunny added modifies/api This PR adds API routes or modifies them type/feature Completely new functionality. Can only be merged if feature freeze is not active. labels Mar 3, 2018

lunny added this to the 1.5.0 milestone Mar 3, 2018

kolaente added 3 commits March 3, 2018 13:55

Merge branch 'master' into feature/api-issue-search

be9ddba

Merge remote-tracking branch 'upstream/master' into feature/api-issue…

c5d9b4c

…-search

Merge branch 'feature/api-issue-search' of https://github.com/kolaent…

5df8c13

…e/gitea into feature/api-issue-search

lunny requested changes Mar 3, 2018

View reviewed changes

thehowl suggested changes Mar 3, 2018

View reviewed changes

kolaente added 2 commits March 3, 2018 16:53

Added explanation keyword

5255550

Simplified check for empty keyword

5f2405d

thehowl reviewed Mar 3, 2018

View reviewed changes

corrected check if keyword is empty

1db0418

thehowl approved these changes Mar 3, 2018

View reviewed changes

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 3, 2018

lunny approved these changes Mar 4, 2018

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 4, 2018

appleboy approved these changes Mar 5, 2018

View reviewed changes

sapk approved these changes Mar 5, 2018

View reviewed changes

Merge branch 'master' into feature/api-issue-search

1f209aa

Morlinest approved these changes Mar 7, 2018

View reviewed changes

Merge branch 'master' into feature/api-issue-search

34918c6

lafriks merged commit 1a83581 into go-gitea:master Mar 7, 2018

kolaente deleted the feature/api-issue-search branch March 7, 2018 21:30

lafriks added the type/changelog Adds the changelog for a new Gitea version label Apr 11, 2018

kolaente mentioned this pull request Apr 16, 2018

Provide issue search via api #2597

Closed

go-gitea locked and limited conversation to collaborators Nov 24, 2020

delvh removed the type/changelog Adds the changelog for a new Gitea version label Oct 7, 2023

Added issue search via api #3612

Added issue search via api #3612

Conversation

kolaente commented Mar 2, 2018

codecov-io commented Mar 2, 2018 • edited Loading

Codecov Report

sapk Mar 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sapk Mar 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl Mar 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Morlinest Mar 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl Mar 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl left a comment

Choose a reason for hiding this comment

lunny commented Mar 4, 2018

sapk left a comment

Choose a reason for hiding this comment

sapk commented Mar 7, 2018

lunny commented Mar 7, 2018

kolaente commented Mar 7, 2018

codecov-io commented Mar 2, 2018 •

edited

Loading

sapk Mar 2, 2018 •

edited

Loading

sapk Mar 2, 2018 •

edited

Loading

thehowl Mar 3, 2018 •

edited

Loading

Morlinest Mar 3, 2018 •

edited

Loading

thehowl Mar 3, 2018 •

edited

Loading