78 lines
3.1 KiB
Python
78 lines
3.1 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import uuid
|
|
from collections.abc import Iterator
|
|
from contextlib import contextmanager
|
|
from datetime import timedelta
|
|
from typing import Any
|
|
|
|
from superset.distributed_lock.utils import get_key
|
|
from superset.exceptions import CreateKeyValueDistributedLockFailedException
|
|
from superset.key_value.types import JsonKeyValueCodec, KeyValueResource
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
CODEC = JsonKeyValueCodec()
|
|
LOCK_EXPIRATION = timedelta(seconds=30)
|
|
RESOURCE = KeyValueResource.LOCK
|
|
|
|
|
|
@contextmanager
|
|
def KeyValueDistributedLock( # pylint: disable=invalid-name # noqa: N802
|
|
namespace: str,
|
|
**kwargs: Any,
|
|
) -> Iterator[uuid.UUID]:
|
|
"""
|
|
KV global lock for refreshing tokens.
|
|
|
|
This context manager acquires a distributed lock for a given namespace, with
|
|
optional parameters (eg, namespace="cache", user_id=1). It yields a UUID for the
|
|
lock that can be used within the context, and corresponds to the key in the KV
|
|
store.
|
|
|
|
:param namespace: The namespace for which the lock is to be acquired.
|
|
:param kwargs: Additional keyword arguments.
|
|
:yields: A unique identifier (UUID) for the acquired lock (the KV key).
|
|
:raises CreateKeyValueDistributedLockFailedException: If the lock is taken.
|
|
"""
|
|
|
|
# pylint: disable=import-outside-toplevel
|
|
from superset.commands.distributed_lock.create import CreateDistributedLock
|
|
from superset.commands.distributed_lock.delete import DeleteDistributedLock
|
|
from superset.commands.distributed_lock.get import GetDistributedLock
|
|
|
|
key = get_key(namespace, **kwargs)
|
|
value = GetDistributedLock(namespace=namespace, params=kwargs).run()
|
|
if value:
|
|
logger.debug("Lock on namespace %s for key %s already taken", namespace, key)
|
|
raise CreateKeyValueDistributedLockFailedException("Lock already taken")
|
|
|
|
logger.debug("Acquiring lock on namespace %s for key %s", namespace, key)
|
|
try:
|
|
CreateDistributedLock(namespace=namespace, params=kwargs).run()
|
|
except CreateKeyValueDistributedLockFailedException as ex:
|
|
logger.debug("Lock on namespace %s for key %s already taken", namespace, key)
|
|
raise CreateKeyValueDistributedLockFailedException("Lock already taken") from ex
|
|
|
|
yield key
|
|
DeleteDistributedLock(namespace=namespace, params=kwargs).run()
|
|
logger.debug("Removed lock on namespace %s for key %s", namespace, key)
|