paas-charm 2.0.dev1__tar.gz → 2.0.dev3__tar.gz

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: paas-charm
-Version: 2.0.dev1
+Version: 2.0.dev3
 Summary: Companion library for 12-factor app support in Charmcraft & Rockcraft.
 Author-email: Canonical IS DevOps team <is-devops-team@canonical.com>
 Project-URL: Repository, https://github.com/canonical/paas-charm
@@ -11,6 +11,9 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
+Requires-Dist: charmlibs-interfaces-tracing==1.0.0
+Requires-Dist: charmlibs-interfaces-oauth==1.1.0
+Requires-Dist: charmlibs-interfaces-openfga==1.0.0
 Requires-Dist: cosl==1.10.3
 Requires-Dist: dpcharmlibs-interfaces==1.2.0
 Requires-Dist: Jinja2==3.1.6

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/pyproject.toml

@@ -2,7 +2,7 @@
 # See LICENSE file for licensing details.
 [project]
 name = "paas-charm"
-version = "2.0.dev1"
+version = "2.0.dev3"
 description = "Companion library for 12-factor app support in Charmcraft & Rockcraft."
 readme = "README.md"
 authors = [
@@ -17,6 +17,9 @@ classifiers = [
     "Programming Language :: Python :: 3",
 ]
 dependencies = [
+    "charmlibs-interfaces-tracing==1.0.0",
+    "charmlibs-interfaces-oauth==1.1.0",
+    "charmlibs-interfaces-openfga==1.0.0",
     "cosl==1.10.3",
     "dpcharmlibs-interfaces==1.2.0",
     "Jinja2==3.1.6",

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/_gunicorn/webserver.py

@@ -17,14 +17,11 @@ import ops
 from ops.pebble import ExecError, PathError
 
 from paas_charm._gunicorn.workload_config import (
-    APPLICATION_ERROR_LOG_FILE,
-    APPLICATION_LOG_FILE,
     STATSD_HOST,
 )
 from paas_charm.app import WorkloadConfig
 from paas_charm.exceptions import CharmConfigInvalidError
 from paas_charm.paas_config import LoggingFormat
-from paas_charm.utils import enable_pebble_log_forwarding
 
 logger = logging.getLogger(__name__)
 
@@ -153,21 +150,14 @@ class GunicornWebserver:  # pylint: disable=too-few-public-methods
                 if isinstance(setting_value, (int, str))
                 else int(setting_value.total_seconds())
             )
-        if enable_pebble_log_forwarding():
-            access_log = "-"
-            error_log = "-"
-        else:
-            access_log = str(APPLICATION_LOG_FILE)
-            error_log = str(APPLICATION_ERROR_LOG_FILE)
-
         jinja_environment = jinja2.Environment(
             loader=jinja2.PackageLoader("paas_charm", "templates"), autoescape=True
         )
         config = jinja_environment.get_template("gunicorn.conf.py.j2").render(
             workload_port=self._workload_config.port,
             workload_app_dir=str(self._workload_config.app_dir),
-            access_log=access_log,
-            error_log=error_log,
+            access_log="-",
+            error_log="-",
             statsd_host=str(STATSD_HOST),
             enable_tracing=self._workload_config.tracing_enabled,
             enable_json_logging=self._workload_config.logging_format == LoggingFormat.JSON,
@@ -197,7 +187,6 @@ class GunicornWebserver:  # pylint: disable=too-few-public-methods
         Raises:
             CharmConfigInvalidError: if the charm configuration is not valid.
         """
-        self._prepare_log_dir()
         webserver_config_path = str(self._config_path)
         try:
             current_webserver_config = self._container.pull(webserver_config_path)
@@ -235,16 +224,3 @@ class GunicornWebserver:  # pylint: disable=too-few-public-methods
         if is_webserver_running:
             logger.info("gunicorn config changed, reloading")
             self._container.send_signal(self._reload_signal, self._workload_config.service_name)
-
-    def _prepare_log_dir(self) -> None:
-        """Prepare access and error log directory for the application."""
-        container = self._container
-        for log in self._workload_config.log_files:
-            log_dir = str(log.parent.absolute())
-            if not container.exists(log_dir):
-                container.make_dir(
-                    log_dir,
-                    make_parents=True,
-                    user=self._workload_config.user,
-                    group=self._workload_config.group,
-                )

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/_gunicorn/workload_config.py

@@ -9,8 +9,6 @@ from paas_charm.app import WorkloadConfig
 from paas_charm.paas_config import PaasConfig
 
 STATSD_HOST = "localhost:9125"
-APPLICATION_LOG_FILE = "/var/log/app/access.log"
-APPLICATION_ERROR_LOG_FILE = "/var/log/app/error.log"
 GUNICORN_CONFIG_DIR = "/var/lib/gunicorn"
 
 
@@ -50,10 +48,6 @@ def create_workload_config(
         app_dir=app_dir,
         state_dir=state_dir,
         service_name=framework_name,
-        log_files=[
-            pathlib.Path(APPLICATION_LOG_FILE),
-            pathlib.Path(APPLICATION_ERROR_LOG_FILE),
-        ],
         metrics_path=metrics_path,
         metrics_port=metrics_port,
         unit_name=unit_name,

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/app.py

@@ -9,7 +9,7 @@ import logging
 import pathlib
 import urllib.parse
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List
+from typing import TYPE_CHECKING
 
 import ops
 from dpcharmlibs.interfaces import ValkeyResponseModel
@@ -21,7 +21,7 @@ from paas_charm.paas_config import LoggingFormat
 logger = logging.getLogger(__name__)
 
 if TYPE_CHECKING:
-    from charms.openfga_k8s.v1.openfga import OpenfgaProviderAppData
+    from charmlibs.interfaces.openfga import OpenfgaProviderAppData
     from charms.smtp_integrator.v0.smtp import SmtpRelationData
 
     from paas_charm.databases import PaaSDatabaseRelationData
@@ -52,7 +52,6 @@ class WorkloadConfig:  # pylint: disable=too-many-instance-attributes
         app_dir: the application directory in the application container.
         state_dir: the directory in the application container to store states information.
         service_name: the WSGI application pebble service name.
-        log_files: list of files to monitor.
         metrics_path: path to scrape for metrics.
         metrics_port: port on which the application exposes metrics.
         unit_name: Name of the unit. Needed to know if schedulers should run here.
@@ -69,7 +68,6 @@ class WorkloadConfig:  # pylint: disable=too-many-instance-attributes
     app_dir: pathlib.Path
     state_dir: pathlib.Path
     service_name: str
-    log_files: List[pathlib.Path]
     metrics_path: str | None = "/metrics"
     metrics_port: int = 8080
     unit_name: str
@@ -446,6 +444,7 @@ class App:  # pylint: disable=too-many-instance-attributes
 
     # 2024/04/25 - we're refactoring this method which will get rid of map_integrations_to_env
     # wrapper function. Ignore too-complex error from flake8 for now.
+    # pylint: disable=too-many-branches
     def gen_environment(self) -> dict[str, str]:  # noqa: too-complex
         """Generate a environment dictionary from the charm configurations.
 
@@ -501,6 +500,7 @@ class App:  # pylint: disable=too-many-instance-attributes
             env[f"{prefix}PEER_FQDNS"] = self._charm_state.peer_fqdns
 
         env.update(self._generate_integration_environments(prefix=self.integrations_prefix))
+
         return env
 
     def _generate_integration_environments(self, prefix: str = "") -> dict[str, str]:
@@ -531,6 +531,17 @@ class App:  # pylint: disable=too-many-instance-attributes
                 relation_data=self._charm_state.integrations.oauth,
             )
         )
