Implement contributors graph

[sahinakkaya]

Update: Unfortunately, this PR got closed by a mistake and can't be reopened. We are continuing discussion in #27882.

Overview

This is the implementation of a requested feature: Contributors graph (#847)

It makes Activity page a multi-tab page and adds a new tab called contributors. Contributors tab shows the contribution graphs over time since the repository existed. It also shows per user contribution graphs for top 100 contributors. Top 100 is calculated based on the selected contribution type (commits, additions or deletions).

---

Demo

Screen.Recording.2023-07-11.at.10.51.37.mov

Features:

• Select contribution type (commits, additions or deletions)
• See overall and per user contribution graphs for the selected contribution type
• Zoom and pan on graphs to see them in detail
• See top 100 contributors based on the selected contribution type and selected time range
• Go directly to users' profile by clicking their name if they are registered gitea users

Benchmarks:

Here are the loading time of the Contributors page for some repositories:

• Gitea repository with ~15k commits:
  • Page: 17079ms
  • Template repo/contributors: 316ms
• My test repo with ~400 commits:
  • Page: 169ms
  • Template repo/contributors: 1ms

Issues to consider before merging

• For big repositories, page loading time increases dramatically. We might consider setting a cron job as @lunny mentioned which I have no idea how to do so.
• Again, for big repositories, updating all charts at the same time (while zooming, panning etc.) might cause performance issues. I don't experience this on my computer but I didn't test it on a low end device.
• When contribution type is changed by user, whole page is re-rendered causing fetching the same data again which is unnecessary. This can be easily avoided by passing only the selected option to Vue. But I don't know how to do it so I need help here. (this is fixed 🥳)
• Following issues are related with each other and likely to be fixed together (these are also fixed 🥳):
  • When contribution type is changed by user, we probably need to sort per user graphs based on the selected contribution type and not commits (which is default).
  • When user zooms or pans the graphs, we need to update title of the page to show correct dates. Currently this is hard-coded. (From repository start date - To current date)
  • When user zooms or pans the graphs, we probably need to update statistics on per user graphs (x commits, y additions, z deletions) to account only commits from the selected date range. Currently, they are calculated from start date to end date and sorted by total commits.
• I don't know how to handle the errors so you might see things like iDontCareAboutErrors, _ := someFunc() while reviewing the code :D We probably need to handle them correctly so please point me in the right direction.
• Most of the code I wrote is taken from other places in this repository and modified to fit my needs. Sometimes I encountered permission related code and I didn't bother to implement proper permission check for this feature. So I just used them as is. All the permission related code is taken from Activity page. We probably need to change them and implement proper permission check.

[sahinakkaya]

It would be nice to get some feedback and help about how to handle the issues I mentioned.

[JakobDev]

Looks cool!

A little thing about the new Tab: We already have a few Tabs for the Repo, depending n what is activated. It might be a good Idea, to add a new Insights Tab like GitHub, where we put this and other stats, that may be added in the future, in. The ACtivity could also be moved in the Insights Tab.

[lunny]

Thank you for your contributions. It's amazing.

Since it sums per day, so we can run the cron job per day and store the result in some table. Then all the performance problems will disappear. Another possible improvement is to retrieve the data via AJAX so the UI will not be blocked to wait data.

[sahinakkaya]

It might be a good Idea, to add a new Insights Tab like GitHub...

@JakobDev yeah I agree. I didn't want to do that in this PR because it is out of scope and I was not sure if I can do it without breaking something :D With the changes in this PR, it is possible to create Code Frequency graph very easily. So someone might do that after creating Insights tab.

@lunny Actually, it doesn't sum per day but per week. The structure is very similar to Github's mentioned in here. Still we can set up a cron job to run per day for big repositories though.

I have implemented an endpoint to get commit data but then deleted it because I couldn't find a way to use it :D Retrieving the data with an AJAX call makes sense. I will try that.

[6543]

please dont forcepush it make's it hard to review :/

we do squashmerge in the end anyway

[silverwind]

Based on the demo video, the graphs seem a bit too high. Should probably reduce their height to 50-70% of what they currently have.

[silverwind]

Not sure I can help on the backend topics, but I will definitely help one the frontend ones.

[sahinakkaya]

@lunny Did you have a chance to look at this again? I am waiting for reviews from maintainers.

[lunny]

@lunny Did you have a chance to look at this again? I am waiting for reviews from maintainers.

I will do it in following week.

outdated

[6543]

tested it and it looks like the template did fall apart a bit - as the menues do not have text anymore :/

[sahinakkaya]

tested it and it looks like the template did fall apart a bit - as the menues do not have text anymore :/

Yeah, I just realized it. It looks like it happened after #27856. I don't know how to fix it though. fixed.

[silverwind]

Will check this out in a few days.

[silverwind]

I'm sorry I destroyed the PR by pushing my main branch onto it accidentially and we can not revive this PR now. Let's continue in #27880.

Lesson for me: use git push sahinakkaya chart:main to push to differently named branch because git apparently will prefer same-named branch as source, at least in my config.
Lesson for sahinakkaya: Never raise a PR from a main branch.

[sahinakkaya]

I'm sorry I destroyed the PR by pushing my main branch onto it accidentially and we can not revive this PR now. Let's continue in #27880.

Can't I force push my branch and continue to this as if nothing happened?

Lesson for sahinakkaya: Never raise a PR from a main branch.

Duly noted.

[silverwind]

Can't I force push my branch and continue to this as if nothing happened?

Yes, try that. I was unable to force-push your branch again as the PR got closed and I lost push permission with the closure, but you should be able to. I can then push my last commit onto that.

[sahinakkaya]

@silverwind I force pushed but I don't see my commits in this PR. Maybe it needs to be re-opened by maintainers if that's possible.

[sahinakkaya]

According to this it should be possible to reopen but I don't know if did the right thing. I just did git push -f which is force pushing my main branch to sahinakkaya:main

Edit: reading that again, it should be possible to reopen this now. I just don't have the permission to do that.

[silverwind]

Hmm no, I can't reopen currently:

I think it's a GitHub bug. I never seen a PR ressurect after resetting a branch.

[silverwind]

If you like, push to a new branch name and make the PR from that, than I will close my new one.

[sahinakkaya]

Ok, I opened a new PR (#27882) with a new branch. You can close yours @silverwind.