@naturalcycles/abba 1.18.5 → 1.19.0

package/dist/abba.d.ts

@@ -1,3 +1,4 @@
+import { Unsaved } from '@naturalcycles/js-lib';
 import { AbbaConfig, Bucket, Experiment, ExperimentAssignmentStatistics, ExperimentWithBuckets, GeneratedUserAssignment } from './types';
 import { SegmentationData } from '.';
 export declare class Abba {
@@ -11,6 +12,10 @@ export declare class Abba {
      * Cached (see CACHE_TTL)
      */
     getAllExperiments(): Promise<ExperimentWithBuckets[]>;
+    /**
+     * Updates all user assignments with a given userId with the provided userId.
+     */
+    updateUserId(oldId: string, newId: string): Promise<void>;
     /**
      * Returns all experiments.
      */
@@ -24,7 +29,7 @@ export declare class Abba {
      * Update experiment information, will also validate the buckets' ratio if experiment.active is true
      * Cold method.
      */
-    saveExperiment(experiment: Experiment, buckets: Bucket[]): Promise<ExperimentWithBuckets>;
+    saveExperiment(experiment: Experiment, buckets: Unsaved<Bucket>[]): Promise<ExperimentWithBuckets>;
     /**
      * Ensures that mutual exclusions are maintained
      */

package/dist/abba.js

@@ -27,6 +27,13 @@ class Abba {
     async getAllExperiments() {
         return await this.getAllExperimentsNoCache();
     }
+    /**
+     * Updates all user assignments with a given userId with the provided userId.
+     */
+    async updateUserId(oldId, newId) {
+        const query = this.userAssignmentDao.query().filterEq('userId', oldId);
+        await this.userAssignmentDao.updateByQuery(query, { userId: newId });
+    }
     /**
      * Returns all experiments.
      */

package/dist/util.d.ts

@@ -1,4 +1,4 @@
-import { Saved } from '@naturalcycles/js-lib';
+import { Unsaved } from '@naturalcycles/js-lib';
 import { Bucket, ExclusionSet, Experiment, ExperimentWithBuckets, SegmentationData, SegmentationRule, SegmentationRuleFn, SegmentationRuleOperator, UserAssignment } from './types';
 /**
  * Generate a new assignment for a given user.
@@ -12,15 +12,15 @@ 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
  */
-export declare const determineAssignment: (sampling: number, buckets: Saved<Bucket>[]) => Bucket | null;
+export declare const determineAssignment: (sampling: number, buckets: Bucket[]) => Bucket | null;
 /**
  * Determines which bucket a user assignment will recieve
  */
-export declare const determineBucket: (buckets: Saved<Bucket>[]) => Bucket;
+export declare const determineBucket: (buckets: Bucket[]) => Bucket;
 /**
  * Validate the total ratio of the buckets equals 100
  */
-export declare const validateTotalBucketRatio: (buckets: Bucket[]) => void;
+export declare const validateTotalBucketRatio: (buckets: Unsaved<Bucket>[]) => void;
 /**
  * Validate a users segmentation data against multiple rules. Returns false if any fail
  *
@@ -36,7 +36,7 @@ export declare const segmentationRuleMap: Record<SegmentationRuleOperator, Segme
 /**
  * Returns true if an experiment is able to generate new assignments based on status and start/end dates
  */
-export declare const canGenerateNewAssignments: (experiment: Saved<Experiment>, exclusionSet: ExclusionSet) => boolean;
+export declare const canGenerateNewAssignments: (experiment: Experiment, exclusionSet: ExclusionSet) => boolean;
 /**
  * Returns an object that includes keys of all experimentIds a user should not be assigned to
  * based on a combination of existing assignments and mutual exclusion configuration

package/dist/util.js

@@ -124,7 +124,7 @@ exports.segmentationRuleMap = {
 const canGenerateNewAssignments = (experiment, exclusionSet) => {
     return (!exclusionSet.has(experiment.id) &&
         experiment.status === types_1.AssignmentStatus.Active &&
-        (0, js_lib_1._isBetween)((0, js_lib_1.todayString)(), experiment.startDateIncl, experiment.endDateExcl, '[)'));
+        js_lib_1.localDate.today().isBetween(experiment.startDateIncl, experiment.endDateExcl, '[)'));
 };
 exports.canGenerateNewAssignments = canGenerateNewAssignments;
 /**

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.18.5",
+  "version": "1.19.0",
   "scripts": {
     "prepare": "husky"
   },
   "dependencies": {
-    "@naturalcycles/db-lib": "^9.1.0",
-    "@naturalcycles/js-lib": "^14.188.1",
+    "@naturalcycles/db-lib": "^9.14.1",
+    "@naturalcycles/js-lib": "^14.237.0",
     "@naturalcycles/nodejs-lib": "^13.1.3",
     "semver": "^7.3.5"
   },

package/src/abba.ts

@@ -1,4 +1,4 @@
-import { _assert, _Memo, _shuffle, pMap } from '@naturalcycles/js-lib'
+import { _assert, _Memo, _shuffle, pMap, Unsaved } from '@naturalcycles/js-lib'
 import { LRUMemoCache } from '@naturalcycles/nodejs-lib'
 import { bucketDao } from './dao/bucket.dao'
 import { experimentDao } from './dao/experiment.dao'
@@ -43,6 +43,14 @@ export class Abba {
     return await this.getAllExperimentsNoCache()
   }
 
+  /**
+   * Updates all user assignments with a given userId with the provided userId.
+   */
+  async updateUserId(oldId: string, newId: string): Promise<void> {
+    const query = this.userAssignmentDao.query().filterEq('userId', oldId)
+    await this.userAssignmentDao.updateByQuery(query, { userId: newId })
+  }
+
   /**
    * Returns all experiments.
    */
@@ -85,7 +93,10 @@ export class Abba {
    * Update experiment information, will also validate the buckets' ratio if experiment.active is true
    * Cold method.
    */
-  async saveExperiment(experiment: Experiment, buckets: Bucket[]): Promise<ExperimentWithBuckets> {
+  async saveExperiment(
+    experiment: Experiment,
+    buckets: Unsaved<Bucket>[],
+  ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
       validateTotalBucketRatio(buckets)
     }

package/src/util.ts

@@ -1,4 +1,4 @@
-import { _isBetween, Saved, todayString } from '@naturalcycles/js-lib'
+import { Unsaved, localDate } from '@naturalcycles/js-lib'
 import { satisfies } from 'semver'
 import {
   AssignmentStatus,
@@ -44,7 +44,7 @@ export const rollDie = (): number => {
 /**
  * Determines a users assignment for this experiment. Returns null if they are not considered to be in the sampling group
  */
-export const determineAssignment = (sampling: number, buckets: Saved<Bucket>[]): Bucket | null => {
+export const determineAssignment = (sampling: number, buckets: Bucket[]): Bucket | null => {
   // Should this person be considered for the experiment?
   if (rollDie() > sampling) {
     return null
@@ -57,7 +57,7 @@ export const determineAssignment = (sampling: number, buckets: Saved<Bucket>[]):
 /**
  * Determines which bucket a user assignment will recieve
  */
-export const determineBucket = (buckets: Saved<Bucket>[]): Bucket => {
+export const determineBucket = (buckets: Bucket[]): Bucket => {
   const bucketRoll = rollDie()
   let range: [number, number] | undefined
   const bucket = buckets.find(b => {
@@ -82,7 +82,7 @@ export const determineBucket = (buckets: Saved<Bucket>[]): Bucket => {
 /**
  * Validate the total ratio of the buckets equals 100
  */
-export const validateTotalBucketRatio = (buckets: Bucket[]): void => {
+export const validateTotalBucketRatio = (buckets: Unsaved<Bucket>[]): 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')
@@ -141,13 +141,13 @@ export const segmentationRuleMap: Record<SegmentationRuleOperator, SegmentationR
  * Returns true if an experiment is able to generate new assignments based on status and start/end dates
  */
 export const canGenerateNewAssignments = (
-  experiment: Saved<Experiment>,
+  experiment: Experiment,
   exclusionSet: ExclusionSet,
 ): boolean => {
   return (
     !exclusionSet.has(experiment.id) &&
     experiment.status === AssignmentStatus.Active &&
-    _isBetween(todayString(), experiment.startDateIncl, experiment.endDateExcl, '[)')
+    localDate.today().isBetween(experiment.startDateIncl, experiment.endDateExcl, '[)')
   )
 }