@naturalcycles/abba 1.17.2 → 1.18.0

package/dist/abba.d.ts

@@ -1,5 +1,4 @@
-import { Saved } from '@naturalcycles/js-lib';
-import { AbbaConfig, Bucket, Experiment, ExperimentAssignmentStatistics, ExperimentWithBuckets, GeneratedUserAssignment, UserAssignment } from './types';
+import { AbbaConfig, Bucket, Experiment, ExperimentAssignmentStatistics, ExperimentWithBuckets, GeneratedUserAssignment } from './types';
 import { SegmentationData } from '.';
 export declare class Abba {
     cfg: AbbaConfig;
@@ -49,8 +48,9 @@ export declare class Abba {
      * Get all existing user assignments.
      * Hot method.
      * Not cached, because Assignments are fast-changing.
+     * Only to be used for testing
      */
-    getAllExistingUserAssignments(userId: string): Promise<Saved<UserAssignment>[]>;
+    getAllExistingGeneratedUserAssignments(userId: string): Promise<GeneratedUserAssignment[]>;
     /**
      * Generate user assignments for all active experiments.
      * Will return any existing and attempt to generate any new assignments if existingOnly is false.

package/dist/abba.js

@@ -116,7 +116,7 @@ class Abba {
         if (experiment.status === types_1.AssignmentStatus.Inactive)
             return null;
         const buckets = await this.bucketDao.getBy('experimentId', experiment.id);
-        const existingAssignments = await this.getAllExistingUserAssignments(userId);
+        const existingAssignments = await this.userAssignmentDao.getBy('userId', userId);
         const existing = existingAssignments.find(a => a.experimentId === experiment.id);
         if (existing) {
             return {
@@ -148,9 +148,19 @@ class Abba {
      * Get all existing user assignments.
      * Hot method.
      * Not cached, because Assignments are fast-changing.
+     * Only to be used for testing
      */
-    async getAllExistingUserAssignments(userId) {
-        return await this.userAssignmentDao.getBy('userId', userId);
+    async getAllExistingGeneratedUserAssignments(userId) {
+        const assignments = await this.userAssignmentDao.getBy('userId', userId);
+        return await (0, js_lib_1.pMap)(assignments, async (assignment) => {
+            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,
+            };
+        });
     }
     /**
      * Generate user assignments for all active experiments.
@@ -159,7 +169,7 @@ class Abba {
      */
     async generateUserAssignments(userId, segmentationData, existingOnly = false) {
         const experiments = await this.getAllExperiments();
-        const existingAssignments = await this.getAllExistingUserAssignments(userId);
+        const existingAssignments = await this.userAssignmentDao.getBy('userId', userId);
         const exclusionSet = (0, util_1.getUserExclusionSet)(experiments, existingAssignments);
         const assignments = [];
         const newAssignments = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.17.2",
+  "version": "1.18.0",
   "scripts": {
     "prepare": "husky install",
     "build": "build",

package/readme.md

@@ -293,7 +293,7 @@ Example segmentation data:
 
 <div id="exclusion"></div>
 
-## Mutual Excluusion
+## Mutual Exclusion
 
 Mutual exclusion is configured per-experiment. If an experiment is listed as mutually exclusive with
 another experiment(s) then new assignments will only be generated with one of the experiments and

package/src/abba.ts

@@ -1,4 +1,4 @@
-import { _assert, _AsyncMemo, _shuffle, pMap, Saved } from '@naturalcycles/js-lib'
+import { _assert, _AsyncMemo, _shuffle, pMap } from '@naturalcycles/js-lib'
 import { LRUMemoCache } from '@naturalcycles/nodejs-lib'
 import { bucketDao } from './dao/bucket.dao'
 import { experimentDao } from './dao/experiment.dao'
@@ -164,7 +164,7 @@ export class Abba {
     if (experiment.status === AssignmentStatus.Inactive) return null
 
     const buckets = await this.bucketDao.getBy('experimentId', experiment.id)
-    const existingAssignments = await this.getAllExistingUserAssignments(userId)
+    const existingAssignments = await this.userAssignmentDao.getBy('userId', userId)
     const existing = existingAssignments.find(a => a.experimentId === experiment.id)
     if (existing) {
       return {
@@ -200,9 +200,19 @@ export class Abba {
    * Get all existing user assignments.
    * Hot method.
    * Not cached, because Assignments are fast-changing.
+   * Only to be used for testing
    */
-  async getAllExistingUserAssignments(userId: string): Promise<Saved<UserAssignment>[]> {
-    return await this.userAssignmentDao.getBy('userId', userId)
+  async getAllExistingGeneratedUserAssignments(userId: string): Promise<GeneratedUserAssignment[]> {
+    const assignments = await this.userAssignmentDao.getBy('userId', userId)
+    return await pMap(assignments, async assignment => {
+      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,
+      }
+    })
   }
 
   /**
@@ -216,7 +226,7 @@ export class Abba {
     existingOnly = false,
   ): Promise<GeneratedUserAssignment[]> {
     const experiments = await this.getAllExperiments()
-    const existingAssignments = await this.getAllExistingUserAssignments(userId)
+    const existingAssignments = await this.userAssignmentDao.getBy('userId', userId)
     const exclusionSet = getUserExclusionSet(experiments, existingAssignments)
     const assignments: GeneratedUserAssignment[] = []
     const newAssignments: UserAssignment[] = []