Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add base management command for projects #73

Merged
merged 4 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 38 additions & 5 deletions api/outdated/commands.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,43 @@
from asyncio import run
from functools import reduce
from operator import or_

from django.core.management.base import BaseCommand
from django.core.management.base import BaseCommand, CommandParser
from django.db.models import Q

from outdated.outdated.models import Project

class AsyncCommand(BaseCommand):
"""Base command to run async code."""

class ProjectCommand(BaseCommand):
def add_arguments(self, parser: CommandParser) -> None:
projects = parser.add_mutually_exclusive_group(required=True)
projects.add_argument(
"--all",
action="store_true",
help="Affect all projects",
)
projects.add_argument("projects", nargs="*", type=str, default=[])

def handle(self, *args, **options):
run(self._handle(*args, **options))
if not options["all"]:
project_names = options["projects"]
q = reduce(or_, (Q(name__iexact=name) for name in project_names))
projects = Project.objects.filter(q)
if projects.count() != len(project_names):
missing_projects = list(
set(project_names).difference(
projects.values_list("name", flat=True),
),
)
missing_projects.sort()
self.stderr.write(
f"Projects with names {', '.join(missing_projects)} do not exist",
)
return
else:
projects = Project.objects.all()

for project in projects:
self._handle(project)

def _handle(self, project: Project) -> None: # pragma: no cover
raise NotImplementedError
22 changes: 6 additions & 16 deletions api/outdated/outdated/management/commands/syncproject.py
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
from django.core.management.base import BaseCommand

from outdated.outdated.models import Project
from outdated.commands import ProjectCommand
from outdated.outdated.synchroniser import Synchroniser


class Command(BaseCommand):
class Command(ProjectCommand):
help = "Syncs the given project with its remote counterpart."

def add_arguments(self, parser):
parser.add_argument("project_name", type=str)

def handle(self, *_, **options):
project_name = options["project_name"]
try:
project = Project.objects.get(name__iexact=project_name)
self.stdout.write(f"Syncing project {project}")
Synchroniser(project).sync()
self.stdout.write(f"Finished syncing {project}")
except Project.DoesNotExist:
self.stdout.write(f"Project {project_name} not found")
def _handle(self, project):
self.stdout.write(f"Syncing project {project}")
Synchroniser(project).sync()
self.stdout.write(f"Finished syncing {project}")
15 changes: 0 additions & 15 deletions api/outdated/outdated/management/commands/syncprojects.py

This file was deleted.

136 changes: 53 additions & 83 deletions api/outdated/outdated/synchroniser.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
from __future__ import annotations

import logging
from asyncio import gather, run, sleep
from pathlib import Path
from re import findall

from aiohttp import ClientSession, client_exceptions
from asgiref.sync import sync_to_async
from dateutil import parser
from django.conf import settings
from django.utils import timezone
from requests import get, post
from semver import Version as SemVer
from tomllib import loads

Expand Down Expand Up @@ -38,7 +35,7 @@ def __init__(self, project):
self.project = project
self.owner, self.name = findall(r"\/([^\/]+)\/([^\/]+)$", self.project.repo)[0]

async def _get_dependencies(self): # noqa: C901
def _get_dependencies(self):
"""Get the dependencies from the lockfiles."""
q = f"""
{{
Expand All @@ -52,58 +49,38 @@ async def _get_dependencies(self): # noqa: C901
}}
"""

async with ClientSession() as session, session.post(
resp = post(
"https://api.github.com/graphql",
headers={
"Authorization": f"Bearer {settings.GITHUB_API_TOKEN}",
"Accept": "application/vnd.github.hawkgirl-preview+json",
},
json={"query": q},
) as response:
json = await response.json()
if json.get("message") == "Bad credentials": # pragma: no cover
msg = "API Token is not set"
raise ValueError(msg)
if json.get("errors") and json["errors"][0]["message"] == "timedout":
return await self._get_dependencies() # pragma: no cover
if json.get("errors"):
raise ValueError(json) # pragma: no cover
headers = response.headers
if headers.get("X-RateLimit-Remaining") == "0": # pragma: no cover
t = (
int(headers.get("X-RateLimit-Reset"))
- int(timezone.now().timestamp())
) / 1000
logger.info("Rate limit exceeded. Sleeping for %s seconds.", t)
await sleep(t)
return await self._get_dependencies()

lockfiles = []
lockfile_tasks = []
for lockfile in json["data"]["repository"]["dependencyGraphManifests"][
"nodes"
]:
if basename(lockfile["blobPath"]) in LOCK_FILES:
url = f"https://raw.githubusercontent.com/{lockfile['blobPath'].replace('blob/', '')}"
lockfile_tasks.append(session.get(url))
lockfiles = [
{
"name": basename(str(lockfile_task.url)),
"data": await lockfile_task.text(),
}
for lockfile_task in await gather(*lockfile_tasks)
]

return await LockFileParser(lockfiles).parse()
timeout=10,
)

