@featurevisor/core 0.0.3

package/lib/linter.js

@@ -0,0 +1,334 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lintProject = exports.printJoiError = exports.getTestsJoiSchema = exports.getFeatureJoiSchema = exports.getSegmentJoiSchema = exports.getConditionsJoiSchema = exports.getAttributeJoiSchema = void 0;
+// for use in node only
+var fs = require("fs");
+var path = require("path");
+var Joi = require("joi");
+var utils_1 = require("./utils");
+function getAttributeJoiSchema(projectConfig) {
+    var attributeJoiSchema = Joi.object({
+        archived: Joi.boolean(),
+        type: Joi.string().allow("boolean", "string", "integer", "double"),
+        description: Joi.string(),
+        capture: Joi.boolean().optional(),
+    });
+    return attributeJoiSchema;
+}
+exports.getAttributeJoiSchema = getAttributeJoiSchema;
+function getConditionsJoiSchema(projectConfig) {
+    var plainConditionJoiSchema = Joi.object({
+        attribute: Joi.string(),
+        operator: Joi.string().valid("equals", "notEquals", 
+        // numeric
+        "greaterThan", "greaterThanOrEquals", "lessThan", "lessThanOrEquals", 
+        // string
+        "contains", "notContains", "startsWith", "endsWith", 
+        // array of strings
+        "in", "notIn"),
+        value: Joi.alternatives().try(
+        // @TODO: make them more specific
+        Joi.string(), Joi.number(), Joi.boolean(), Joi.array().items(Joi.string())),
+    });
+    var andOrConditionJoiSchema = Joi.alternatives()
+        .try(Joi.object({
+        and: Joi.array().items(Joi.link("#andOrCondition"), plainConditionJoiSchema),
+    }), Joi.object({
+        or: Joi.array().items(Joi.link("#andOrCondition"), plainConditionJoiSchema),
+    }))
+        .id("andOrCondition");
+    var conditionJoiSchema = Joi.alternatives().try(andOrConditionJoiSchema, plainConditionJoiSchema);
+    var conditionsJoiSchema = Joi.alternatives().try(conditionJoiSchema, Joi.array().items(conditionJoiSchema));
+    return conditionsJoiSchema;
+}
+exports.getConditionsJoiSchema = getConditionsJoiSchema;
+function getSegmentJoiSchema(projectConfig, conditionsJoiSchema) {
+    var segmentJoiSchema = Joi.object({
+        archived: Joi.boolean().optional(),
+        description: Joi.string(),
+        conditions: conditionsJoiSchema,
+    });
+    return segmentJoiSchema;
+}
+exports.getSegmentJoiSchema = getSegmentJoiSchema;
+function getFeatureJoiSchema(projectConfig, conditionsJoiSchema) {
+    var variationValueJoiSchema = Joi.alternatives().try(Joi.string(), Joi.number(), Joi.boolean());
+    var variableValueJoiSchema = Joi.alternatives()
+        .try(Joi.string(), Joi.number(), Joi.boolean(), Joi.array().items(Joi.string()))
+        .allow("");
+    var plainGroupSegment = Joi.string();
+    var andOrGroupSegment = Joi.alternatives()
+        .try(Joi.object({
+        and: Joi.array().items(Joi.link("#andOrGroupSegment"), plainGroupSegment),
+    }), Joi.object({
+        or: Joi.array().items(Joi.link("#andOrGroupSegment"), plainGroupSegment),
+    }))
+        .id("andOrGroupSegment");
+    var groupSegment = Joi.alternatives().try(andOrGroupSegment, plainGroupSegment);
+    var groupSegmentsJoiSchema = Joi.alternatives().try(Joi.array().items(groupSegment), groupSegment);
+    var environmentJoiSchema = Joi.object({
+        expose: Joi.boolean(),
+        rules: Joi.array().items(Joi.object({
+            key: Joi.string(),
+            segments: groupSegmentsJoiSchema,
+            percentage: Joi.number().min(0).max(100), // @TODO: allow maximum 3 decimal places
+        })),
+        force: Joi.array().items(Joi.object({
+            // @TODO: either of the two below
+            segments: groupSegmentsJoiSchema,
+            conditions: conditionsJoiSchema,
+            variation: variationValueJoiSchema,
+            variables: Joi.object(), // @TODO: make it stricter
+        })),
+    });
+    var allEnvironomentsSchema = {};
+    projectConfig.environments.forEach(function (environmentKey) {
+        allEnvironomentsSchema[environmentKey] = environmentJoiSchema;
+    });
+    var allEnvironomentsJoiSchema = Joi.object(allEnvironomentsSchema);
+    var featureJoiSchema = Joi.object({
+        archived: Joi.boolean().optional(),
+        description: Joi.string(),
+        tags: Joi.array().items(Joi.string()),
+        defaultVariation: variationValueJoiSchema,
+        bucketBy: Joi.alternatives().try(Joi.string(), Joi.array().items(Joi.string())),
+        variablesSchema: Joi.array().items(Joi.object({
+            key: Joi.string(),
+            type: Joi.string().valid("string", "integer", "boolean", "double", "array"),
+            defaultValue: variableValueJoiSchema, // @TODO: make it stricter based on `type`
+        })),
+        variations: Joi.array().items(Joi.object({
+            type: Joi.string().valid("string", "integer", "boolean", "double"),
+            value: variationValueJoiSchema,
+            weight: Joi.number().integer().min(0).max(100),
+            variables: Joi.array().items(Joi.object({
+                key: Joi.string(),
+                value: variableValueJoiSchema,
+                overrides: Joi.array().items(Joi.object({
+                    // @TODO: either segments or conditions prsent at a time
+                    segments: groupSegmentsJoiSchema,
+                    conditions: conditionsJoiSchema,
+                    // @TODO: make it stricter based on `type`
+                    value: variableValueJoiSchema,
+                })),
+            })),
+        })),
+        environments: allEnvironomentsJoiSchema,
+    });
+    return featureJoiSchema;
+}
+exports.getFeatureJoiSchema = getFeatureJoiSchema;
+function getTestsJoiSchema(projectConfig) {
+    var testsJoiSchema = Joi.object({
+        tests: Joi.array().items(Joi.object({
+            description: Joi.string().optional(),
+            tag: Joi.string(),
+            environment: Joi.string().valid("production", "staging", "testing", "development"),
+            features: Joi.array().items(Joi.object({
+                key: Joi.string(),
+                assertions: Joi.array().items(Joi.object({
+                    description: Joi.string().optional(),
+                    at: Joi.number().integer().min(0).max(100),
+                    attributes: Joi.object(),
+                    // @TODO: one or both below
+                    expectedVariation: Joi.alternatives().try(Joi.string(), Joi.number(), Joi.boolean()),
+                    expectedVariables: Joi.object(), // @TODO: make it specific
+                })),
+            })),
+        })),
+    });
+    return testsJoiSchema;
+}
+exports.getTestsJoiSchema = getTestsJoiSchema;
+function printJoiError(e) {
+    var details = e.details;
+    details.forEach(function (detail) {
+        var _a;
+        console.error("     => Error:", detail.message);
+        console.error("     => Path:", detail.path.join("."));
+        console.error("     => Value:", (_a = detail.context) === null || _a === void 0 ? void 0 : _a.value);
+    });
+}
+exports.printJoiError = printJoiError;
+function lintProject(projectConfig) {
+    return __awaiter(this, void 0, void 0, function () {
+        var hasError, attributeFilePaths, attributeJoiSchema, _i, attributeFilePaths_1, filePath, key, parsed, e_1, segmentFilePaths, conditionsJoiSchema, segmentJoiSchema, _a, segmentFilePaths_1, filePath, key, parsed, e_2, featureFilePaths, featureJoiSchema, _b, featureFilePaths_1, filePath, key, parsed, e_3, testFilePaths, testsJoiSchema, _c, testFilePaths_1, filePath, key, parsed, e_4;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    hasError = false;
+                    // lint attributes
+                    console.log("Linting attributes...\n");
+                    attributeFilePaths = (0, utils_1.getYAMLFiles)(path.join(projectConfig.attributesDirectoryPath));
+                    attributeJoiSchema = getAttributeJoiSchema(projectConfig);
+                    _i = 0, attributeFilePaths_1 = attributeFilePaths;
+                    _d.label = 1;
+                case 1:
+                    if (!(_i < attributeFilePaths_1.length)) return [3 /*break*/, 6];
+                    filePath = attributeFilePaths_1[_i];
+                    key = path.basename(filePath, ".yml");
+                    parsed = (0, utils_1.parseYaml)(fs.readFileSync(filePath, "utf8"));
+                    console.log("  =>", key);
+                    _d.label = 2;
+                case 2:
+                    _d.trys.push([2, 4, , 5]);
+                    return [4 /*yield*/, attributeJoiSchema.validateAsync(parsed)];
+                case 3:
+                    _d.sent();
+                    return [3 /*break*/, 5];
+                case 4:
+                    e_1 = _d.sent();
+                    if (e_1 instanceof Joi.ValidationError) {
+                        printJoiError(e_1);
+                    }
+                    else {
+                        console.log(e_1);
+                    }
+                    hasError = true;
+                    return [3 /*break*/, 5];
+                case 5:
+                    _i++;
+                    return [3 /*break*/, 1];
+                case 6:
+                    // lint segments
+                    console.log("\nLinting segments...\n");
+                    segmentFilePaths = (0, utils_1.getYAMLFiles)(path.join(projectConfig.segmentsDirectoryPath));
+                    conditionsJoiSchema = getConditionsJoiSchema(projectConfig);
+                    segmentJoiSchema = getSegmentJoiSchema(projectConfig, conditionsJoiSchema);
+                    _a = 0, segmentFilePaths_1 = segmentFilePaths;
+                    _d.label = 7;
+                case 7:
+                    if (!(_a < segmentFilePaths_1.length)) return [3 /*break*/, 12];
+                    filePath = segmentFilePaths_1[_a];
+                    key = path.basename(filePath, ".yml");
+                    parsed = (0, utils_1.parseYaml)(fs.readFileSync(filePath, "utf8"));
+                    console.log("  =>", key);
+                    _d.label = 8;
+                case 8:
+                    _d.trys.push([8, 10, , 11]);
+                    return [4 /*yield*/, segmentJoiSchema.validateAsync(parsed)];
+                case 9:
+                    _d.sent();
+                    return [3 /*break*/, 11];
+                case 10:
+                    e_2 = _d.sent();
+                    if (e_2 instanceof Joi.ValidationError) {
+                        printJoiError(e_2);
+                    }
+                    else {
+                        console.log(e_2);
+                    }
+                    hasError = true;
+                    return [3 /*break*/, 11];
+                case 11:
+                    _a++;
+                    return [3 /*break*/, 7];
+                case 12:
+                    // lint features
+                    console.log("\nLinting features...\n");
+                    featureFilePaths = (0, utils_1.getYAMLFiles)(path.join(projectConfig.featuresDirectoryPath));
+                    featureJoiSchema = getFeatureJoiSchema(projectConfig, conditionsJoiSchema);
+                    _b = 0, featureFilePaths_1 = featureFilePaths;
+                    _d.label = 13;
+                case 13:
+                    if (!(_b < featureFilePaths_1.length)) return [3 /*break*/, 18];
+                    filePath = featureFilePaths_1[_b];
+                    key = path.basename(filePath, ".yml");
+                    parsed = (0, utils_1.parseYaml)(fs.readFileSync(filePath, "utf8"));
+                    console.log("  =>", key);
+                    _d.label = 14;
+                case 14:
+                    _d.trys.push([14, 16, , 17]);
+                    return [4 /*yield*/, featureJoiSchema.validateAsync(parsed)];
+                case 15:
+                    _d.sent();
+                    return [3 /*break*/, 17];
+                case 16:
+                    e_3 = _d.sent();
+                    if (e_3 instanceof Joi.ValidationError) {
+                        printJoiError(e_3);
+                    }
+                    else {
+                        console.log(e_3);
+                    }
+                    hasError = true;
+                    return [3 /*break*/, 17];
+                case 17:
+                    _b++;
+                    return [3 /*break*/, 13];
+                case 18:
+                    // lint tests
+                    console.log("\nLinting tests...\n");
+                    testFilePaths = (0, utils_1.getYAMLFiles)(path.join(projectConfig.testsDirectoryPath));
+                    testsJoiSchema = getTestsJoiSchema(projectConfig);
+                    _c = 0, testFilePaths_1 = testFilePaths;
+                    _d.label = 19;
+                case 19:
+                    if (!(_c < testFilePaths_1.length)) return [3 /*break*/, 24];
+                    filePath = testFilePaths_1[_c];
+                    key = path.basename(filePath, ".yml");
+                    parsed = (0, utils_1.parseYaml)(fs.readFileSync(filePath, "utf8"));
+                    console.log("  =>", key);
+                    _d.label = 20;
+                case 20:
+                    _d.trys.push([20, 22, , 23]);
+                    return [4 /*yield*/, testsJoiSchema.validateAsync(parsed)];
+                case 21:
+                    _d.sent();
+                    return [3 /*break*/, 23];
+                case 22:
+                    e_4 = _d.sent();
+                    if (e_4 instanceof Joi.ValidationError) {
+                        printJoiError(e_4);
+                    }
+                    else {
+                        console.log(e_4);
+                    }
+                    hasError = true;
+                    return [3 /*break*/, 23];
+                case 23:
+                    _c++;
+                    return [3 /*break*/, 19];
+                case 24: return [2 /*return*/, hasError];
+            }
+        });
+    });
+}
+exports.lintProject = lintProject;
+//# sourceMappingURL=linter.js.map

package/lib/linter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linter.js","sourceRoot":"","sources":["../src/linter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAuB;AACvB,uBAAyB;AACzB,2BAA6B;AAE7B,yBAA2B;AAG3B,iCAAkD;AAElD,SAAgB,qBAAqB,CAAC,aAA4B;IAChE,IAAM,kBAAkB,GAAG,GAAG,CAAC,MAAM,CAAC;QACpC,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE;QACvB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;QAClE,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;QACzB,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AATD,sDASC;AAED,SAAgB,sBAAsB,CAAC,aAA4B;IACjE,IAAM,uBAAuB,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1B,QAAQ,EACR,WAAW;QAEX,UAAU;QACV,aAAa,EACb,qBAAqB,EACrB,UAAU,EACV,kBAAkB;QAElB,SAAS;QACT,UAAU,EACV,aAAa,EACb,YAAY,EACZ,UAAU;QAEV,mBAAmB;QACnB,IAAI,EACJ,OAAO,CACR;QACD,KAAK,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG;QAC3B,iCAAiC;QACjC,GAAG,CAAC,MAAM,EAAE,EACZ,GAAG,CAAC,MAAM,EAAE,EACZ,GAAG,CAAC,OAAO,EAAE,EACb,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAChC;KACF,CAAC,CAAC;IAEH,IAAM,uBAAuB,GAAG,GAAG,CAAC,YAAY,EAAE;SAC/C,GAAG,CACF,GAAG,CAAC,MAAM,CAAC;QACT,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;KAC7E,CAAC,EACF,GAAG,CAAC,MAAM,CAAC;QACT,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;KAC5E,CAAC,CACH;SACA,EAAE,CAAC,gBAAgB,CAAC,CAAC;IAExB,IAAM,kBAAkB,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAC/C,uBAAuB,EACvB,uBAAuB,CACxB,CAAC;IAEF,IAAM,mBAAmB,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAChD,kBAAkB,EAClB,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CACtC,CAAC;IAEF,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAtDD,wDAsDC;AAED,SAAgB,mBAAmB,CAAC,aAA4B,EAAE,mBAAmB;IACnF,IAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC;QAClC,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;QACzB,UAAU,EAAE,mBAAmB;KAChC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AARD,kDAQC;AAED,SAAgB,mBAAmB,CAAC,aAA4B,EAAE,mBAAmB;IACnF,IAAM,uBAAuB,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAClG,IAAM,sBAAsB,GAAG,GAAG,CAAC,YAAY,EAAE;SAC9C,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;SAC/E,KAAK,CAAC,EAAE,CAAC,CAAC;IAEb,IAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;IAEvC,IAAM,iBAAiB,GAAG,GAAG,CAAC,YAAY,EAAE;SACzC,GAAG,CACF,GAAG,CAAC,MAAM,CAAC;QACT,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;KAC1E,CAAC,EACF,GAAG,CAAC,MAAM,CAAC;QACT,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;KACzE,CAAC,CACH;SACA,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAE3B,IAAM,YAAY,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAElF,IAAM,sBAAsB,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CACnD,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,EAC/B,YAAY,CACb,CAAC;IAEF,IAAM,oBAAoB,GAAG,GAAG,CAAC,MAAM,CAAC;QACtC,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE;QACrB,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CACtB,GAAG,CAAC,MAAM,CAAC;YACT,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE;YACjB,QAAQ,EAAE,sBAAsB;YAChC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,wCAAwC;SACnF,CAAC,CACH;QACD,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CACtB,GAAG,CAAC,MAAM,CAAC;YACT,iCAAiC;YACjC,QAAQ,EAAE,sBAAsB;YAChC,UAAU,EAAE,mBAAmB;YAE/B,SAAS,EAAE,uBAAuB;YAClC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,0BAA0B;SACpD,CAAC,CACH;KACF,CAAC,CAAC;IAEH,IAAM,sBAAsB,GAAG,EAAE,CAAC;IAClC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,UAAC,cAAc;QAChD,sBAAsB,CAAC,cAAc,CAAC,GAAG,oBAAoB,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,IAAM,yBAAyB,GAAG,GAAG,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAErE,IAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC;QAClC,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;QACzB,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QAErC,gBAAgB,EAAE,uBAAuB;QAEzC,QAAQ,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAE/E,eAAe,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAChC,GAAG,CAAC,MAAM,CAAC;YACT,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC;YAC3E,YAAY,EAAE,sBAAsB,EAAE,0CAA0C;SACjF,CAAC,CACH;QAED,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAC3B,GAAG,CAAC,MAAM,CAAC;YACT,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC;YAClE,KAAK,EAAE,uBAAuB;YAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAC9C,SAAS,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAC1B,GAAG,CAAC,MAAM,CAAC;gBACT,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE;gBACjB,KAAK,EAAE,sBAAsB;gBAC7B,SAAS,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAC1B,GAAG,CAAC,MAAM,CAAC;oBACT,wDAAwD;oBACxD,QAAQ,EAAE,sBAAsB;oBAChC,UAAU,EAAE,mBAAmB;oBAE/B,0CAA0C;oBAC1C,KAAK,EAAE,sBAAsB;iBAC9B,CAAC,CACH;aACF,CAAC,CACH;SACF,CAAC,CACH;QAED,YAAY,EAAE,yBAAyB;KACxC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAlGD,kDAkGC;AAED,SAAgB,iBAAiB,CAAC,aAA4B;IAC5D,IAAM,cAAc,GAAG,GAAG,CAAC,MAAM,CAAC;QAChC,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CACtB,GAAG,CAAC,MAAM,CAAC;YACT,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACpC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE;YACjB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,aAAa,CAAC;YAClF,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CACzB,GAAG,CAAC,MAAM,CAAC;gBACT,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE;gBACjB,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAC3B,GAAG,CAAC,MAAM,CAAC;oBACT,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBACpC,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;oBAC1C,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE;oBAExB,2BAA2B;oBAC3B,iBAAiB,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CACvC,GAAG,CAAC,MAAM,EAAE,EACZ,GAAG,CAAC,MAAM,EAAE,EACZ,GAAG,CAAC,OAAO,EAAE,CACd;oBACD,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,0BAA0B;iBAC5D,CAAC,CACH;aACF,CAAC,CACH;SACF,CAAC,CACH;KACF,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACxB,CAAC;AAhCD,8CAgCC;AAED,SAAgB,aAAa,CAAC,CAAsB;IAC1C,IAAA,OAAO,GAAK,CAAC,QAAN,CAAO;IAEtB,OAAO,CAAC,OAAO,CAAC,UAAC,MAAM;;QACrB,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAA,MAAM,CAAC,OAAO,0CAAE,KAAK,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC;AARD,sCAQC;AAED,SAAsB,WAAW,CAAC,aAA4B;;;;;;oBACxD,QAAQ,GAAG,KAAK,CAAC;oBAErB,kBAAkB;oBAClB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;oBACjC,kBAAkB,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBACpF,kBAAkB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;0BAEvB,EAAlB,yCAAkB;;;yBAAlB,CAAA,gCAAkB,CAAA;oBAA9B,QAAQ;oBACX,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,MAAM,GAAG,IAAA,iBAAS,EAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAQ,CAAC;oBACnE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;;;;oBAGvB,qBAAM,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAA;;oBAA9C,SAA8C,CAAC;;;;oBAE/C,IAAI,GAAC,YAAY,GAAG,CAAC,eAAe,EAAE;wBACpC,aAAa,CAAC,GAAC,CAAC,CAAC;qBAClB;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,GAAC,CAAC,CAAC;qBAChB;oBAED,QAAQ,GAAG,IAAI,CAAC;;;oBAdG,IAAkB,CAAA;;;oBAkBzC,gBAAgB;oBAChB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;oBACjC,gBAAgB,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;oBAChF,mBAAmB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;oBAC5D,gBAAgB,GAAG,mBAAmB,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;0BAE1C,EAAhB,qCAAgB;;;yBAAhB,CAAA,8BAAgB,CAAA;oBAA5B,QAAQ;oBACX,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,MAAM,GAAG,IAAA,iBAAS,EAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAQ,CAAC;oBACnE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;;;;oBAGvB,qBAAM,gBAAgB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAA;;oBAA5C,SAA4C,CAAC;;;;oBAE7C,IAAI,GAAC,YAAY,GAAG,CAAC,eAAe,EAAE;wBACpC,aAAa,CAAC,GAAC,CAAC,CAAC;qBAClB;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,GAAC,CAAC,CAAC;qBAChB;oBAED,QAAQ,GAAG,IAAI,CAAC;;;oBAdG,IAAgB,CAAA;;;oBAkBvC,gBAAgB;oBAChB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;oBACjC,gBAAgB,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;oBAChF,gBAAgB,GAAG,mBAAmB,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;0BAE1C,EAAhB,qCAAgB;;;yBAAhB,CAAA,8BAAgB,CAAA;oBAA5B,QAAQ;oBACX,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,MAAM,GAAG,IAAA,iBAAS,EAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAQ,CAAC;oBACnE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;;;;oBAGvB,qBAAM,gBAAgB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAA;;oBAA5C,SAA4C,CAAC;;;;oBAE7C,IAAI,GAAC,YAAY,GAAG,CAAC,eAAe,EAAE;wBACpC,aAAa,CAAC,GAAC,CAAC,CAAC;qBAClB;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,GAAC,CAAC,CAAC;qBAChB;oBAED,QAAQ,GAAG,IAAI,CAAC;;;oBAdG,IAAgB,CAAA;;;oBAkBvC,aAAa;oBACb,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;oBAC9B,aAAa,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;oBAC1E,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;0BAEpB,EAAb,+BAAa;;;yBAAb,CAAA,2BAAa,CAAA;oBAAzB,QAAQ;oBACX,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,MAAM,GAAG,IAAA,iBAAS,EAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAQ,CAAC;oBACnE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;;;;oBAGvB,qBAAM,cAAc,CAAC,aAAa,CAAC,MAAM,CAAC,EAAA;;oBAA1C,SAA0C,CAAC;;;;oBAE3C,IAAI,GAAC,YAAY,GAAG,CAAC,eAAe,EAAE;wBACpC,aAAa,CAAC,GAAC,CAAC,CAAC;qBAClB;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,GAAC,CAAC,CAAC;qBAChB;oBAED,QAAQ,GAAG,IAAI,CAAC;;;oBAdG,IAAa,CAAA;;yBAkBpC,sBAAO,QAAQ,EAAC;;;;CACjB;AAjGD,kCAiGC"}

package/lib/tester.d.ts

@@ -0,0 +1,26 @@
+import { Attributes, VariableKey, VariableValue, VariationValue } from "@featurevisor/types";
+import { ProjectConfig } from "./config";
+export interface Assertion {
+    description?: string;
+    at: number;
+    attributes: Attributes;
+    expectedVariation?: VariationValue;
+    expectedVariables?: {
+        [key: VariableKey]: VariableValue;
+    };
+}
+export interface TestFeature {
+    key: string;
+    assertions: Assertion[];
+}
+export interface Test {
+    description?: string;
+    tag: string;
+    environment: string;
+    features: TestFeature[];
+}
+export interface Spec {
+    tests: Test[];
+}
+export declare function checkIfArraysAreEqual(a: any, b: any): boolean;
+export declare function testProject(rootDirectoryPath: string, projectConfig: ProjectConfig): boolean;

package/lib/tester.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testProject = exports.checkIfArraysAreEqual = void 0;
+var fs = require("fs");
+var path = require("path");
+var sdk_1 = require("@featurevisor/sdk");
+var utils_1 = require("./utils");
+var builder_1 = require("./builder");
+var errorColor = "\x1b[31m";
+// @TODO: make it better
+function checkIfArraysAreEqual(a, b) {
+    if (!Array.isArray(a) || !Array.isArray(b)) {
+        return false;
+    }
+    if (a.length !== b.length)
+        return false;
+    for (var i = 0; i < a.length; ++i) {
+        if (a[i] !== b[i]) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.checkIfArraysAreEqual = checkIfArraysAreEqual;
+function testProject(rootDirectoryPath, projectConfig) {
+    var hasError = false;
+    if (!fs.existsSync(projectConfig.testsDirectoryPath)) {
+        console.error("Tests directory does not exist: ".concat(projectConfig.testsDirectoryPath));
+        hasError = true;
+        return hasError;
+    }
+    var testFiles = fs
+        .readdirSync(projectConfig.testsDirectoryPath)
+        .filter(function (f) { return f.endsWith(".yml"); });
+    if (testFiles.length === 0) {
+        console.error("No tests found in: ".concat(projectConfig.testsDirectoryPath));
+        hasError = true;
+        return hasError;
+    }
+    for (var _i = 0, testFiles_1 = testFiles; _i < testFiles_1.length; _i++) {
+        var testFile = testFiles_1[_i];
+        var testFilePath = path.join(projectConfig.testsDirectoryPath, testFile);
+        console.log("  => Testing: ".concat(testFilePath.replace(rootDirectoryPath, "")));
+        var parsed = (0, utils_1.parseYaml)(fs.readFileSync(testFilePath, "utf8"));
+        parsed.tests.forEach(function (test, tIndex) {
+            var datafilePath = (0, builder_1.getDatafilePath)(projectConfig, test.environment, test.tag);
+            if (!fs.existsSync(datafilePath)) {
+                console.error("     => Datafile does not exist: ".concat(datafilePath));
+                hasError = true;
+                return;
+            }
+            var datafileContent = JSON.parse(fs.readFileSync(datafilePath, "utf8"));
+            var currentAt = 0;
+            var sdk = new sdk_1.FeaturevisorSDK({
+                datafile: datafileContent,
+                configureBucketValue: function (feature, attributes, bucketValue) {
+                    return currentAt;
+                },
+            });
+            test.features.forEach(function (feature, fIndex) {
+                var featureKey = feature.key;
+                console.log("     => Feature \"".concat(featureKey, "\" in environment \"").concat(test.environment, "\":"));
+                feature.assertions.forEach(function (assertion, aIndex) {
+                    console.log("        => Assertion #".concat(aIndex + 1, ": ").concat(assertion.description || ""));
+                    var assertionHasError = false;
+                    currentAt = assertion.at * (sdk_1.MAX_BUCKETED_NUMBER / 100);
+                    // variation
+                    if ("expectedVariation" in assertion) {
+                        var variation = sdk.getVariation(featureKey, assertion.attributes);
+                        if (variation !== assertion.expectedVariation) {
+                            hasError = true;
+                            assertionHasError = true;
+                            console.error("           Variation failed: expected \"".concat(assertion.expectedVariation, "\", got \"").concat(variation, "\""));
+                        }
+                    }
+                    // variables
+                    if (typeof assertion.expectedVariables === "object") {
+                        Object.keys(assertion.expectedVariables).forEach(function (variableKey) {
+                            var expectedValue = assertion.expectedVariables && assertion.expectedVariables[variableKey];
+                            var actualValue = sdk.getVariable(featureKey, variableKey, assertion.attributes);
+                            var passed = Array.isArray(expectedValue)
+                                ? checkIfArraysAreEqual(expectedValue, actualValue)
+                                : expectedValue === actualValue;
+                            if (!passed) {
+                                hasError = true;
+                                assertionHasError = true;
+                                console.error("           Variable \"".concat(variableKey, "\" failed: expected \"").concat(expectedValue, "\", got \"").concat(actualValue, "\""));
+                            }
+                        });
+                    }
+                });
+            });
+        });
+    }
+    return hasError;
+}
+exports.testProject = testProject;
+//# sourceMappingURL=tester.js.map

package/lib/tester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tester.js","sourceRoot":"","sources":["../src/tester.ts"],"names":[],"mappings":";;;AAAA,uBAAyB;AACzB,2BAA6B;AAS7B,yCAAyE;AAGzE,iCAAoC;AACpC,qCAA4C;AA4B5C,IAAM,UAAU,GAAG,UAAU,CAAC;AAE9B,wBAAwB;AACxB,SAAgB,qBAAqB,CAAC,CAAC,EAAE,CAAC;IACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAC1C,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAExC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACjC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;YACjB,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAdD,sDAcC;AAED,SAAgB,WAAW,CAAC,iBAAyB,EAAE,aAA4B;IACjF,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE;QACpD,OAAO,CAAC,KAAK,CAAC,0CAAmC,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;QACrF,QAAQ,GAAG,IAAI,CAAC;QAEhB,OAAO,QAAQ,CAAC;KACjB;IAED,IAAM,SAAS,GAAG,EAAE;SACjB,WAAW,CAAC,aAAa,CAAC,kBAAkB,CAAC;SAC7C,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAlB,CAAkB,CAAC,CAAC;IAErC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,CAAC,KAAK,CAAC,6BAAsB,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;QACxE,QAAQ,GAAG,IAAI,CAAC;QAEhB,OAAO,QAAQ,CAAC;KACjB;IAED,KAAuB,UAAS,EAAT,uBAAS,EAAT,uBAAS,EAAT,IAAS,EAAE;QAA7B,IAAM,QAAQ,kBAAA;QACjB,IAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAE3E,OAAO,CAAC,GAAG,CAAC,wBAAiB,YAAY,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAE,CAAC,CAAC;QAE5E,IAAM,MAAM,GAAG,IAAA,iBAAS,EAAC,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAS,CAAC;QAExE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,MAAM;YACzC,IAAM,YAAY,GAAG,IAAA,yBAAe,EAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAEhF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBAChC,OAAO,CAAC,KAAK,CAAC,2CAAoC,YAAY,CAAE,CAAC,CAAC;gBAClE,QAAQ,GAAG,IAAI,CAAC;gBAEhB,OAAO;aACR;YAED,IAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAoB,CAAC;YAE7F,IAAI,SAAS,GAAG,CAAC,CAAC;YAElB,IAAI,GAAG,GAAG,IAAI,qBAAe,CAAC;gBAC5B,QAAQ,EAAE,eAAe;gBACzB,oBAAoB,EAAE,UAAC,OAAO,EAAE,UAAU,EAAE,WAAW;oBACrD,OAAO,SAAS,CAAC;gBACnB,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;gBAC7C,IAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;gBAE/B,OAAO,CAAC,GAAG,CAAC,4BAAoB,UAAU,iCAAqB,IAAI,CAAC,WAAW,QAAI,CAAC,CAAC;gBAErF,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,SAAS,EAAE,MAAM;oBACpD,OAAO,CAAC,GAAG,CAAC,gCAAyB,MAAM,GAAG,CAAC,eAAK,SAAS,CAAC,WAAW,IAAI,EAAE,CAAE,CAAC,CAAC;oBAEnF,IAAI,iBAAiB,GAAG,KAAK,CAAC;oBAC9B,SAAS,GAAG,SAAS,CAAC,EAAE,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAAC;oBAEvD,YAAY;oBACZ,IAAI,mBAAmB,IAAI,SAAS,EAAE;wBACpC,IAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;wBAErE,IAAI,SAAS,KAAK,SAAS,CAAC,iBAAiB,EAAE;4BAC7C,QAAQ,GAAG,IAAI,CAAC;4BAChB,iBAAiB,GAAG,IAAI,CAAC;4BAEzB,OAAO,CAAC,KAAK,CACX,kDAA0C,SAAS,CAAC,iBAAiB,uBAAW,SAAS,OAAG,CAC7F,CAAC;yBACH;qBACF;oBAED,YAAY;oBACZ,IAAI,OAAO,SAAS,CAAC,iBAAiB,KAAK,QAAQ,EAAE;wBACnD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,UAAU,WAAW;4BACpE,IAAM,aAAa,GACjB,SAAS,CAAC,iBAAiB,IAAI,SAAS,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;4BAC1E,IAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;4BAEnF,IAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;gCACzC,CAAC,CAAC,qBAAqB,CAAC,aAAa,EAAE,WAAW,CAAC;gCACnD,CAAC,CAAC,aAAa,KAAK,WAAW,CAAC;4BAElC,IAAI,CAAC,MAAM,EAAE;gCACX,QAAQ,GAAG,IAAI,CAAC;gCAChB,iBAAiB,GAAG,IAAI,CAAC;gCAEzB,OAAO,CAAC,KAAK,CACX,gCAAwB,WAAW,mCAAuB,aAAa,uBAAW,WAAW,OAAG,CACjG,CAAC;6BACH;wBACH,CAAC,CAAC,CAAC;qBACJ;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AArGD,kCAqGC"}

package/lib/traffic.d.ts

@@ -0,0 +1,2 @@
+import { Rule, ExistingFeature, Traffic, Variation } from "@featurevisor/types";
+export declare function getNewTraffic(variations: Variation[], parsedRules: Rule[], existingFeature: ExistingFeature | undefined): Traffic[];

package/lib/traffic.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNewTraffic = void 0;
+var sdk_1 = require("@featurevisor/sdk");
+function getNewTraffic(
+// from current YAML
+variations, parsedRules, 
+// from previous release
+existingFeature) {
+    var result = [];
+    parsedRules.forEach(function (parsedRollout) {
+        var rolloutPercentage = parsedRollout.percentage;
+        var traffic = {
+            key: parsedRollout.key,
+            segments: typeof parsedRollout.segments !== "string"
+                ? JSON.stringify(parsedRollout.segments)
+                : parsedRollout.segments,
+            percentage: rolloutPercentage * (sdk_1.MAX_BUCKETED_NUMBER / 100),
+            allocation: [],
+        };
+        var existingTrafficRollout = existingFeature === null || existingFeature === void 0 ? void 0 : existingFeature.traffic.find(function (t) { return t.key === parsedRollout.key; });
+        // @TODO: handle if Variations changed (added/removed, or weight changed)
+        //  - new variation added
+        //  - variation removed
+        //  - variation weight changed
+        //
+        // make it better by maintaining as much of the previous bucketing as possible
+        var variationsChanged = existingFeature
+            ? JSON.stringify(existingFeature.variations.map(function (_a) {
+                var value = _a.value, weight = _a.weight;
+                return ({
+                    value: value,
+                    weight: weight,
+                });
+            })) !== JSON.stringify(variations.map(function (_a) {
+                var value = _a.value, weight = _a.weight;
+                return ({ value: value, weight: weight });
+            }))
+            : false;
+        var diffPercentage = 0;
+        if (existingTrafficRollout) {
+            diffPercentage =
+                rolloutPercentage - existingTrafficRollout.percentage / (sdk_1.MAX_BUCKETED_NUMBER / 100);
+            if (diffPercentage > 0 &&
+                !variationsChanged // if variations changed, we need to re-bucket
+            ) {
+                // increase: build on top of existing allocations
+                traffic.allocation = existingTrafficRollout.allocation.map(function (_a) {
+                    var variation = _a.variation, percentage = _a.percentage;
+                    return {
+                        variation: variation,
+                        percentage: percentage,
+                    };
+                });
+            }
+        }
+        variations.forEach(function (variation) {
+            var newPercentage = parseInt(((variation.weight / 100) *
+                rolloutPercentage *
+                (sdk_1.MAX_BUCKETED_NUMBER / 100)).toFixed(2));
+            if (!existingTrafficRollout || variationsChanged === true) {
+                traffic.allocation.push({
+                    variation: variation.value,
+                    percentage: newPercentage,
+                });
+                return;
+            }
+            // const prevTotalWeightForVariation = existingTrafficRollout.allocation
+            //   .filter((a) => a.variation === variation.value)
+            //   .reduce((acc, curr) => acc + curr.percentage, 0);
+            // const diffWeightForVariation = (variation.weight as number) - prevTotalWeightForVariation / (MAX_BUCKETED_NUMBER / 100));
+            if (diffPercentage === 0) {
+                // no change
+                traffic.allocation.push({
+                    variation: variation.value,
+                    percentage: newPercentage,
+                });
+                return;
+            }
+            if (diffPercentage > 0) {
+                // increase - need to consistently bucket
+                traffic.allocation.push({
+                    variation: variation.value,
+                    percentage: parseInt((variation.weight *
+                        (diffPercentage / 100) *
+                        (sdk_1.MAX_BUCKETED_NUMBER / 100)).toFixed(2)),
+                });
+                return;
+            }
+            if (diffPercentage < 0) {
+                // decrease - need to re-bucket
+                // @TODO: can we maintain as much pre bucketed values as possible? to be close to consistent bucketing?
+                traffic.allocation.push({
+                    variation: variation.value,
+                    percentage: newPercentage,
+                });
+                return;
+            }
+        });
+        result.push(traffic);
+    });
+    return result;
+}
+exports.getNewTraffic = getNewTraffic;
+//# sourceMappingURL=traffic.js.map

package/lib/traffic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traffic.js","sourceRoot":"","sources":["../src/traffic.ts"],"names":[],"mappings":";;;AACA,yCAAwD;AAExD,SAAgB,aAAa;AAC3B,oBAAoB;AACpB,UAAuB,EACvB,WAAmB;AAEnB,wBAAwB;AACxB,eAA4C;IAE5C,IAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,WAAW,CAAC,OAAO,CAAC,UAAC,aAAa;QAChC,IAAM,iBAAiB,GAAG,aAAa,CAAC,UAAU,CAAC;QAEnD,IAAM,OAAO,GAAY;YACvB,GAAG,EAAE,aAAa,CAAC,GAAG;YACtB,QAAQ,EACN,OAAO,aAAa,CAAC,QAAQ,KAAK,QAAQ;gBACxC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC;gBACxC,CAAC,CAAC,aAAa,CAAC,QAAQ;YAC5B,UAAU,EAAE,iBAAiB,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC;YAC3D,UAAU,EAAE,EAAE;SACf,CAAC;QAEF,IAAM,sBAAsB,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,CAAC,IAAI,CAC1D,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,GAAG,KAAK,aAAa,CAAC,GAAG,EAA3B,CAA2B,CACnC,CAAC;QAEF,yEAAyE;QAEzE,yBAAyB;QACzB,uBAAuB;QACvB,8BAA8B;QAC9B,EAAE;QACF,8EAA8E;QAC9E,IAAM,iBAAiB,GAAG,eAAe;YACvC,CAAC,CAAC,IAAI,CAAC,SAAS,CACZ,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAiB;oBAAf,KAAK,WAAA,EAAE,MAAM,YAAA;gBAAO,OAAA,CAAC;oBACrD,KAAK,OAAA;oBACL,MAAM,QAAA;iBACP,CAAC;YAHoD,CAGpD,CAAC,CACJ,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAiB;oBAAf,KAAK,WAAA,EAAE,MAAM,YAAA;gBAAO,OAAA,CAAC,EAAE,KAAK,OAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAAnB,CAAmB,CAAC,CAAC;YAClF,CAAC,CAAC,KAAK,CAAC;QAEV,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,IAAI,sBAAsB,EAAE;YAC1B,cAAc;gBACZ,iBAAiB,GAAG,sBAAsB,CAAC,UAAU,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAAC;YAEtF,IACE,cAAc,GAAG,CAAC;gBAClB,CAAC,iBAAiB,CAAC,8CAA8C;cACjE;gBACA,iDAAiD;gBAEjD,OAAO,CAAC,UAAU,GAAG,sBAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAyB;wBAAvB,SAAS,eAAA,EAAE,UAAU,gBAAA;oBACjF,OAAO;wBACL,SAAS,WAAA;wBACT,UAAU,YAAA;qBACX,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;SACF;QAED,UAAU,CAAC,OAAO,CAAC,UAAC,SAAS;YAC3B,IAAM,aAAa,GAAG,QAAQ,CAC5B,CACE,CAAE,SAAS,CAAC,MAAiB,GAAG,GAAG,CAAC;gBACpC,iBAAiB;gBACjB,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAC5B,CAAC,OAAO,CAAC,CAAC,CAAC,CACb,CAAC;YAEF,IAAI,CAAC,sBAAsB,IAAI,iBAAiB,KAAK,IAAI,EAAE;gBACzD,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,wEAAwE;YACxE,oDAAoD;YACpD,sDAAsD;YAEtD,4HAA4H;YAE5H,IAAI,cAAc,KAAK,CAAC,EAAE;gBACxB,YAAY;gBACZ,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,IAAI,cAAc,GAAG,CAAC,EAAE;gBACtB,yCAAyC;gBACzC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,QAAQ,CAClB,CACG,SAAS,CAAC,MAAiB;wBAC5B,CAAC,cAAc,GAAG,GAAG,CAAC;wBACtB,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAC5B,CAAC,OAAO,CAAC,CAAC,CAAC,CACb;iBACF,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,IAAI,cAAc,GAAG,CAAC,EAAE;gBACtB,+BAA+B;gBAE/B,uGAAuG;gBAEvG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AApID,sCAoIC"}

package/lib/traffic.spec.d.ts

@@ -0,0 +1 @@
+export {};