mirrors/takahe
1
1
Fork 0
mirror of https://github.com/jointakahe/takahe.git synced 2024-11-24 16:20:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

Module-specific loggers and minor reformatting (#657)

Browse source
This commit is contained in:
Osma Ahvenlampi 2023-11-16 19:27:20 +02:00 committed by GitHub
parent 2f546dfa74
commit 1ceef59bec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 84 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
activities/models/post.py
View file

@ -46,6 +46,8 @@ from users.models.identity import Identity, IdentityStates
from users.models.inbox_message import InboxMessage from users.models.inbox_message import InboxMessage
from users.models.system_actor import SystemActor from users.models.system_actor import SystemActor
logger = logging.getLogger(__name__)
class PostStates(StateGraph): class PostStates(StateGraph):
new = State(try_interval=300) new = State(try_interval=300)
@ -897,7 +899,7 @@ class Post(StatorModel):
# don't have content, but this shouldn't be a total failure # don't have content, but this shouldn't be a total failure
post.content = get_value_or_map(data, "content", "contentMap") post.content = get_value_or_map(data, "content", "contentMap")
except ActivityPubFormatError as err: except ActivityPubFormatError as err:
logging.warning(f"{err} on {post.url}") logger.warning("%s on %s", err, post.url)
post.content = None post.content = None
# Document types have names, not summaries # Document types have names, not summaries
post.summary = data.get("summary") or data.get("name") post.summary = data.get("summary") or data.get("name")
@ -993,8 +995,10 @@ class Post(StatorModel):
try: try:
cls.ensure_object_uri(post.in_reply_to, reason=post.object_uri) cls.ensure_object_uri(post.in_reply_to, reason=post.object_uri)
except ValueError: except ValueError:
logging.warning( logger.warning(
f"Cannot fetch ancestor of Post={post.pk}, ancestor_uri={post.in_reply_to}" "Cannot fetch ancestor of Post=%s, ancestor_uri=%s",
post.pk,
post.in_reply_to,
) )
else: else:
parent.calculate_stats() parent.calculate_stats()

4
activities/services/post.py
View file

@ -9,6 +9,8 @@ from activities.models import (
) )
from users.models import Identity from users.models import Identity
logger = logging.getLogger(__name__)
class PostService: class PostService:
""" """
@ -99,7 +101,7 @@ class PostService:
try: try:
Post.ensure_object_uri(object_uri, reason=reason) Post.ensure_object_uri(object_uri, reason=reason)
except ValueError: except ValueError:
logging.error( logger.error(
f"Cannot fetch ancestor Post={self.post.pk}, ancestor_uri={object_uri}" f"Cannot fetch ancestor Post={self.post.pk}, ancestor_uri={object_uri}"
) )
break break

6
core/ld.py
View file