+
+        for relation in self._charm_state.custom_relations:
+            for key, value in (relation.gen_environment() or {}).items():
+                if key in env:
+                    logger.warning(
+                        "Custom relation %s overwrites environment variable %s",
+                        relation.relation_name,
+                        key,
+                    )
+                env[key] = value
+
         return {prefix + k: v for (k, v) in env.items()}
 
     @property

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/charm.py

@@ -9,8 +9,8 @@ import pathlib
 import typing
 
 import ops
+from charmlibs.interfaces.openfga import OpenFGARequires
 from charms.data_platform_libs.v0.data_interfaces import DatabaseRequiresEvent
-from charms.openfga_k8s.v1.openfga import OpenFGARequires
 from charms.smtp_integrator.v0.smtp import SmtpRequires
 from charms.traefik_k8s.v2.ingress import IngressPerAppRequirer
 from ops import RelationMeta
@@ -22,7 +22,11 @@ from paas_charm.charm_state import CharmState, IntegrationRequirers
 from paas_charm.charm_utils import block_if_invalid_data
 from paas_charm.database_migration import DatabaseMigration, DatabaseMigrationStatus
 from paas_charm.databases import make_database_requirers
-from paas_charm.exceptions import CharmConfigInvalidError, RelationDataError
+from paas_charm.exceptions import (
+    CharmConfigInvalidError,
+    CustomRelationError,
+    RelationDataError,
+)
 from paas_charm.http_proxy import PaaSHttpProxyRequirer
 from paas_charm.oauth import PaaSOAuthRequirer
 from paas_charm.observability import Observability
