#  Copyright 2021 Collate
#  Licensed 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.

"""
Unique Ratio Composed Metric definition
"""
from typing import Any, Dict, Optional, Tuple

from metadata.orm_profiler.metrics.core import ComposedMetric
from metadata.orm_profiler.metrics.static.count import Count
from metadata.orm_profiler.metrics.static.unique_count import UniqueCount


class UniqueRatio(ComposedMetric):
    """
    Given the total count and unique count,
    compute the unique ratio
    """

    @classmethod
    def name(cls):
        return "uniqueProportion"

    @classmethod
    def required_metrics(cls) -> Tuple[str, ...]:
        return Count.name(), UniqueCount.name()

    @property
    def metric_type(self):
        """
        Override default metric_type definition as
        we now don't care about the column
        """
        return float

    def fn(self, res: Dict[str, Any]) -> Optional[float]:
        """
        Safely compute null ratio based on the profiler
        results of other Metrics
        """
        res_count = res.get(Count.name())
        res_unique = res.get(UniqueCount.name())

        if res_count and res_unique is not None:
            # Why do we need to wrap this into a min?
            # If we run metrics on a random sample, each time
            # a query gets executed against the sample CTE, new
            # random numbers will get generated. This means that
            # when running the Count metric in a session and the
            # Unique Count metric in another, we could possibly obtain
            # res_unique > res_count for tables with a low number
            # of rows. In those cases, the tendency would still be
            # to have a high number of uniques, so we can
            # comfortably return 100%.
            # The alternative would be to try to find repeatable
            # random generators, but not all dialects support
            # setting a global seed, and it is more interesting
            # to have a wider variety of results for the
            # profiler runs.
            return min(res_unique / res_count, 100)

        return None