@ -8,6 +8,8 @@ from pyld import jsonld
from core.exceptions import ActivityPubFormatError from core.exceptions import ActivityPubFormatError
logger = logging.getLogger(__name__)
schemas = { schemas = {
"unknown": { "unknown": {
"contentType": "application/ld+json", "contentType": "application/ld+json",
@ -630,7 +632,7 @@ def builtin_document_loader(url: str, options={}):
# Get URL without scheme # Get URL without scheme
pieces = urllib_parse.urlparse(url) pieces = urllib_parse.urlparse(url)
if pieces.hostname is None: if pieces.hostname is None:
logging.info(f"No host name for json-ld schema: {url!r}") logger.info(f"No host name for json-ld schema: {url!r}")
return schemas["unknown"] return schemas["unknown"]
key = pieces.hostname + pieces.path.rstrip("/") key = pieces.hostname + pieces.path.rstrip("/")
try: try:
@ -641,7 +643,7 @@ def builtin_document_loader(url: str, options={}):
return schemas[key] return schemas[key]
except KeyError: except KeyError:
# return an empty context instead of throwing an error # return an empty context instead of throwing an error
logging.info(f"Ignoring unknown json-ld schema: {url!r}") logger.info(f"Ignoring unknown json-ld schema: {url!r}")
return schemas["unknown"] return schemas["unknown"]

2
core/sentry.py
View file

@ -27,12 +27,14 @@ if SENTRY_ENABLED:
set_context = sentry_sdk.set_context set_context = sentry_sdk.set_context
set_tag = sentry_sdk.set_tag set_tag = sentry_sdk.set_tag
start_transaction = sentry_sdk.start_transaction start_transaction = sentry_sdk.start_transaction
start_span = sentry_sdk.start_span
else: else:
configure_scope = noop_context configure_scope = noop_context
push_scope = noop_context push_scope = noop_context
set_context = noop set_context = noop
set_tag = noop set_tag = noop
start_transaction = noop_context start_transaction = noop_context
start_span = noop_context
def set_takahe_app(name: str): def set_takahe_app(name: str):

4
core/signatures.py
View file

@ -19,6 +19,8 @@ from pyld import jsonld
from core.ld import format_ld_date from core.ld import format_ld_date
logger = logging.getLogger(__name__)
class VerificationError(BaseException): class VerificationError(BaseException):
""" """
@ -259,7 +261,7 @@ class HttpSignature:
) )
except SSLError as invalid_cert: except SSLError as invalid_cert:
# Not our problem if the other end doesn't have proper SSL # Not our problem if the other end doesn't have proper SSL
logging.info(f"{uri} {invalid_cert}") logger.info("Invalid cert on %s %s", uri, invalid_cert)
raise SSLCertVerificationError(invalid_cert) from invalid_cert raise SSLCertVerificationError(invalid_cert) from invalid_cert
except InvalidCodepoint as ex: except InvalidCodepoint as ex:
# Convert to a more generic error we handle # Convert to a more generic error we handle

6
stator/management/commands/runstator.py
View file

@ -8,6 +8,8 @@ from core.models import Config
from stator.models import StatorModel from stator.models import StatorModel
from stator.runner import StatorRunner from stator.runner import StatorRunner
logger = logging.getLogger(__name__)
class Command(BaseCommand): class Command(BaseCommand):
help = "Runs a Stator runner" help = "Runs a Stator runner"
@ -80,7 +82,7 @@ class Command(BaseCommand):
if not models: if not models:
models = StatorModel.subclasses models = StatorModel.subclasses
models = [model for model in models if model not in excluded] models = [model for model in models if model not in excluded]
logging.info( logger.info(
"Running for models: " + " ".join(m._meta.label_lower for m in models) "Running for models: " + " ".join(m._meta.label_lower for m in models)
) )
# Run a runner # Run a runner
@ -94,4 +96,4 @@ class Command(BaseCommand):
try: try:
runner.run() runner.run()
except KeyboardInterrupt: except KeyboardInterrupt:
logging.critical("Ctrl-C received") logger.critical("Ctrl-C received")

6
stator/models.py
View file

@ -11,6 +11,8 @@ from django.utils.functional import classproperty
from stator.exceptions import TryAgainLater from stator.exceptions import TryAgainLater
from stator.graph import State, StateGraph from stator.graph import State, StateGraph
logger = logging.getLogger(__name__)
class StateField(models.CharField): class StateField(models.CharField):
""" """
@ -189,7 +191,7 @@ class StatorModel(models.Model):
# If it's a manual progression state don't even try # If it's a manual progression state don't even try
# We shouldn't really be here in this case, but it could be a race condition # We shouldn't really be here in this case, but it could be a race condition
if current_state.externally_progressed: if current_state.externally_progressed:
logging.warning( logger.warning(
f"Warning: trying to progress externally progressed state {self.state}!" f"Warning: trying to progress externally progressed state {self.state}!"
) )
return None return None
@ -203,7 +205,7 @@ class StatorModel(models.Model):
except TryAgainLater: except TryAgainLater:
pass pass
except BaseException as e: except BaseException as e:
logging.exception(e) logger.exception(e)
else: else:
if next_state: if next_state:
# Ensure it's a State object # Ensure it's a State object

33
stator/runner.py
View file

@ -14,6 +14,8 @@ from core import sentry
from core.models import Config from core.models import Config
from stator.models import StatorModel, Stats from stator.models import StatorModel, Stats
logger = logging.getLogger(__name__)
class LoopingTimer: class LoopingTimer:
""" """
@ -84,7 +86,7 @@ class StatorRunner:
self.scheduling_timer = LoopingTimer(self.schedule_interval) self.scheduling_timer = LoopingTimer(self.schedule_interval)
self.deletion_timer = LoopingTimer(self.delete_interval) self.deletion_timer = LoopingTimer(self.delete_interval)
# For the first time period, launch tasks # For the first time period, launch tasks
logging.info("Running main task loop") logger.info("Running main task loop")
try: try:
with sentry.configure_scope() as scope: with sentry.configure_scope() as scope:
while True: while True:
@ -137,18 +139,18 @@ class StatorRunner:
pass pass
# Wait for tasks to finish # Wait for tasks to finish
logging.info("Waiting for tasks to complete") logger.info("Waiting for tasks to complete")
self.executor.shutdown() self.executor.shutdown()
# We're done # We're done
logging.info("Complete") logger.info("Complete")
def alarm_handler(self, signum, frame): def alarm_handler(self, signum, frame):
""" """
Called when SIGALRM fires, which means we missed a schedule loop. Called when SIGALRM fires, which means we missed a schedule loop.
Just exit as we're likely deadlocked. Just exit as we're likely deadlocked.
""" """
logging.warning("Watchdog timeout exceeded") logger.warning("Watchdog timeout exceeded")
os._exit(2) os._exit(2)
def load_config(self): def load_config(self):
@ -163,13 +165,14 @@ class StatorRunner:
""" """
with sentry.start_transaction(op="task", name="stator.run_scheduling"): with sentry.start_transaction(op="task", name="stator.run_scheduling"):
for model in self.models: for model in self.models:
num = self.handled.get(model._meta.label_lower, 0) with sentry.start_span(description=model._meta.label_lower):
if num or settings.DEBUG: num = self.handled.get(model._meta.label_lower, 0)
logging.info( if num or settings.DEBUG:
f"{model._meta.label_lower}: Scheduling ({num} handled)" logger.info(
) f"{model._meta.label_lower}: Scheduling ({num} handled)"
self.submit_stats(model) )
model.transition_clean_locks() self.submit_stats(model)
model.transition_clean_locks()
def submit_stats(self, model: type[StatorModel]): def submit_stats(self, model: type[StatorModel]):
""" """
@ -239,7 +242,7 @@ class StatorRunner:
try: try:
task.result() task.result()
except BaseException as e: except BaseException as e:
logging.exception(e) logger.exception(e)
def run_single_cycle(self): def run_single_cycle(self):
""" """
@ -269,11 +272,11 @@ def task_transition(instance: StatorModel, in_thread: bool = True):
result = instance.transition_attempt() result = instance.transition_attempt()
duration = time.monotonic() - started duration = time.monotonic() - started
if result: if result:
logging.info( logger.info(
f"{instance._meta.label_lower}: {instance.pk}: {instance.state} -> {result} ({duration:.2f}s)" f"{instance._meta.label_lower}: {instance.pk}: {instance.state} -> {result} ({duration:.2f}s)"
) )
else: else:
logging.info( logger.info(
f"{instance._meta.label_lower}: {instance.pk}: {instance.state} unchanged ({duration:.2f}s)" f"{instance._meta.label_lower}: {instance.pk}: {instance.state} unchanged ({duration:.2f}s)"
) )
if in_thread: if in_thread:
@ -289,7 +292,7 @@ def task_deletion(model: type[StatorModel], in_thread: bool = True):
deleted = model.transition_delete_due() deleted = model.transition_delete_due()
if not deleted: if not deleted:
break break
logging.info(f"{model._meta.label_lower}: Deleted {deleted} stale items") logger.info(f"{model._meta.label_lower}: Deleted {deleted} stale items")
time.sleep(1) time.sleep(1)
if in_thread: if in_thread:
close_old_connections() close_old_connections()

18
users/models/domain.py
View file

@ -14,6 +14,8 @@ from core.models import Config
from stator.models import State, StateField, StateGraph, StatorModel from stator.models import State, StateField, StateGraph, StatorModel
from users.schemas import NodeInfo from users.schemas import NodeInfo
logger = logging.getLogger(__name__)
class DomainStates(StateGraph): class DomainStates(StateGraph):
outdated = State(try_interval=60 * 30, force_initial=True) outdated = State(try_interval=60 * 30, force_initial=True)
@ -209,13 +211,14 @@ class Domain(StatorModel):
and response.status_code < 500 and response.status_code < 500
and response.status_code not in [401, 403, 404, 406, 410] and response.status_code not in [401, 403, 404, 406, 410]
): ):
logging.warning( logger.warning(
f"Client error fetching nodeinfo: {str(ex)}", "Client error fetching nodeinfo: %d %s %s",
response.status_code,
nodeinfo20_url,
ex,
extra={ extra={
"code": response.status_code,
"content": response.content, "content": response.content,
"domain": self.domain, "domain": self.domain,
"nodeinfo20_url": nodeinfo20_url,
}, },
) )
return None return None
@ -223,11 +226,12 @@ class Domain(StatorModel):
try: try:
info = NodeInfo(**response.json()) info = NodeInfo(**response.json())
except (json.JSONDecodeError, pydantic.ValidationError) as ex: except (json.JSONDecodeError, pydantic.ValidationError) as ex:
logging.warning( logger.warning(
f"Client error decoding nodeinfo: {str(ex)}", "Client error decoding nodeinfo: %s %s",
nodeinfo20_url,
ex,
extra={ extra={
"domain": self.domain, "domain": self.domain,
"nodeinfo20_url": nodeinfo20_url,
}, },
) )
return None return None

