@naturalcycles/abba 1.7.0 → 1.9.1

package/src/abba.ts

@@ -1,300 +1,269 @@
-import { Bucket, Experiment, Prisma, PrismaClient, UserAssignment } from './prisma-output'
-import { AssignmentStatus } from './types'
-import { determineAssignment, validateSegmentationRules, validateTotalBucketRatio } from './util'
+import { _assert, _AsyncMemo, pMap, Saved } from '@naturalcycles/js-lib'
+import { LRUMemoCache } from '@naturalcycles/nodejs-lib'
 import {
+  AbbaConfig,
+  AssignmentStatus,
+  Bucket,
   BucketInput,
+  Experiment,
   ExperimentWithBuckets,
-  ExperimentInput,
-  SegmentationData,
-  SegmentationRule,
-  AssignmentStatistics,
-} from '.'
+  UserAssignment,
+} from './types'
+import { determineAssignment, validateSegmentationRules, validateTotalBucketRatio } from './util'
+import { ExperimentDao, experimentDao } from './dao/experiment.dao'
+import { UserAssignmentDao, userAssignmentDao } from './dao/userAssignment.dao'
+import { BucketDao, bucketDao } from './dao/bucket.dao'
+import { SegmentationData, AssignmentStatistics } from '.'
 
-// Note: Schema currently contains an output dir which generates all the files to the prisma dir
-// it would be tidier not to include it here when possible later on:
-// Explanation is here: https://github.com/prisma/prisma/issues/9435#issuecomment-960290681
+const CACHE_TTL = 600_000 // 10 minutes
 
 export class Abba {
-  private client: PrismaClient
-
-  constructor(dbUrl?: string) {
-    this.client = new PrismaClient({
-      datasources: {
-        db: {
-          url: dbUrl,
-        },
-      },
-    })
+  constructor(public cfg: AbbaConfig) {
+    const { db } = cfg
+    this.experimentDao = experimentDao(db)
+    this.bucketDao = bucketDao(db)
+    this.userAssignmentDao = userAssignmentDao(db)
   }
+
+  private experimentDao: ExperimentDao
+  private bucketDao: BucketDao
+  private userAssignmentDao: UserAssignmentDao
+
   /**
-   * Returns all experiments
+   * Returns all (active and inactive) experiments.
    *
-   * @returns
+   * Cold method, not cached.
    */
-  async getAllExperiments(excludeInactive: boolean = false): Promise<ExperimentWithBuckets[]> {
-    return await this.client.experiment.findMany({
-      where: excludeInactive ? { NOT: { status: AssignmentStatus.Inactive } } : undefined,
-      include: { buckets: true },
-    })
+  async getAllExperiments(): Promise<ExperimentWithBuckets[]> {
+    const experiments = await this.experimentDao.query().runQuery()
+
+    const buckets = await this.bucketDao
+      .query()
+      .filter(
+        'experimentId',
+        'in',
+        experiments.map(e => e.id),
+      )
+      .runQuery()
+
+    return experiments.map(experiment => ({
+      ...experiment,
+      buckets: buckets.filter(bucket => bucket.experimentId === experiment.id),
+    }))
   }
 
   /**
-   * Creates a new experiment
-   *
-   * @param experiment
-   * @param buckets
-   * @returns
+   * Returns only active experiments.
+   * Hot method.
+   * Cached in-memory for N minutes (currently 10).
+   */
+  @_AsyncMemo({ cacheFactory: () => new LRUMemoCache({ ttl: CACHE_TTL, max: 1 }) })
+  async getActiveExperiments(): Promise<ExperimentWithBuckets[]> {
+    const experiments = await this.experimentDao
+      .query()
+      .filter('status', '!=', AssignmentStatus.Inactive)
+      .runQuery()
+
+    const buckets = await this.bucketDao
+      .query()
+      .filter(
+        'experimentId',
+        'in',
+        experiments.map(e => e.id),
+      )
+      .runQuery()
+
+    return experiments.map(experiment => ({
+      ...experiment,
+      buckets: buckets.filter(bucket => bucket.experimentId === experiment.id),
+    }))
+  }
+
+  /**
+   * Creates a new experiment.
+   * Cold method.
    */
   async createExperiment(
-    experiment: ExperimentInput,
+    experiment: Experiment,
     buckets: BucketInput[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
       validateTotalBucketRatio(buckets)
     }
 
-    const created = await this.client.experiment.create({
-      data: {
-        ...experiment,
-        rules: experiment.rules as Prisma.InputJsonArray,
-        buckets: {
-          createMany: {
-            data: buckets,
-          },
-        },
-      },
-      include: {
-        buckets: true,
-      },
-    })
-    return created
+    await this.experimentDao.save(experiment)
+
+    return {
+      ...(experiment as Saved<Experiment>),
+      buckets: await this.bucketDao.saveBatch(
+        buckets.map(b => ({ ...b, experimentId: experiment.id! })),
+      ),
+    }
   }
 
   /**
-   * Update experiment information, will also validate the buckets ratio if experiment.active is true
-   *
-   * @param id
-   * @param experiment
-   * @param rules
-   * @param buckets
-   * @returns
+   * Update experiment information, will also validate the buckets' ratio if experiment.active is true
+   * Cold method.
    */
   async saveExperiment(
-    id: number,
-    experiment: ExperimentInput,
-    buckets: BucketInput[],
+    experiment: Experiment & { id: number },
+    buckets: Bucket[],
   ): Promise<ExperimentWithBuckets> {
     if (experiment.status === AssignmentStatus.Active) {
       validateTotalBucketRatio(buckets)
     }
 
-    const updatedExperiment = await this.updateExperiment(id, experiment)
-    const updatedBuckets = await this.saveBuckets(buckets)
+    await this.experimentDao.save(experiment)
 
     return {
-      ...updatedExperiment,
-      buckets: updatedBuckets,
+      ...(experiment as Saved<Experiment>),
+      buckets: await this.bucketDao.saveBatch(
+        buckets.map(b => ({ ...b, experimentId: experiment.id })),
+      ),
     }
   }
 
   /**
-   * Delete an experiment. Removes all user assignments and buckets
-   *
-   * @param id
+   * Delete an experiment. Removes all user assignments and buckets.
+   * Cold method.
    */
   async deleteExperiment(id: number): Promise<void> {
-    await this.client.experiment.delete({ where: { id } })
+    await this.experimentDao.deleteById(id)
   }
 
   /**
-   * Get an assignment for a given user. If existingOnly is false, it will attempt generate a new assignment
+   * Get an assignment for a given user. If existingOnly is false, it will attempt to generate a new assignment
+   * Cold method.
    *
    * @param experimentId
    * @param userId
-   * @param createNew
-   * @param segmentationData
-   * @returns
+   * @param existingOnly Do not generate any new assignments for this experiment
+   * @param segmentationData Required if existingOnly is false
    */
   async getUserAssignment(
     experimentId: number,
     userId: string,
     existingOnly: boolean,
     segmentationData?: SegmentationData,
-  ): Promise<UserAssignment | null> {
-    const experiment = await this.client.experiment.findUnique({
-      where: { id: experimentId },
-      include: { buckets: true },
-    })
-    if (!experiment) throw new Error('Experiment not found')
-
+  ): Promise<Saved<UserAssignment> | null> {
     const existing = await this.getExistingUserAssignment(experimentId, userId)
     if (existing) return existing
+    if (existingOnly) return null
 
-    if (experiment.status !== AssignmentStatus.Active || existingOnly) return null
+    const experiment = await this.experimentDao.requireById(experimentId)
+    if (experiment.status !== AssignmentStatus.Active) return null
 
-    if (!segmentationData)
-      throw new Error('Segmentation data required when creating a new assignment')
+    _assert(segmentationData, 'Segmentation data required when creating a new assignment')
 
-    return await this.generateUserAssignment(experiment, userId, segmentationData)
+    const buckets = await this.bucketDao.getBy('experimentId', experimentId)
+
+    const assignment = this.generateUserAssignmentData(
+      { ...experiment, buckets },
+      userId,
+      segmentationData,
+    )
+    if (!assignment) return null
+
+    return await this.userAssignmentDao.save(assignment)
   }
 
   /**
-   * Get all existing user assignments
-   *
-   * @param userId G
-   * @returns
+   * Get all existing user assignments.
+   * Hot method.
+   * Not cached, because Assignments are fast-changing.
    */
-  async getAllExistingUserAssignments(userId: string): Promise<UserAssignment[]> {
-    return await this.client.userAssignment.findMany({ where: { userId } })
+  async getAllExistingUserAssignments(userId: string): Promise<Saved<UserAssignment>[]> {
+    return await this.userAssignmentDao.getBy('userId', userId)
   }
 
   /**
-   * Generate user assignments for all active experiments. Will return any existing and attempt to generate any new assignments.
-   *
-   * @param userId
-   * @param segmentationData
-   * @returns
+   * Generate user assignments for all active experiments.
+   * Will return any existing and attempt to generate any new assignments.
+   * Hot method.
    */
   async generateUserAssignments(
     userId: string,
     segmentationData: SegmentationData,
-  ): Promise<UserAssignment[]> {
-    const experiments = await this.getAllExperiments(true)
+  ): Promise<Saved<UserAssignment>[]> {
+    const experiments = await this.getActiveExperiments() // cached
     const existingAssignments = await this.getAllExistingUserAssignments(userId)
 
-    const assignments: UserAssignment[] = []
-    const generatedAssignments: Promise<UserAssignment | null>[] = []
+    const allAssignments: Saved<UserAssignment>[] = []
+    const generatedAssignments: UserAssignment[] = []
 
     for (const experiment of experiments) {
       const existing = existingAssignments.find(ua => ua.experimentId === experiment.id)
       if (existing) {
-        assignments.push(existing)
-        continue
+        allAssignments.push(existing)
       } else {
-        generatedAssignments.push(this.generateUserAssignment(experiment, userId, segmentationData))
+        const assignment = this.generateUserAssignmentData(experiment, userId, segmentationData)
+        if (assignment) {
+          generatedAssignments.push(assignment)
+        }
       }
     }
 
-    const generated = await Promise.all(generatedAssignments)
-    const filtered = generated.filter((ua): ua is UserAssignment => ua !== null)
-    return [...assignments, ...filtered]
+    await this.userAssignmentDao.saveBatch(generatedAssignments)
+
+    return [...allAssignments, ...(generatedAssignments as Saved<UserAssignment>[])]
   }
 
   /**
-   * Get assignment statistics for an experiment
-   *
-   * @param experimentId
-   * @returns
+   * Get assignment statistics for an experiment.
+   * Cold method.
    */
   async getExperimentAssignmentStatistics(experimentId: number): Promise<AssignmentStatistics> {
     const statistics = {
-      sampled: await this.client.userAssignment.count({ where: { experimentId } }),
+      sampled: await this.userAssignmentDao
+        .query()
+        .filterEq('experimentId', experimentId)
+        .runQueryCount(),
       buckets: {},
     }
 
-    const buckets = await this.client.bucket.findMany({ where: { experimentId } })
-    const assignmentCounts = await this.client.userAssignment.groupBy({
-      where: { experimentId },
-      by: ['bucketId'],
-      _count: {
-        _all: true,
-      },
-    })
-
-    buckets.forEach(({ id }) => {
-      statistics.buckets[`${id}`] = assignmentCounts.find(i => i.bucketId === id)?._count?._all || 0
+    const buckets = await this.bucketDao.getBy('experimentId', experimentId)
+    await pMap(buckets, async bucket => {
+      statistics[bucket.id] = await this.userAssignmentDao
+        .query()
+        .filterEq('bucketId', bucket.id)
+        .runQueryCount()
     })
 
     return statistics
   }
 
   /**
-   * Generate a new assignment for a given user
-   *
-   * @param experimentId
-   * @param userId
-   * @param segmentationData
-   * @returns
+   * Generate a new assignment for a given user.
+   * Doesn't save it.
    */
-  private async generateUserAssignment(
+  private generateUserAssignmentData(
     experiment: ExperimentWithBuckets,
     userId: string,
     segmentationData: SegmentationData,
-  ): Promise<UserAssignment | null> {
-    const segmentationMatch = validateSegmentationRules(
-      experiment.rules as unknown as SegmentationRule[],
-      segmentationData,
-    )
+  ): UserAssignment | null {
+    const segmentationMatch = validateSegmentationRules(experiment.rules, segmentationData)
     if (!segmentationMatch) return null
 
-    const bucketId = determineAssignment(experiment.sampling, experiment.buckets)
-    return await this.client.userAssignment.create({
-      data: { userId, experimentId: experiment.id, bucketId },
-    })
+    return {
+      userId,
+      experimentId: experiment.id,
+      bucketId: determineAssignment(experiment.sampling, experiment.buckets),
+    }
   }
 
   /**
    * Queries to retrieve an existing user assignment for a given experiment
-   *
-   * @param experimentId
-   * @param userId
-   * @returns
    */
   private async getExistingUserAssignment(
     experimentId: number,
     userId: string,
-  ): Promise<UserAssignment | null> {
-    return await this.client.userAssignment.findFirst({ where: { userId, experimentId } })
-  }
-
-  /**
-   * Update experiment information
-   *
-   * @param id
-   * @param experiment
-   * @param rules
-   * @returns
-   */
-  private async updateExperiment(id: number, experiment: Partial<Experiment>): Promise<Experiment> {
-    return await this.client.experiment.update({
-      where: { id },
-      data: {
-        ...experiment,
-        rules: experiment.rules as Prisma.InputJsonArray,
-      },
-    })
-  }
-
-  /**
-   * Upserts bucket info
-   *
-   * @param id
-   * @param experiment
-   * @returns
-   */
-  private async saveBuckets(buckets: BucketInput[]): Promise<Bucket[]> {
-    const savedBuckets: Promise<Bucket>[] = []
-    for (const bucket of buckets) {
-      const { id, ...data } = bucket
-      if (id) {
-        savedBuckets.push(this.client.bucket.update({ where: { id }, data }))
-      } else {
-        savedBuckets.push(
-          this.client.bucket.create({
-            data: {
-              key: data.key,
-              ratio: data.ratio,
-              experiment: {
-                connect: {
-                  id: data.experimentId,
-                },
-              },
-            },
-          }),
-        )
-      }
-    }
+  ): Promise<Saved<UserAssignment> | null> {
+    const [assignment] = await this.userAssignmentDao
+      .query()
+      .filterEq('userId', userId)
+      .filterEq('experimentId', experimentId)
+      .runQuery()
 
-    return await Promise.all(savedBuckets)
+    return assignment || null
   }
 }

package/src/dao/bucket.dao.ts

@@ -0,0 +1,13 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib'
+import { Bucket } from '../types'
+
+export class BucketDao extends CommonDao<Bucket> {}
+
+export const bucketDao = (db: CommonDB): BucketDao =>
+  new BucketDao({
+    db,
+    table: 'Bucket',
+    createId: false, // mysql auto_increment is used instead
+    idType: 'number',
+    assignGeneratedIds: true,
+  })

package/src/dao/experiment.dao.ts

@@ -0,0 +1,22 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib'
+import { Saved } from '@naturalcycles/js-lib'
+import { BaseExperiment, Experiment } from '../types'
+
+type ExperimentDBM = Saved<BaseExperiment> & {
+  rules: string | null
+}
+
+export class ExperimentDao extends CommonDao<Experiment, ExperimentDBM> {}
+
+export const experimentDao = (db: CommonDB): ExperimentDao =>
+  new ExperimentDao({
+    db,
+    table: 'Experiment',
+    createId: false, // mysql auto_increment is used instead
+    idType: 'number',
+    assignGeneratedIds: true,
+    hooks: {
+      beforeBMToDBM: bm => ({ ...bm, rules: bm.rules.length ? JSON.stringify(bm.rules) : null }),
+      beforeDBMToBM: dbm => ({ ...dbm, rules: (dbm.rules && JSON.parse(dbm.rules)) || [] }),
+    },
+  })

package/src/dao/userAssignment.dao.ts

@@ -0,0 +1,13 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib'
+import { UserAssignment } from '../types'
+
+export class UserAssignmentDao extends CommonDao<UserAssignment> {}
+
+export const userAssignmentDao = (db: CommonDB): UserAssignmentDao =>
+  new UserAssignmentDao({
+    db,
+    table: 'UserAssignment',
+    createId: false, // mysql auto_increment is used instead
+    idType: 'number',
+    assignGeneratedIds: true,
+  })

package/src/index.ts

@@ -1,5 +1,2 @@
-export type { Bucket, Experiment, UserAssignment } from './prisma-output'
-
 export * from './types'
-
 export { Abba } from './abba'

package/src/migrations/init.sql

@@ -0,0 +1,47 @@
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `Bucket` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `experimentId` INTEGER NOT NULL,
+    `key` VARCHAR(10) NOT NULL,
+    `ratio` INTEGER NOT NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `Experiment` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `name` VARCHAR(191) NOT NULL,
+    `status` INTEGER NOT NULL,
+    `sampling` INTEGER NOT NULL,
+    `description` VARCHAR(240) NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+    `rules` JSON NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `UserAssignment` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `userId` VARCHAR(191) NOT NULL,
+    `experimentId` INTEGER NOT NULL,
+    `bucketId` INTEGER NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+
+    UNIQUE INDEX `UserAssignment_userId_experimentId_key`(`userId`, `experimentId`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `Bucket` ADD CONSTRAINT `Bucket_experimentId_fkey` FOREIGN KEY (`experimentId`) REFERENCES `Experiment`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `UserAssignment` ADD CONSTRAINT `UserAssignment_bucketId_fkey` FOREIGN KEY (`bucketId`) REFERENCES `Bucket`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `UserAssignment` ADD CONSTRAINT `UserAssignment_experimentId_fkey` FOREIGN KEY (`experimentId`) REFERENCES `Experiment`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;

package/src/types.ts

@@ -1,16 +1,50 @@
-import { Bucket, Experiment } from './prisma-output'
+import { CommonDB } from '@naturalcycles/db-lib'
+import { BaseDBEntity, Saved } from '@naturalcycles/js-lib'
 
-export type Unsaved<T> = Omit<T, 'createdAt' | 'updatedAt'> & {
-  id?: number
+export interface AbbaConfig {
+  db: CommonDB
+
+  /**
+   * Determines for how long to cache "hot" requests.
+   * Caches in memory.
+   * Default is 10.
+   * Set to 0 to disable cache (every request will hit the DB).
+   */
+  // cacheMinutes?: number
+}
+
+export type BaseExperiment = BaseDBEntity<number> & {
+  name: string
+  status: number
+  sampling: number
+  description: string | null
 }
 
-export type ExperimentWithBuckets = Experiment & {
-  buckets: Bucket[]
+export type Experiment = BaseExperiment & {
+  rules: SegmentationRule[]
 }
 
-export type ExperimentInput = Unsaved<Experiment>
+export type ExperimentWithBuckets = Saved<Experiment> & {
+  buckets: Saved<Bucket>[]
+}
 
-export type BucketInput = Unsaved<Bucket>
+export interface BucketInput {
+  experimentId: number
+  key: string
+  ratio: number
+}
+
+export type Bucket = BaseDBEntity<number> & {
+  experimentId: number
+  key: string
+  ratio: number
+}
+
+export type UserAssignment = BaseDBEntity<number> & {
+  userId: string
+  experimentId: number
+  bucketId: number | null
+}
 
 export type SegmentationData = Record<string, string | boolean | number>