@@ -33,6 +37,7 @@ from paas_charm.paas_config import (
 )
 from paas_charm.peers import Peers
 from paas_charm.rabbitmq import RabbitMQRequires
+from paas_charm.relations import Context, CustomRelation
 from paas_charm.s3 import PaaSS3Requirer
 from paas_charm.saml import PaaSSAMLRequirer
 from paas_charm.secret_key import SecretKeyStorage
@@ -54,10 +59,12 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
     Attrs:
         framework_config_class: base class for the framework config.
         paas_config_framework_fields: Mapping from framework fields to paas-config fields.
+        custom_relations: Classes describing charm relations.
     """
 
     framework_config_class: type[BaseModel]
     paas_config_framework_fields: dict[str, str] = {}
+    custom_relations: list[type[CustomRelation]] = []
 
     @property
     @abc.abstractmethod
@@ -128,7 +135,6 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
                 )
         self._observability = Observability(
             charm=self,
-            log_files=self._workload_config.log_files,
             container_name=self._workload_config.container_name,
             cos_dir=self.build_cos_dir(),
             metrics_port=self._workload_config.metrics_port,
@@ -173,6 +179,8 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
             self._reconcile_without_migrations,
         )
 
+        self._custom_relations: list[CustomRelation] = self._init_custom_relations()
+
     def _init_valkey(self, requires: dict[str, RelationMeta]) -> "ValkeyClientRequirer | None":
         """Initialize the Valkey relation if it is required.
 
@@ -299,21 +307,15 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         """
         _tracing = None
         if "tracing" in requires and requires["tracing"].interface_name == "tracing":
-            try:
-                _tracing = PaaSTracingEndpointRequirer(
-                    self, relation_name="tracing", protocols=["otlp_http"]
-                )
-                self.framework.observe(
-                    _tracing.on.endpoint_changed, self._reconcile_without_migrations
-                )
-                self.framework.observe(
-                    _tracing.on.endpoint_removed, self._reconcile_without_migrations
-                )
-            except NameError:
-                logger.exception(
-                    "Missing charm library, please run "
-                    "`charmcraft fetch-lib charms.tempo_coordinator_k8s.v0.tracing`"
-                )
+            _tracing = PaaSTracingEndpointRequirer(
+                self, relation_name="tracing", protocols=["otlp_http"]
+            )
+            self.framework.observe(
+                _tracing.on.endpoint_changed, self._reconcile_without_migrations
+            )
+            self.framework.observe(
+                _tracing.on.endpoint_removed, self._reconcile_without_migrations
+            )
         return _tracing
 
     def _init_smtp(self, requires: dict[str, RelationMeta]) -> "SmtpRequires | None":
@@ -350,16 +352,10 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         """
         openfga = None
         if "openfga" in requires and requires["openfga"].interface_name == "openfga":
