Bump pydantic from 1.10.12 to 2.1.1 (#640)

* Bump pydantic from 1.10.12 to 2.1.1

Bumps [pydantic](https://github.com/pydantic/pydantic) from 1.10.12 to 2.1.1.
- [Release notes](https://github.com/pydantic/pydantic/releases)
- [Changelog](https://github.com/pydantic/pydantic/blob/main/HISTORY.md)
- [Commits](pydantic/pydantic@v1.10.12...v2.1.1)

---
updated-dependencies:
- dependency-name: pydantic
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Add pydantic-settings

* Update model.dict() -> model.model_dump()

* Various Pydantic v1 -> v2 changes

* Remove dotenv extra from pydantic

This is provided by pydantic-settings now

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Graham Beckley <[email protected]>

Author: dependabot[bot]

jbi/app.py

@@ -32,7 +32,7 @@ def traces_sampler(sampling_context: dict[str, Any]) -> float:
 
 
 sentry_sdk.init(
-    dsn=settings.sentry_dsn,
+    dsn=str(settings.sentry_dsn) if settings.sentry_dsn else None,
     traces_sampler=traces_sampler,
 )
 

jbi/environment.py

@@ -7,7 +7,8 @@
 from pathlib import Path
 from typing import Optional
 
-from pydantic import AnyUrl, BaseSettings
+from pydantic import AnyUrl
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class Environment(str, Enum):
@@ -50,14 +51,10 @@ class Settings(BaseSettings):
     log_format: str = "json"  # set to "text" for human-readable logs
 
     # Sentry
-    sentry_dsn: Optional[SentryDsn]
+    sentry_dsn: Optional[SentryDsn] = None
     sentry_traces_sample_rate: float = 1.0
 
-    class Config:
-        """Pydantic configuration"""
-
-        env_file = ".env"
-        env_file_encoding = "utf-8"
+    model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")
 
 
 @lru_cache(maxsize=1)

jbi/log.py

@@ -6,6 +6,7 @@
 import sys
 import time
 from datetime import datetime
+from typing import Optional
 
 from fastapi import Request
 from pydantic import BaseModel
@@ -56,6 +57,7 @@ class RequestSummary(BaseModel):
     agent: str
     path: str
     method: str
+    lang: Optional[str]
     querystring: str
     errno: int
     t: int
@@ -81,4 +83,4 @@ def format_request_summary_fields(
         time=datetime.fromtimestamp(current_time).isoformat(),
         status_code=status_code,
         rid=request.state.rid,
-    ).dict()
+    ).model_dump()

jbi/models.py

@@ -8,10 +8,11 @@
 import warnings
 from collections import defaultdict
 from copy import copy
-from typing import DefaultDict, Literal, Mapping, Optional, TypedDict
+from typing import DefaultDict, Literal, Mapping, Optional
 from urllib.parse import ParseResult, urlparse
 
-from pydantic import BaseModel, Extra, Field, validator
+from pydantic import BaseModel, ConfigDict, Extra, Field, RootModel, field_validator
+from typing_extensions import TypedDict
 
 from jbi import Operation, steps
 from jbi.errors import ActionNotFoundError
@@ -40,8 +41,9 @@ class ActionSteps(BaseModel):
         "create_comment",
     ]
 
-    @validator("*")
-    def validate_steps(cls, function_names):  # pylint: disable=no-self-argument
+    @field_validator("*")
+    @classmethod
+    def validate_steps(cls, function_names: list[str]):
         """Validate that all configure step functions exist in the steps module"""
 
         invalid_functions = [
@@ -69,7 +71,7 @@ class ActionParams(BaseModel):
     jira_project_key: str
     steps: ActionSteps = ActionSteps()
     jira_components: JiraComponents = JiraComponents()
-    labels_brackets: str = Field("no", enum=["yes", "no", "both"])
+    labels_brackets: Literal["yes", "no", "both"] = "no"
     status_map: dict[str, str] = {}
     resolution_map: dict[str, str] = {}
     issue_type_map: dict[str, str] = {"task": "Task", "defect": "Bug"}
@@ -91,23 +93,24 @@ def jira_project_key(self):
         return self.parameters.jira_project_key
 
 
-class Actions(BaseModel):
+class Actions(RootModel):
     """
     Actions is the container model for the list of actions in the configuration file
     """
 
-    __root__: list[Action] = Field(..., min_items=1)
+    root: list[Action] = Field(..., min_length=1)
 
     @functools.cached_property
     def by_tag(self) -> Mapping[str, Action]:
         """Build mapping of actions by lookup tag."""
-        return {action.whiteboard_tag: action for action in self.__root__}
+        # pylint: disable-next=not-an-iterable
+        return {action.whiteboard_tag: action for action in self.root}
 
     def __iter__(self):
-        return iter(self.__root__)
+        return iter(self.root)  # pylint: disable=not-an-iterable
 
     def __len__(self):
-        return len(self.__root__)
+        return len(self.root)
 
     def __getitem__(self, item):
         return self.by_tag[item]
@@ -119,12 +122,12 @@ def get(self, tag: Optional[str]) -> Optional[Action]:
     @functools.cached_property
     def configured_jira_projects_keys(self) -> set[str]:
         """Return the list of Jira project keys from all configured actions"""
-        return {action.jira_project_key for action in self.__root__}
+        # pylint: disable-next=not-an-iterable
+        return {action.jira_project_key for action in self.root}
 
-    @validator("__root__")
-    def validate_actions(  # pylint: disable=no-self-argument
-        cls, actions: list[Action]
-    ):
+    @field_validator("root")
+    @classmethod
+    def validate_actions(cls, actions: list[Action]):
         """
         Inspect the list of actions:
          - Validate that lookup tags are uniques
@@ -143,10 +146,7 @@ def validate_actions(  # pylint: disable=no-self-argument
 
         return actions
 
-    class Config:
-        """Pydantic configuration"""
-
-        keep_untouched = (functools.cached_property,)
+    model_config = ConfigDict(ignored_types=(functools.cached_property,))
 
 
 class BugzillaWebhookUser(BaseModel):
@@ -169,48 +169,49 @@ class BugzillaWebhookEvent(BaseModel):
     """Bugzilla Event Object"""
 
     action: str
-    time: Optional[datetime.datetime]
-    user: Optional[BugzillaWebhookUser]
-    changes: Optional[list[BugzillaWebhookEventChange]]
-    target: Optional[str]
-    routing_key: Optional[str]
+    time: Optional[datetime.datetime] = None
+    user: Optional[BugzillaWebhookUser] = None
+    changes: Optional[list[BugzillaWebhookEventChange]] = None
+    target: Optional[str] = None
+    routing_key: Optional[str] = None
 
     def changed_fields(self) -> list[str]:
         """Returns the names of changed fields in a bug"""
+        # pylint: disable-next=not-an-iterable
         return [c.field for c in self.changes] if self.changes else []
 
 
 class BugzillaWebhookComment(BaseModel):
     """Bugzilla Comment Object"""
 
-    body: Optional[str]
-    id: Optional[int]
-    number: Optional[int]
-    is_private: Optional[bool]
-    creation_time: Optional[datetime.datetime]
+    body: Optional[str] = None
+    id: Optional[int] = None
+    number: Optional[int] = None
+    is_private: Optional[bool] = None
+    creation_time: Optional[datetime.datetime] = None
 
 
 class BugzillaBug(BaseModel):
     """Bugzilla Bug Object"""
 
     id: int
-    is_private: Optional[bool]
-    type: Optional[str]
-    product: Optional[str]
-    component: Optional[str]
-    whiteboard: Optional[str]
-    keywords: Optional[list]
-    flags: Optional[list]
-    groups: Optional[list]
-    status: Optional[str]
-    resolution: Optional[str]
-    see_also: Optional[list]
-    summary: Optional[str]
-    severity: Optional[str]
-    priority: Optional[str]
-    creator: Optional[str]
-    assigned_to: Optional[str]
-    comment: Optional[BugzillaWebhookComment]
+    is_private: Optional[bool] = None
+    type: Optional[str] = None
+    product: Optional[str] = None
+    component: Optional[str] = None
+    whiteboard: Optional[str] = None
+    keywords: Optional[list] = None
+    flags: Optional[list] = None
+    groups: Optional[list] = None
+    status: Optional[str] = None
+    resolution: Optional[str] = None
+    see_also: Optional[list] = None
+    summary: Optional[str] = None
+    severity: Optional[str] = None
+    priority: Optional[str] = None
+    creator: Optional[str] = None
+    assigned_to: Optional[str] = None
+    comment: Optional[BugzillaWebhookComment] = None
 
     @property
     def product_component(self) -> str:
@@ -297,8 +298,8 @@ class BugzillaComment(BaseModel):
 class BugzillaApiResponse(BaseModel):
     """Bugzilla Response Object"""
 
-    faults: Optional[list]
-    bugs: Optional[list[BugzillaBug]]
+    faults: Optional[list] = None
+    bugs: Optional[list[BugzillaBug]] = None
 
 
 class BugzillaWebhook(BaseModel):
@@ -326,7 +327,7 @@ def slug(self):
 class BugzillaWebhooksResponse(BaseModel):
     """Bugzilla Webhooks List Response Object"""
 
-    webhooks: Optional[list[BugzillaWebhook]]
+    webhooks: Optional[list[BugzillaWebhook]] = None
 
 
 class Context(BaseModel):
@@ -341,8 +342,8 @@ class JiraContext(Context):
     """Logging context about Jira"""
 
     project: str
-    issue: Optional[str]
-    labels: Optional[list[str]]
+    issue: Optional[str] = None
+    labels: Optional[list[str]] = None
 
 
 BugId = TypedDict("BugId", {"id": Optional[int]})
@@ -354,7 +355,7 @@ class RunnerContext(Context, extra=Extra.forbid):
     rid: str
     operation: Operation
     event: BugzillaWebhookEvent
-    action: Optional[Action]
+    action: Optional[Action] = None
     bug: BugId | BugzillaBug
 
 
@@ -364,7 +365,7 @@ class ActionContext(Context, extra=Extra.forbid):
     action: Action
     rid: str
     operation: Operation
-    current_step: Optional[str]
+    current_step: Optional[str] = None
     event: BugzillaWebhookEvent
     jira: JiraContext
     bug: BugzillaBug

jbi/runner.py

@@ -47,7 +47,7 @@ def groups2operation(steps: ActionSteps):
     try:
         by_operation = {
             GROUP_TO_OPERATION[entry]: steps_list
-            for entry, steps_list in steps.dict().items()
+            for entry, steps_list in steps.model_dump().items()
         }
     except KeyError as err:
         raise ValueError(f"Unsupported entry in `steps`: {err}") from err
@@ -129,7 +129,7 @@ def __call__(self, context: ActionContext) -> ActionResult:
                     response,
                     extra={
                         "response": response,
-                        **context.dict(),
+                        **context.model_dump(),
                     },
                 )
 
@@ -165,12 +165,14 @@ def execute_action(
 
         logger.debug(
             "Handling incoming request",
-            extra=runner_context.dict(),
+            extra=runner_context.model_dump(),
         )
         try:
             bug = bugzilla.get_service().refresh_bug_data(bug)
         except Exception as err:
-            logger.exception("Failed to get bug: %s", err, extra=runner_context.dict())
+            logger.exception(
+                "Failed to get bug: %s", err, extra=runner_context.model_dump()
+            )
             raise IgnoreInvalidRequestError(
                 "bug not accessible or bugzilla down"
             ) from err
@@ -195,7 +197,7 @@ def execute_action(
             event=event,
             operation=Operation.IGNORE,
             jira=JiraContext(project=action.jira_project_key, issue=linked_issue_key),
-            extra={k: str(v) for k, v in action.parameters.dict().items()},
+            extra={k: str(v) for k, v in action.parameters.model_dump().items()},
         )
 
         if action_context.jira.issue is None:
@@ -242,7 +244,7 @@ def execute_action(
             "Execute action '%s' for Bug %s",
             action.whiteboard_tag,
             bug.id,
-            extra=runner_context.update(operation=Operation.EXECUTE).dict(),
+            extra=runner_context.update(operation=Operation.EXECUTE).model_dump(),
         )
         executor = Executor(parameters=action.parameters)
         handled, details = executor(context=action_context)
@@ -253,15 +255,15 @@ def execute_action(
             bug.id,
             extra=runner_context.update(
                 operation=Operation.SUCCESS if handled else Operation.IGNORE
-            ).dict(),
+            ).model_dump(),
         )
         statsd.incr("jbi.bugzilla.processed.count")
         return details
     except IgnoreInvalidRequestError as exception:
         logger.info(
             "Ignore incoming request: %s",
             exception,
-            extra=runner_context.update(operation=Operation.IGNORE).dict(),
+            extra=runner_context.update(operation=Operation.IGNORE).model_dump(),
         )
         statsd.incr("jbi.bugzilla.ignored.count")
         raise

jbi/services/bugzilla.py

@@ -176,7 +176,7 @@ def add_link_to_jira(self, context: ActionContext):
             "Link %r on Bug %s",
             jira_url,
             bug.id,
-            extra=context.update(operation=Operation.LINK).dict(),
+            extra=context.update(operation=Operation.LINK).model_dump(),
         )
         return self.client.update_bug(bug.id, see_also={"add": [jira_url]})