qcs-api-client-common 0.17.4

Common code for QCS API clients
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

"""Middleware for gRPC clients."""

from abc import ABCMeta
from collections.abc import Callable
from typing import Any

import grpc  # type: ignore
from grpc import ClientCallDetails  # type: ignore
from grpc.aio import Call, UnaryUnaryClientInterceptor  # type: ignore

from .configuration import ClientConfiguration, SecretAccessToken  # type: ignore


class RefreshInterceptor(UnaryUnaryClientInterceptor, metaclass=ABCMeta):
    """A `RefreshInterceptor` will add your QCS authorization token to all your QCS requests.

    The interceptor will automatically refresh your token as needed.
    """

    def __init__(self, client_configuration: ClientConfiguration | None = None):
        """Initialize the interceptor using a `ClientConfiguration`.

        If `client_configuration` is unset, `ClientConfiguratio.load_default()` will be used.
        """
        if client_configuration is None:
            client_configuration = ClientConfiguration.load_default()
        self.configuration = client_configuration

    async def _get_access_token(self) -> SecretAccessToken:
        return await self.configuration.get_bearer_access_token_async()

    async def intercept_unary_unary(
        self,
        continuation: Callable[[ClientCallDetails, Any], Call],
        client_call_details: ClientCallDetails,
        request: Any,
    ) -> Any:
        """Adds the QCS authorization token to the request metadata, refreshing the token if needed."""
        # Modify the headers to add the access token
        authorized_metadata: list[tuple[str, str]] = []
        if client_call_details.metadata is not None:
            authorized_metadata = list(client_call_details.metadata)

        authorized_metadata.append(("authorization", f"Bearer {await self._get_access_token()}"))

        new_client_call_details = grpc.aio.ClientCallDetails(
            client_call_details.method,
            client_call_details.timeout,
            authorized_metadata,
            client_call_details.credentials,
            client_call_details.wait_for_ready,
        )

        return await continuation(new_client_call_details, request)