Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Make LoggingContext's name optional #9857

Merged
merged 2 commits into from
Apr 21, 2021
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
1 change: 1 addition & 0 deletions changelog.d/9857.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a regression in Synapse v1.32.1 which caused `LoggingContext` errors in plugins.
15 changes: 12 additions & 3 deletions synapse/logging/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,8 @@ class LoggingContext:
child to the parent

Args:
name (str): Name for the context for debugging.
name: Name for the context for logging. If this is omitted, it is
inherited from the parent context.
parent_context (LoggingContext|None): The parent of the new context
"""

Expand All @@ -277,12 +278,11 @@ class LoggingContext:

def __init__(
self,
name: str,
name: Optional[str] = None,
parent_context: "Optional[LoggingContext]" = None,
request: Optional[ContextRequest] = None,
) -> None:
self.previous_context = current_context()
self.name = name

# track the resources used by this context so far
self._resource_usage = ContextResourceUsage()
Expand Down Expand Up @@ -314,6 +314,15 @@ def __init__(
# the request param overrides the request from the parent context
self.request = request

# if we don't have a `name`, but do have a parent context, use its name.
if self.parent_context and name is None:
name = str(self.parent_context)
if name is None:
raise ValueError(
"LoggingContext must be given either a name or a parent context"
)
self.name = name

def __str__(self) -> str:
return self.name

Expand Down