10
users/models/follow.py
View file

@ -11,6 +11,8 @@ from users.models.block import Block
from users.models.identity import Identity from users.models.identity import Identity
from users.models.inbox_message import InboxMessage from users.models.inbox_message import InboxMessage
logger = logging.getLogger(__name__)
class FollowStates(StateGraph): class FollowStates(StateGraph):
unrequested = State(try_interval=600) unrequested = State(try_interval=600)
@ -350,7 +352,7 @@ class Follow(StatorModel):
try: try:
follow = cls.by_ap(data, create=True) follow = cls.by_ap(data, create=True)
except Identity.DoesNotExist: except Identity.DoesNotExist:
logging.info( logger.info(
"Identity not found for incoming Follow", extra={"data": data} "Identity not found for incoming Follow", extra={"data": data}
) )
return return
@ -367,7 +369,7 @@ class Follow(StatorModel):
try: try:
follow = cls.by_ap(data["object"]) follow = cls.by_ap(data["object"])
except (cls.DoesNotExist, Identity.DoesNotExist): except (cls.DoesNotExist, Identity.DoesNotExist):
logging.info( logger.info(
"Follow or Identity not found for incoming Accept", "Follow or Identity not found for incoming Accept",
extra={"data": data}, extra={"data": data},
) )
@ -389,7 +391,7 @@ class Follow(StatorModel):
try: try:
follow = cls.by_ap(data["object"]) follow = cls.by_ap(data["object"])
except (cls.DoesNotExist, Identity.DoesNotExist): except (cls.DoesNotExist, Identity.DoesNotExist):
logging.info( logger.info(
"Follow or Identity not found for incoming Reject", "Follow or Identity not found for incoming Reject",
extra={"data": data}, extra={"data": data},
) )
@ -419,7 +421,7 @@ class Follow(StatorModel):
try: try:
follow = cls.by_ap(data["object"]) follow = cls.by_ap(data["object"])
except (cls.DoesNotExist, Identity.DoesNotExist): except (cls.DoesNotExist, Identity.DoesNotExist):
logging.info( logger.info(
"Follow or Identity not found for incoming Undo", extra={"data": data} "Follow or Identity not found for incoming Undo", extra={"data": data}
) )
return return

