Skip to content

feat: support '*' wildcard on department for subscriptions #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BatLeDev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support '*' wildcard on department for subscriptions #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions api/src/events/operations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,19 @@ export const getSubscriptionsFilter = (event: Event): Filter<Subscription> => {
subscriptionsFilter['sender.id'] = event.sender.id
if (event.sender.role) subscriptionsFilter['sender.role'] = event.sender.role
if (event.sender.department) {
// a departmental event also matches subscriptions using the '*' wildcard (any department)
if (event.sender.department !== '*') {
subscriptionsFilter['sender.department'] = event.sender.department
subscriptionsFilter.$or = [
{ 'sender.department': event.sender.department },
{ 'sender.department': '*' }
]
}
} else {
subscriptionsFilter['sender.department'] = { $exists: false }
// a root event matches subscriptions without department, or using the '*' wildcard
subscriptionsFilter.$or = [
{ 'sender.department': { $exists: false } },
{ 'sender.department': '*' }
]
}
} else {
subscriptionsFilter.sender = { $exists: false }
Expand Down
14 changes: 12 additions & 2 deletions tests/events.unit.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,12 @@ test.describe('getSubscriptionsFilter', () => {
const filter = getSubscriptionsFilter(event)
expect(filter['sender.type']).toBe('organization')
expect(filter['sender.id']).toBe('org1')
expect(filter['sender.department']).toEqual({ $exists: false })
// a root event matches subscriptions without department, or using the '*' wildcard
expect(filter.$or).toEqual([
{ 'sender.department': { $exists: false } },
{ 'sender.department': '*' }
])
expect(filter['sender.department']).toBeUndefined()
})

test('filters by sender with department', () => {
Expand All @@ -71,7 +76,12 @@ test.describe('getSubscriptionsFilter', () => {
sender: { type: 'organization', id: 'org1', department: 'dep1' }
}
const filter = getSubscriptionsFilter(event)
expect(filter['sender.department']).toBe('dep1')
// a departmental event also matches subscriptions using the '*' wildcard (any department)
expect(filter.$or).toEqual([
{ 'sender.department': 'dep1' },
{ 'sender.department': '*' }
])
expect(filter['sender.department']).toBeUndefined()
})

test('wildcard department does not filter', () => {
Expand Down
27 changes: 27 additions & 0 deletions tests/subscriptions.api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,33 @@ test.describe('subscriptions', () => {
expect(res.data.count).toBe(1)
})

test('should send any-department subscription notifications for root and departmental events', async () => {
// a root member subscribes to every department of the org using the '*' wildcard
const res = await admin1.post('/api/subscriptions', {
topic: { key: 'topic1' },
sender: { type: 'organization', id: 'test1', department: '*', name: 'Test Organization 1' }
})
expect(res.data.visibility).toBe('private')

// a root event (no department) must reach the wildcard subscription
await axPush.post('/api/events', [{
date: new Date().toISOString(),
topic: { key: 'topic1' },
title: 'a root notification',
sender: { type: 'organization', id: 'test1', name: 'Test Organization 1' }
}])
// a departmental event must also reach the wildcard subscription
await axPush.post('/api/events', [{
date: new Date().toISOString(),
topic: { key: 'topic1' },
title: 'a departmental notification',
sender: { type: 'organization', id: 'test1', department: 'dep1', name: 'Test Organization 1' }
}])

const notifs = await admin1.get('/api/notifications')
expect(notifs.data.count).toBe(2)
})

test('should send a private department notification to member of right department in sender organization', async () => {
let res = await user1.post('/api/subscriptions', {
topic: { key: 'topic1' },
Expand Down
1 change: 1 addition & 0 deletions ui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex" />
<link href="{SITE_PATH}/simple-directory/api/sites/_theme.css" rel="stylesheet">
</head>
<body>
Expand Down
Loading