def sync(self):
"""Sync the project with the remote project."""
run(self.a_sync())
json = resp.json()

if json.get("message") == "Bad credentials": # pragma: no cover
msg = "API Token is not set"
raise ValueError(msg)
if json.get("errors"): # pragma: no cover
raise ValueError(json)

lockfiles = []
for lockfile in json["data"]["repository"]["dependencyGraphManifests"]["nodes"]:
if basename(lockfile["blobPath"]) not in LOCK_FILES:
continue

url = f"https://raw.githubusercontent.com/{lockfile['blobPath'].replace('blob/', '')}"
lockfiles.append({"name": basename(url), "data": get(url, timeout=10).text})

return LockFileParser(lockfiles).parse()

async def a_sync(self):
def sync(self):
"""Sync the project with the remote project."""
dependencies = await self._get_dependencies()
await sync_to_async(self.project.versioned_dependencies.set)(dependencies)
dependencies = self._get_dependencies()
self.project.versioned_dependencies.set(dependencies)


class LockFileParser:
Expand All @@ -118,61 +95,55 @@ def _get_provider(self, name: str) -> str:
return "NPM"
return "PIP"

async def _get_version(self, requirements: tuple, provider: str) -> models.Version:
dependency, dependency_created = await models.Dependency.objects.aget_or_create(
def _get_version(self, requirements: tuple, provider: str) -> models.Version:
dependency, dependency_created = models.Dependency.objects.get_or_create(
name=requirements[0],
provider=provider,
)
major, minor, patch = SemVer.parse(get_version(requirements[1])).to_tuple()[0:3]

release_version, _ = await models.ReleaseVersion.objects.aget_or_create(
release_version, _ = models.ReleaseVersion.objects.get_or_create(
dependency=dependency,
major_version=major,
minor_version=minor,
)

version, version_created = await models.Version.objects.aget_or_create(
version, version_created = models.Version.objects.get_or_create(
release_version=release_version,
patch_version=patch,
)

if dependency_created or version_created:
version.release_date = await self._get_release_date(version)
await sync_to_async(version.save)()
version.release_date = self._get_release_date(version)
version.save()

return version

async def _get_release_date(self, version):
def _get_release_date(self, version):
"""Get the release date of a dependency."""
dependency = version.release_version.dependency
name, provider = dependency.name, dependency.provider

try:
if provider == "NPM":
async with ClientSession() as session, session.get(
f"https://registry.npmjs.org/{name}",
) as response:
response.raise_for_status()
json = await response.json()
release_date = json["time"][version.version]

elif provider == "PIP":
async with ClientSession() as session, session.get(
f"https://pypi.org/pypi/{name}/{version.version}/json",
) as response:
response.raise_for_status()
release_date = (await response.json())["urls"][0]["upload_time"]
return parser.parse(release_date).date()
except (
client_exceptions.ClientOSError,
client_exceptions.ServerDisconnectedError,
): # pragma: no cover
await sleep(1)
return await self._get_release_date(version)

async def parse(self):
if provider == "NPM":
resp = get(f"https://registry.npmjs.org/{name}", timeout=10)
resp.raise_for_status()
json = resp.json()
release_date = json["time"][version.version]

elif provider == "PIP":
resp = get(
f"https://pypi.org/pypi/{name}/{version.version}/json",
timeout=10,
)
resp.raise_for_status()
json = resp.json()
release_date = json["urls"][0]["upload_time"]

return parser.parse(release_date).date()

def parse(self):
"""Parse the lockfile and return a dictionary of dependencies."""
tasks = []
versions = []
for lockfile in self.lockfiles:
name = lockfile["name"]
data = lockfile["data"]
Expand All @@ -192,11 +163,10 @@ async def parse(self):
for dependency in loads(data)["package"]
if dependency["name"] in settings.TRACKED_DEPENDENCIES
]
tasks.extend(
versions.extend(
[
self._get_version(dependency, provider)
for dependency in dependencies
],
)

return await gather(*tasks)
return versions
Loading