mirror of
https://github.com/boostorg/website-v2.git
synced 2026-01-19 04:42:17 +00:00
48c09d3d5e
View stats per release, we do this by doing log diffs between release tags. Ex: `git log boost-1.78.0..boost-1.79.0`. The output is parsed and the commits are saved with a foreign key to the `LibraryVersion` it relates to. - commits are imported by doing "bare" clones (no project files, only git data) of repos into temporary directories, as created by python's bulitin `tempfile.TemporaryDirectory` - Added Commit model - Added CommitAuthor model - Added CommitAuthorEmail model - One CommitAuthor can have many emails. - Added task for importing commits. (and admin link to trigger it) - Added task for importing CommitAuthor github data (avatar and profile url, with admin link to trigger it) - Added a basic Library stat page which can be viewed by going to the admin -> library -> view stats. - Added a `Get Release Report` button in the `LibraryAdmin` which allows a staff member to select a boost version and up to 8 libraries to generate a report for. The report is just a webpage which attempts to convert cleanly to a pdf using the browser's print to pdf functionality. - Updated the Library Detail page to show commits per release instead of per month. - Updated the Library Detail page to show `Maintainers & Contributors` sorted by maintainers, then the top contributors for the selected release, then the top contributors overall by commits descending. - Removed CommitData, which was tracking monthly commit stats
519 lines
18 KiB
Python
519 lines
18 KiB
Python
import re
|
|
import time
|
|
import tempfile
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from dateutil.relativedelta import relativedelta
|
|
|
|
import structlog
|
|
from ghapi.core import HTTP404NotFoundError
|
|
from fastcore.xtras import obj2dict
|
|
|
|
from django.db.models import Exists, OuterRef
|
|
from django.utils.autoreload import subprocess
|
|
from django.contrib.auth import get_user_model
|
|
from django.db import transaction
|
|
from django.utils import dateparse, timezone
|
|
|
|
from versions.models import Version
|
|
from .models import (
|
|
Category,
|
|
Commit,
|
|
CommitAuthor,
|
|
CommitAuthorEmail,
|
|
Issue,
|
|
Library,
|
|
LibraryVersion,
|
|
PullRequest,
|
|
)
|
|
from core.githubhelper import GithubAPIClient, GithubDataParser
|
|
|
|
from .utils import generate_fake_email, parse_date
|
|
|
|
logger = structlog.get_logger()
|
|
|
|
User = get_user_model()
|
|
|
|
|
|
now = timezone.now()
|
|
FIRST_OF_MONTH_ONE_YEAR_AGO = timezone.make_aware(
|
|
timezone.datetime(year=now.year - 1, month=now.month, day=1)
|
|
)
|
|
FIRST_OF_CURRENT_MONTH = timezone.make_aware(
|
|
timezone.datetime(year=now.year, month=now.month, day=1)
|
|
) - relativedelta(days=1)
|
|
|
|
|
|
@dataclass
|
|
class ParsedCommit:
|
|
email: str
|
|
name: str
|
|
message: str
|
|
sha: str
|
|
version: str
|
|
is_merge: bool
|
|
committed_at: timezone.datetime
|
|
avatar_url: str | None = None
|
|
|
|
|
|
def get_commit_data_for_repo_versions(key):
|
|
library = Library.objects.get(key=key)
|
|
parser = re.compile(
|
|
r"^commit (?P<sha>\w+)(?:\n(?P<merge>Merge).*)?\nAuthor: (?P<name>[^\<]+)"
|
|
r"\s+\<(?P<email>[^\>]+)\>\nDate:\s+(?P<date>.*)\n(?P<message>(.|\n)+?)"
|
|
r"(?=(commit|\Z))",
|
|
flags=re.MULTILINE,
|
|
)
|
|
|
|
retry_count = 0
|
|
with tempfile.TemporaryDirectory() as temp_dir:
|
|
git_dir = Path(temp_dir) / f"{library.key}.git"
|
|
while retry_count < 5:
|
|
retry_count += 1
|
|
completed = subprocess.run(
|
|
["git", "clone", f"{library.github_url}.git", "--bare", str(git_dir)],
|
|
capture_output=True,
|
|
)
|
|
error = completed.stderr.decode()
|
|
if "fatal: unable to access" in error:
|
|
logger.warning(
|
|
f"{completed.args} failed. Retrying git clone. Retry {retry_count}."
|
|
)
|
|
time.sleep(2**retry_count)
|
|
continue
|
|
else:
|
|
break
|
|
versions = [""] + list(
|
|
Version.objects.filter(library_version__library__key=library.key)
|
|
.order_by("name")
|
|
.values_list("name", flat=True)
|
|
)
|
|
for a, b in zip(versions, versions[1:]):
|
|
log_output = subprocess.run(
|
|
["git", "--git-dir", str(git_dir), "log", f"{a}..{b}", "--date", "iso"],
|
|
capture_output=True,
|
|
)
|
|
commits = log_output.stdout.decode()
|
|
for match in parser.finditer(commits):
|
|
groups = match.groupdict()
|
|
name = groups["name"].strip()
|
|
email = groups["email"].strip()
|
|
sha = groups["sha"].strip()
|
|
is_merge = bool(groups.get("merge", False))
|
|
message = groups["message"].strip("\n")
|
|
message = "\n".join(
|
|
[m[4:] if m.startswith(" ") else m for m in message.split("\n")]
|
|
)
|
|
committed_at = dateparse.parse_datetime(groups["date"])
|
|
assert committed_at # should always exist
|
|
yield ParsedCommit(
|
|
email=email,
|
|
name=name,
|
|
message=message,
|
|
sha=sha,
|
|
committed_at=committed_at,
|
|
is_merge=is_merge,
|
|
version=b,
|
|
)
|
|
|
|
|
|
class LibraryUpdater:
|
|
"""
|
|
This class is used to sync Libraries from the list of git submodules
|
|
and their `libraries.json` file metadata.
|
|
"""
|
|
|
|
def __init__(self, client=None, token=None):
|
|
if client:
|
|
self.client = client
|
|
else:
|
|
self.client = GithubAPIClient()
|
|
self.api = self.client.initialize_api(token=token)
|
|
self.parser = GithubDataParser()
|
|
self.logger = structlog.get_logger()
|
|
|
|
# Modules we need to skip as they are not really Boost Libraries
|
|
self.skip_modules = [
|
|
"inspect",
|
|
"boostbook",
|
|
"bcp",
|
|
"build",
|
|
"quickbook",
|
|
"litre",
|
|
"auto_index",
|
|
"boostdep",
|
|
"check_build",
|
|
"headers",
|
|
"boost_install",
|
|
"docca",
|
|
"cmake",
|
|
"more",
|
|
]
|
|
# Libraries to skip that are not "modules", but appear as child-libraries
|
|
# of other modules. Identified by the key used in the libraries.json file.
|
|
self.skip_libraries = ["chrono/stopwatch"]
|
|
|
|
def get_library_list(self, gitmodules=None):
|
|
"""
|
|
Retrieve the full list of library data for Boost libraries from their Github
|
|
repos.
|
|
|
|
Included libraries are rrtrieved from the list of modules in .gitmodules in the
|
|
main Boost repo. The libraries.json file is retrieved from each module and
|
|
parsed to get the library metadata. Most libraries.json files contain info
|
|
about individual libraries, but a few such as "system", "functional", etc.
|
|
contain multiple libraries.
|
|
"""
|
|
libraries = []
|
|
for gitmodule in gitmodules:
|
|
if gitmodule["module"] in self.skip_modules:
|
|
continue
|
|
|
|
libraries_json = self.client.get_libraries_json(
|
|
repo_slug=gitmodule["module"]
|
|
)
|
|
github_data = self.client.get_repo(repo_slug=gitmodule["module"])
|
|
extra_data = {
|
|
"github_url": github_data.get("html_url", ""),
|
|
}
|
|
|
|
if type(libraries_json) is list:
|
|
for library in libraries_json:
|
|
data = self.parser.parse_libraries_json(library)
|
|
if data["key"] in self.skip_libraries:
|
|
continue
|
|
libraries.append({**data, **extra_data})
|
|
|
|
elif type(libraries_json) is dict:
|
|
data = self.parser.parse_libraries_json(libraries_json)
|
|
if data["key"] in self.skip_libraries:
|
|
continue
|
|
libraries.append({**data, **extra_data})
|
|
|
|
return libraries
|
|
|
|
def update_libraries(self):
|
|
"""
|
|
Update all libraries with the metadata from their libraries.json file.
|
|
"""
|
|
raw_gitmodules = self.client.get_gitmodules()
|
|
gitmodules = self.parser.parse_gitmodules(raw_gitmodules.decode("utf-8"))
|
|
library_data = self.get_library_list(gitmodules=gitmodules)
|
|
|
|
self.logger.info(
|
|
"update_all_libraries_metadata", library_count=len(library_data)
|
|
)
|
|
|
|
for lib in library_data:
|
|
obj = self.update_library(lib)
|
|
if not obj:
|
|
continue
|
|
|
|
self.update_categories(obj, categories=lib["category"])
|
|
# self.update_authors(obj, authors=lib["authors"])
|
|
|
|
def update_library(self, library_data: dict) -> Library:
|
|
"""Update an individual library"""
|
|
logger = self.logger.bind(library=library_data)
|
|
try:
|
|
obj, created = Library.objects.update_or_create(
|
|
key=library_data["key"],
|
|
defaults={
|
|
"name": library_data["name"],
|
|
"github_url": library_data["github_url"],
|
|
"description": library_data["description"],
|
|
"cpp_standard_minimum": library_data["cxxstd"],
|
|
"data": library_data,
|
|
},
|
|
)
|
|
|
|
logger = logger.bind(obj_created=created)
|
|
obj.save()
|
|
logger.info("library_udpated")
|
|
return obj
|
|
|
|
except Exception:
|
|
logger.exception("library_update_failed")
|
|
|
|
def update_categories(self, obj, categories):
|
|
"""Update all of the categories for an object"""
|
|
|
|
obj.categories.clear()
|
|
for cat_name in categories:
|
|
cat, _ = Category.objects.get_or_create(name=cat_name)
|
|
obj.categories.add(cat)
|
|
|
|
def update_authors(self, obj, authors=None):
|
|
"""
|
|
Receives a list of strings from the libraries.json of a Boost library, and
|
|
an object with an "authors" attribute.
|
|
|
|
Processes that string into a User object that is added as an
|
|
Author to the Library.
|
|
"""
|
|
if not authors:
|
|
return obj
|
|
|
|
for author in authors:
|
|
person_data = self.parser.extract_contributor_data(author)
|
|
email = person_data["email"]
|
|
user = User.objects.find_contributor(
|
|
email=person_data["email"],
|
|
first_name=person_data["first_name"],
|
|
last_name=person_data["last_name"],
|
|
)
|
|
|
|
if not user:
|
|
email = person_data.pop("email")
|
|
if not email:
|
|
email = generate_fake_email(
|
|
f"{person_data['first_name']} {person_data['last_name']}"
|
|
)
|
|
# With a new email, we may have a user record
|
|
user = User.objects.find_contributor(email=email)
|
|
|
|
# If still no user, generate a fake one
|
|
if not user:
|
|
user = User.objects.create_stub_user(email.lower(), **person_data)
|
|
self.logger.info(f"User {user.email} created.")
|
|
|
|
obj.authors.add(user)
|
|
|
|
return obj
|
|
|
|
def update_maintainers(self, obj, maintainers=None):
|
|
"""
|
|
Receives a list of strings from the libraries.json of a Boost library, and
|
|
an object with a M2M "maintainers" attribute.
|
|
|
|
Processes the list of strings into User objects and adds them as Maintainers
|
|
to the object.
|
|
"""
|
|
if not maintainers:
|
|
return
|
|
|
|
for maintainer in maintainers:
|
|
person_data = self.parser.extract_contributor_data(maintainer)
|
|
user = User.objects.find_contributor(
|
|
email=person_data["email"],
|
|
first_name=person_data["first_name"],
|
|
last_name=person_data["last_name"],
|
|
)
|
|
|
|
if not user:
|
|
email = person_data.pop("email")
|
|
if not email:
|
|
email = generate_fake_email(
|
|
f"{person_data['first_name']} {person_data['last_name']}"
|
|
)
|
|
user = User.objects.create_stub_user(email.lower(), **person_data)
|
|
self.logger.info(f"User {user.email} created.")
|
|
|
|
obj.maintainers.add(user)
|
|
self.logger.info(f"User {user.email} added as a maintainer of {obj}")
|
|
|
|
def update_issues(self, obj):
|
|
"""Import GitHub issues for the library and update the database"""
|
|
self.logger.info("updating_repo_issues")
|
|
|
|
issues_data = self.client.get_repo_issues(
|
|
self.client.owner, obj.github_repo, state="all", issues_only=True
|
|
)
|
|
for issue_dict in issues_data:
|
|
# Get the date information
|
|
closed_at = None
|
|
created_at = None
|
|
modified_at = None
|
|
|
|
if issue_dict.get("closed_at"):
|
|
closed_at = parse_date(issue_dict["closed_at"])
|
|
|
|
if issue_dict.get("created_at"):
|
|
created_at = parse_date(issue_dict["created_at"])
|
|
|
|
if issue_dict.get("updated_at"):
|
|
modified_at = parse_date(issue_dict["updated_at"])
|
|
|
|
# Create or update the Issue object
|
|
try:
|
|
issue, created = Issue.objects.update_or_create(
|
|
library=obj,
|
|
github_id=issue_dict["id"],
|
|
defaults={
|
|
"title": issue_dict["title"][:255],
|
|
"number": issue_dict["number"],
|
|
"is_open": issue_dict["state"] == "open",
|
|
"closed": closed_at,
|
|
"created": created_at,
|
|
"modified": modified_at,
|
|
"data": obj2dict(issue_dict),
|
|
},
|
|
)
|
|
self.logger.info(
|
|
"issue_updated_successfully",
|
|
issue_id=issue.id,
|
|
created_issue=created,
|
|
issue_github_id=issue.github_id,
|
|
)
|
|
except Exception as e:
|
|
self.logger.exception(
|
|
"update_issues_error_skipped_issue",
|
|
issue_github_id=issue_dict.get("id"),
|
|
exc_msg=str(e),
|
|
)
|
|
continue
|
|
|
|
def update_prs(self, obj):
|
|
"""Update all PRs for a library"""
|
|
self.logger.info("updating_repo_prs")
|
|
|
|
prs_data = self.client.get_repo_prs(obj.github_repo, state="all")
|
|
|
|
for pr_dict in prs_data:
|
|
# Get the date information
|
|
closed_at = None
|
|
merged_at = None
|
|
created_at = None
|
|
modified_at = None
|
|
|
|
if pr_dict.get("closed_at"):
|
|
closed_at = parse_date(pr_dict["closed_at"])
|
|
|
|
if pr_dict.get("merged_at"):
|
|
merged_at = parse_date(pr_dict["merged_at"])
|
|
|
|
if pr_dict.get("created_at"):
|
|
created_at = parse_date(pr_dict["created_at"])
|
|
|
|
if pr_dict.get("updated_at"):
|
|
modified_at = parse_date(pr_dict["updated_at"])
|
|
|
|
try:
|
|
pull_request, created = PullRequest.objects.update_or_create(
|
|
library=obj,
|
|
github_id=pr_dict["id"],
|
|
defaults={
|
|
"title": pr_dict["title"][:255],
|
|
"number": pr_dict["number"],
|
|
"is_open": pr_dict["state"] == "open",
|
|
"closed": closed_at,
|
|
"merged": merged_at,
|
|
"created": created_at,
|
|
"modified": modified_at,
|
|
"data": obj2dict(pr_dict),
|
|
},
|
|
)
|
|
self.logger.info(
|
|
"pull_request_updated_successfully",
|
|
pr_id=pull_request.id,
|
|
created_pr=created,
|
|
pr_github_id=pull_request.github_id,
|
|
)
|
|
except Exception as e:
|
|
self.logger.exception(
|
|
"update_prs_error_skipped_pr",
|
|
pr_github_id=pr_dict.get("id"),
|
|
exc_msg=str(e),
|
|
)
|
|
|
|
def update_commits(self, obj: Library, clean=False):
|
|
"""Import a record of all commits between LibraryVersions."""
|
|
authors = {}
|
|
commits = []
|
|
library_versions = {
|
|
x.version.name: x
|
|
for x in LibraryVersion.objects.filter(library=obj).select_related(
|
|
"version"
|
|
)
|
|
}
|
|
with transaction.atomic():
|
|
if clean:
|
|
Commit.objects.filter(library_versions__library=obj).delete()
|
|
for commit in get_commit_data_for_repo_versions(obj.key):
|
|
author = authors.get(commit.email, None)
|
|
if not author:
|
|
if (
|
|
commit_author_email := CommitAuthorEmail.objects.filter(
|
|
email=commit.email,
|
|
)
|
|
.select_related("author")
|
|
.first()
|
|
):
|
|
author = commit_author_email.author
|
|
else:
|
|
author = CommitAuthor.objects.create(
|
|
name=commit.name, avatar_url=commit.avatar_url
|
|
)
|
|
CommitAuthorEmail.objects.create(
|
|
email=commit.email, author=author
|
|
)
|
|
authors[commit.email] = author
|
|
commits.append(
|
|
Commit(
|
|
author=author,
|
|
library_version=library_versions[commit.version],
|
|
sha=commit.sha,
|
|
message=commit.message,
|
|
committed_at=commit.committed_at,
|
|
is_merge=commit.is_merge,
|
|
)
|
|
)
|
|
Commit.objects.bulk_create(
|
|
commits,
|
|
update_conflicts=True,
|
|
update_fields=["author", "message", "committed_at", "is_merge"],
|
|
unique_fields=["library_version", "sha"],
|
|
)
|
|
|
|
def update_commit_author_github_data(self, obj=None, email=None, overwrite=False):
|
|
"""Update CommitAuthor data by parsing data on their most recent commit."""
|
|
if email:
|
|
authors = CommitAuthor.objects.filter(
|
|
Exists(CommitAuthorEmail.objects.filter(id=OuterRef("pk"), email=email))
|
|
)
|
|
elif obj:
|
|
authors = CommitAuthor.objects.filter(
|
|
Exists(
|
|
Library.objects.filter(
|
|
library_version__commit__author=OuterRef("id"),
|
|
pk=obj.pk,
|
|
)
|
|
)
|
|
)
|
|
else:
|
|
authors = CommitAuthor.objects.all()
|
|
|
|
if not overwrite:
|
|
authors = authors.filter(avatar_url=None)
|
|
|
|
authors = authors.annotate(
|
|
most_recent_commit_sha=Commit.objects.filter(author=OuterRef("pk"))
|
|
.order_by("-committed_at")
|
|
.values("sha")[:1]
|
|
).annotate(
|
|
most_recent_library_key=Library.objects.filter(
|
|
library_version__commit__sha=OuterRef("most_recent_commit_sha")
|
|
).values("key")[:1]
|
|
)
|
|
libraries = Library.objects.filter(
|
|
key__in=[x.most_recent_library_key for x in authors]
|
|
)
|
|
repos = {x.key: x for x in libraries}
|
|
for author in authors:
|
|
try:
|
|
commit = self.client.get_repo_ref(
|
|
repo_slug=repos[author.most_recent_library_key].github_repo,
|
|
ref=author.most_recent_commit_sha,
|
|
)
|
|
except HTTP404NotFoundError:
|
|
self.logger.info(
|
|
f"Commit not found. Skipping avatar update for {author}."
|
|
)
|
|
continue
|
|
if gh_author := commit["author"]:
|
|
if gh_author["avatar_url"]:
|
|
author.avatar_url = gh_author["avatar_url"]
|
|
if gh_author["html_url"]:
|
|
author.github_profile_url = gh_author["html_url"]
|
|
author.save(update_fields=["avatar_url", "github_profile_url"])
|