@naturalcycles/abba 1.2.0 → 1.3.0

package/dist/prisma-output/schema.prisma

@@ -4,8 +4,8 @@ generator client {
 }
 
 datasource db {
-  provider = "postgresql"
-  url      = env("EXPERIMENT_MANAGER_DB_URL")
+  provider = "mysql"
+  url      = env("ABBA_DB_URL")
 }
 
 model Bucket {

package/dist/util.d.ts

@@ -1,11 +1,11 @@
-import { Bucket, Experiment } from './prisma-output';
+import { Bucket } from './prisma-output';
 import { BucketInput, SegmentationData, SegmentationRule } from '.';
 /**
  * Generate a random number between 0 and 100
  *
  * @returns
  */
-export declare function rollDie(): number;
+export declare const rollDie: () => number;
 /**
  * Determines a users assignment for this experiment. Returns null if they are not considered to be in the sampling group
  *
@@ -13,28 +13,21 @@ export declare function rollDie(): number;
  * @param buckets
  * @returns
  */
-export declare function determineAssignment(sampling: number, buckets: Bucket[]): number | null;
-/**
- * Determines whether a user will be considered for a bucket assignment based on the experiment sampling rate
- *
- * @param experiment
- * @returns
- */
-export declare function determineExperiment(experiment: Experiment): boolean;
+export declare const determineAssignment: (sampling: number, buckets: Bucket[]) => number | null;
 /**
  * Determines which bucket a user assignment will recieve
  *
  * @param buckets
  * @returns
  */
-export declare function determineBucket(buckets: Bucket[]): number;
+export declare const determineBucket: (buckets: Bucket[]) => number;
 /**
  * Validate the total ratio of the buckets equals 100
  *
  * @param buckets
  * @returns
  */
-export declare function validateBuckets(buckets: BucketInput[]): void;
+export declare const validateTotalBucketRatio: (buckets: BucketInput[]) => void;
 /**
  * Validate a users segmentation data against multiple rules. Returns false if any fail
  *
@@ -42,7 +35,7 @@ export declare function validateBuckets(buckets: BucketInput[]): void;
  * @param segmentationData
  * @returns
  */
-export declare function validateSegmentationRules(rules: SegmentationRule[], segmentationData: SegmentationData): boolean;
+export declare const validateSegmentationRules: (rules: SegmentationRule[], segmentationData: SegmentationData) => boolean;
 /**
  * Validate a users segmentation data against a single rule
  *
@@ -50,4 +43,4 @@ export declare function validateSegmentationRules(rules: SegmentationRule[], seg
  * @param segmentationData
  * @returns
  */
-export declare function validateSegmentationRule(rule: SegmentationRule, data: SegmentationData): boolean;
+export declare const validateSegmentationRule: (rule: SegmentationRule, data: SegmentationData) => boolean;

package/dist/util.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSegmentationRule = exports.validateSegmentationRules = exports.validateBuckets = exports.determineBucket = exports.determineExperiment = exports.determineAssignment = exports.rollDie = void 0;
+exports.validateSegmentationRule = exports.validateSegmentationRules = exports.validateTotalBucketRatio = exports.determineBucket = exports.determineAssignment = exports.rollDie = void 0;
 const semver_1 = require("semver");
 /**
  * Generate a random number between 0 and 100
  *
  * @returns
  */
-function rollDie() {
+const rollDie = () => {
     return Math.random() * 100;
-}
+};
 exports.rollDie = rollDie;
 /**
  * Determines a users assignment for this experiment. Returns null if they are not considered to be in the sampling group
@@ -18,34 +18,23 @@ exports.rollDie = rollDie;
  * @param buckets
  * @returns
  */
-function determineAssignment(sampling, buckets) {
+const determineAssignment = (sampling, buckets) => {
     // Should this person be considered for the experiment?
-    const isIncludedInSample = rollDie() <= sampling;
-    if (!isIncludedInSample) {
+    if ((0, exports.rollDie)() > sampling) {
         return null;
     }
     // get their bucket
-    return determineBucket(buckets);
-}
+    return (0, exports.determineBucket)(buckets);
+};
 exports.determineAssignment = determineAssignment;
-/**
- * Determines whether a user will be considered for a bucket assignment based on the experiment sampling rate
- *
- * @param experiment
- * @returns
- */
-function determineExperiment(experiment) {
-    return rollDie() <= experiment.sampling; // between 0 and 100
-}
-exports.determineExperiment = determineExperiment;
 /**
  * Determines which bucket a user assignment will recieve
  *
  * @param buckets
  * @returns
  */
-function determineBucket(buckets) {
-    const bucketRoll = rollDie();
+const determineBucket = (buckets) => {
+    const bucketRoll = (0, exports.rollDie)();
     let range;
     const bucket = buckets.find(b => {
         if (!range) {
@@ -62,7 +51,7 @@ function determineBucket(buckets) {
         throw new Error('Could not detetermine bucket from ratios');
     }
     return bucket.id;
-}
+};
 exports.determineBucket = determineBucket;
 /**
  * Validate the total ratio of the buckets equals 100
@@ -70,13 +59,13 @@ exports.determineBucket = determineBucket;
  * @param buckets
  * @returns
  */
-function validateBuckets(buckets) {
+const validateTotalBucketRatio = (buckets) => {
     const bucketSum = buckets.reduce((sum, current) => sum + current.ratio, 0);
     if (bucketSum !== 100) {
         throw new Error('Total bucket ratio must be 100 before you can activate an experiment');
     }
-}
-exports.validateBuckets = validateBuckets;
+};
+exports.validateTotalBucketRatio = validateTotalBucketRatio;
 /**
  * Validate a users segmentation data against multiple rules. Returns false if any fail
  *
@@ -84,13 +73,13 @@ exports.validateBuckets = validateBuckets;
  * @param segmentationData
  * @returns
  */
-function validateSegmentationRules(rules, segmentationData) {
+const validateSegmentationRules = (rules, segmentationData) => {
     for (const rule of rules) {
-        if (!validateSegmentationRule(rule, segmentationData))
+        if (!(0, exports.validateSegmentationRule)(rule, segmentationData))
             return false;
     }
     return true;
-}
+};
 exports.validateSegmentationRules = validateSegmentationRules;
 /**
  * Validate a users segmentation data against a single rule
@@ -99,7 +88,7 @@ exports.validateSegmentationRules = validateSegmentationRules;
  * @param segmentationData
  * @returns
  */
-function validateSegmentationRule(rule, data) {
+const validateSegmentationRule = (rule, data) => {
     const { key, value, operator } = rule;
     if (operator === '==') {
         return data[key] === value;
@@ -119,5 +108,5 @@ function validateSegmentationRule(rule, data) {
     else {
         return false;
     }
-}
+};
 exports.validateSegmentationRule = validateSegmentationRule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "scripts": {
     "prepare": "husky install",
     "build": "build && npm run copy-prisma-output",
@@ -13,7 +13,6 @@
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.0.0",
-    "@types/json-logic-js": "^1.2.1",
     "@types/node": "^16.0.0",
     "@types/semver": "^7.3.9",
     "jest": "^27.5.1",

package/readme.md

@@ -77,16 +77,16 @@ This template doesn't rely on any external dependencies or services._
    npm install @naturalcyles/abba
    ```
 
-2. Execute the [sql script found here](/src/prisma/migrations/init.md) to generate the required DB
-   Schema
+2. Execute the [sql script found here](/src/prisma/migrations/20220218075343_init/migration.sql) to
+   generate the required DB Schema
 
 3. Create a `.env` file add add your Database Url using the following key:
    ```sh
-   EXPERIMENT_MANAGER_DB_URL="{{insert your instance url}}"
+   ABBA_DB_URL="{{insert your instance url}}"
    ```
-4. Create a new instance of the AssignmentManager class
+4. Create a new instance of the Abba class
    ```js
-   const manager = new AssignmentManager()
+   const abba = new Abba()
    ```
 
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -102,7 +102,7 @@ This template doesn't rely on any external dependencies or services._
 Creates a new experiment
 
 ```js
-async manager.createExperiment(
+async createExperiment(
 	input: ExperimentInput,
 	buckets: BucketInput[]
 ): Promise<Experiment>
@@ -113,7 +113,7 @@ async manager.createExperiment(
 Updates an existing experiment.
 
 ```js
-async manager.updateExperiment(
+async updateExperiment(
 	id: number,
 	input: ExperimentInput,
 	buckets: BucketInput[]
@@ -125,7 +125,7 @@ async manager.updateExperiment(
 Delete an experiment. Removes all users assignments and buckets
 
 ```js
-async manager.deleteExperiment(
+async deleteExperiment(
 	id: number
 ): Promise<void>
 ```

package/src/abba.ts

@@ -1,6 +1,6 @@
 import { Bucket, Experiment, Prisma, PrismaClient, UserAssignment } from './prisma-output'
 import { AssignmentStatus } from './types'
-import { determineAssignment, validateSegmentationRules, validateBuckets } from './util'
+import { determineAssignment, validateSegmentationRules, validateTotalBucketRatio } from './util'
 import {
   BucketInput,
   ExperimentWithBuckets,
@@ -44,7 +44,7 @@ export class Abba {
     buckets: BucketInput[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
-      validateBuckets(buckets)
+      validateTotalBucketRatio(buckets)
     }
 
     const created = await this.client.experiment.create({
@@ -79,7 +79,7 @@ export class Abba {
     buckets: BucketInput[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
-      validateBuckets(buckets)
+      validateTotalBucketRatio(buckets)
     }
 
     const updatedExperiment = await this.updateExperiment(id, experiment)

package/src/prisma-output/index-browser.js

@@ -113,11 +113,6 @@ exports.Prisma.NullableJsonNullValueInput = makeEnum({
   JsonNull: 'JsonNull',
 })
 
-exports.Prisma.QueryMode = makeEnum({
-  default: 'default',
-  insensitive: 'insensitive',
-})
-
 exports.Prisma.JsonNullValueFilter = makeEnum({
   DbNull: 'DbNull',
   JsonNull: 'JsonNull',

package/src/prisma-output/index.d.ts

@@ -3920,13 +3920,6 @@ export namespace Prisma {
   export type NullableJsonNullValueInput =
     typeof NullableJsonNullValueInput[keyof typeof NullableJsonNullValueInput]
 
-  export const QueryMode: {
-    default: 'default'
-    insensitive: 'insensitive'
-  }
-
-  export type QueryMode = typeof QueryMode[keyof typeof QueryMode]
-
   export const JsonNullValueFilter: {
     DbNull: 'DbNull'
     JsonNull: 'JsonNull'
@@ -4338,7 +4331,6 @@ export namespace Prisma {
     contains?: string
     startsWith?: string
     endsWith?: string
-    mode?: QueryMode
     not?: NestedStringFilter | string
   }
 
@@ -4434,7 +4426,6 @@ export namespace Prisma {
     contains?: string
     startsWith?: string
     endsWith?: string
-    mode?: QueryMode
     not?: NestedStringWithAggregatesFilter | string
     _count?: NestedIntFilter
     _min?: NestedStringFilter
@@ -4466,7 +4457,6 @@ export namespace Prisma {
     contains?: string
     startsWith?: string
     endsWith?: string
-    mode?: QueryMode
     not?: NestedStringNullableFilter | string | null
   }
   export type JsonNullableFilter =
@@ -4548,7 +4538,6 @@ export namespace Prisma {
     contains?: string
     startsWith?: string
     endsWith?: string
-    mode?: QueryMode
     not?: NestedStringNullableWithAggregatesFilter | string | null
     _count?: NestedIntNullableFilter
     _min?: NestedStringNullableFilter