@splitsoftware/splitio-commons
Version:
Split JavaScript SDK common components
144 lines (143 loc) • 7.91 kB
JavaScript
import { objectAssign } from '../utils/lang/objectAssign';
import { validateAttributes, validateEvent, validateEventValue, validateEventProperties, validateKey, validateSplit, validateSplits, validateTrafficType, validateIfNotDestroyed, validateIfOperational, validateEvaluationOptions } from '../utils/inputValidation';
import { startsWith } from '../utils/lang';
import { CONTROL, CONTROL_WITH_CONFIG, GET_TREATMENT, GET_TREATMENTS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENT_WITH_CONFIG, TRACK_FN_LABEL } from '../utils/constants';
import { isConsumerMode } from '../utils/settingsValidation/mode';
import { validateFlagSets } from '../utils/settingsValidation/splitFilters';
/**
* Decorator that validates the input before actually executing the client methods.
* We should "guard" the client here, while not polluting the "real" implementation of those methods.
*/
export function clientInputValidationDecorator(settings, client, readinessManager) {
var log = settings.log, mode = settings.mode;
var isAsync = isConsumerMode(mode);
/**
* Avoid repeating this validations code
*/
function validateEvaluationParams(methodName, maybeKey, maybeNameOrNames, maybeAttributes, maybeOptions) {
var key = validateKey(log, maybeKey, methodName);
var nameOrNames = methodName.indexOf('ByFlagSet') > -1 ?
validateFlagSets(log, methodName, maybeNameOrNames, settings.sync.__splitFiltersValidation.groupedFilters.bySet) :
startsWith(methodName, GET_TREATMENTS) ?
validateSplits(log, maybeNameOrNames, methodName) :
validateSplit(log, maybeNameOrNames, methodName);
var attributes = validateAttributes(log, maybeAttributes, methodName);
var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, methodName);
var options = validateEvaluationOptions(log, maybeOptions, methodName);
validateIfOperational(log, readinessManager, methodName, nameOrNames);
var valid = isNotDestroyed && key && nameOrNames && attributes !== false;
return {
valid: valid,
key: key,
nameOrNames: nameOrNames,
attributes: attributes,
options: options
};
}
function wrapResult(value) {
return isAsync ? Promise.resolve(value) : value;
}
function getTreatment(maybeKey, maybeFeatureFlagName, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENT, maybeKey, maybeFeatureFlagName, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatment(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
return wrapResult(CONTROL);
}
}
function getTreatmentWithConfig(maybeKey, maybeFeatureFlagName, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENT_WITH_CONFIG, maybeKey, maybeFeatureFlagName, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentWithConfig(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
return wrapResult(objectAssign({}, CONTROL_WITH_CONFIG));
}
}
function getTreatments(maybeKey, maybeFeatureFlagNames, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS, maybeKey, maybeFeatureFlagNames, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatments(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
var res_1 = {};
if (params.nameOrNames)
params.nameOrNames.forEach(function (split) { return res_1[split] = CONTROL; });
return wrapResult(res_1);
}
}
function getTreatmentsWithConfig(maybeKey, maybeFeatureFlagNames, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS_WITH_CONFIG, maybeKey, maybeFeatureFlagNames, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentsWithConfig(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
var res_2 = {};
if (params.nameOrNames)
params.nameOrNames.forEach(function (split) { return res_2[split] = objectAssign({}, CONTROL_WITH_CONFIG); });
return wrapResult(res_2);
}
}
function getTreatmentsByFlagSets(maybeKey, maybeFlagSets, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS_BY_FLAG_SETS, maybeKey, maybeFlagSets, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentsByFlagSets(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
return wrapResult({});
}
}
function getTreatmentsWithConfigByFlagSets(maybeKey, maybeFlagSets, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, maybeKey, maybeFlagSets, maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentsWithConfigByFlagSets(params.key, params.nameOrNames, params.attributes, params.options);
}
else {
return wrapResult({});
}
}
function getTreatmentsByFlagSet(maybeKey, maybeFlagSet, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS_BY_FLAG_SET, maybeKey, [maybeFlagSet], maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentsByFlagSet(params.key, params.nameOrNames[0], params.attributes, params.options);
}
else {
return wrapResult({});
}
}
function getTreatmentsWithConfigByFlagSet(maybeKey, maybeFlagSet, maybeAttributes, maybeOptions) {
var params = validateEvaluationParams(GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, maybeKey, [maybeFlagSet], maybeAttributes, maybeOptions);
if (params.valid) {
return client.getTreatmentsWithConfigByFlagSet(params.key, params.nameOrNames[0], params.attributes, params.options);
}
else {
return wrapResult({});
}
}
function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
var key = validateKey(log, maybeKey, TRACK_FN_LABEL);
var tt = validateTrafficType(log, maybeTT, TRACK_FN_LABEL);
var event = validateEvent(log, maybeEvent, TRACK_FN_LABEL);
var eventValue = validateEventValue(log, maybeEventValue, TRACK_FN_LABEL);
var _a = validateEventProperties(log, maybeProperties, TRACK_FN_LABEL), properties = _a.properties, size = _a.size;
var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, TRACK_FN_LABEL);
if (isNotDestroyed && key && tt && event && eventValue !== false && properties !== false) { // @ts-expect-error
return client.track(key, tt, event, eventValue, properties, size);
}
else {
return isAsync ? Promise.resolve(false) : false;
}
}
return {
getTreatment: getTreatment,
getTreatmentWithConfig: getTreatmentWithConfig,
getTreatments: getTreatments,
getTreatmentsWithConfig: getTreatmentsWithConfig,
getTreatmentsByFlagSets: getTreatmentsByFlagSets,
getTreatmentsWithConfigByFlagSets: getTreatmentsWithConfigByFlagSets,
getTreatmentsByFlagSet: getTreatmentsByFlagSet,
getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
track: track
};
}