atproto/packages/bsky/tests/views/notifications.test.ts
rafael be800369c5
Notification cursor delay (#3573)
* Use ISO 8601 datetime string as notif list cursor

* Refactor pagination functions to methods

* Implement configurable notification delay

* Add comment

* Apply PR suggestions

* Implement suggestions

* Properly synchronize notification delay test

* Simplify date validation logic
2025-02-28 17:35:43 -03:00

694 lines
20 KiB
TypeScript

import { AtpAgent } from '@atproto/api'
import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
import { delayCursor } from '../../src/api/app/bsky/notification/listNotifications'
import { ids } from '../../src/lexicon/lexicons'
import { Notification } from '../../src/lexicon/types/app/bsky/notification/listNotifications'
import { forSnapshot, paginateAll } from '../_util'
describe('notification views', () => {
let network: TestNetwork
let agent: AtpAgent
let sc: SeedClient
// account dids, for convenience
let alice: string
beforeAll(async () => {
network = await TestNetwork.create({
dbPostgresSchema: 'bsky_views_notifications',
})
agent = network.bsky.getClient()
sc = network.getSeedClient()
await basicSeed(sc)
await network.processAll()
alice = sc.dids.alice
})
afterAll(async () => {
await network.close()
})
const sort = (notifs: Notification[]) => {
// Need to sort because notification ordering is not well-defined
return notifs.sort((a, b) => {
const stableUriA = a.uri.replace(
/\/did:plc:.+?\//,
`/${a.author.handle}/`,
)
const stableUriB = b.uri.replace(
/\/did:plc:.+?\//,
`/${b.author.handle}/`,
)
if (stableUriA === stableUriB) {
return a.indexedAt > b.indexedAt ? -1 : 1
}
return stableUriA > stableUriB ? -1 : 1
})
}
it('fetches notification count without a last-seen', async () => {
const notifCountAlice =
await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
expect(notifCountAlice.data.count).toBe(12)
const notifCountBob = await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
sc.dids.bob,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
expect(notifCountBob.data.count).toBeGreaterThanOrEqual(3)
})
it('generates notifications for all reply ancestors', async () => {
// Add to reply chain, post ancestors: alice -> bob -> alice -> carol.
// Should have added one notification for each of alice and bob.
await sc.reply(
sc.dids.carol,
sc.posts[alice][1].ref,
sc.replies[alice][0].ref,
'indeed',
)
await network.processAll()
const notifCountAlice =
await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
expect(notifCountAlice.data.count).toBe(13)
const notifCountBob = await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
sc.dids.bob,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
expect(notifCountBob.data.count).toBeGreaterThanOrEqual(4)
})
it('does not give notifs for a deleted subject', async () => {
const root = await sc.post(sc.dids.alice, 'root')
const first = await sc.reply(sc.dids.bob, root.ref, root.ref, 'first')
await sc.deletePost(sc.dids.alice, root.ref.uri)
const second = await sc.reply(sc.dids.carol, root.ref, first.ref, 'second')
await network.processAll()
const notifsAlice = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
sc.dids.alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const hasNotif = notifsAlice.data.notifications.some(
(notif) => notif.uri === second.ref.uriStr,
)
expect(hasNotif).toBe(false)
// cleanup
await sc.deletePost(sc.dids.bob, first.ref.uri)
await sc.deletePost(sc.dids.carol, second.ref.uri)
await network.processAll()
})
it('generates notifications for quotes', async () => {
// Dan was quoted by alice
const notifsDan = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
sc.dids.dan,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(forSnapshot(sort(notifsDan.data.notifications))).toMatchSnapshot()
})
it('fetches notifications without a last-seen', async () => {
const notifRes = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const notifs = notifRes.data.notifications
expect(notifs.length).toBe(13)
const readStates = notifs.map((notif) => notif.isRead)
expect(readStates).toEqual(notifs.map((_, i) => i !== 0)) // only first appears unread
expect(forSnapshot(sort(notifs))).toMatchSnapshot()
})
it('paginates', async () => {
const results = (results) =>
sort(results.flatMap((res) => res.notifications))
const paginator = async (cursor?: string) => {
const res = await agent.api.app.bsky.notification.listNotifications(
{ cursor, limit: 6 },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
return res.data
}
const paginatedAll = await paginateAll(paginator)
paginatedAll.forEach((res) =>
expect(res.notifications.length).toBeLessThanOrEqual(6),
)
const full = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(full.data.notifications.length).toEqual(13)
expect(results(paginatedAll)).toEqual(results([full.data]))
})
it('fetches notification count with a last-seen', async () => {
const full = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const seenAt = full.data.notifications[3].indexedAt
await agent.api.app.bsky.notification.updateSeen(
{ seenAt },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationUpdateSeen,
),
encoding: 'application/json',
},
)
const full2 = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(full2.data.notifications.length).toBe(full.data.notifications.length)
expect(full2.data.seenAt).toEqual(seenAt)
const notifCount = await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
expect(notifCount.data.count).toBe(
full.data.notifications.filter((n) => n.indexedAt > seenAt).length,
)
expect(notifCount.data.count).toBeGreaterThan(0)
// reset last-seen
await agent.api.app.bsky.notification.updateSeen(
{ seenAt: new Date(0).toISOString() },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationUpdateSeen,
),
encoding: 'application/json',
},
)
})
it('fetches notifications with a last-seen', async () => {
const full = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const seenAt = full.data.notifications[3].indexedAt
await agent.api.app.bsky.notification.updateSeen(
{ seenAt },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationUpdateSeen,
),
encoding: 'application/json',
},
)
const notifRes = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const notifs = notifRes.data.notifications
expect(notifs.length).toBe(13)
const readStates = notifs.map((notif) => notif.isRead)
expect(readStates).toEqual(notifs.map((n) => n.indexedAt < seenAt))
// reset last-seen
await agent.api.app.bsky.notification.updateSeen(
{ seenAt: new Date(0).toISOString() },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationUpdateSeen,
),
encoding: 'application/json',
},
)
})
it('fetches notifications omitting mentions and replies for taken-down posts', async () => {
const postRef1 = sc.replies[sc.dids.carol][0].ref // Reply
const postRef2 = sc.posts[sc.dids.dan][1].ref // Mention
await Promise.all(
[postRef1, postRef2].map((postRef) =>
network.bsky.ctx.dataplane.takedownRecord({
recordUri: postRef.uriStr,
}),
),
)
const notifRes = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
const notifCount = await agent.api.app.bsky.notification.getUnreadCount(
{},
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationGetUnreadCount,
),
},
)
const notifs = sort(notifRes.data.notifications)
expect(notifs.length).toBe(11)
expect(forSnapshot(notifs)).toMatchSnapshot()
expect(notifCount.data.count).toBe(11)
// Cleanup
await Promise.all(
[postRef1, postRef2].map((postRef) =>
network.bsky.ctx.dataplane.untakedownRecord({
recordUri: postRef.uriStr,
}),
),
)
})
it('fetches notifications with explicit priority', async () => {
const priority = await agent.api.app.bsky.notification.listNotifications(
{ priority: true },
{
headers: await network.serviceHeaders(
sc.dids.carol,
ids.AppBskyNotificationListNotifications,
),
},
)
// only notifs from follow (alice)
expect(
priority.data.notifications.every(
(notif) => ![sc.dids.bob, sc.dids.dan].includes(notif.author.did),
),
).toBe(true)
expect(forSnapshot(priority.data)).toMatchSnapshot()
const noPriority = await agent.api.app.bsky.notification.listNotifications(
{ priority: false },
{
headers: await network.serviceHeaders(
sc.dids.carol,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(forSnapshot(noPriority.data)).toMatchSnapshot()
})
it('fetches notifications with default priority', async () => {
await agent.api.app.bsky.notification.putPreferences(
{ priority: true },
{
encoding: 'application/json',
headers: await network.serviceHeaders(
sc.dids.carol,
ids.AppBskyNotificationPutPreferences,
),
},
)
await network.processAll()
const notifs = await agent.api.app.bsky.notification.listNotifications(
{},
{
headers: await network.serviceHeaders(
sc.dids.carol,
ids.AppBskyNotificationListNotifications,
),
},
)
// only notifs from follow (alice)
expect(
notifs.data.notifications.every(
(notif) => ![sc.dids.bob, sc.dids.dan].includes(notif.author.did),
),
).toBe(true)
expect(forSnapshot(notifs.data)).toMatchSnapshot()
await agent.api.app.bsky.notification.putPreferences(
{ priority: false },
{
encoding: 'application/json',
headers: await network.serviceHeaders(
sc.dids.carol,
ids.AppBskyNotificationPutPreferences,
),
},
)
await network.processAll()
})
it('filters notifications by reason', async () => {
const res = await agent.app.bsky.notification.listNotifications(
{
reasons: ['mention'],
},
{
headers: await network.serviceHeaders(
sc.dids.alice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(res.data.notifications.length).toBe(1)
expect(forSnapshot(res.data)).toMatchSnapshot()
})
it('filters notifications by multiple reasons', async () => {
const res = await agent.app.bsky.notification.listNotifications(
{
reasons: ['mention', 'reply'],
},
{
headers: await network.serviceHeaders(
sc.dids.alice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(res.data.notifications.length).toBe(4)
expect(forSnapshot(res.data)).toMatchSnapshot()
})
it('paginates filtered notifications', async () => {
const results = (results) =>
sort(results.flatMap((res) => res.notifications))
const paginator = async (cursor?: string) => {
const res = await agent.app.bsky.notification.listNotifications(
{ reasons: ['mention', 'reply'], cursor, limit: 2 },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
return res.data
}
const paginatedAll = await paginateAll(paginator)
paginatedAll.forEach((res) =>
expect(res.notifications.length).toBeLessThanOrEqual(2),
)
const full = await agent.app.bsky.notification.listNotifications(
{ reasons: ['mention', 'reply'] },
{
headers: await network.serviceHeaders(
alice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(full.data.notifications.length).toBe(4)
expect(results(paginatedAll)).toEqual(results([full.data]))
})
describe('notifications delay', () => {
const notificationsDelayMs = 5_000
let delayNetwork: TestNetwork
let delayAgent: AtpAgent
let delaySc: SeedClient
let delayAlice: string
beforeAll(async () => {
delayNetwork = await TestNetwork.create({
bsky: {
notificationsDelayMs,
},
dbPostgresSchema: 'bsky_views_notifications_delay',
})
delayAgent = delayNetwork.bsky.getClient()
delaySc = delayNetwork.getSeedClient()
await basicSeed(delaySc)
await delayNetwork.processAll()
delayAlice = delaySc.dids.alice
// Add to reply chain, post ancestors: alice -> bob -> alice -> carol.
// Should have added one notification for each of alice and bob.
await delaySc.reply(
delaySc.dids.carol,
delaySc.posts[delayAlice][1].ref,
delaySc.replies[delayAlice][0].ref,
'indeed',
)
await delayNetwork.processAll()
// @NOTE: Use fake timers after inserting seed data,
// to avoid inserting all notifications with the same timestamp.
jest.useFakeTimers({
doNotFake: [
'nextTick',
'performance',
'setImmediate',
'setInterval',
'setTimeout',
],
})
})
afterAll(async () => {
jest.useRealTimers()
await delayNetwork.close()
})
it('paginates', async () => {
const firstNotification = await delayNetwork.bsky.db.db
.selectFrom('notification')
.selectAll()
.limit(1)
.orderBy('sortAt', 'asc')
.executeTakeFirstOrThrow()
// Sets the system time to when the first notification happened.
// At this point we won't have any notifications that already crossed the delay threshold.
jest.setSystemTime(new Date(firstNotification.sortAt))
const results = (results) =>
sort(results.flatMap((res) => res.notifications))
const paginator = async (cursor?: string) => {
const res =
await delayAgent.api.app.bsky.notification.listNotifications(
{ cursor, limit: 6 },
{
headers: await delayNetwork.serviceHeaders(
delayAlice,
ids.AppBskyNotificationListNotifications,
),
},
)
return res.data
}
const paginatedAllBeforeDelay = await paginateAll(paginator)
paginatedAllBeforeDelay.forEach((res) =>
expect(res.notifications.length).toBe(0),
)
const fullBeforeDelay =
await delayAgent.api.app.bsky.notification.listNotifications(
{},
{
headers: await delayNetwork.serviceHeaders(
delayAlice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(fullBeforeDelay.data.notifications.length).toEqual(0)
expect(results(paginatedAllBeforeDelay)).toEqual(
results([fullBeforeDelay.data]),
)
const lastNotification = await delayNetwork.bsky.db.db
.selectFrom('notification')
.selectAll()
.limit(1)
.orderBy('sortAt', 'desc')
.executeTakeFirstOrThrow()
// Sets the system time to when the last notification happened and the delay has elapsed.
// At this point we all notifications already crossed the delay threshold.
jest.setSystemTime(
new Date(
new Date(lastNotification.sortAt).getTime() +
notificationsDelayMs +
1,
),
)
const paginatedAllAfterDelay = await paginateAll(paginator)
paginatedAllAfterDelay.forEach((res) =>
expect(res.notifications.length).toBeLessThanOrEqual(6),
)
const fullAfterDelay =
await delayAgent.api.app.bsky.notification.listNotifications(
{},
{
headers: await delayNetwork.serviceHeaders(
delayAlice,
ids.AppBskyNotificationListNotifications,
),
},
)
expect(fullAfterDelay.data.notifications.length).toEqual(13)
expect(results(paginatedAllAfterDelay)).toEqual(
results([fullAfterDelay.data]),
)
})
describe('cursor delay', () => {
const delay0s = 0
const delay5s = 5_000
const now = '2021-01-01T01:00:00.000Z'
const nowMinus2s = '2021-01-01T00:59:58.000Z'
const nowMinus5s = '2021-01-01T00:59:55.000Z'
const nowMinus8s = '2021-01-01T00:59:52.000Z'
beforeAll(async () => {
jest.useFakeTimers({ doNotFake: ['performance'] })
jest.setSystemTime(new Date(now))
})
afterAll(async () => {
jest.useRealTimers()
})
describe('for undefined cursor', () => {
it('returns now minus delay', async () => {
const delayedCursor = delayCursor(undefined, delay5s)
expect(delayedCursor).toBe(nowMinus5s)
})
it('returns now if delay is 0', async () => {
const delayedCursor = delayCursor(undefined, delay0s)
expect(delayedCursor).toBe(now)
})
})
describe('for defined cursor', () => {
it('returns original cursor if delay is 0', async () => {
const originalCursor = nowMinus2s
const delayedCursor = delayCursor(originalCursor, delay0s)
expect(delayedCursor).toBe(originalCursor)
})
it('returns "now minus delay" for cursor that is after that', async () => {
// Cursor is "now - 2s", should become "now - 5s"
const originalCursor = nowMinus2s
const cursor = delayCursor(originalCursor, delay5s)
expect(cursor).toBe(nowMinus5s)
})
it('returns original cursor for cursor that is before "now minus delay"', async () => {
// Cursor is "now - 8s", should stay like that.
const originalCursor = nowMinus8s
const cursor = delayCursor(originalCursor, delay5s)
expect(cursor).toBe(originalCursor)
})
it('passes through a non-date cursor', async () => {
const originalCursor = '123_abc'
const cursor = delayCursor(originalCursor, delay5s)
expect(cursor).toBe(originalCursor)
})
})
})
})
})