@naturalcycles/abba 1.24.0 → 1.25.1

package/dist/abba.d.ts

@@ -1,6 +1,6 @@
 import { Unsaved } from '@naturalcycles/js-lib';
-import { AbbaConfig, Bucket, Experiment, ExperimentAssignmentStatistics, ExperimentWithBuckets, GeneratedUserAssignment } from './types';
 import { SegmentationData } from '.';
+import { AbbaConfig, Bucket, Experiment, ExperimentAssignmentStatistics, ExperimentWithBuckets, GeneratedUserAssignment } from './types';
 export declare class Abba {
     cfg: AbbaConfig;
     private experimentDao;
@@ -48,7 +48,7 @@ export declare class Abba {
      * @param existingOnly Do not generate any new assignments for this experiment
      * @param segmentationData Required if existingOnly is false
      */
-    getUserAssignment(experimentKey: string, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<GeneratedUserAssignment | null>;
+    getUserAssignment(experimentKey: string, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<GeneratedUserAssignment>;
     /**
      * Get all existing user assignments.
      * Hot method.

package/dist/abba.js

@@ -32,7 +32,7 @@ class Abba {
      */
     async updateUserId(oldId, newId) {
         const query = this.userAssignmentDao.query().filterEq('userId', oldId);
-        await this.userAssignmentDao.updateByQuery(query, { userId: newId });
+        await this.userAssignmentDao.patchByQuery(query, { userId: newId });
     }
     /**
      * Returns all experiments.
@@ -128,39 +128,61 @@ class Abba {
         const experiment = await this.experimentDao.getOneBy('key', experimentKey);
         (0, js_lib_1._assert)(experiment, `Experiment does not exist: ${experimentKey}`);
         // Inactive experiments should never return an assignment
-        if (experiment.status === types_1.AssignmentStatus.Inactive)
-            return null;
+        if (experiment.status === types_1.AssignmentStatus.Inactive) {
+            return {
+                experiment,
+                assignment: null,
+            };
+        }
         const buckets = await this.bucketDao.getBy('experimentId', experiment.id);
         const existingAssignments = await this.userAssignmentDao.getBy('userId', userId);
         const existing = existingAssignments.find(a => a.experimentId === experiment.id);
         if (existing) {
             const bucket = buckets.find(b => b.id === existing.bucketId);
             return {
-                ...existing,
-                experimentKey: experiment.key,
-                bucketKey: bucket?.key || null,
-                bucketData: bucket?.data || null,
+                experiment,
+                assignment: {
+                    ...existing,
+                    experimentKey: experiment.key,
+                    bucketKey: bucket?.key || null,
+                    bucketData: bucket?.data || null,
+                },
             };
         }
         // No existing assignment, but we don't want to generate a new one
-        if (existingOnly || experiment.status === types_1.AssignmentStatus.Paused)
-            return null;
+        if (existingOnly || experiment.status === types_1.AssignmentStatus.Paused) {
+            return {
+                experiment,
+                assignment: null,
+            };
+        }
         const experiments = await this.getAllExperiments();
         const exclusionSet = (0, util_1.getUserExclusionSet)(experiments, existingAssignments);
-        if (!(0, util_1.canGenerateNewAssignments)(experiment, exclusionSet))
-            return null;
+        if (!(0, util_1.canGenerateNewAssignments)(experiment, exclusionSet)) {
+            return {
+                experiment,
+                assignment: null,
+            };
+        }
         (0, js_lib_1._assert)(segmentationData, 'Segmentation data required when creating a new assignment');
         const experimentWithBuckets = { ...experiment, buckets };
         const assignment = (0, util_1.generateUserAssignmentData)(experimentWithBuckets, userId, segmentationData);
-        if (!assignment)
-            return null;
+        if (!assignment) {
+            return {
+                experiment,
+                assignment: null,
+            };
+        }
         const newAssignment = await this.userAssignmentDao.save(assignment);
         const bucket = buckets.find(b => b.id === newAssignment.bucketId);
         return {
-            ...newAssignment,
-            experimentKey: experiment.key,
-            bucketKey: bucket?.key || null,
-            bucketData: bucket?.data || null,
+            experiment,
+            assignment: {
+                ...newAssignment,
+                experimentKey: experiment.key,
+                bucketKey: bucket?.key || null,
+                bucketData: bucket?.data || null,
+            },
         };
     }
     /**
@@ -175,10 +197,13 @@ class Abba {
             const experiment = await this.experimentDao.requireById(assignment.experimentId);
             const bucket = await this.bucketDao.getById(assignment.bucketId);
             return {
-                ...assignment,
-                experimentKey: experiment.key,
-                bucketKey: bucket?.key || null,
-                bucketData: bucket?.data || null,
+                experiment,
+                assignment: {
+                    ...assignment,
+                    experimentKey: experiment.key,
+                    bucketKey: bucket?.key || null,
+                    bucketData: bucket?.data || null,
+                },
             };
         });
     }
@@ -202,10 +227,13 @@ class Abba {
             if (existing) {
                 const bucket = experiment.buckets.find(b => b.id === existing.bucketId);
                 assignments.push({
-                    ...existing,
-                    experimentKey: experiment.key,
-                    bucketKey: bucket?.key || null,
-                    bucketData: bucket?.data || null,
+                    experiment,
+                    assignment: {
+                        ...existing,
+                        experimentKey: experiment.key,
+                        bucketKey: bucket?.key || null,
+                        bucketData: bucket?.data || null,
+                    },
                 });
             }
             else if (!existingOnly && (0, util_1.canGenerateNewAssignments)(experiment, exclusionSet)) {
@@ -215,10 +243,13 @@ class Abba {
                     newAssignments.push(created);
                     const bucket = experiment.buckets.find(b => b.id === created.bucketId);
                     assignments.push({
-                        ...created,
-                        experimentKey: experiment.key,
-                        bucketKey: bucket?.key || null,
-                        bucketData: bucket?.data || null,
+                        experiment,
+                        assignment: {
+                            ...created,
+                            experimentKey: experiment.key,
+                            bucketKey: bucket?.key || null,
+                            bucketData: bucket?.data || null,
+                        },
                     });
                     // Prevent future exclusion clashes
                     experiment.exclusions.forEach(experimentId => exclusionSet.add(experimentId));

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export * from './types';
 export * from './abba';
+export * from './types';

package/dist/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./types"), exports);
 tslib_1.__exportStar(require("./abba"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -51,11 +51,14 @@ export type UserAssignment = BaseDBEntity & {
     experimentId: string;
     bucketId: string | null;
 };
-export type GeneratedUserAssignment = Saved<UserAssignment> & {
-    experimentKey: string;
-    bucketKey: string | null;
-    bucketData: AnyObject | null;
-};
+export interface GeneratedUserAssignment {
+    assignment: (Saved<UserAssignment> & {
+        experimentKey: string;
+        bucketKey: string | null;
+        bucketData: AnyObject | null;
+    }) | null;
+    experiment: Saved<Experiment>;
+}
 export type SegmentationData = AnyObject;
 export declare enum AssignmentStatus {
     /**

package/dist/util.js

@@ -108,7 +108,7 @@ exports.segmentationRuleMap = {
         return (0, semver_1.satisfies)(keyValue?.toString() || '', ruleValue.toString());
     },
     [types_1.SegmentationRuleOperator.Regex](keyValue, ruleValue) {
-        return new RegExp(`${ruleValue}`).test(keyValue?.toString() || '');
+        return new RegExp(ruleValue).test(keyValue?.toString() || '');
     },
     [types_1.SegmentationRuleOperator.Boolean](keyValue, ruleValue) {
         // If it's true, then must be true

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.24.0",
+  "version": "1.25.1",
   "scripts": {
-    "prepare": "husky"
+    "prepare": "husky",
+    "build": "dev-lib build",
+    "test": "dev-lib test",
+    "lint": "dev-lib lint",
+    "bt": "dev-lib bt",
+    "lbt": "dev-lib lbt"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^9.14.1",
@@ -11,8 +16,8 @@
     "semver": "^7.3.5"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^13.44.8",
-    "@types/node": "^20.2.4",
+    "@naturalcycles/dev-lib": "^15.19.0",
+    "@types/node": "^22.7.4",
     "@types/semver": "^7.3.9",
     "jest": "^29.3.1"
   },
@@ -34,7 +39,7 @@
     "url": "https://github.com/NaturalCycles/abba"
   },
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.13.0"
   },
   "description": "AB test assignment configuration tool for Node.js",
   "author": "Natural Cycles Team",

package/src/abba.ts

@@ -1,5 +1,6 @@
 import { _assert, _Memo, _shuffle, pMap, Unsaved } from '@naturalcycles/js-lib'
 import { LRUMemoCache } from '@naturalcycles/nodejs-lib'
+import { SegmentationData } from '.'
 import { bucketDao } from './dao/bucket.dao'
 import { experimentDao } from './dao/experiment.dao'
 import { userAssignmentDao } from './dao/userAssignment.dao'
@@ -20,7 +21,6 @@ import {
   getUserExclusionSet,
   validateTotalBucketRatio,
 } from './util'
-import { SegmentationData } from '.'
 
 /**
  * 10 minutes
@@ -48,7 +48,7 @@ export class Abba {
    */
   async updateUserId(oldId: string, newId: string): Promise<void> {
     const query = this.userAssignmentDao.query().filterEq('userId', oldId)
-    await this.userAssignmentDao.updateByQuery(query, { userId: newId })
+    await this.userAssignmentDao.patchByQuery(query, { userId: newId })
   }
 
   /**
@@ -178,12 +178,17 @@ export class Abba {
     userId: string,
     existingOnly: boolean,
     segmentationData?: SegmentationData,
-  ): Promise<GeneratedUserAssignment | null> {
+  ): Promise<GeneratedUserAssignment> {
     const experiment = await this.experimentDao.getOneBy('key', experimentKey)
     _assert(experiment, `Experiment does not exist: ${experimentKey}`)
 
     // Inactive experiments should never return an assignment
-    if (experiment.status === AssignmentStatus.Inactive) return null
+    if (experiment.status === AssignmentStatus.Inactive) {
+      return {
+        experiment,
+        assignment: null,
+      }
+    }
 
     const buckets = await this.bucketDao.getBy('experimentId', experiment.id)
     const existingAssignments = await this.userAssignmentDao.getBy('userId', userId)
@@ -191,35 +196,56 @@ export class Abba {
     if (existing) {
       const bucket = buckets.find(b => b.id === existing.bucketId)
       return {
-        ...existing,
-        experimentKey: experiment.key,
-        bucketKey: bucket?.key || null,
-        bucketData: bucket?.data || null,
+        experiment,
+        assignment: {
+          ...existing,
+          experimentKey: experiment.key,
+          bucketKey: bucket?.key || null,
+          bucketData: bucket?.data || null,
+        },
       }
     }
 
     // No existing assignment, but we don't want to generate a new one
-    if (existingOnly || experiment.status === AssignmentStatus.Paused) return null
+    if (existingOnly || experiment.status === AssignmentStatus.Paused) {
+      return {
+        experiment,
+        assignment: null,
+      }
+    }
 
     const experiments = await this.getAllExperiments()
     const exclusionSet = getUserExclusionSet(experiments, existingAssignments)
-    if (!canGenerateNewAssignments(experiment, exclusionSet)) return null
+    if (!canGenerateNewAssignments(experiment, exclusionSet)) {
+      return {
+        experiment,
+        assignment: null,
+      }
+    }
 
     _assert(segmentationData, 'Segmentation data required when creating a new assignment')
 
     const experimentWithBuckets = { ...experiment, buckets }
     const assignment = generateUserAssignmentData(experimentWithBuckets, userId, segmentationData)
-    if (!assignment) return null
+    if (!assignment) {
+      return {
+        experiment,
+        assignment: null,
+      }
+    }
 
     const newAssignment = await this.userAssignmentDao.save(assignment)
 
     const bucket = buckets.find(b => b.id === newAssignment.bucketId)
 
     return {
-      ...newAssignment,
-      experimentKey: experiment.key,
-      bucketKey: bucket?.key || null,
-      bucketData: bucket?.data || null,
+      experiment,
+      assignment: {
+        ...newAssignment,
+        experimentKey: experiment.key,
+        bucketKey: bucket?.key || null,
+        bucketData: bucket?.data || null,
+      },
     }
   }
 
@@ -235,10 +261,13 @@ export class Abba {
       const experiment = await this.experimentDao.requireById(assignment.experimentId)
       const bucket = await this.bucketDao.getById(assignment.bucketId)
       return {
-        ...assignment,
-        experimentKey: experiment.key,
-        bucketKey: bucket?.key || null,
-        bucketData: bucket?.data || null,
+        experiment,
+        assignment: {
+          ...assignment,
+          experimentKey: experiment.key,
+          bucketKey: bucket?.key || null,
+          bucketData: bucket?.data || null,
+        },
       }
     })
   }
@@ -273,10 +302,13 @@ export class Abba {
       if (existing) {
         const bucket = experiment.buckets.find(b => b.id === existing.bucketId)
         assignments.push({
-          ...existing,
-          experimentKey: experiment.key,
-          bucketKey: bucket?.key || null,
-          bucketData: bucket?.data || null,
+          experiment,
+          assignment: {
+            ...existing,
+            experimentKey: experiment.key,
+            bucketKey: bucket?.key || null,
+            bucketData: bucket?.data || null,
+          },
         })
       } else if (!existingOnly && canGenerateNewAssignments(experiment, exclusionSet)) {
         const assignment = generateUserAssignmentData(experiment, userId, segmentationData)
@@ -285,10 +317,13 @@ export class Abba {
           newAssignments.push(created)
           const bucket = experiment.buckets.find(b => b.id === created.bucketId)
           assignments.push({
-            ...created,
-            experimentKey: experiment.key,
-            bucketKey: bucket?.key || null,
-            bucketData: bucket?.data || null,
+            experiment,
+            assignment: {
+              ...created,
+              experimentKey: experiment.key,
+              bucketKey: bucket?.key || null,
+              bucketData: bucket?.data || null,
+            },
           })
           // Prevent future exclusion clashes
           experiment.exclusions.forEach(experimentId => exclusionSet.add(experimentId))

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from './types'
 export * from './abba'
+export * from './types'

package/src/types.ts

@@ -59,10 +59,15 @@ export type UserAssignment = BaseDBEntity & {
   bucketId: string | null
 }
 
-export type GeneratedUserAssignment = Saved<UserAssignment> & {
-  experimentKey: string
-  bucketKey: string | null
-  bucketData: AnyObject | null
+export interface GeneratedUserAssignment {
+  assignment:
+    | (Saved<UserAssignment> & {
+        experimentKey: string
+        bucketKey: string | null
+        bucketData: AnyObject | null
+      })
+    | null
+  experiment: Saved<Experiment>
 }
 
 export type SegmentationData = AnyObject

package/src/util.ts

@@ -1,4 +1,4 @@
-import { Unsaved, localDate } from '@naturalcycles/js-lib'
+import { localDate, Unsaved } from '@naturalcycles/js-lib'
 import { satisfies } from 'semver'
 import {
   AssignmentStatus,
@@ -127,7 +127,7 @@ export const segmentationRuleMap: Record<SegmentationRuleOperator, SegmentationR
     return satisfies(keyValue?.toString() || '', ruleValue.toString())
   },
   [SegmentationRuleOperator.Regex](keyValue, ruleValue) {
-    return new RegExp(`${ruleValue}`).test(keyValue?.toString() || '')
+    return new RegExp(ruleValue).test(keyValue?.toString() || '')
   },
   [SegmentationRuleOperator.Boolean](keyValue, ruleValue) {
     // If it's true, then must be true