File size: 8,747 Bytes
b2a00c5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | import {
AnnotationGranularity,
AnnotationType,
canAddAnnotation,
canEditAnnotation,
getAnnotationAuthorship,
getAnnotationGranularity,
getAnnotationTimeLabel,
groupAnnotationsByTimeLabel
} from './annotations'
import { Interval } from '../stats/graph/intervals'
import { Role, UserContextValue } from '../user-context'
const loggedInUser = (role: Role, id: number = 42): UserContextValue => ({
loggedIn: true,
id,
role,
team: { identifier: null, hasConsolidatedView: false }
})
const publicUser: UserContextValue = {
loggedIn: false,
id: null,
role: Role.public,
team: { identifier: null, hasConsolidatedView: false }
}
describe(`${getAnnotationAuthorship.name}`, () => {
it('returns the owner name for a site annotation with an owner', () => {
expect(
getAnnotationAuthorship({
type: AnnotationType.site,
owner_name: 'Alice'
})
).toBe('Alice')
})
it('returns "Site note" for a site annotation with a dangling owner', () => {
expect(
getAnnotationAuthorship({
type: AnnotationType.site,
owner_name: null
})
).toBe('Site note')
})
it('returns "Personal note" for a personal annotation regardless of owner (we assume personal notes are served only to the author)', () => {
expect(
getAnnotationAuthorship({
type: AnnotationType.personal,
owner_name: 'Alice'
})
).toBe('Personal note')
})
})
describe(`${canAddAnnotation.name}`, () => {
it.each([[Role.admin], [Role.editor], [Role.owner]])(
'allows adding a site annotation if the user is logged in, in role %p, and the site-annotations feature is available',
(role) => {
expect(
canAddAnnotation({
type: AnnotationType.site,
user: loggedInUser(role),
siteAnnotationsAvailable: true
})
).toBe(true)
}
)
it.each([[Role.admin], [Role.editor], [Role.owner]])(
'forbids adding a site annotation in role %p when the feature is unavailable (billing gate)',
(role) => {
expect(
canAddAnnotation({
type: AnnotationType.site,
user: loggedInUser(role),
siteAnnotationsAvailable: false
})
).toBe(false)
}
)
it.each([[Role.viewer], [Role.billing]])(
'forbids adding a site annotation in role %p even when the feature is available',
(role) => {
expect(
canAddAnnotation({
type: AnnotationType.site,
user: loggedInUser(role),
siteAnnotationsAvailable: true
})
).toBe(false)
}
)
it.each([
[Role.viewer],
[Role.billing],
[Role.editor],
[Role.admin],
[Role.owner]
])(
'allows adding a personal annotation in role %p regardless of site-annotations availability',
(role) => {
expect(
canAddAnnotation({
type: AnnotationType.personal,
user: loggedInUser(role),
siteAnnotationsAvailable: true
})
).toBe(true)
expect(
canAddAnnotation({
type: AnnotationType.personal,
user: loggedInUser(role),
siteAnnotationsAvailable: false
})
).toBe(true)
}
)
it.each([[AnnotationType.personal], [AnnotationType.site]])(
'forbids the public role from adding %s annotations',
(type) => {
expect(
canAddAnnotation({
type,
user: publicUser,
siteAnnotationsAvailable: true
})
).toBe(false)
}
)
})
describe(`${canEditAnnotation.name}`, () => {
it.each([[Role.admin], [Role.editor], [Role.owner]])(
'allows editing a site annotation if the user is logged in and in role %p',
(role) => {
expect(
canEditAnnotation({
type: AnnotationType.site,
user: loggedInUser(role)
})
).toBe(true)
}
)
it.each([[Role.viewer], [Role.billing]])(
'forbids editing site annotations in role %p',
(role) => {
expect(
canEditAnnotation({
type: AnnotationType.site,
user: loggedInUser(role)
})
).toBe(false)
}
)
it.each([
[Role.viewer],
[Role.billing],
[Role.editor],
[Role.admin],
[Role.owner]
])('allows editing a personal annotation when in role %p', (role) => {
expect(
canEditAnnotation({
type: AnnotationType.personal,
user: loggedInUser(role)
})
).toBe(true)
})
it.each([[AnnotationType.personal], [AnnotationType.site]])(
'forbids the public role from editing %s annotations',
(type) => {
expect(
canEditAnnotation({
type,
user: publicUser
})
).toBe(false)
}
)
})
describe(`${getAnnotationGranularity.name}`, () => {
it.each<[Interval, AnnotationGranularity]>([
[Interval.minute, AnnotationGranularity.minute],
[Interval.hour, AnnotationGranularity.minute],
[Interval.day, AnnotationGranularity.date],
[Interval.week, AnnotationGranularity.date],
[Interval.month, AnnotationGranularity.date]
])('maps interval %s to granularity %s', (interval, granularity) => {
expect(getAnnotationGranularity(interval)).toBe(granularity)
})
})
describe(`${getAnnotationTimeLabel.name}`, () => {
// 2025-02-26 is a Wednesday
const dateAnnotation = {
datetime: '2025-02-26',
granularity: AnnotationGranularity.date
}
it.each<[Interval, string]>([
[Interval.minute, '2025-02-26'],
[Interval.hour, '2025-02-26'],
[Interval.day, '2025-02-26'],
[Interval.week, '2025-02-24'],
[Interval.month, '2025-02-01']
])(
`date-granularity annotation on ${dateAnnotation.datetime} bucketed to %s yields %s`,
(interval, expected) => {
expect(getAnnotationTimeLabel(dateAnnotation, interval)).toBe(expected)
}
)
const minuteAnnotation = {
datetime: '2025-02-26T10:30:00',
granularity: AnnotationGranularity.minute
}
it.each<[Interval, string]>([
[Interval.month, '2025-02-01'],
[Interval.week, '2025-02-24'],
[Interval.day, '2025-02-26'],
[Interval.hour, '2025-02-26 10:00:00'],
[Interval.minute, '2025-02-26 10:30:00']
])(
`minute granularity annotation with datetime ${minuteAnnotation.datetime} bucketed to %s yields %s`,
(interval, expected) => {
expect(getAnnotationTimeLabel(minuteAnnotation, interval)).toBe(expected)
}
)
})
describe(`${groupAnnotationsByTimeLabel.name}`, () => {
const dateGranularity = AnnotationGranularity.date
const annotations = [
{ id: 1, datetime: '2025-02-24 00:00:00', granularity: dateGranularity }, // Mon
{ id: 2, datetime: '2025-02-26 00:00:00', granularity: dateGranularity }, // Wed (same week)
{ id: 3, datetime: '2025-03-05 00:00:00', granularity: dateGranularity } // following month
]
it('groups annotations by day when the interval is day', () => {
const grouped = groupAnnotationsByTimeLabel(annotations, Interval.day)
expect(Object.keys(grouped).sort()).toEqual([
'2025-02-24',
'2025-02-26',
'2025-03-05'
])
expect(grouped['2025-02-24']!.map((a) => a.id)).toEqual([1])
expect(grouped['2025-02-26']!.map((a) => a.id)).toEqual([2])
expect(grouped['2025-03-05']!.map((a) => a.id)).toEqual([3])
})
it('collapses annotations from the same week into one bucket', () => {
const grouped = groupAnnotationsByTimeLabel(annotations, Interval.week)
expect(Object.keys(grouped).sort()).toEqual(['2025-02-24', '2025-03-03'])
expect(grouped['2025-02-24']!.map((a) => a.id)).toEqual([1, 2])
expect(grouped['2025-03-03']!.map((a) => a.id)).toEqual([3])
})
it('collapses annotations from the same month into one bucket', () => {
const grouped = groupAnnotationsByTimeLabel(annotations, Interval.month)
expect(Object.keys(grouped).sort()).toEqual(['2025-02-01', '2025-03-01'])
expect(grouped['2025-02-01']!.map((a) => a.id)).toEqual([1, 2])
expect(grouped['2025-03-01']!.map((a) => a.id)).toEqual([3])
})
it('preserves insertion order within a bucket', () => {
const sameDay = [
{ id: 10, datetime: '2025-02-26 08:00:00', granularity: dateGranularity },
{ id: 11, datetime: '2025-02-26 09:00:00', granularity: dateGranularity },
{ id: 12, datetime: '2025-02-26 10:00:00', granularity: dateGranularity }
]
const grouped = groupAnnotationsByTimeLabel(sameDay, Interval.day)
expect(grouped['2025-02-26']!.map((a) => a.id)).toEqual([10, 11, 12])
})
it('returns an empty object when there are no annotations', () => {
expect(
groupAnnotationsByTimeLabel(
[] as { datetime: string; granularity: AnnotationGranularity }[],
Interval.day
)
).toEqual({})
})
})
|