Skip to content
Snippets Groups Projects
Unverified Commit d9bd62f9 authored by Richard van der Hoff's avatar Richard van der Hoff Committed by GitHub
Browse files

Make LoggingContext's name optional (#9857)

parent bdb4c20d
No related branches found
No related tags found
No related merge requests found
Fix a regression in Synapse v1.32.1 which caused `LoggingContext` errors in plugins.
......@@ -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
"""
......@@ -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()
......@@ -314,6 +314,15 @@ class LoggingContext:
# 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment