evaluations.spec.js

import { SplitFactory } from '../../';

const SDK_INSTANCES_TO_TEST = 4;

export default async function (config, key, assert) {
  let i = 0, tested = 0;

  const getTreatmentTests = (client, sdkInstance) => {
    assert.comment(`Get Treatment Tests - Sdk Instance ${sdkInstance + 1}`);
    assert.equal(client.getTreatment(key, 'whitelist'), 'allowed');
    assert.equal(client.getTreatment(key, 'qc_team'), 'no');

    assert.equal(client.getTreatment(key, 'user_attr_gte_10_and_user_attr2_is_not_foo'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_gte_10_and_user_attr2_is_not_foo', {
      attr: 55,
      attr2: 'bar'
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_10_and_user_attr2_is_not_foo', {
      attr: 55,
      attr2: 'foo'
    }), 'off');

    assert.equal(client.getTreatment(key, 'user_account_in_whitelist'), 'off');
    assert.equal(client.getTreatment(key, 'user_account_in_whitelist', {
      account: 'key_1@split.io'
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_account_in_whitelist', {
      account: 'key_6@split.io'
    }), 'off');

    assert.equal(client.getTreatment(key, 'user_account_in_segment_all'), 'off');
    assert.equal(client.getTreatment(key, 'user_account_in_segment_all', {
      account: 'something'
    }), 'on');

    assert.equal(client.getTreatment(key, 'user_attr_btw_datetime_1458240947021_and_1458246884077', {
      attr: new Date('2016-03-17T18:55:47.021Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_btw_datetime_1458240947021_and_1458246884077', {
      attr: new Date('2016-03-17T17:55:47.021Z').getTime()
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_datetime_1458240947021_and_1458246884077', {
      attr: new Date('2016-03-17T21:34:44.077Z').getTime()
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_datetime_1458240947021_and_1458246884077'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_btw_number_10_and_20'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_number_10_and_20', {
      attr: 9
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_number_10_and_20', {
      attr: 21
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_number_10_and_20', {
      attr: 15
    }), 'on');

    assert.equal(client.getTreatment(key, 'user_attr_btw_10_and_20'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_10_and_20', {
      attr: 9
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_10_and_20', {
      attr: 21
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_btw_10_and_20', {
      attr: 15
    }), 'on');

    assert.equal(client.getTreatment(key, 'user_attr_lte_datetime_1458240947021', {
      attr: new Date('2016-03-17T18:55:47.021Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_datetime_1458240947021', {
      attr: new Date('2016-03-16T17:55:47.021Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_datetime_1458240947021', {
      attr: new Date('2016-03-17T19:55:47.021Z').getTime()
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_lte_datetime_1458240947021'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_lte_number_10', {
      attr: 9
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_number_10', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_number_10', {
      attr: 11
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_lte_number_10'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_lte_10', {
      attr: 9
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_10', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_lte_10', {
      attr: 11
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_lte_10'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_gte_datetime_1458240947021', {
      attr: new Date('2016-03-17T18:55:47.021Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_datetime_1458240947021', {
      attr: new Date('2016-03-17T19:55:47.021Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_datetime_1458240947021', {
      attr: new Date('2016-03-17T17:55:47.021Z').getTime()
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_gte_datetime_1458240947021'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_gte_number_10'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_gte_number_10', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_number_10', {
      attr: 11
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_number_10', {
      attr: 0
    }), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_gte_10'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_gte_10', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_10', {
      attr: 11
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_gte_10', {
      attr: 0
    }), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_eq_datetime_1458240947021', {
      attr: new Date('2016-03-17T00:00:00Z').getTime()
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_eq_datetime_1458240947021', {
      attr: new Date('2016-03-16T10:01:10Z').getTime()
    }), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_eq_datetime_1458240947021'), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_eq_number_ten'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_eq_number_ten', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_eq_number_ten', {
      attr: 9
    }), 'off');

    assert.equal(client.getTreatment(key, 'user_attr_eq_ten'), 'off');
    assert.equal(client.getTreatment(key, 'user_attr_eq_ten', {
      attr: 10
    }), 'on');
    assert.equal(client.getTreatment(key, 'user_attr_eq_ten', {
      attr: 9
    }), 'off');

    // This split depends on Split hierarchical_dep_hierarchical which depends on a split that always retuns 'on'
    assert.equal(client.getTreatment(key, 'hierarchical_splits_test'), 'on');

    // This split has a traffic allocation of 1 (lowest) and the key we're using also returns the lowest bucket for TA (1)
    // As the only matcher is a segment_all, we should get the treatment from the condition, not the default one (default_treatment)
    assert.equal(client.getTreatment('aaaaaaklmnbv', 'ta_bucket1_test'), 'rollout_treatment');
    // With a higher bucket it's ok to get default treatment
    assert.equal(client.getTreatment('nico_test', 'ta_bucket1_test'), 'default_treatment');

    // Rule-based segments
    assert.equal(client.getTreatment('emi@split.io', 'rbs_test_flag'), 'v2', 'key in excluded segment');
    assert.equal(client.getTreatment('mauro@split.io', 'rbs_test_flag'), 'v2', 'excluded key');
    assert.equal(client.getTreatment('bilal@split.io', 'rbs_test_flag'), 'v1', 'key satisfies the rbs condition');
    assert.equal(client.getTreatment('other_key', 'rbs_test_flag'), 'v2', 'key not in segment');

    assert.equal(client.getTreatment('emi@split.io', 'rbs_test_flag_negated'), 'v1', 'key in excluded segment');
    assert.equal(client.getTreatment('mauro@split.io', 'rbs_test_flag_negated'), 'v1', 'excluded key');
    assert.equal(client.getTreatment('bilal@split.io', 'rbs_test_flag_negated'), 'v2', 'key satisfies the rbs condition');
    assert.equal(client.getTreatment('other_key', 'rbs_test_flag_negated'), 'v1', 'key not in segment');

    // Prerequisites
    assert.equal(client.getTreatment('bilal@split.io', 'always_on_if_prerequisite'), 'on', 'prerequisite satisfied (key satisfies the rbs condition)');
    assert.equal(client.getTreatment('emi@split.io', 'always_on_if_prerequisite'), 'off', 'prerequisite not satisfied (key in excluded segment)');
  };

  const getTreatmentsTests = (client, sdkInstance) => {
    assert.comment(`Get Treatments Tests - Sdk Instance ${sdkInstance + 1}`);

    assert.deepEqual(client.getTreatments(key, [
      // Treatments List
      'whitelist',
      'qc_team',
      'hierarchical_splits_test'
    ]), {
      // Expected result
      whitelist: 'allowed',
      qc_team: 'no',
      hierarchical_splits_test: 'on'
    });

    // I'm not sending the attributes
    assert.deepEqual(client.getTreatments(key, [
      'user_attr_gte_10_and_user_attr2_is_not_foo',
      'user_account_in_whitelist'
    ]), {
      user_attr_gte_10_and_user_attr2_is_not_foo: 'off',
      user_account_in_whitelist: 'off'
    });

    assert.deepEqual(client.getTreatments(key, [
      'user_attr_gte_10_and_user_attr2_is_not_foo',
      'user_account_in_whitelist'
    ], {
      // Attributes
      age: 20,
      attr: 55,
      attr2: 'bar',
      account: 'key@split.io'
    }), {
      user_attr_gte_10_and_user_attr2_is_not_foo: 'on',
      user_account_in_whitelist: 'off'
    });

    assert.deepEqual(client.getTreatments(key, [
      'user_attr_gte_10_and_user_attr2_is_not_foo',
      'user_account_in_whitelist'
    ], {
      // Attributes
      age: 21,
      attr: 55,
      attr2: 'foo',
      account: 'key_1@split.io'
    }), {
      user_attr_gte_10_and_user_attr2_is_not_foo: 'off',
      user_account_in_whitelist: 'on'
    });

  };

  const getTreatmentsWithConfigTests = (client, sdkInstance) => {
    assert.comment(`Get Treatment and Treatments with Configurations testing - Sdk Instance ${sdkInstance + 1}`);
    const expectedConfig = '{"color":"brown","dimensions":{"height":12,"width":14},"text":{"inner":"click me"}}';

    // Evaluate for the unitary version
    assert.deepEqual(client.getTreatmentWithConfig(null), { treatment: 'control', config: null }, 'If I try to get a treatment with invalid input, I get the config null and treatment control.');
    assert.deepEqual(client.getTreatmentWithConfig('a_key', 'not_existent_split'), { treatment: 'control', config: null }, 'If I try to get a treatment for a non existent Split, I get the config null and treatment control.');
    assert.deepEqual(client.getTreatmentWithConfig('a_key', 'split_with_config'), { treatment: 'o.n', config: expectedConfig }, 'If we get the treatment for a Split WITH config, we get such config as a string and the treatment.');
    assert.deepEqual(client.getTreatmentWithConfig('a_key', 'split_with_config', { group: 'value_without_config' }), { treatment: 'off', config: null }, 'If we get the treatment for a Split without config, the config value is null.');

    const CONTROL_WITH_CONFIG = {
      treatment: 'control',
      config: null
    };

    // Evaluate for the multiple version
    assert.deepEqual(client.getTreatmentsWithConfig(null), {}, 'If I try go get treatments with inproper input, I get empty object as always.');
    assert.deepEqual(client.getTreatmentsWithConfig(null, ['errored', null, 'errored', 'something']), { errored: CONTROL_WITH_CONFIG, something: CONTROL_WITH_CONFIG }, 'If I try go get treatments with inproper input but the split names are valid, I get control as treatment and config null for those names.');
    assert.deepEqual(client.getTreatmentsWithConfig('a_key', ['not_existent', 'other']), { not_existent: CONTROL_WITH_CONFIG, other: CONTROL_WITH_CONFIG }, 'If Iget a treatment for non existent Splits, I get control as treatment and config null for those split names.');
    assert.deepEqual(client.getTreatmentsWithConfig('a_key', ['split_with_config', 'qc_team']), {
      qc_team: { treatment: 'no', config: null },
      split_with_config: { treatment: 'o.n', config: expectedConfig }
    }, 'If I get treatments right, I get a map of objects with those treatments and the configs when existent, null config otherwise.');
  };

  for (i; i < SDK_INSTANCES_TO_TEST; i++) {
    let splitio = SplitFactory(config);

    let client = splitio.client();

    await client.ready();

    assert.deepEqual(client.setAttribute, undefined, 'should not be available');
    assert.deepEqual(client.getAttribute, undefined, 'should not be available');
    assert.deepEqual(client.removeAttribute, undefined, 'should not be available');
    assert.deepEqual(client.setAttributes, undefined, 'should not be available');
    assert.deepEqual(client.getAttributes, undefined, 'should not be available');
    assert.deepEqual(client.clearAttributes, undefined, 'should not be available');

    assert.deepEqual(splitio.UserConsent, undefined, 'UserConsent API should not be available');

    getTreatmentTests(client, i);
    getTreatmentsTests(client, i);
    getTreatmentsWithConfigTests(client, i);

    await client.destroy();

    tested++;

    if (tested === SDK_INSTANCES_TO_TEST) {
      assert.end();
    }
  }
}