@naturalcycles/abba 1.1.0 → 1.5.0

package/dist/prisma-output/schema.prisma

@@ -0,0 +1,47 @@
+generator client {
+  provider = "prisma-client-js"
+  output   = "../src/prisma-output"
+  binaryTargets = ["native", "darwin", "debian-openssl-1.1.x"]
+}
+
+datasource db {
+  provider = "mysql"
+  url      = env("ABBA_DB_URL")
+}
+
+model Bucket {
+  id              Int              @id @default(autoincrement())
+  experimentId    Int
+  key             String           @db.VarChar(10)
+  ratio           Int
+  createdAt       DateTime         @default(now())
+  updatedAt       DateTime         @updatedAt
+  experiment      Experiment       @relation(fields: [experimentId], references: [id], onDelete: Cascade)
+  userAssignments UserAssignment[]
+}
+
+model Experiment {
+  id              Int              @id @default(autoincrement())
+  name            String
+  status          Int
+  sampling        Int
+  createdAt       DateTime         @default(now())
+  updatedAt       DateTime         @updatedAt
+  description     String?          @db.VarChar(240)
+  rules           Json?
+  buckets         Bucket[]
+  userAssignments UserAssignment[]
+}
+
+model UserAssignment {
+  id           Int        @id @default(autoincrement())
+  userId       String
+  experimentId Int
+  bucketId     Int?
+  createdAt    DateTime   @default(now())
+  updatedAt    DateTime   @updatedAt
+  bucket       Bucket?    @relation(fields: [bucketId], references: [id], onDelete: Cascade)
+  experiment   Experiment @relation(fields: [experimentId], references: [id], onDelete: Cascade)
+  
+  @@unique([userId, experimentId])
+}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Bucket, Experiment } from '../prisma/generated/output';
+import { Bucket, Experiment } from './prisma-output';
 export declare type Unsaved<T> = Omit<T, 'createdAt' | 'updatedAt'> & {
     id?: number;
 };

package/dist/util.d.ts

@@ -1,11 +1,11 @@
-import { Bucket, Experiment } from '../prisma/generated/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,8 +1,11 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.1.0",
+  "version": "1.5.0",
   "scripts": {
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "build": "build && npm run copy-prisma-output",
+    "build-prod": "build-prod && npm run copy-prisma-output",
+    "copy-prisma-output": "cp -R src/prisma-output dist"
   },
   "dependencies": {
     "@prisma/client": "^3.9.2",
@@ -10,15 +13,11 @@
   },
   "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",
     "prisma": "^3.9.2"
   },
