@naturalcycles/abba 2.7.3 → 2.9.0

package/dist/abba.js

@@ -8,17 +8,13 @@ import { LRUMemoCache } from '@naturalcycles/nodejs-lib/lruMemoCache';
 import { bucketDao } from './dao/bucket.dao.js';
 import { experimentDao } from './dao/experiment.dao.js';
 import { userAssignmentDao } from './dao/userAssignment.dao.js';
-import { AssignmentStatus } from './types.js';
+import { AbbaErrorCode, AssignmentStatus } from './types.js';
 import { canGenerateNewAssignments, generateUserAssignmentData, getUserExclusionSet, validateTotalBucketRatio, } from './util.js';
 /**
  * 10 minutes
  */
 const CACHE_TTL = 600_000;
 export class Abba {
-    cfg;
-    experimentDao;
-    bucketDao;
-    userAssignmentDao;
     constructor(cfg) {
         this.cfg = cfg;
         this.experimentDao = experimentDao(cfg.db);
@@ -72,7 +68,7 @@ export class Abba {
     async mergeAssignmentsForUserIds(fromUserId, intoUserId) {
         const fromAssignments = await this.userAssignmentDao.getBy('userId', fromUserId);
         const existingIntoAssignments = await this.userAssignmentDao.getBy('userId', intoUserId);
-        await pMap(fromAssignments, async from => {
+        await pMap(fromAssignments, async (from) => {
             if (!existingIntoAssignments.some(into => into.experimentId === from.experimentId)) {
                 await this.userAssignmentDao.patch(from, { userId: intoUserId });
             }
@@ -109,7 +105,7 @@ export class Abba {
             validateTotalBucketRatio(buckets);
         }
         const updatedExperiment = await this.experimentDao.save(experiment, { saveMethod: 'update' });
-        const updatedBuckets = await pMap(buckets, async bucket => {
+        const updatedBuckets = await pMap(buckets, async (bucket) => {
             return await this.bucketDao.save({ ...bucket, experimentId: updatedExperiment.id }, { saveMethod: bucket.id ? 'update' : undefined });
         });
         await this.updateExclusions(updatedExperiment.id, updatedExperiment.exclusions);
@@ -154,7 +150,7 @@ export class Abba {
         const experiment = await this.experimentDao.requireById(experimentId);
         const hasBeenInactiveFor15Mins = experiment.status === AssignmentStatus.Inactive &&
             localTime(experiment.updated).isOlderThan(15, 'minute');
-        _assert(hasBeenInactiveFor15Mins, 'Experiment must be inactive for at least 15 minutes before deletion');
+        _assert(hasBeenInactiveFor15Mins, 'Experiment must be inactive for at least 15 minutes before deletion', { code: AbbaErrorCode.ExperimentDeletionTooSoon });
         await this.userAssignmentDao.deleteByExperimentId(experimentId);
         await this.bucketDao.deleteByExperimentId(experimentId);
         await this.experimentDao.deleteById(experimentId);
@@ -171,7 +167,9 @@ export class Abba {
      */
     async getUserAssignment(experimentKey, userId, existingOnly, segmentationData) {
         const experiment = await this.experimentDao.getByKey(experimentKey);
-        _assert(experiment, `Experiment does not exist: ${experimentKey}`);
+        _assert(experiment, `Experiment does not exist: ${experimentKey}`, {
+            code: AbbaErrorCode.ExperimentNotFound,
+        });
         // Inactive experiments should never return an assignment
         if (experiment.status === AssignmentStatus.Inactive) {
             return null;
@@ -197,7 +195,9 @@ export class Abba {
         if (!canGenerateNewAssignments(experiment, exclusionSet)) {
             return null;
         }
-        _assert(segmentationData, 'Segmentation data required when creating a new assignment');
+        _assert(segmentationData, 'Segmentation data required when creating a new assignment', {
+            code: AbbaErrorCode.SegmentationDataRequired,
+        });
         const experimentWithBuckets = { ...experiment, buckets };
         const assignment = generateUserAssignmentData(experimentWithBuckets, userId, segmentationData);
         if (!assignment) {
@@ -221,7 +221,7 @@ export class Abba {
      */
     async getAllExistingUserAssignments(userId) {
         const assignments = await this.userAssignmentDao.getBy('userId', userId);
-        return await pMap(assignments, async assignment => {
+        return await pMap(assignments, async (assignment) => {
             const experiment = await this.experimentDao.requireById(assignment.experimentId);
             const bucket = await this.bucketDao.getById(assignment.bucketId);
             return {
@@ -288,7 +288,7 @@ export class Abba {
     async getExperimentAssignmentStatistics(experimentId) {
         const totalAssignments = await this.userAssignmentDao.getCountByExperimentId(experimentId);
         const buckets = await this.bucketDao.getByExperimentId(experimentId);
-        const bucketAssignments = await pMap(buckets, async bucket => {
+        const bucketAssignments = await pMap(buckets, async (bucket) => {
             const totalAssignments = await this.userAssignmentDao.getCountByBucketId(bucket.id);
             return {
                 bucketId: bucket.id,

package/dist/dao/experiment.dao.js

@@ -19,11 +19,7 @@ export function experimentDao(db) {
             beforeBMToDBM: bm => ({
                 ...bm,
                 rules: bm.rules.length ? JSON.stringify(bm.rules) : null,
-                // We add the map here to account for backwards compatibility where exclusion experimentIds were stored as a number
-                // TODO: Remove after some time when we are certain only strings are stored
-                exclusions: bm.exclusions.length
-                    ? JSON.stringify(bm.exclusions.map(exclusion => exclusion.toString()))
-                    : null,
+                exclusions: bm.exclusions.length ? JSON.stringify(bm.exclusions) : null,
                 data: bm.data ? JSON.stringify(bm.data) : null,
             }),
             beforeDBMToBM: dbm => ({
@@ -31,11 +27,7 @@ export function experimentDao(db) {
                 startDateIncl: parseMySQLDate(dbm.startDateIncl),
                 endDateExcl: parseMySQLDate(dbm.endDateExcl),
                 rules: (dbm.rules && JSON.parse(dbm.rules)) || [],
-                // We add the map here to account for backwards compatibility where exclusion experimentIds were stored as a number
-                // TODO: Remove after some time when we are certain only strings are stored
-                exclusions: (dbm.exclusions &&
-                    JSON.parse(dbm.exclusions).map((exclusion) => exclusion.toString())) ||
-                    [],
+                exclusions: (dbm.exclusions && JSON.parse(dbm.exclusions)) || [],
                 data: dbm.data ? JSON.parse(dbm.data) : null,
             }),
         },

package/dist/types.d.ts

@@ -1,5 +1,12 @@
 import type { CommonDB } from '@naturalcycles/db-lib';
 import type { AnyObject, BaseDBEntity, IsoDate } from '@naturalcycles/js-lib/types';
+export declare const AbbaErrorCode: {
+    readonly ExperimentNotFound: 'abba/experimentNotFound';
+    readonly ExperimentDeletionTooSoon: 'abba/experimentDeletionTooSoon';
+    readonly SegmentationDataRequired: 'abba/segmentationDataRequired';
+    readonly InvalidBucketRatio: 'abba/invalidBucketRatio';
+    readonly BucketDeterminationFailed: 'abba/bucketDeterminationFailed';
+};
 export interface AbbaConfig {
     db: CommonDB;
 }

package/dist/types.js

@@ -1,5 +1,11 @@
-export { AssignmentStatus };
-var AssignmentStatus;
+export const AbbaErrorCode = {
+    ExperimentNotFound: 'abba/experimentNotFound',
+    ExperimentDeletionTooSoon: 'abba/experimentDeletionTooSoon',
+    SegmentationDataRequired: 'abba/segmentationDataRequired',
+    InvalidBucketRatio: 'abba/invalidBucketRatio',
+    BucketDeterminationFailed: 'abba/bucketDeterminationFailed',
+};
+export var AssignmentStatus;
 (function (AssignmentStatus) {
     /**
      * Will return existing assignments and generate new assignments
@@ -14,8 +20,7 @@ var AssignmentStatus;
      */
     AssignmentStatus[AssignmentStatus["Inactive"] = 3] = "Inactive";
 })(AssignmentStatus || (AssignmentStatus = {}));
-export { SegmentationRuleOperator };
-var SegmentationRuleOperator;
+export var SegmentationRuleOperator;
 (function (SegmentationRuleOperator) {
     SegmentationRuleOperator["IsSet"] = "isSet";
     SegmentationRuleOperator["IsNotSet"] = "isNotSet";

package/dist/util.js

@@ -1,6 +1,7 @@
 import { localDate } from '@naturalcycles/js-lib/datetime';
+import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { satisfies } from 'semver';
-import { AssignmentStatus, SegmentationRuleOperator } from './types.js';
+import { AbbaErrorCode, AssignmentStatus, SegmentationRuleOperator } from './types.js';
 /**
  * Generate a new assignment for a given user.
  * Doesn't save it.
@@ -53,9 +54,9 @@ export function determineBucket(buckets) {
             return b;
         }
     });
-    if (!bucket) {
-        throw new Error('Could not detetermine bucket from ratios');
-    }
+    _assert(bucket, 'Could not determine bucket from ratios', {
+        code: AbbaErrorCode.BucketDeterminationFailed,
+    });
     return bucket;
 }
 /**
@@ -63,9 +64,7 @@ export function determineBucket(buckets) {
  */
 export function 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');
-    }
+    _assert(bucketSum === 100, 'Total bucket ratio must be 100 before you can activate an experiment', { code: AbbaErrorCode.InvalidBucketRatio });
 }
 /**
  * Validate a users segmentation data against multiple rules. Returns false if any fail
@@ -93,12 +92,15 @@ export const segmentationRuleMap = {
         return !keyValue;
     },
     [SegmentationRuleOperator.EqualsText](keyValue, ruleValue) {
+        // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
         return keyValue?.toString() === ruleValue.toString();
     },
     [SegmentationRuleOperator.NotEqualsText](keyValue, ruleValue) {
+        // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
         return keyValue?.toString() !== ruleValue.toString();
     },
     [SegmentationRuleOperator.Semver](keyValue, ruleValue) {
+        // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
         return satisfies(keyValue?.toString() || '', ruleValue.toString());
     },
     [SegmentationRuleOperator.Regex](keyValue, ruleValue) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/abba",
   "type": "module",
-  "version": "2.7.3",
+  "version": "2.9.0",
   "dependencies": {
     "@naturalcycles/db-lib": "^10",
     "@naturalcycles/js-lib": "^15",
@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "@types/semver": "^7",
-    "@typescript/native-preview": "7.0.0-dev.20260301.1",
+    "@typescript/native-preview": "7.0.0-dev.20260401.1",
     "@naturalcycles/dev-lib": "18.4.2"
   },
   "exports": {

package/src/abba.ts

@@ -23,7 +23,7 @@ import type {
   UserAssignment,
   UserExperiment,
 } from './types.js'
-import { AssignmentStatus } from './types.js'
+import { AbbaErrorCode, AssignmentStatus } from './types.js'
 import {
   canGenerateNewAssignments,
   generateUserAssignmentData,
@@ -233,6 +233,7 @@ export class Abba {
     _assert(
       hasBeenInactiveFor15Mins,
       'Experiment must be inactive for at least 15 minutes before deletion',
+      { code: AbbaErrorCode.ExperimentDeletionTooSoon },
     )
 
     await this.userAssignmentDao.deleteByExperimentId(experimentId)
@@ -257,7 +258,9 @@ export class Abba {
     segmentationData?: SegmentationData,
   ): Promise<DecoratedUserAssignment | null> {
     const experiment = await this.experimentDao.getByKey(experimentKey)
-    _assert(experiment, `Experiment does not exist: ${experimentKey}`)
+    _assert(experiment, `Experiment does not exist: ${experimentKey}`, {
+      code: AbbaErrorCode.ExperimentNotFound,
+    })
 
     // Inactive experiments should never return an assignment
     if (experiment.status === AssignmentStatus.Inactive) {
@@ -291,7 +294,9 @@ export class Abba {
       return null
     }
 
-    _assert(segmentationData, 'Segmentation data required when creating a new assignment')
+    _assert(segmentationData, 'Segmentation data required when creating a new assignment', {
+      code: AbbaErrorCode.SegmentationDataRequired,
+    })
 
     const experimentWithBuckets = { ...experiment, buckets }
     const assignment = generateUserAssignmentData(experimentWithBuckets, userId, segmentationData)

package/src/dao/experiment.dao.ts

@@ -26,11 +26,7 @@ export function experimentDao(db: CommonDB): ExperimentDao {
       beforeBMToDBM: bm => ({
         ...bm,
         rules: bm.rules.length ? JSON.stringify(bm.rules) : null,
-        // We add the map here to account for backwards compatibility where exclusion experimentIds were stored as a number
-        // TODO: Remove after some time when we are certain only strings are stored
-        exclusions: bm.exclusions.length
-          ? JSON.stringify(bm.exclusions.map(exclusion => exclusion.toString()))
-          : null,
+        exclusions: bm.exclusions.length ? JSON.stringify(bm.exclusions) : null,
         data: bm.data ? JSON.stringify(bm.data) : null,
       }),
       beforeDBMToBM: dbm => ({
@@ -38,12 +34,7 @@ export function experimentDao(db: CommonDB): ExperimentDao {
         startDateIncl: parseMySQLDate(dbm.startDateIncl),
         endDateExcl: parseMySQLDate(dbm.endDateExcl),
         rules: (dbm.rules && JSON.parse(dbm.rules)) || [],
-        // We add the map here to account for backwards compatibility where exclusion experimentIds were stored as a number
-        // TODO: Remove after some time when we are certain only strings are stored
-        exclusions:
-          (dbm.exclusions &&
-            JSON.parse(dbm.exclusions).map((exclusion: string | number) => exclusion.toString())) ||
-          [],
+        exclusions: (dbm.exclusions && JSON.parse(dbm.exclusions)) || [],
         data: dbm.data ? JSON.parse(dbm.data) : null,
       }),
     },

package/src/types.ts

@@ -1,6 +1,14 @@
 import type { CommonDB } from '@naturalcycles/db-lib'
 import type { AnyObject, BaseDBEntity, IsoDate } from '@naturalcycles/js-lib/types'
 
+export const AbbaErrorCode = {
+  ExperimentNotFound: 'abba/experimentNotFound',
+  ExperimentDeletionTooSoon: 'abba/experimentDeletionTooSoon',
+  SegmentationDataRequired: 'abba/segmentationDataRequired',
+  InvalidBucketRatio: 'abba/invalidBucketRatio',
+  BucketDeterminationFailed: 'abba/bucketDeterminationFailed',
+} as const
+
 export interface AbbaConfig {
   db: CommonDB
 }

package/src/util.ts

@@ -1,4 +1,5 @@
 import { localDate } from '@naturalcycles/js-lib/datetime'
+import { _assert } from '@naturalcycles/js-lib/error/assert.js'
 import type { Unsaved } from '@naturalcycles/js-lib/types'
 import { satisfies } from 'semver'
 import type {
@@ -13,7 +14,7 @@ import type {
   UserAssignment,
   UserExperiment,
 } from './types.js'
-import { AssignmentStatus, SegmentationRuleOperator } from './types.js'
+import { AbbaErrorCode, AssignmentStatus, SegmentationRuleOperator } from './types.js'
 
 /**
  * Generate a new assignment for a given user.
@@ -78,9 +79,9 @@ export function determineBucket(buckets: Bucket[]): Bucket {
     }
   })
 
-  if (!bucket) {
-    throw new Error('Could not detetermine bucket from ratios')
-  }
+  _assert(bucket, 'Could not determine bucket from ratios', {
+    code: AbbaErrorCode.BucketDeterminationFailed,
+  })
 
   return bucket
 }
@@ -90,9 +91,11 @@ export function determineBucket(buckets: Bucket[]): Bucket {
  */
 export function validateTotalBucketRatio(buckets: (Unsaved<Bucket> | BucketInput)[]): void {
   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')
-  }
+  _assert(
+    bucketSum === 100,
+    'Total bucket ratio must be 100 before you can activate an experiment',
+    { code: AbbaErrorCode.InvalidBucketRatio },
+  )
 }
 
 /**
@@ -124,12 +127,15 @@ export const segmentationRuleMap: Record<SegmentationRuleOperator, SegmentationR
     return !keyValue
   },
   [SegmentationRuleOperator.EqualsText](keyValue, ruleValue) {
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
     return keyValue?.toString() === ruleValue.toString()
   },
   [SegmentationRuleOperator.NotEqualsText](keyValue, ruleValue) {
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
     return keyValue?.toString() !== ruleValue.toString()
   },
   [SegmentationRuleOperator.Semver](keyValue, ruleValue) {
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion
     return satisfies(keyValue?.toString() || '', ruleValue.toString())
   },
   [SegmentationRuleOperator.Regex](keyValue, ruleValue) {