"""
This submodule contains interfaces for various components of the SDK.
They may be useful in writing new implementations of these components, or for testing.
"""
from abc import ABCMeta, abstractmethod, abstractproperty
from .versioned_data_kind import VersionedDataKind
from typing import Any, Callable, Mapping, Optional
[docs]class FeatureStore:
"""
Interface for a versioned store for feature flags and related objects received from LaunchDarkly.
Implementations should permit concurrent access and updates.
An "object", for ``FeatureStore``, is simply a dict of arbitrary data which must have at least
three properties: ``key`` (its unique key), ``version`` (the version number provided by
LaunchDarkly), and ``deleted`` (True if this is a placeholder for a deleted object).
Delete and upsert requests are versioned: if the version number in the request is less than
the currently stored version of the object, the request should be ignored.
These semantics support the primary use case for the store, which synchronizes a collection
of objects based on update messages that may be received out-of-order.
"""
__metaclass__ = ABCMeta
[docs] @abstractmethod
def get(self, kind: VersionedDataKind, key: str, callback: Callable[[Any], Any]=lambda x: x) -> Any:
"""
Retrieves the object to which the specified key is mapped, or None if the key is not found
or the associated object has a ``deleted`` property of True. The retrieved object, if any (a
dict) can be transformed by the specified callback.
:param kind: The kind of object to get
:param key: The key whose associated object is to be returned
:param callback: A function that accepts the retrieved data and returns a transformed value
:return: The result of executing callback
"""
[docs] @abstractmethod
def all(self, kind: VersionedDataKind, callback: Callable[[Any], Any]=lambda x: x) -> Any:
"""
Retrieves a dictionary of all associated objects of a given kind. The retrieved dict of keys
to objects can be transformed by the specified callback.
:param kind: The kind of objects to get
:param callback: A function that accepts the retrieved data and returns a transformed value
"""
[docs] @abstractmethod
def init(self, all_data: Mapping[VersionedDataKind, Mapping[str, dict]]):
"""
Initializes (or re-initializes) the store with the specified set of objects. Any existing entries
will be removed. Implementations can assume that this set of objects is up to date-- there is no
need to perform individual version comparisons between the existing objects and the supplied data.
:param all_data: All objects to be stored
"""
[docs] @abstractmethod
def delete(self, kind: VersionedDataKind, key: str, version: int):
"""
Deletes the object associated with the specified key, if it exists and its version is less than
the specified version. The object should be replaced in the data store by a
placeholder with the specified version and a "deleted" property of TErue.
:param kind: The kind of object to delete
:param key: The key of the object to be deleted
:param version: The version for the delete operation
"""
[docs] @abstractmethod
def upsert(self, kind: VersionedDataKind, item: dict):
"""
Updates or inserts the object associated with the specified key. If an item with the same key
already exists, it should update it only if the new item's version property is greater than
the old one.
:param kind: The kind of object to update
:param item: The object to update or insert
"""
@abstractproperty
def initialized(self) -> bool:
"""
Returns whether the store has been initialized yet or not
"""
[docs]class FeatureStoreCore:
"""
Interface for a simplified subset of the functionality of :class:`FeatureStore`, to be used
in conjunction with :class:`ldclient.feature_store_helpers.CachingStoreWrapper`. This allows
developers of custom ``FeatureStore`` implementations to avoid repeating logic that would
commonly be needed in any such implementation, such as caching. Instead, they can implement
only ``FeatureStoreCore`` and then create a ``CachingStoreWrapper``.
"""
__metaclass__ = ABCMeta
[docs] @abstractmethod
def get_internal(self, kind: VersionedDataKind, key: str) -> dict:
"""
Returns the object to which the specified key is mapped, or None if no such item exists.
The method should not attempt to filter out any items based on their deleted property,
nor to cache any items.
:param kind: The kind of object to get
:param key: The key of the object
:return: The object to which the specified key is mapped, or None
"""
[docs] @abstractmethod
def get_all_internal(self, callback) -> Mapping[str, dict]:
"""
Returns a dictionary of all associated objects of a given kind. The method should not attempt
to filter out any items based on their deleted property, nor to cache any items.
:param kind: The kind of objects to get
:return: A dictionary of keys to items
"""
[docs] @abstractmethod
def init_internal(self, all_data: Mapping[VersionedDataKind, Mapping[str, dict]]):
"""
Initializes (or re-initializes) the store with the specified set of objects. Any existing entries
will be removed. Implementations can assume that this set of objects is up to date-- there is no
need to perform individual version comparisons between the existing objects and the supplied
data.
:param all_data: A dictionary of data kinds to item collections
"""
[docs] @abstractmethod
def upsert_internal(self, kind: VersionedDataKind, item: dict) -> dict:
"""
Updates or inserts the object associated with the specified key. If an item with the same key
already exists, it should update it only if the new item's version property is greater than
the old one. It should return the final state of the item, i.e. if the update succeeded then
it returns the item that was passed in, and if the update failed due to the version check
then it returns the item that is currently in the data store (this ensures that
`CachingStoreWrapper` will update the cache correctly).
:param kind: The kind of object to update
:param item: The object to update or insert
:return: The state of the object after the update
"""
[docs] @abstractmethod
def initialized_internal(self) -> bool:
"""
Returns true if this store has been initialized. In a shared data store, it should be able to
detect this even if initInternal was called in a different process, i.e. the test should be
based on looking at what is in the data store. The method does not need to worry about caching
this value; `CachingStoreWrapper` will only call it when necessary.
"""
# Internal use only. Common methods for components that perform a task in the background.
[docs]class BackgroundOperation:
# noinspection PyMethodMayBeStatic
[docs] def start(self):
"""
Starts an operation in the background. Should return immediately and not block.
"""
pass
[docs] def stop(self):
"""
Stops an operation running in the background. May return before the operation is actually stopped.
"""
pass
# noinspection PyMethodMayBeStatic
[docs] def is_alive(self) -> bool:
"""
Returns whether the operation is alive or not
"""
return True
[docs]class UpdateProcessor(BackgroundOperation):
"""
Interface for the component that obtains feature flag data in some way and passes it to a
:class:`FeatureStore`. The built-in implementations of this are the client's standard streaming
or polling behavior. For testing purposes, there is also :func:`ldclient.integrations.Files.new_data_source()`.
"""
__metaclass__ = ABCMeta
[docs] def initialized(self) -> bool:
"""
Returns whether the update processor has received feature flags and has initialized its feature store.
"""
[docs]class EventProcessor:
"""
Interface for the component that buffers analytics events and sends them to LaunchDarkly.
The default implementation can be replaced for testing purposes.
"""
__metaclass__ = ABCMeta
[docs] @abstractmethod
def send_event(self, event):
"""
Processes an event to be sent at some point.
"""
[docs] @abstractmethod
def flush(self):
"""
Specifies that any buffered events should be sent as soon as possible, rather than waiting
for the next flush interval. This method is asynchronous, so events still may not be sent
until a later time. However, calling ``stop()`` will synchronously deliver any events that were
not yet delivered prior to shutting down.
"""
[docs] @abstractmethod
def stop(self):
"""
Shuts down the event processor after first delivering all pending events.
"""
[docs]class FeatureRequester:
"""
Interface for the component that acquires feature flag data in polling mode. The default
implementation can be replaced for testing purposes.
"""
__metaclass__ = ABCMeta
[docs] def get_all(self):
"""
Gets all feature flags.
"""
pass
[docs]class DiagnosticDescription:
"""
Optional interface for components to describe their own configuration.
"""
[docs] @abstractmethod
def describe_configuration(self, config) -> str:
"""
Used internally by the SDK to inspect the configuration.
:param config: the full configuration, in case this component depends on properties outside itself
:return: a string describing the type of the component, or None
"""
pass
[docs]class BigSegmentStore:
"""
Interface for a read-only data store that allows querying of user membership in Big Segments.
Big Segments are a specific type of user segments. For more information, read the LaunchDarkly
documentation: https://docs.launchdarkly.com/home/users/big-segments
"""
[docs] @abstractmethod
def get_membership(self, user_hash: str) -> Optional[dict]:
"""
Queries the store for a snapshot of the current segment state for a specific user.
The user_hash is a base64-encoded string produced by hashing the user key as defined by
the Big Segments specification; the store implementation does not need to know the details
of how this is done, because it deals only with already-hashed keys, but the string can be
assumed to only contain characters that are valid in base64.
The return value should be either a `dict`, or None if the user is not referenced in any big
segments. Each key in the dictionary is a "segment reference", which is how segments are
identified in Big Segment data. This string is not identical to the segment key-- the SDK
will add other information. The store implementation should not be concerned with the
format of the string. Each value in the dictionary is True if the user is explicitly included
in the segment, False if the user is explicitly excluded from the segment-- and is not also
explicitly included (that is, if both an include and an exclude existed in the data, the
include would take precedence). If the user's status in a particular segment is undefined,
there should be no key or value for that segment.
This dictionary may be cached by the SDK, so it should not be modified after it is created.
It is a snapshot of the segment membership state at one point in time.
:param user_hash: the hashed user key
:return: True/False values for Big Segments that reference this user
"""
pass
[docs] @abstractmethod
def stop(self):
"""
Shuts down the store component and releases and resources it is using.
"""
pass
[docs]class BigSegmentStoreStatus:
"""
Information about the state of a Big Segment store, provided by :class:`BigSegmentStoreStatusProvider`.
Big Segments are a specific type of user segments. For more information, read the LaunchDarkly
documentation: https://docs.launchdarkly.com/home/users/big-segments
"""
[docs] def __init__(self, available: bool, stale: bool):
self.__available = available
self.__stale = stale
@property
def available(self) -> bool:
"""
True if the Big Segment store is able to respond to queries, so that the SDK can evaluate
whether a user is in a segment or not.
If this property is False, the store is not able to make queries (for instance, it may not have
a valid database connection). In this case, the SDK will treat any reference to a Big Segment
as if no users are included in that segment. Also, the :func:`ldclient.flag.EvaluationDetail.reason`
associated with with any flag evaluation that references a Big Segment when the store is not
available will have a `bigSegmentsStatus` of `"STORE_ERROR"`.
"""
return self.__available
@property
def stale(self) -> bool:
"""
True if the Big Segment store is available, but has not been updated within the amount of time
specified by {BigSegmentsConfig#stale_after}.
This may indicate that the LaunchDarkly Relay Proxy, which populates the store, has stopped
running or has become unable to receive fresh data from LaunchDarkly. Any feature flag
evaluations that reference a Big Segment will be using the last known data, which may be out
of date. Also, the :func:`ldclient.flag.EvaluationDetail.reason` associated with those evaluations
will have a `bigSegmentsStatus` of `"STALE"`.
"""
return self.__stale
[docs]class BigSegmentStoreStatusProvider:
"""
An interface for querying the status of a Big Segment store.
The Big Segment store is the component that receives information about Big Segments, normally
from a database populated by the LaunchDarkly Relay Proxy. Big Segments are a specific type
of user segments. For more information, read the LaunchDarkly documentation:
https://docs.launchdarkly.com/home/users/big-segments
An implementation of this abstract class is returned by :func:`ldclient.client.LDClient.big_segment_store_status_provider`.
Application code never needs to implement this interface.
There are two ways to interact with the status. One is to simply get the current status; if its
`available` property is true, then the SDK is able to evaluate user membership in Big Segments,
and the `stale`` property indicates whether the data might be out of date.
The other way is to subscribe to status change notifications. Applications may wish to know if
there is an outage in the Big Segment store, or if it has become stale (the Relay Proxy has
stopped updating it with new data), since then flag evaluations that reference a Big Segment
might return incorrect values. Use `add_listener` to register a callback for notifications.
"""
@abstractproperty
def status(self) -> BigSegmentStoreStatus:
"""
Gets the current status of the store.
:return: the status
"""
pass
[docs] @abstractmethod
def add_listener(self, listener: Callable[[BigSegmentStoreStatus], None]) -> None:
"""
Subscribes for notifications of status changes.
The listener is a function or method that will be called with a single parameter: the
new `BigSegmentStoreStatus`.
:param listener: the listener to add
"""
pass
[docs] @abstractmethod
def remove_listener(self, listener: Callable[[BigSegmentStoreStatus], None]) -> None:
"""
Unsubscribes from notifications of status changes.
:param listener: a listener that was previously added with `add_listener`; if it was not,
this method does nothing
"""
pass