API method to list all commits of a repository

[Mikescher]

This adds a new API Endpoint to list the commits of a repository:
/api/v1/repos/{user}/{repo}/git/commits?sha={id}&page={p}
(equivalent github api)

This functionality was a few times requested ( #3710 ; #5181 ) but I think nobody ever implemented it and because I need it for a personal project I tried my hands on it :)

I'm not really proficient in go, but I hope I did everything ok.

[codecov-io]

Codecov Report

Merging #6408 into master will increase coverage by 0.09%.
The diff coverage is 73.65%.

@@            Coverage Diff             @@
##           master    #6408      +/-   ##
==========================================
+ Coverage   41.49%   41.58%   +0.09%     
==========================================
  Files         479      479              
  Lines       63983    64124     +141     
==========================================
+ Hits        26550    26667     +117     
- Misses      33977    33995      +18     
- Partials     3456     3462       +6

Impacted Files	Coverage Δ
routers/api/v1/api.go	71.65% <100%> (+0.08%)	⬆️
routers/api/v1/repo/commits.go	77.44% <72.5%> (+4.53%)	⬆️
models/repo_list.go	73.17% <0%> (-0.98%)	⬇️
models/repo_indexer.go	66.66% <0%> (+2.03%)	⬆️

---

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 6b3f52f...e91dbbd. Read the comment docs.

[mmarif4u]

I was going to open an issue for this, but thanks to this new PR.

Few questions @Mikescher,

• what is git here? is this part of the path?
• how many commits will it return by default or per page?

Minor feature request, is it possible to add boolean(true/false) flag to return in json for pagination if there is more than one page. That will make it more convinient instead of calling the end point for more results when there are not.

Thanks for the work.

[Mikescher]

what is git here? is this part of the path?

Well, the repos/{user}/{repo}/git/<sha> method did already exist (to get a single commit) so I thought I just keep the same schema

how many commits will it return by default or per page?

The page size is the one specified in git.CommitsRangeSize, currently it's 50 [1]

Is it possible to add boolean(true/false) flag to return in json for pagination if there is more than one page. That will make it more convinient instead of calling the end point for more results when there are not.

Hmm, I kinda liked it that it is (more or less) the same format as the Github API.
Perhaps I could add two header fields, X-CurrentPage and X-PageCount?

[1] https://github.com/go-gitea/gitea/blob/master/vendor/code.gitea.io/git/repo_commit.go#L229

[mmarif4u]

Thanks @Mikescher.

I was more into stackoverflow api.
"has_more": true

https://api.stackexchange.com/docs/questions#order=desc&sort=activity&filter=default&site=stackoverflow&run=true

[Mikescher]

@ mmarif4u
Yeah, that would also be a possibility.
There are currently a few other API method in gitea that return a paginated list:

• /repos/{owner}/{repo}/issuesList (List a repositories issues)
• /repos/{owner}/{repo}/pulls (List a repo's pull requests)

and they all follows the same design (directly return an array).

Would it be really be a problem for you if I put the has_more information into an response_header field? I kinda like the idea :)

[mmarif4u]

Anything will work with me as i need this for the Android app to implement, so i no need to call the API the 2nd time if there are no more records for the call.
https://gitlab.com/mmarif4u/gitnex

[Mikescher]

@mmarif4u:
Hey your the gitnex guy, I'm actually using your app on my phone :D

I added a few Response headers: X-Page, X-HasMore, X-PageCount, X-PerPage and X-Total.
And the I spend a stupid amount of time to get swagger to recognize them...

I hope they are enough for your use case.

[Mikescher]

(rebased pull request cause of #6364)

Imo everything is cleared up and the PR can be reviewed

[Mikescher]

Well, I have no idea why the drone CI build suddenly fails. The only thing I did was rebasing my commits because there where quite a lot of commits since I created this PR...

It look like the go vendor build step is downloading the latest versions of everything in /vendor/ and is then failing because it's different from the used versions - but no idea why it's suddenly doing that...

Also: Is there something I should change to get this merged or just wait until someone has time to look at it?

[EDIT]: Fixed it - CI works again, someone moved the import path of the Commit struct

[zeripath]

Hmm... Why can't you just use git for this?

[lunny]

@zeripath for an andorid client or others like, it's meaningful.

[sapk]

@Mikescher Can you make the suggested refactor?
@lunny @lafriks if not possible are you ok to merge as this and I will send the refactor after merge?

[Mikescher]

@Mikescher Can you make the suggested refactor?

Okay I moved some code to a commit toCommit method, I hope that was what you meant?

I'm currently in the middle of my exams so I don't have that much free time...

[sapk]

That exactly what I mean and I totally understand that you may have no time for that so that why I suggest to merge as this. But this is perfect. Thanks again for your time. Good luck for your exams.

[sapk]

Looking at last comment from @lunny, I think I can merge this.

Thanks again for your contrib @Mikescher

[richmahn]

@Mikescher Good job! Glad we got this in! Just happened to look at this one today to see where it was and cool to see it had activity today and got merged in.

[24unix]

Is there any kind of special configuration needed to get the headers?
For me it works (on a private repo) with
curl -X GET -I "https://git.xxx.net/api/v1/repos/xxx.net/yyy/commits" -H "accept: application/json" -H "Authorization: token scrambledtoken"
but with an axios request I just receive the content-type in the header. I spent hours finding the mistake by myself but to no avail :( found some things related to cors stuff, but it is enabled in my app.ini.
So, what do I have to change in app.ini to get those headers with axios? Or, even better, would it be possible to return X-Total in data, like lenght?

[zeripath]

The headers required are: "accept: application/json" and "Authorization: token scrambledtoken"

[24unix]

Thanks for the very fast reply, but it didn't help :-(
I guess it's something stupid I don't see …

axios.get(https://git.xxx.net/api/v1/repos/xxxx.net/yyy/commits?page=${this.currentPage}&limit=5`,
{
headers: {
Authorization: 'token ' + "xxxxxxxxx3c259f249d1292e2a3ce6234abe46f1a",
accept: "application/json"
}
})
.then((response) => {`

[zeripath]

Is Axios actually sending a get? Do you have access to the server router logs - just to double check that it's querying with GET. It could be useful to see what Axios is sending by checking the browser network logs.

Seeing that the curl command works implies that the problem is at the Axios end.

[24unix]

This are the logs:
176.94.8.122 - - [31/Jul/2020:21:39:01 +0000] "OPTIONS /api/v1/repos/xxx.net/yyy/commits?page=1&limit=5 HTTP/1.1" 200 4363 "https://127.0.0.1:8000/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_16_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.105 Safari/537.36" 176.94.8.122 - - [31/Jul/2020:21:39:01 +0000] "GET /api/v1/repos/xxx.net/yyy/commits?page=1&limit=5 HTTP/1.1" 200 8547 "https://127.0.0.1:8000/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_16_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.105 Safari/537.36"

edit: The access-control-allow-header are empty, I read something that there ust be the allowed values, but I didn't find any option in Gitea.

edit2: according to this:
https://stackoverflow.com/questions/37897523/axios-get-access-to-response-header-fields
and that:
https://stackoverflow.com/questions/37897523/axios-get-access-to-response-header-fields
the headers are available (like in my screenshot) but they are not exposed to to axios, so there must be a server side cors config for access-control-allow-headers.
I tried the direct way (port 3000, avoiding the apache proxy), same result, so it must be changed in gitea.
Only difference: gitea send this in the browsers network headers:
Access-Control-Allow-Headers: authorization
I added mod_headers to the apache, added authorization and X-tal, but it still is not visible for axios, so I'll need to find a way to tell gitea to send the headers.
I found this thread about AccessControlAllowOrigin:
https://github.com/go-gitea/gitea/pull/5719/files/a9a1e4259868b6c1e6090e1f556f9ec6354d8b7b

gotcha, found that:
ctx.Resp.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization, User-Agent")

pulled the source, but it looks very different now, as the thread is from 2018. I'll dig deeper into it …

last edit for today: spent hours building a go toolchain, building gitea from scratch, found out a bit about gitea internals but not yet enough, will try agaiin tomorrow, err … later

[zeripath]

Axios is sending an OPTIONS request not a GET, following that OPTIONS request it appears to send a GET but I wonder if that OPTIONS is to blame?

[24unix]

Oh, yes, overlooked it lasts night. Found that:
axios/axios#475
It's a preflight check from axios to check capabilities. But axios still won't work.

[24unix]

Nobody here using axios with gitea? Or am I the only one with that problem?

[6543]

@24unix looks like not

and if you have more issues pleace create a new issue(s) and just reverence merged pulls / closed issues :)
this keep unrelated stuff seperated :)