-            try:
-                openfga = OpenFGARequires(self, self.app.name)
-                self.framework.observe(
-                    openfga.on.openfga_store_created, self._reconcile_without_migrations
-                )
-            except NameError:
-                logger.exception(
-                    "Missing charm library, please run "
-                    "`charmcraft fetch-lib charms.openfga_k8s.v1.openfga`"
-                )
+            openfga = OpenFGARequires(self, self.app.name)
+            self.framework.observe(
+                openfga.on.openfga_store_created, self._reconcile_without_migrations
+            )
         return openfga
 
     def _init_oauth(self, requires: dict[str, RelationMeta]) -> "PaaSOAuthRequirer | None":
@@ -376,26 +372,62 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         if len(oauth_integrations) != 1:
             return None
         endpoint_name = oauth_integrations[0][0]
-        try:
-            _oauth = PaaSOAuthRequirer(
-                charm=self,
-                base_url=self._base_url,
-                relation_name=endpoint_name,
-                charm_config=self.config,
-            )
-            self.framework.observe(
-                _oauth.on.oauth_info_changed, self._reconcile_without_migrations
-            )
-            self.framework.observe(
-                _oauth.on.oauth_info_removed, self._reconcile_without_migrations
-            )
-        except NameError:
-            logger.exception(
-                "Missing charm library, please run `charmcraft fetch-lib charms.hydra.v0.oauth`"
-            )
-            return None
+        _oauth = PaaSOAuthRequirer(
+            charm=self,
+            base_url=self._base_url,
+            relation_name=endpoint_name,
+            charm_config=self.config,
+        )
+        self.framework.observe(_oauth.on.oauth_info_changed, self._reconcile_without_migrations)
+        self.framework.observe(_oauth.on.oauth_info_removed, self._reconcile_without_migrations)
         return _oauth
 
+    def _build_custom_relation_context(self) -> Context:
+        """Build the read-only :class:`Context` injected into custom relations.
+
+        Returns:
+            A :class:`Context` populated with the current charm configuration.
+        """
+        return Context(
+            app_name=self.app.name,
+            framework_name=self._framework_name,
+            port=self._workload_config.port,
+            container_name=self._workload_config.container_name,
+            config=self._resolve_charm_config(),
+        )
+
+    def _init_custom_relations(self) -> list[CustomRelation]:
+        """Instantiate and wire author-supplied custom relations.
+
+        Each class in :attr:`custom_relations` is validated against the charm
+        metadata, instantiated as an ``ops.Object`` child, injected with
+        :class:`Context` and the required flag (read from the metadata
+        ``optional`` field), and finally set up with the reconcile callback.
+
+        Returns:
+            The list of instantiated custom relations.
+        """
+        if not self.custom_relations:
+            return []
+        context = self._build_custom_relation_context()
+        requires: dict[str, RelationMeta] = self.framework.meta.requires
+        relations: list[CustomRelation] = []
+        for relation_class in self.custom_relations:
+            if not isinstance(relation_class, type) or not issubclass(
+                relation_class, CustomRelation
+            ):
+                raise CustomRelationError(f"non-CustomRelation entry: {relation_class!r}")
+            relation_name = relation_class.relation_name
+            if relation_name not in requires:
+                raise CustomRelationError(f"Unused custom relation: {relation_class!r}")
+            instance = relation_class(self)
+            # Framework-injected private state; pylint: disable=protected-access
+            instance._context = context
+            instance._required = not requires[relation_name].optional
+            instance.setup(on_change=self._reconcile)
+            relations.append(instance)
+        return relations
+
     def get_framework_config(self) -> BaseModel:
         """Return the framework related configurations.
 
@@ -407,14 +439,7 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         """
         # Will raise an AttributeError if it the attribute framework_config_class does not exist.
         framework_config_class = self.framework_config_class