-  "directories": {
-    "prisma": "./prisma"
-  },
   "files": [
     "dist",
     "src",

package/readme.md

@@ -77,17 +77,9 @@ 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
-
-3. Create a `.env` file add add your Database Url using the following key:
-   ```sh
-   EXPERIMENT_MANAGER_DB_URL="{{insert your instance url}}"
-   ```
-4. Create a new instance of the AssignmentManager class
-   ```js
-   const manager = new AssignmentManager()
-   ```
+2. Execute the
+   [sql script found here](https://github.com/NaturalCycles/abba/blob/master/prisma/migrations/20220218075343_init/migration.sql)
+   to generate the required DB Schema
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -97,12 +89,24 @@ This template doesn't rely on any external dependencies or services._
 
 <div id="usage"></div>
 
+### Create an instance of Abba
+
+Creates an instance of Abba. You can pass in the database url in the constructor. If it does not
+exist it will fallback to trying to use the `ABBA_DB_URL` which must be added to your environment
+variables.
+
+```js
+const abba = new Abba('url')
+// or reading from process.env.ABBA_DB_URL
+const abba = new Abba()
+```
+
 ### Create a new experiment
 
 Creates a new experiment
 
 ```js
-async manager.createExperiment(
+async createExperiment(
 	input: ExperimentInput,
 	buckets: BucketInput[]
 ): Promise<Experiment>
@@ -113,7 +117,7 @@ async manager.createExperiment(
 Updates an existing experiment.
 
 ```js
-async manager.updateExperiment(
+async updateExperiment(
 	id: number,
 	input: ExperimentInput,
 	buckets: BucketInput[]
@@ -125,7 +129,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,12 +1,6 @@
-import {
-  Bucket,
-  Experiment,
-  Prisma,
-  PrismaClient,
-  UserAssignment,
-} from '../prisma/generated/output'
+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,
@@ -23,8 +17,14 @@ import {
 export class Abba {
   private client: PrismaClient
 
-  constructor() {
-    this.client = new PrismaClient()
+  constructor(dbUrl?: string) {
+    this.client = new PrismaClient({
+      datasources: {
+        db: {
+          url: dbUrl,
+        },
+      },
+    })
   }
   /**
    * Returns all experiments
@@ -50,7 +50,7 @@ export class Abba {
     buckets: BucketInput[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
-      validateBuckets(buckets)
+      validateTotalBucketRatio(buckets)
     }
 
     const created = await this.client.experiment.create({
@@ -85,7 +85,7 @@ export class Abba {
     buckets: BucketInput[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
-      validateBuckets(buckets)
+      validateTotalBucketRatio(buckets)
     }
 
     const updatedExperiment = await this.updateExperiment(id, experiment)
@@ -260,7 +260,7 @@ export class Abba {
       where: { id },
       data: {
         ...experiment,
-        rules: experiment.rules as Prisma.InputJsonObject,
+        rules: experiment.rules as Prisma.InputJsonArray,
       },
     })
   }

package/src/index.ts

@@ -1,4 +1,4 @@
-export type { Bucket, Experiment, UserAssignment } from '../prisma/generated/output'
+export type { Bucket, Experiment, UserAssignment } from './prisma-output'
 
 export * from './types'
 

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

@@ -0,0 +1,141 @@
+Object.defineProperty(exports, '__esModule', { value: true })
+
+const { Decimal } = require('./runtime/index-browser')
+
+const Prisma = {}
+
+exports.Prisma = Prisma
+
+/**
+ * Prisma Client JS version: 3.9.2
+ * Query Engine version: bcc2ff906db47790ee902e7bbc76d7ffb1893009
+ */
+Prisma.prismaVersion = {
+  client: '3.9.2',
+  engine: 'bcc2ff906db47790ee902e7bbc76d7ffb1893009',
+}
+
+Prisma.PrismaClientKnownRequestError = () => {
+  throw new Error(`PrismaClientKnownRequestError is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.PrismaClientUnknownRequestError = () => {
+  throw new Error(`PrismaClientUnknownRequestError is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.PrismaClientRustPanicError = () => {
+  throw new Error(`PrismaClientRustPanicError is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.PrismaClientInitializationError = () => {
+  throw new Error(`PrismaClientInitializationError is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.PrismaClientValidationError = () => {
+  throw new Error(`PrismaClientValidationError is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.Decimal = Decimal
+
+/**
+ * Re-export of sql-template-tag
+ */
+Prisma.sql = () => {
+  throw new Error(`sqltag is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.empty = () => {
+  throw new Error(`empty is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.join = () => {
+  throw new Error(`join is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.raw = () => {
+  throw new Error(`raw is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`)
+}
+Prisma.validator = () => val => val
+
+/**
+ * Shorthand utilities for JSON filtering
+ */
+Prisma.DbNull = 'DbNull'
+Prisma.JsonNull = 'JsonNull'
+Prisma.AnyNull = 'AnyNull'
+
+/**
+ * Enums
+ */
+// Based on
+// https://github.com/microsoft/TypeScript/issues/3192#issuecomment-261720275
+function makeEnum(x) {
+  return x
+}
+
+exports.Prisma.BucketScalarFieldEnum = makeEnum({
+  id: 'id',
+  experimentId: 'experimentId',
+  key: 'key',
+  ratio: 'ratio',
+  createdAt: 'createdAt',
+  updatedAt: 'updatedAt',
+})
+
+exports.Prisma.ExperimentScalarFieldEnum = makeEnum({
+  id: 'id',
+  name: 'name',
+  status: 'status',
+  sampling: 'sampling',
+  createdAt: 'createdAt',
+  updatedAt: 'updatedAt',
+  description: 'description',
+  rules: 'rules',
+})
+
+exports.Prisma.UserAssignmentScalarFieldEnum = makeEnum({
+  id: 'id',
+  userId: 'userId',
+  experimentId: 'experimentId',
+  bucketId: 'bucketId',
+  createdAt: 'createdAt',
+  updatedAt: 'updatedAt',
+})
+
+exports.Prisma.SortOrder = makeEnum({
+  asc: 'asc',
+  desc: 'desc',
+})
+
+exports.Prisma.NullableJsonNullValueInput = makeEnum({
+  DbNull: 'DbNull',
+  JsonNull: 'JsonNull',
+})
+
+exports.Prisma.JsonNullValueFilter = makeEnum({
+  DbNull: 'DbNull',
+  JsonNull: 'JsonNull',
+  AnyNull: 'AnyNull',
+})
+
+exports.Prisma.ModelName = makeEnum({
+  Bucket: 'Bucket',
+  Experiment: 'Experiment',
+  UserAssignment: 'UserAssignment',
+})
+
+/**
+ * Create the Client
+ */
+class PrismaClient {
+  constructor() {
+    throw new Error(
+      `PrismaClient is unable to be run in the browser.
+In case this error is unexpected for you, please report it in https://github.com/prisma/prisma/issues`,
+    )
+  }
+}
+exports.PrismaClient = PrismaClient
+
+Object.assign(exports, Prisma)