10
users/models/identity.py
View file

@ -37,6 +37,8 @@ from users.models.domain import Domain
from users.models.inbox_message import InboxMessage from users.models.inbox_message import InboxMessage
from users.models.system_actor import SystemActor from users.models.system_actor import SystemActor
logger = logging.getLogger(__name__)
class IdentityStates(StateGraph): class IdentityStates(StateGraph):
""" """
@ -872,7 +874,7 @@ class Identity(StatorModel):
# Their account got deleted, so let's do the same. # Their account got deleted, so let's do the same.
Identity.objects.filter(pk=self.pk).delete() Identity.objects.filter(pk=self.pk).delete()
if status_code < 500 and status_code not in [401, 403, 404, 406, 410]: if status_code < 500 and status_code not in [401, 403, 404, 406, 410]:
logging.info( logger.info(
"Client error fetching actor: %d %s", status_code, self.actor_uri "Client error fetching actor: %d %s", status_code, self.actor_uri
) )
return False return False
@ -880,7 +882,7 @@ class Identity(StatorModel):
document = canonicalise(response.json(), include_security=True) document = canonicalise(response.json(), include_security=True)
except ValueError: except ValueError:
# servers with empty or invalid responses are inevitable # servers with empty or invalid responses are inevitable
logging.info( logger.info(
"Invalid response fetching actor %s", "Invalid response fetching actor %s",
self.actor_uri, self.actor_uri,
extra={ extra={
@ -942,10 +944,10 @@ class Identity(StatorModel):
self.domain = Domain.get_remote_domain(webfinger_domain) self.domain = Domain.get_remote_domain(webfinger_domain)
except TryAgainLater: except TryAgainLater:
# continue with original domain when webfinger times out # continue with original domain when webfinger times out
logging.info("WebFinger timed out: %s", self.actor_uri) logger.info("WebFinger timed out: %s", self.actor_uri)
pass pass
except ValueError as exc: except ValueError as exc:
logging.info( logger.info(
"Can't parse WebFinger: %s %s", "Can't parse WebFinger: %s %s",
exc.args[0], exc.args[0],
self.actor_uri, self.actor_uri,

4
users/services/identity.py
View file

@ -19,6 +19,8 @@ from users.models import (
User, User,
) )
logger = logging.getLogger(__name__)
class IdentityService: class IdentityService:
""" """
@ -226,7 +228,7 @@ class IdentityService:
state__in=PostInteractionStates.group_active(), state__in=PostInteractionStates.group_active(),
) )
except MultipleObjectsReturned as exc: except MultipleObjectsReturned as exc:
logging.exception("%s on %s", exc, object_uri) logger.exception("%s on %s", exc, object_uri)
pass pass
except Post.DoesNotExist: except Post.DoesNotExist:
# ignore 404s... # ignore 404s...

24
users/views/activitypub.py
View file

@ -26,6 +26,8 @@ from users.models import Identity, InboxMessage, SystemActor
from users.models.domain import Domain from users.models.domain import Domain
from users.shortcuts import by_handle_or_404 from users.shortcuts import by_handle_or_404
logger = logging.getLogger(__name__)
class HttpResponseUnauthorized(HttpResponse): class HttpResponseUnauthorized(HttpResponse):
status_code = 401 status_code = 401
@ -147,7 +149,7 @@ class Inbox(View):
# This ensures that the signature used for the headers matches the actor # This ensures that the signature used for the headers matches the actor
# described in the payload. # described in the payload.
if "actor" not in document: if "actor" not in document:
logging.warning("Inbox error: unspecified actor") logger.warning("Inbox error: unspecified actor")
return HttpResponseBadRequest("Unspecified actor") return HttpResponseBadRequest("Unspecified actor")
identity = Identity.by_actor_uri(document["actor"], create=True, transient=True) identity = Identity.by_actor_uri(document["actor"], create=True, transient=True)
@ -167,7 +169,7 @@ class Inbox(View):
domain = Domain.get_remote_domain(actor_url_parts.hostname) domain = Domain.get_remote_domain(actor_url_parts.hostname)
if identity.blocked or domain.recursively_blocked(): if identity.blocked or domain.recursively_blocked():
# I love to lie! Throw it away! # I love to lie! Throw it away!
logging.info( logger.info(
"Inbox: Discarded message from blocked %s %s", "Inbox: Discarded message from blocked %s %s",
"domain" if domain.recursively_blocked() else "user", "domain" if domain.recursively_blocked() else "user",
identity.actor_uri, identity.actor_uri,
@ -196,21 +198,21 @@ class Inbox(View):
request, request,
identity.public_key, identity.public_key,
) )
logging.debug( logger.debug(
"Inbox: %s from %s has good HTTP signature", "Inbox: %s from %s has good HTTP signature",
document_type, document_type,
identity, identity,
) )
else: else:
logging.info( logger.info(
"Inbox: New actor, no key available: %s", "Inbox: New actor, no key available: %s",
document["actor"], document["actor"],
) )
except VerificationFormatError as e: except VerificationFormatError as e:
logging.warning("Inbox error: Bad HTTP signature format: %s", e.args[0]) logger.warning("Inbox error: Bad HTTP signature format: %s", e.args[0])
return HttpResponseBadRequest(e.args[0]) return HttpResponseBadRequest(e.args[0])
except VerificationError: except VerificationError:
logging.warning("Inbox error: Bad HTTP signature from %s", identity) logger.warning("Inbox error: Bad HTTP signature from %s", identity)
return HttpResponseUnauthorized("Bad signature") return HttpResponseUnauthorized("Bad signature")
# Mastodon advices not implementing LD Signatures, but # Mastodon advices not implementing LD Signatures, but
@ -224,18 +226,18 @@ class Inbox(View):
creator, create=True, transient=True creator, create=True, transient=True
) )
if not creator_identity.public_key: if not creator_identity.public_key:
logging.info("Inbox: New actor, no key available: %s", creator) logger.info("Inbox: New actor, no key available: %s", creator)
# if we can't verify it, we don't keep it # if we can't verify it, we don't keep it
document.pop("signature") document.pop("signature")
else: else:
LDSignature.verify_signature(document, creator_identity.public_key) LDSignature.verify_signature(document, creator_identity.public_key)
logging.debug( logger.debug(
"Inbox: %s from %s has good LD signature", "Inbox: %s from %s has good LD signature",
document["type"], document["type"],
creator_identity, creator_identity,
) )
except VerificationFormatError as e: except VerificationFormatError as e:
logging.warning("Inbox error: Bad LD signature format: %s", e.args[0]) logger.warning("Inbox error: Bad LD signature format: %s", e.args[0])
return HttpResponseBadRequest(e.args[0]) return HttpResponseBadRequest(e.args[0])
except VerificationError: except VerificationError:
# An invalid LD Signature might also indicate nothing but # An invalid LD Signature might also indicate nothing but
@ -243,14 +245,14 @@ class Inbox(View):
# Strip it out if we can't verify it. # Strip it out if we can't verify it.
if "signature" in document: if "signature" in document:
document.pop("signature") document.pop("signature")
logging.info( logger.info(
"Inbox: Stripping invalid LD signature from %s %s", "Inbox: Stripping invalid LD signature from %s %s",
creator_identity, creator_identity,
document["id"], document["id"],
) )
if not ("signature" in request or "signature" in document): if not ("signature" in request or "signature" in document):
logging.debug( logger.debug(
"Inbox: %s from %s is unauthenticated. That's OK.", "Inbox: %s from %s is unauthenticated. That's OK.",
document["type"], document["type"],
identity, identity,