-        charm_config = {k: config_get_with_secret(self, k) for k in self.config.keys()}
-        config = typing.cast(
-            dict,
-            {
-                k: v.get_content(refresh=True) if isinstance(v, ops.Secret) else v
-                for k, v in charm_config.items()
-            },
-        )
+        config = self._resolve_charm_config()
         for framework_field, paas_config_field in self.paas_config_framework_fields.items():
             if paas_config_field not in self._paas_config.model_fields_set:
                 continue
@@ -523,12 +548,7 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
             self.update_app_and_unit_status(ops.WaitingStatus("Waiting for secret key creation"))
             return False
 
-        missing_integrations = list(self._missing_required_integrations(charm_state))
-        if missing_integrations:
-            self._create_app().stop_all_services()
-            self._database_migration.set_status_to_pending()
-            logger.info(message := f"missing integrations: {', '.join(missing_integrations)}")
-            self.update_app_and_unit_status(ops.BlockedStatus(message))
+        if self._has_missing_relations(charm_state):
             return False
 
         if self._oauth and self._oauth.is_related():
@@ -549,6 +569,33 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
             return False
         return True
 
+    def _stop_all_and_set_blocked(self, message: str) -> None:
+        """Stop services, mark database migrations as pending and set ``BlockedStatus``."""
+        self._create_app().stop_all_services()
+        self._database_migration.set_status_to_pending()
+        self.update_app_and_unit_status(ops.BlockedStatus(message))
+
+    def _has_missing_relations(self, charm_state: CharmState) -> bool:
+        """Check if any relations are missing or not ready."""
+        missing_integrations = list(self._missing_required_integrations(charm_state))
+        if missing_integrations:
+            logger.info(message := f"missing integrations: {', '.join(missing_integrations)}")
+            self._stop_all_and_set_blocked(message)
+            return True
+
+        try:
+            missing_integrations = list(self._missing_custom_relations())
+            if missing_integrations:
+                logger.info(message := f"missing integrations: {', '.join(missing_integrations)}")
+                self._stop_all_and_set_blocked(message)
+                return True
+        except RelationDataError as e:
+            logger.error(message := f"RelationDataError: {e}")
+            self._stop_all_and_set_blocked(message)
+            return True
+
+        return False
+
     def _missing_required_database_integrations(
         self, requires: dict[str, RelationMeta], charm_state: CharmState
     ) -> typing.Generator:
@@ -621,6 +668,29 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         ):
             yield "valkey"
 
+    def _missing_custom_relations(self) -> typing.Generator:
+        """Return custom relations that are not established and required.
+
+        For not established but required relations this method returns a list
+        of the relation names. If a relation is not ready due to some problems
+        with missing / invalid data and raises an exception, the exception
+        is propagated to the caller.
+
+        Raises:
+            RelationDataError: if relation is not ready due to missing or
+            invalid data.
+        """  # noqa: DCO051
+        for relation in self._custom_relations:
+            name = relation.relation_name
+            related = any(
+                model_relation.active for model_relation in self.model.relations.get(name, [])
+            )
+            if related:
+                # may raise RelationDataError or InvalidRelationDataError
+                relation.ensure_ready()
+            elif relation.required:
+                yield name
+
     def _missing_required_integrations(
         self, charm_state: CharmState
     ) -> typing.Generator:  # noqa: C901
