@naturalcycles/abba 1.7.0 → 1.9.1

package/dist/abba.d.ts

@@ -1,102 +1,75 @@
-import { UserAssignment } from './prisma-output';
-import { BucketInput, ExperimentWithBuckets, ExperimentInput, SegmentationData, AssignmentStatistics } from '.';
+import { Saved } from '@naturalcycles/js-lib';
+import { AbbaConfig, Bucket, BucketInput, Experiment, ExperimentWithBuckets, UserAssignment } from './types';
+import { SegmentationData, AssignmentStatistics } from '.';
 export declare class Abba {
-    private client;
-    constructor(dbUrl?: string);
+    cfg: AbbaConfig;
+    constructor(cfg: AbbaConfig);
+    private experimentDao;
+    private bucketDao;
+    private userAssignmentDao;
     /**
-     * Returns all experiments
+     * Returns all (active and inactive) experiments.
      *
-     * @returns
+     * Cold method, not cached.
      */
-    getAllExperiments(excludeInactive?: boolean): Promise<ExperimentWithBuckets[]>;
+    getAllExperiments(): Promise<ExperimentWithBuckets[]>;
     /**
-     * Creates a new experiment
-     *
-     * @param experiment
-     * @param buckets
-     * @returns
+     * Returns only active experiments.
+     * Hot method.
+     * Cached in-memory for N minutes (currently 10).
      */
-    createExperiment(experiment: ExperimentInput, buckets: BucketInput[]): Promise<ExperimentWithBuckets>;
+    getActiveExperiments(): Promise<ExperimentWithBuckets[]>;
     /**
-     * Update experiment information, will also validate the buckets ratio if experiment.active is true
-     *
-     * @param id
-     * @param experiment
-     * @param rules
-     * @param buckets
-     * @returns
+     * Creates a new experiment.
+     * Cold method.
      */
-    saveExperiment(id: number, experiment: ExperimentInput, buckets: BucketInput[]): Promise<ExperimentWithBuckets>;
+    createExperiment(experiment: Experiment, buckets: BucketInput[]): Promise<ExperimentWithBuckets>;
     /**
-     * Delete an experiment. Removes all user assignments and buckets
-     *
-     * @param id
+     * Update experiment information, will also validate the buckets' ratio if experiment.active is true
+     * Cold method.
+     */
+    saveExperiment(experiment: Experiment & {
+        id: number;
+    }, buckets: Bucket[]): Promise<ExperimentWithBuckets>;
+    /**
+     * Delete an experiment. Removes all user assignments and buckets.
+     * Cold method.
      */
     deleteExperiment(id: number): Promise<void>;
     /**
-     * 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
      */
-    getUserAssignment(experimentId: number, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<UserAssignment | null>;
+    getUserAssignment(experimentId: number, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<Saved<UserAssignment> | null>;
     /**
-     * Get all existing user assignments
-     *
-     * @param userId G
-     * @returns
+     * Get all existing user assignments.
+     * Hot method.
+     * Not cached, because Assignments are fast-changing.
      */
-    getAllExistingUserAssignments(userId: string): Promise<UserAssignment[]>;
+    getAllExistingUserAssignments(userId: string): Promise<Saved<UserAssignment>[]>;
     /**
-     * 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.
      */
-    generateUserAssignments(userId: string, segmentationData: SegmentationData): Promise<UserAssignment[]>;
+    generateUserAssignments(userId: string, segmentationData: SegmentationData): Promise<Saved<UserAssignment>[]>;
     /**
-     * Get assignment statistics for an experiment
-     *
-     * @param experimentId
-     * @returns
+     * Get assignment statistics for an experiment.
+     * Cold method.
      */
     getExperimentAssignmentStatistics(experimentId: number): Promise<AssignmentStatistics>;
     /**
-     * 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 generateUserAssignment;
+    private generateUserAssignmentData;
     /**
      * Queries to retrieve an existing user assignment for a given experiment
-     *
-     * @param experimentId
-     * @param userId
-     * @returns
      */
     private getExistingUserAssignment;
-    /**
-     * Update experiment information
-     *
-     * @param id
-     * @param experiment
-     * @param rules
-     * @returns
-     */
-    private updateExperiment;
-    /**
-     * Upserts bucket info
-     *
-     * @param id
-     * @param experiment
-     * @returns
-     */
-    private saveBuckets;
 }

package/dist/abba.js

@@ -1,245 +1,199 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Abba = void 0;
-const prisma_output_1 = require("./prisma-output");
+const tslib_1 = require("tslib");
+const js_lib_1 = require("@naturalcycles/js-lib");
+const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const types_1 = require("./types");
 const util_1 = require("./util");
-// 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 experiment_dao_1 = require("./dao/experiment.dao");
+const userAssignment_dao_1 = require("./dao/userAssignment.dao");
+const bucket_dao_1 = require("./dao/bucket.dao");
+const CACHE_TTL = 600000; // 10 minutes
 class Abba {
-    constructor(dbUrl) {
-        this.client = new prisma_output_1.PrismaClient({
-            datasources: {
-                db: {
-                    url: dbUrl,
-                },
-            },
-        });
+    constructor(cfg) {
+        this.cfg = cfg;
+        const { db } = cfg;
+        this.experimentDao = (0, experiment_dao_1.experimentDao)(db);
+        this.bucketDao = (0, bucket_dao_1.bucketDao)(db);
+        this.userAssignmentDao = (0, userAssignment_dao_1.userAssignmentDao)(db);
     }
     /**
-     * Returns all experiments
+     * Returns all (active and inactive) experiments.
      *
-     * @returns
+     * Cold method, not cached.
      */
-    async getAllExperiments(excludeInactive = false) {
-        return await this.client.experiment.findMany({
-            where: excludeInactive ? { NOT: { status: types_1.AssignmentStatus.Inactive } } : undefined,
-            include: { buckets: true },
-        });
+    async getAllExperiments() {
+        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).
+     */
+    async getActiveExperiments() {
+        const experiments = await this.experimentDao
+            .query()
+            .filter('status', '!=', types_1.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, buckets) {
         if (experiment.status === types_1.AssignmentStatus.Active) {
             (0, util_1.validateTotalBucketRatio)(buckets);
         }
-        const created = await this.client.experiment.create({
-            data: {
-                ...experiment,
-                rules: experiment.rules,
-                buckets: {
-                    createMany: {
-                        data: buckets,
-                    },
-                },
-            },
-            include: {
-                buckets: true,
-            },
-        });
-        return created;
+        await this.experimentDao.save(experiment);
+        return {
+            ...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, experiment, buckets) {
+    async saveExperiment(experiment, buckets) {
         if (experiment.status === types_1.AssignmentStatus.Active) {
             (0, util_1.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,
+            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) {
-        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, userId, existingOnly, segmentationData) {
-        const experiment = await this.client.experiment.findUnique({
-            where: { id: experimentId },
-            include: { buckets: true },
-        });
-        if (!experiment)
-            throw new Error('Experiment not found');
         const existing = await this.getExistingUserAssignment(experimentId, userId);
         if (existing)
             return existing;
-        if (experiment.status !== types_1.AssignmentStatus.Active || existingOnly)
+        if (existingOnly)
+            return null;
+        const experiment = await this.experimentDao.requireById(experimentId);
+        if (experiment.status !== types_1.AssignmentStatus.Active)
+            return null;
+        (0, js_lib_1._assert)(segmentationData, 'Segmentation data required when creating a new assignment');
+        const buckets = await this.bucketDao.getBy('experimentId', experimentId);
+        const assignment = this.generateUserAssignmentData({ ...experiment, buckets }, userId, segmentationData);
+        if (!assignment)
             return null;
-        if (!segmentationData)
-            throw new Error('Segmentation data required when creating a new assignment');
-        return await this.generateUserAssignment(experiment, userId, segmentationData);
+        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) {
-        return await this.client.userAssignment.findMany({ where: { userId } });
+        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, segmentationData) {
-        const experiments = await this.getAllExperiments(true);
+        const experiments = await this.getActiveExperiments(); // cached
         const existingAssignments = await this.getAllExistingUserAssignments(userId);
-        const assignments = [];
+        const allAssignments = [];
         const generatedAssignments = [];
         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 !== null);
-        return [...assignments, ...filtered];
+        await this.userAssignmentDao.saveBatch(generatedAssignments);
+        return [...allAssignments, ...generatedAssignments];
     }
     /**
-     * Get assignment statistics for an experiment
-     *
-     * @param experimentId
-     * @returns
+     * Get assignment statistics for an experiment.
+     * Cold method.
      */
     async getExperimentAssignmentStatistics(experimentId) {
         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 (0, js_lib_1.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.
      */
-    async generateUserAssignment(experiment, userId, segmentationData) {
+    generateUserAssignmentData(experiment, userId, segmentationData) {
         const segmentationMatch = (0, util_1.validateSegmentationRules)(experiment.rules, segmentationData);
         if (!segmentationMatch)
             return null;
-        const bucketId = (0, util_1.determineAssignment)(experiment.sampling, experiment.buckets);
-        return await this.client.userAssignment.create({
-            data: { userId, experimentId: experiment.id, bucketId },
-        });
+        return {
+            userId,
+            experimentId: experiment.id,
+            bucketId: (0, util_1.determineAssignment)(experiment.sampling, experiment.buckets),
+        };
     }
     /**
      * Queries to retrieve an existing user assignment for a given experiment
-     *
-     * @param experimentId
-     * @param userId
-     * @returns
      */
     async getExistingUserAssignment(experimentId, userId) {
-        return await this.client.userAssignment.findFirst({ where: { userId, experimentId } });
-    }
-    /**
-     * Update experiment information
-     *
-     * @param id
-     * @param experiment
-     * @param rules
-     * @returns
-     */
-    async updateExperiment(id, experiment) {
-        return await this.client.experiment.update({
-            where: { id },
-            data: {
-                ...experiment,
-                rules: experiment.rules,
-            },
-        });
-    }
-    /**
-     * Upserts bucket info
-     *
-     * @param id
-     * @param experiment
-     * @returns
-     */
-    async saveBuckets(buckets) {
-        const savedBuckets = [];
-        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,
-                            },
-                        },
-                    },
-                }));
-            }
-        }
-        return await Promise.all(savedBuckets);
+        const [assignment] = await this.userAssignmentDao
+            .query()
+            .filterEq('userId', userId)
+            .filterEq('experimentId', experimentId)
+            .runQuery();
+        return assignment || null;
     }
 }
+tslib_1.__decorate([
+    (0, js_lib_1._AsyncMemo)({ cacheFactory: () => new nodejs_lib_1.LRUMemoCache({ ttl: CACHE_TTL, max: 1 }) })
+], Abba.prototype, "getActiveExperiments", null);
 exports.Abba = Abba;

package/dist/dao/bucket.dao.d.ts

@@ -0,0 +1,5 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { Bucket } from '../types';
+export declare class BucketDao extends CommonDao<Bucket> {
+}
+export declare const bucketDao: (db: CommonDB) => BucketDao;

package/dist/dao/bucket.dao.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bucketDao = exports.BucketDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class BucketDao extends db_lib_1.CommonDao {
+}
+exports.BucketDao = BucketDao;
+const bucketDao = (db) => new BucketDao({
+    db,
+    table: 'Bucket',
+    createId: false,
+    idType: 'number',
+    assignGeneratedIds: true,
+});
+exports.bucketDao = bucketDao;

package/dist/dao/experiment.dao.d.ts

@@ -0,0 +1,10 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { Saved } from '@naturalcycles/js-lib';
+import { BaseExperiment, Experiment } from '../types';
+declare type ExperimentDBM = Saved<BaseExperiment> & {
+    rules: string | null;
+};
+export declare class ExperimentDao extends CommonDao<Experiment, ExperimentDBM> {
+}
+export declare const experimentDao: (db: CommonDB) => ExperimentDao;
+export {};

package/dist/dao/experiment.dao.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.experimentDao = exports.ExperimentDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class ExperimentDao extends db_lib_1.CommonDao {
+}
+exports.ExperimentDao = ExperimentDao;
+const experimentDao = (db) => new ExperimentDao({
+    db,
+    table: 'Experiment',
+    createId: false,
+    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)) || [] }),
+    },
+});
+exports.experimentDao = experimentDao;

package/dist/dao/userAssignment.dao.d.ts

@@ -0,0 +1,5 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { UserAssignment } from '../types';
+export declare class UserAssignmentDao extends CommonDao<UserAssignment> {
+}
+export declare const userAssignmentDao: (db: CommonDB) => UserAssignmentDao;

package/dist/dao/userAssignment.dao.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userAssignmentDao = exports.UserAssignmentDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class UserAssignmentDao extends db_lib_1.CommonDao {
+}
+exports.UserAssignmentDao = UserAssignmentDao;
+const userAssignmentDao = (db) => new UserAssignmentDao({
+    db,
+    table: 'UserAssignment',
+    createId: false,
+    idType: 'number',
+    assignGeneratedIds: true,
+});
+exports.userAssignmentDao = userAssignmentDao;

package/dist/index.d.ts

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

package/dist/index.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Abba = void 0;
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./types"), exports);
+tslib_1.__exportStar(require("./types"), exports);
 var abba_1 = require("./abba");
 Object.defineProperty(exports, "Abba", { enumerable: true, get: function () { return abba_1.Abba; } });

package/dist/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;