Files
overleaf-cep/services/web/test/frontend/shared/utils/parse-mentions.test.ts
T
Kristina f179e89c0c [web] add analytics for @mentions (#36144)
GitOrigin-RevId: 9fb1447166eb5ee82867466abc9af2207c886f8b
2026-09-17 11:47:22 +00:00

166 lines
5.8 KiB
TypeScript

import { expect } from 'chai'
import {
countMentionedUsers,
parseMentions,
sliceMentionSegments,
} from '@/shared/utils/parse-mentions'
import { UserId } from '@ol-types/user'
describe('parseMentions', function () {
it('should return a single text segment for plain text', function () {
expect(parseMentions('hello world')).to.deep.equal([
{ type: 'text', value: 'hello world' },
])
})
it('should return an empty array for an empty string', function () {
expect(parseMentions('')).to.deep.equal([])
})
it('should parse a single mention', function () {
const userId = 'aabbccddeeff00112233aabb' as UserId
expect(parseMentions(`@[${userId}]`)).to.deep.equal([
{ type: 'mention', userId },
])
})
it('should parse text before and after a mention', function () {
const userId = 'aabbccddeeff00112233aabb' as UserId
expect(parseMentions(`hey @[${userId}] check this`)).to.deep.equal([
{ type: 'text', value: 'hey ' },
{ type: 'mention', userId },
{ type: 'text', value: ' check this' },
])
})
it('should parse multiple mentions', function () {
const userId1 = 'aabbccddeeff00112233aabb' as UserId
const userId2 = '112233445566778899aabbcc' as UserId
expect(parseMentions(`@[${userId1}] and @[${userId2}]`)).to.deep.equal([
{ type: 'mention', userId: userId1 },
{ type: 'text', value: ' and ' },
{ type: 'mention', userId: userId2 },
])
})
it('should not match bare @userId without brackets', function () {
expect(parseMentions('@aabbccddeeff00112233aabb')).to.deep.equal([
{ type: 'text', value: '@aabbccddeeff00112233aabb' },
])
})
it('should not match @[...] with non-hex characters', function () {
expect(parseMentions('@[gghhiijjkkllmmnnooppqqrr]')).to.deep.equal([
{ type: 'text', value: '@[gghhiijjkkllmmnnooppqqrr]' },
])
})
it('should not match @[...] with wrong length', function () {
expect(parseMentions('@[aabbcc]')).to.deep.equal([
{ type: 'text', value: '@[aabbcc]' },
])
})
it('should handle adjacent mentions with no text between', function () {
const userId1 = 'aabbccddeeff00112233aabb' as UserId
const userId2 = '112233445566778899aabbcc' as UserId
expect(parseMentions(`@[${userId1}]@[${userId2}]`)).to.deep.equal([
{ type: 'mention', userId: userId1 },
{ type: 'mention', userId: userId2 },
])
})
it('should handle a truncated mention as plain text', function () {
expect(parseMentions('@[aabbccddeeff001122')).to.deep.equal([
{ type: 'text', value: '@[aabbccddeeff001122' },
])
})
})
describe('countMentionedUsers', function () {
const userId1 = 'aabbccddeeff00112233aabb' as UserId
const userId2 = '112233445566778899aabbcc' as UserId
it('should return 0 for content without mentions', function () {
expect(countMentionedUsers('hello world')).to.equal(0)
})
it('should count a single mention', function () {
expect(countMentionedUsers(`hey @[${userId1}]`)).to.equal(1)
})
it('should count distinct mentioned users', function () {
expect(countMentionedUsers(`@[${userId1}] and @[${userId2}]`)).to.equal(2)
})
it('should count a repeated user only once', function () {
expect(countMentionedUsers(`@[${userId1}] @[${userId1}]`)).to.equal(1)
})
it('should ignore malformed mentions', function () {
expect(countMentionedUsers('@[aabbcc] @aabbccddeeff00112233aabb')).to.equal(
0
)
})
})
describe('sliceMentionSegments', function () {
const userId = 'aabbccddeeff00112233aabb' as UserId
it('should return all segments when under the limit', function () {
const segments = parseMentions(`hi @[${userId}]`)
const result = sliceMentionSegments(segments, 100)
expect(result).to.deep.equal(segments)
})
it('should truncate a text segment at the limit', function () {
const segments = parseMentions('hello world')
const result = sliceMentionSegments(segments, 5)
expect(result).to.deep.equal([{ type: 'text', value: 'hello' }])
})
it('should drop a mention that crosses the limit', function () {
const segments = parseMentions(`hey @[${userId}]`)
// "hey " = 4 chars, mention = 27 chars raw; limit 10 leaves only 6 for mention
const result = sliceMentionSegments(segments, 10)
expect(result).to.deep.equal([{ type: 'text', value: 'hey ' }])
})
it('should include a mention that fits exactly', function () {
const segments = parseMentions(`hey @[${userId}]`)
// "hey " = 4 chars, mention = 27 chars; limit = 31
const result = sliceMentionSegments(segments, 31)
expect(result).to.deep.equal(segments)
})
it('should return empty array when limit is 0', function () {
const segments = parseMentions('hello')
const result = sliceMentionSegments(segments, 0)
expect(result).to.deep.equal([])
})
it('should handle a mention as the first segment', function () {
const segments = parseMentions(`@[${userId}] done`)
// mention = 27 chars; limit 27 fits the mention but not " done"
const result = sliceMentionSegments(segments, 27)
expect(result).to.deep.equal([{ type: 'mention', userId }])
})
it('should drop a leading mention that does not fit', function () {
const segments = parseMentions(`@[${userId}] done`)
const result = sliceMentionSegments(segments, 10)
expect(result).to.deep.equal([])
})
it('should handle multiple segments with truncation mid-text', function () {
const userId2 = '112233445566778899aabbcc' as UserId
const segments = parseMentions(`@[${userId}] and @[${userId2}]`)
// mention(27) + " and "(5) = 32; limit 35 leaves 3 chars but mention needs 27
const result = sliceMentionSegments(segments, 35)
expect(result).to.deep.equal([
{ type: 'mention', userId },
{ type: 'text', value: ' and ' },
])
})
})