@@ -677,6 +747,14 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         """
         return self._create_app().gen_environment()
 
+    def _resolve_charm_config(self) -> dict[str, typing.Any]:
+        """Resolve any secrets in the config."""
+        charm_config = {k: config_get_with_secret(self, k) for k in self.config}
+        return {
+            k: v.get_content(refresh=True) if isinstance(v, ops.Secret) else v
+            for k, v in charm_config.items()
+        }
+
     def _create_charm_state(self) -> CharmState:
         """Create charm state.
 
@@ -685,14 +763,7 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
         Returns:
             New CharmState
         """
-        charm_config = {k: config_get_with_secret(self, k) for k in self.config.keys()}
-        config = typing.cast(
-            dict,
-            {
-                k: v.get_content(refresh=True) if isinstance(v, ops.Secret) else v
-                for k, v in charm_config.items()
-            },
-        )
+        config = self._resolve_charm_config()
         return CharmState.from_charm(
             charm_dir=self.charm_dir,
             config=config,
@@ -712,6 +783,7 @@ class PaasCharm(abc.ABC, ops.CharmBase):  # pylint: disable=too-many-instance-at
                 oauth=self._oauth,
                 http_proxy=self._http_proxy,
             ),
+            custom_relations=self._custom_relations,
             base_url=self._base_url,
         )
 

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/charm_state.py

@@ -17,12 +17,13 @@ from paas_charm.exceptions import (
     RelationDataError,
 )
 from paas_charm.peers import Peers
+from paas_charm.relations import CustomRelation
 from paas_charm.secret_key import SecretKeyStorage
 from paas_charm.utils import build_validation_error_message, config_metadata
 
 # This is just for type checking, no need to cover this code.
 if typing.TYPE_CHECKING:  # pragma: nocover
-    from charms.openfga_k8s.v1.openfga import OpenfgaProviderAppData, OpenFGARequires
+    from charmlibs.interfaces.openfga import OpenfgaProviderAppData, OpenFGARequires
     from charms.smtp_integrator.v0.smtp import SmtpRelationData, SmtpRequires
     from charms.squid_forward_proxy.v0.http_proxy import ProxyConfig
     from dpcharmlibs.interfaces import ValkeyResponseModel
@@ -62,6 +63,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
         peer_fqdns: str | None = None,
         integrations: "IntegrationsState | None" = None,
         base_url: str | None = None,
+        custom_relations: list[CustomRelation] | None = None,
     ):
         """Initialize a new instance of the CharmState class.
 
@@ -74,6 +76,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
             peer_fqdns: The FQDN of units in the peer relation.
             integrations: Information about the integrations.
             base_url: Base URL for the service.
+            custom_relations: Custom relations.
         """
         self.framework = framework
         self._framework_config = framework_config if framework_config is not None else {}
@@ -83,6 +86,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
         self.peer_fqdns = peer_fqdns
         self.integrations = integrations or IntegrationsState()
         self.base_url = base_url
+        self.custom_relations = custom_relations or []
 
     @classmethod
     def from_charm(  # pylint: disable=too-many-arguments,too-many-locals
@@ -95,6 +99,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
         secret_key: SecretKeyStorage,
         peers: Peers,
         integration_requirers: "IntegrationRequirers",
+        custom_relations: list[CustomRelation] | None = None,
         base_url: str | None = None,
     ) -> "CharmState":
         """Initialize a new instance of the CharmState class from the associated charm.
@@ -107,6 +112,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
             secret_key: The application secret key manager.
             peers: The peer coordination helper.
             integration_requirers: The collection of integration requirers.
+            custom_relations: Custom relations.
             base_url: Base URL for the service.
 
         Return:
@@ -210,6 +216,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
                 f"{exc.relation} relation data is either unavailable, invalid or not usable.",
                 relation=exc.relation,
             ) from exc
+
         peer_fqdns = None
         if peers.is_related and (peer_unit_fqdns := peers.get_peer_unit_fqdns()):
             peer_fqdns = ",".join(peer_unit_fqdns)
