Update ops to v2.14

Workaround for breaking change in ops 2.10: canonical/operator#1091 (comment)

Workaround may break during deferred ops events or collect status ops events (canonical/operator#1091 (comment))

pyproject.toml

@@ -10,7 +10,7 @@ authors = []
 
 [tool.poetry.dependencies]
 python = "^3.10"
-ops = "^2.6.0,<2.10.0"
+ops = "^2.14.0"
 lightkube = "^0.14.0"
 tenacity = "^8.2.3"
 jinja2 = "^3.1.2"
@@ -57,7 +57,7 @@ pytest-xdist = "^3.3.1"
 pytest-forked = "^1.6.0"
 pytest-cov = "^4.1.0"
 ops-scenario = "^5.6.2"
-ops = "<2.10.0"
+ops = "^2.14.0"
 pytest-mock = "^3.11.1"
 
 [tool.poetry.group.integration.dependencies]
@@ -69,7 +69,7 @@ juju = "^3.2.2"
 mysql-connector-python = "~8.0.33"
 pyyaml = "^6.0.1"
 tenacity = "^8.2.2"
-ops = "<2.10.0"
+ops = "^2.14.0"
 allure-pytest = "^2.13.2"
 allure-pytest-collection-report = {git = "https://github.com/canonical/data-platform-workflows", tag = "v16.2.0", subdirectory = "python/pytest_plugins/allure_pytest_collection_report"}
 

src/abstract_charm.py

@@ -318,7 +318,7 @@ def reconcile(self, event=None) -> None:  # noqa: C901
                         logger.warning(
                             "Modifying relations during an upgrade is not supported. The charm may be in a broken, unrecoverable state. Re-deploy the charm"
                         )
-                    self._database_provides.delete_all_databags()
+                    self._database_provides.delete_all_databags(event)
                 elif (
                     not self._upgrade.in_progress
                     and isinstance(workload_, workload.AuthenticatedWorkload)

src/relations/database_provides.py

@@ -182,10 +182,24 @@ def __init__(self, charm_: "abstract_charm.MySQLRouterCharm") -> None:
         charm_.framework.observe(self._interface.on.database_requested, charm_.reconcile)
         charm_.framework.observe(charm_.on[self._NAME].relation_broken, charm_.reconcile)
 
+    # TODO python3.10 min version: Use `list` instead of `typing.List`
+    def _relations(self, event) -> typing.List[ops.Relation]:
+        """All relations, including relations that are breaking
+
+        Needed because of breaking change in ops 2.10
+        https://github.com/canonical/operator/pull/1091#issuecomment-1888644075
+
+        May break during deferred ops events or collect status ops events
+        (https://github.com/canonical/operator/pull/1091#issuecomment-2191460188)
+        """
+        if isinstance(event, ops.RelationBrokenEvent):
+            return [*self._interface.relations, event.relation]
+        return self._interface.relations
+
     def external_connectivity(self, event) -> bool:
         """Whether any of the relations are marked as external."""
         requested_users = []
-        for relation in self._interface.relations:
+        for relation in self._relations(event):
             try:
                 requested_users.append(
                     _RelationThatRequestedUser(
@@ -200,11 +214,10 @@ def external_connectivity(self, event) -> bool:
                 pass
         return any(relation.external_connectivity for relation in requested_users)
 
-    @property
     # TODO python3.10 min version: Use `list` instead of `typing.List`
-    def _shared_users(self) -> typing.List[_RelationWithSharedUser]:
+    def _shared_users(self, event) -> typing.List[_RelationWithSharedUser]:
         shared_users = []
-        for relation in self._interface.relations:
+        for relation in self._relations(event):
             try:
                 shared_users.append(
                     _RelationWithSharedUser(relation=relation, interface=self._interface)
@@ -247,25 +260,25 @@ def reconcile_users(
                 _UnsupportedExtraUserRole,
             ):
                 pass
-        logger.debug(f"State of reconcile users {requested_users=}, {self._shared_users=}")
+        logger.debug(f"State of reconcile users {requested_users=}, {self._shared_users(event)=}")
         for relation in requested_users:
-            if relation not in self._shared_users:
+            if relation not in self._shared_users(event):
                 relation.create_database_and_user(
                     router_read_write_endpoint=router_read_write_endpoint,
                     router_read_only_endpoint=router_read_only_endpoint,
                     exposed_read_write_endpoint=exposed_read_write_endpoint,
                     exposed_read_only_endpoint=exposed_read_only_endpoint,
                     shell=shell,
                 )
-        for relation in self._shared_users:
+        for relation in self._shared_users(event):
             if relation not in requested_users:
                 relation.delete_user(shell=shell)
         logger.debug(
             f"Reconciled users {event=}, {router_read_write_endpoint=}, {router_read_only_endpoint=}, "
             f"{exposed_read_write_endpoint=}, {exposed_read_only_endpoint=}"
         )
 
-    def delete_all_databags(self) -> None:
+    def delete_all_databags(self, event) -> None:
         """Remove connection information from all databags.
 
         Called when relation with MySQL is breaking
@@ -274,7 +287,7 @@ def delete_all_databags(self) -> None:
         will need to be created.
         """
         logger.debug("Deleting all application databags")
-        for relation in self._shared_users:
+        for relation in self._shared_users(event):
             # MySQL charm will delete user; just delete databag
             relation.delete_databag()
         logger.debug("Deleted all application databags")

src/relations/database_requires.py

@@ -69,7 +69,15 @@ class CompleteConnectionInformation(ConnectionInformation):
     """
 
     def __init__(self, *, interface: data_interfaces.DatabaseRequires, event) -> None:
-        relations = interface.relations
+        # Needed because of breaking change in ops 2.10
+        # https://github.com/canonical/operator/pull/1091#issuecomment-1888644075
+        # May break during deferred ops events or collect status ops events
+        # (https://github.com/canonical/operator/pull/1091#issuecomment-2191460188)
+        if isinstance(event, ops.RelationBrokenEvent):
+            relations = [*interface.relations, event.relation]
+        else:
+            relations = interface.relations
+
         endpoint_name = interface.relation_name
         if not relations:
             raise _MissingRelation(endpoint_name=endpoint_name)