Contribution system: History heatmap for user

[joubertredrat]

Hi guys,

I think that is a possible feature, a history heatmap similar to github or gitlab.
Actually exists a plugin called Calendar HeatMap. I used this on mine project to heat application log and worked fine here.
Then, is only a idea, what you think? :)

http://cal-heatmap.com/
https://github.com/wa0x6e/cal-heatmap

Reference: gogs/gogs#1640

[bkcsoft]

I would prefer a solution that is in the backend, unless it's required to have it update without reloading. Unfortunately I can't seem to find anything that does that 😒

Also this would require caching, since it will fetch huge amounts of data from disk...

[joubertredrat]

Yes, this plugin build on front-end, with backend I don't know too, but we can consider make component for this.

In my case I use ajax to get data, but build on frontend anyway

[xinity]

following @bkcsoft retention strategy in cache is a must if we don't want gitea to waste ressources.
something like in the latest 15days could be enough don't you think ?

[bkcsoft]

@xinity a simple LRU-cache should suffice in my opinion. Might be useful to be able to set the size of that cache though.
For my own projects I use hashicorp/golang-lru which works just fine and has a configurable size 🙂

[charlesreid1]

d3-calendar illustrates this really nicely and simply with javascript: https://bl.ocks.org/mbostock/4063318

git log is really flexible, so you can use it to output directly to JSON format, filter on users or dates, customize output format, etc (even has its own set of shortcodes). After an aggregation step, that data can be loaded into D3 calendar (basically just json objects with a key of the date and a value of the number of commits).

Here is a single-user activity graph that illustrates embedding the Javascript visualization in the home template file: git.charlesreid1.com and modified home template.

[lunny]

@charlesreid1 could you send a PR to gitea with your heatmap?

[charlesreid1]

I'm happy to put together a visualization in an PR, but a couple of things need to be worked out first:

1. Placement. My example heatmap is commit data scraped for a single user, displayed on the home page for the (single-user) gitea server - which doesn't make sense for multi-user gitea servers. If we wanted to have a per-user heatmap, it could go a couple of places:

• Behind the "Public Activity" tab on the user's profile (most appropriate place, but not very visible)
• Just on top of the three tabs "Repositories"/"Public Activity"/"Starred repositories" on the user's profile (most visible, on user profile so useful for others to see your activity graph)
• On the top of the user's dashboard (less useful since others cannot see your activity graph)

2. Data. The model I'm using for data would need to be changed a bit as well (my visualization points to a JSON file not dynamically generated by gitea). We could modify gitea to cache per-user commit data (updated with a post-commit hook or a daily maintenance task) and provide an endpoint route, where you provide it a username and it returns commit data in a JSON form convenient for visualization.

Thoughts? Potential roadblocks?

[lunny]

I would like put it under the Public Activity tab and top of all the activities on user's profile. Like the below example image:

[joubertredrat]

@lunny I liked this approach, if possible to change color to green can be best.... or not, github is green too.