Overleaf/services/web/test/unit/src/SplitTests/SplitTestSessionHandlerTests.js

const Path = require('path')
const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
const { expect } = require('chai')
const { ObjectId } = require('mongodb-legacy')

const MODULE_PATH = Path.join(
  __dirname,
  '../../../../app/src/Features/SplitTests/SplitTestSessionHandler'
)

describe('SplitTestSessionHandler', function () {
  beforeEach(function () {
    this.SplitTestCache = {
      get: sinon.stub().resolves(),
    }
    this.SplitTestUserGetter = {}
    this.Metrics = {}

    this.SplitTestCache.get = sinon.stub().resolves(
      new Map(
        Object.entries({
          'anon-test-1': {
            _id: '661f92a4669764bb03f73e37',
            name: 'anon-test-1',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'enabled',
                  },
                ],
              },
            ],
          },
          'anon-test-2': {
            _id: '661f92a9d68ea711d6bf2df4',
            name: 'anon-test-2',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'v-1',
                  },
                  {
                    name: 'v-2',
                  },
                ],
              },
            ],
          },
        })
      )
    )

    this.SplitTestSessionHandler = SandboxedModule.require(MODULE_PATH, {
      requires: {
        './SplitTestCache': this.SplitTestCache,
        './SplitTestUserGetter': this.SplitTestUserGetter,
        '@overleaf/metrics': this.Metrics,
        'mongodb-legacy': { ObjectId },
      },
    })
  })

  it('should read from the splitTests field', async function () {
    const session = {
      splitTests: {
        'anon-test-1': [
          {
            variantName: 'default',
            versionNumber: 1,
            phase: 'release',
            assignedAt: new Date(1712872800000), // 2024-04-11 22:00:00
          },
        ],
        'anon-test-2': [
          {
            variantName: 'default',
            versionNumber: 1,
            phase: 'release',
            assignedAt: new Date(1712307600000), // 2024-04-05 09:00:00
          },
          {
            variantName: 'v-2',
            versionNumber: 2,
            phase: 'release',
            assignedAt: new Date(1712581200000), // 2024-04-08 13:00:00
          },
        ],
      },
      sta: ``,
    }

    const assignments =
      await this.SplitTestSessionHandler.promises.getAssignments(session)
    expect(assignments).to.deep.equal({
      'anon-test-1': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712872800000),
        },
      ],
      'anon-test-2': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712307600000),
        },
        {
          variantName: 'v-2',
          versionNumber: 2,
          phase: 'release',
          assignedAt: new Date(1712581200000),
        },
      ],
    })
  })

  it('should read from the sta field', async function () {
    this.SplitTestCache.get = sinon.stub().resolves(
      new Map(
        Object.entries({
          'anon-test-1': {
            _id: '661f92a4669764bb03f73e37',
            name: 'anon-test-1',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'enabled',
                  },
                ],
              },
            ],
          },
          'anon-test-2': {
            _id: '661f92a9d68ea711d6bf2df4',
            name: 'anon-test-2',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'v-1',
                  },
                  {
                    name: 'v-2',
                  },
                ],
              },
            ],
          },
        })
      )
    )
    const session = {
      sta: `Zh+SpGaXZLsD9z43_1=d:sbrvs0;Zh+SqdaOpxHWvy30_1=d:sbtqg0;Zh+SqdaOpxHWvy30_2=1:sbsi00`,
    }

    const assignments =
      await this.SplitTestSessionHandler.promises.getAssignments(session)
    expect(assignments).to.deep.equal({
      'anon-test-1': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712829600000),
        },
      ],
      'anon-test-2': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712916000000),
        },
        {
          variantName: 'v-2',
          versionNumber: 2,
          phase: 'release',
          assignedAt: new Date(1712858400000),
        },
      ],
    })
  })

  it('should deduplicate entries from the sta field', async function () {
    this.SplitTestCache.get = sinon.stub().resolves(
      new Map(
        Object.entries({
          'anon-test-1': {
            _id: '661f92a4669764bb03f73e37',
            name: 'anon-test-1',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'enabled',
                  },
                ],
              },
            ],
          },
          'anon-test-2': {
            _id: '661f92a9d68ea711d6bf2df4',
            name: 'anon-test-2',
            versions: [
              {
                versionNumber: 1,
                variants: [
                  {
                    name: 'v-1',
                  },
                  {
                    name: 'v-2',
                  },
                ],
              },
            ],
          },
        })
      )
    )
    const session = {
      sta: `Zh+SpGaXZLsD9z43_1=d:sbrvs0;Zh+SqdaOpxHWvy30_1=d:sbtqg0;Zh+SqdaOpxHWvy30_1=d:sbtqg0;Zh+SpGaXZLsD9z43_1=d:sbrvs0;Zh+SqdaOpxHWvy30_2=1:sbsi00;Zh+SqdaOpxHWvy30_1=d:sbtqg0`,
    }

    const assignments =
      await this.SplitTestSessionHandler.promises.getAssignments(session)
    expect(assignments).to.deep.equal({
      'anon-test-1': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712829600000),
        },
      ],
      'anon-test-2': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712916000000),
        },
        {
          variantName: 'v-2',
          versionNumber: 2,
          phase: 'release',
          assignedAt: new Date(1712858400000),
        },
      ],
    })
  })

  it('should merge assignments from both splitTests and sta fields', async function () {
    const session = {
      splitTests: {
        'anon-test-1': [
          {
            variantName: 'default',
            versionNumber: 1,
            phase: 'release',
            assignedAt: new Date(1712872800000),
          },
        ],
        'anon-test-2': [
          {
            variantName: 'default',
            versionNumber: 1,
            phase: 'release',
            assignedAt: new Date(1712307600000),
          },
        ],
      },
      sta: `Zh+SqdaOpxHWvy30_2=1:sbsi00`,
    }

    const assignments =
      await this.SplitTestSessionHandler.promises.getAssignments(session)
    expect(assignments).to.deep.equal({
      'anon-test-1': [
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712872800000),
        },
      ],
      'anon-test-2': [
        {
          variantName: 'v-2',
          versionNumber: 2,
          phase: 'release',
          assignedAt: new Date(1712858400000),
        },
        {
          variantName: 'default',
          versionNumber: 1,
          phase: 'release',
          assignedAt: new Date(1712307600000),
        },
      ],
    })
  })
})