Merge pull request #4346 from overleaf/ab-configurable-split-test-2

Configurable Split Tests GitOrigin-RevId: e648a77848ddb8b8b55a95887f87cf7cdd300ee9
2021-07-28 12:36:27 +00:00
parent 9468e5cb4f
commit 51546b29c4
7 changed files with 797 additions and 3 deletions
@@ -0,0 +1,111 @@
+const mongoose = require('../infrastructure/Mongoose')
+const { Schema } = mongoose
+const _ = require('lodash')
+
+const MIN_NAME_LENGTH = 3
+const MAX_NAME_LENGTH = 200
+const MIN_VARIANT_NAME_LENGTH = 3
+const MAX_VARIANT_NAME_LENGTH = 255
+const NAME_REGEX = /^[a-zA-Z0-9\-_]+$/
+
+const RolloutPercentType = {
+  type: Number,
+  default: 0,
+  min: [0, 'Rollout percentage must be between 0 and 100, got {VALUE}'],
+  max: [100, 'Rollout percentage must be between 0 and 100, got {VALUE}'],
+  required: true,
+}
+
+const VariantSchema = new Schema(
+  {
+    name: {
+      type: String,
+      minLength: MIN_VARIANT_NAME_LENGTH,
+      maxLength: MAX_VARIANT_NAME_LENGTH,
+      required: true,
+      validate: {
+        validator: function (input) {
+          return input !== null && input !== 'default' && NAME_REGEX.test(input)
+        },
+        message: `invalid, cannot be 'default' and must match: ${NAME_REGEX}, got {VALUE}`,
+      },
+    },
+    active: {
+      type: Boolean,
+      default: true,
+      required: true,
+    },
+    rolloutPercent: RolloutPercentType,
+    rolloutStripes: [
+      {
+        start: RolloutPercentType,
+        end: RolloutPercentType,
+      },
+    ],
+  },
+  { _id: false }
+)
+
+const VersionSchema = new Schema(
+  {
+    versionNumber: {
+      type: Number,
+      default: 1,
+      min: [1, 'must be 1 or higher, got {VALUE}'],
+      required: true,
+    },
+    phase: {
+      type: String,
+      default: 'alpha',
+      enum: ['alpha', 'beta', 'release'],
+      required: true,
+    },
+    active: {
+      type: Boolean,
+      default: true,
+      required: true,
+    },
+    variants: [VariantSchema],
+  },
+  { _id: false }
+)
+
+const SplitTestSchema = new Schema({
+  name: {
+    type: String,
+    minLength: MIN_NAME_LENGTH,
+    maxlength: MAX_NAME_LENGTH,
+    required: true,
+    unique: true,
+    validate: {
+      validator: function (input) {
+        return input !== null && NAME_REGEX.test(input)
+      },
+      message: `invalid, must match: ${NAME_REGEX}`,
+    },
+  },
+  versions: [VersionSchema],
+  forbidReleasePhase: {
+    type: Boolean,
+    required: false,
+  },
+})
+
+SplitTestSchema.methods.getCurrentVersion = function () {
+  if (this.versions && this.versions.length > 0) {
+    return _.maxBy(this.versions, 'versionNumber')
+  } else {
+    return undefined
+  }
+}
+
+SplitTestSchema.methods.getVersion = function (versionNumber) {
+  return _.find(this.versions || [], {
+    versionNumber,
+  })
+}
+
+module.exports = {
+  SplitTest: mongoose.model('SplitTest', SplitTestSchema),
+  SplitTestSchema,
+}