@@ -225,6 +232,7 @@ class CharmState:  # pylint: disable=too-many-instance-attributes
             peer_fqdns=peer_fqdns,
             integrations=integrations,
             base_url=base_url,
+            custom_relations=custom_relations,
         )
 
     @property

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/exceptions.py

@@ -68,3 +68,12 @@ class InvalidRelationDataError(RelationDataError):
 
 class InvalidCustomCOSDirectoryError(Exception):
     """Raised when the custom COS directory is invalid."""
+
+
+class CustomRelationError(Exception):
+    """Raised when a custom relation class is invalid.
+
+    Raised when an entry in ``custom_relations`` is not a ``CustomRelation``
+    subclass, or when the relation class is not declared in the charm metadata
+    (unused custom relation).
+    """

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/expressjs/charm.py

@@ -68,7 +68,6 @@ class Charm(PaasCharm):
             base_dir=base_dir,
             app_dir=base_dir,
             state_dir=base_dir / "state",
-            log_files=[],
             service_name=self._framework_name,
             metrics_path=metrics_path,
             metrics_port=metrics_port,

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/fastapi/charm.py

@@ -76,7 +76,6 @@ class Charm(PaasCharm):
             app_dir=base_dir,
             state_dir=self._state_dir,
             service_name=framework_name,
-            log_files=[],
             metrics_path=metrics_path,
             metrics_port=metrics_port,
             unit_name=self.unit.name,

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/go/charm.py

@@ -66,7 +66,6 @@ class Charm(PaasCharm):
             app_dir=base_dir,
             state_dir=self._state_dir,
             service_name=framework_name,
-            log_files=[],
             unit_name=self.unit.name,
             metrics_path=metrics_path,
             metrics_port=metrics_port,

{paas_charm-2.0.dev1 → paas_charm-2.0.dev3}/src/paas_charm/oauth.py

@@ -6,7 +6,7 @@
 import logging
 
 import ops
-from charms.hydra.v0.oauth import ClientConfig, OAuthRequirer
+from charmlibs.interfaces.oauth import ClientConfig, OAuthRequirer
 from ops import ConfigData
 from pydantic import BaseModel, ValidationError
 
@@ -95,6 +95,11 @@ class PaaSOAuthRequirer(OAuthRequirer):
             if not self.is_client_created():
                 return None
             prod_info = self.get_provider_info()
+            client_config = self._client_config
+            if prod_info is None or client_config is None:
+                raise InvalidOAuthRelationDataError(
+                    "OAuth provider or client configuration is unavailable."
+                )
             user_name_attribute = str(
                 self._charm_config.get(f"{self._relation_name}-user-name-attribute", "sub")
             )
@@ -107,9 +112,9 @@ class PaaSOAuthRequirer(OAuthRequirer):
                     "token_endpoint": prod_info.token_endpoint,
                     "userinfo_endpoint": prod_info.userinfo_endpoint,
                     "jwks_endpoint": prod_info.jwks_endpoint,
-                    "scopes": self._client_config.scope,
+                    "scopes": client_config.scope,
                     "provider_name": self._relation_name,
-                    "redirect_uri": self._client_config.redirect_uri,
+                    "redirect_uri": client_config.redirect_uri,
                     "user_name_attribute": user_name_attribute,
                 }
             )
@@ -160,7 +165,13 @@ class PaaSOAuthRequirer(OAuthRequirer):
     def get_related_app_name(self) -> str:
         """Return the related Oauth provider charm's name.
 
+        Raises:
+            InvalidOAuthRelationDataError: If no OAuth provider is related.
+
         Returns:
             Name of the Oauth provider charm.
         """
-        return self.model.relations.get(self._relation_name)[0].app.name
+        relations = self.model.relations.get(self._relation_name)
+        if not relations:
+            raise InvalidOAuthRelationDataError("No OAuth provider is related.")
+        return relations[0].app.name