io.getunleash.strategy.GradualRolloutUserIdStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unleash-client-java Show documentation

A client library for Unleash

There is a newer version: 9.2.4

package io.getunleash.strategy;

import io.getunleash.UnleashContext;
import java.util.Map;
import java.util.Optional;

/**
 * Implements a gradual roll-out strategy based on userId.
 *
 * Using this strategy you can target only logged in users and gradually expose your feature to
 * higher percentage of the logged in user.
 *
 * This strategy takes two parameters: - percentage : a number between 0 and 100. The percentage
 * you want to enable the feature for. - groupId : a groupId used for rolling out the feature. By
 * using the same groupId for different toggles you can correlate the user experience across
 * toggles.
 */
public final class GradualRolloutUserIdStrategy implements Strategy {
    protected static final String PERCENTAGE = "percentage";
    protected static final String GROUP_ID = "groupId";

    private static final String NAME = "gradualRolloutUserId";

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public boolean isEnabled(Map parameters) {
        return false;
    }

    @Override
    public boolean isEnabled(final Map parameters, UnleashContext unleashContext) {
        Optional userId = unleashContext.getUserId();

        if (!userId.isPresent()) {
            return false;
        }

        final int percentage = StrategyUtils.getPercentage(parameters.get(PERCENTAGE));
        final String groupId = parameters.getOrDefault(GROUP_ID, "");

        final int normalizedUserId = StrategyUtils.getNormalizedNumber(userId.get(), groupId, 0);

        return percentage > 0 && normalizedUserId <= percentage;
    }
}