feat: work on traceability with addition of event.originator and event.resource (#1)

Author: albanm

api/package.json

@@ -14,9 +14,9 @@
     "#types/*": "./types/*"
   },
   "dependencies": {
-    "@data-fair/lib-common-types": "^1.5.4",
-    "@data-fair/lib-express": "^1.12.3",
-    "@data-fair/lib-node": "^2.2.0",
+    "@data-fair/lib-common-types": "^1.8.0",
+    "@data-fair/lib-express": "^1.16.1",
+    "@data-fair/lib-node": "^2.5.1",
     "ajv-formats": "^3.0.1",
     "ajv-i18n": "^4.2.0",
     "config": "^3.3.11",

api/src/events/router.ts

@@ -1,43 +1,46 @@
-import type { SortDirection, Filter } from 'mongodb'
+import type { Filter, Sort } from 'mongodb'
 import type { FullEvent } from '#types'
 
 import { Router } from 'express'
 import mongo from '#mongo'
 import config from '#config'
 import * as postReq from '#doc/events/post-req/index.ts'
 import { session, mongoPagination, mongoProjection, httpError, assertReqInternalSecret, reqOrigin } from '@data-fair/lib-express/index.js'
-import { postEvents, localizeEvent } from './service.ts'
+import { postEvents, localizeEvent, cleanEvent } from './service.ts'
 
 const router = Router()
 export default router
 
 router.get('', async (req, res, next) => {
-  const { account, lang } = await session.reqAuthenticated(req)
+  const sessionState = await session.reqAuthenticated(req)
+  const { account, lang } = sessionState
 
   const query: Filter<FullEvent> = { 'sender.type': account.type, 'sender.id': account.id }
   if (req.query.q && typeof req.query.q === 'string') query.$text = { $search: req.query.q, $language: lang || config.i18n.defaultLocale }
+  if (typeof req.query.resource === 'string') query['resource.id'] = req.query.resource
 
   const project = mongoProjection(req.query.select, ['_search', 'htmlBody'])
 
   // implement a special pagination based on the fact that we always sort by date
-  const sort = { date: -1 as SortDirection }
-  const { skip, size } = mongoPagination(req.query)
+  const sort: Sort = { date: -1, _id: -1 }
+  const { skip, size } = mongoPagination(req.query, 20)
   if (skip) throw httpError(400, 'skip is not supported, use "before" parameter with the date of the last event of the previous page')
   if (req.query.before && typeof req.query.before === 'string') {
-    const [beforeId, beforeDate] = req.query.before.split(':')
+    const [beforeDate, beforeId] = req.query.before.split('/')
     query.date = { $lte: beforeDate }
-    query._id = { $ne: beforeId }
+    // optional beforeId as a tie-breaker
+    if (beforeId) query._id = { $lt: beforeId }
   }
 
   const events = (await mongo.events.find(query).project(project).limit(size).sort(sort).toArray()) as FullEvent[]
 
-  const results = events.map(event => localizeEvent(event, lang))
+  const results = events.map(event => cleanEvent(localizeEvent(event, lang), sessionState))
 
   const response: any = { results }
 
   if (results.length === size) {
     const next = new URL(req.originalUrl, reqOrigin(req))
-    next.searchParams.set('before', results[results.length - 1]._id + ':' + results[results.length - 1].date)
+    next.searchParams.set('before', results[results.length - 1].date + '/' + results[results.length - 1]._id)
     response.next = next.href
   }
 

api/src/events/service.ts

@@ -6,6 +6,7 @@ import { sendNotification, prepareSubscriptionNotification } from '../notificati
 import { createWebhook } from '../webhooks/service.ts'
 import { nanoid } from 'nanoid'
 import debugModule from 'debug'
+import { type SessionStateAuthenticated } from '@data-fair/lib-express'
 
 const debug = debugModule('events')
 
@@ -62,8 +63,17 @@ export const postEvents = async (events: Event[], extraSubscriptionsFilter?: Fil
     }
     for (const locale of config.i18n.locales) {
       const localizedEvent = localizeEvent(event, locale)
-      const searchParts: (string | undefined)[] = [...event.topic.key.split(':'), event.topic.title, localizedEvent.title, localizedEvent.body]
-      event._search.push({ language: locale, text: searchParts.filter(Boolean).join(' ') })
+      const searchParts: (string | undefined)[] = [...event.topic.key.split(':'), event.topic.title, localizedEvent.title, localizedEvent.body, event.sender.id, event.sender.name]
+      if (event.originator) {
+        if (event.originator.organization) {
+          searchParts.push(event.originator.organization.name, event.originator.organization.id)
+        }
+        if (event.originator.user && (!event.originator.organization || (event.sender.type === 'organization' && event.sender.id === event.originator.organization.id))) {
+          // do not add the user name if the originator is another organization
+          searchParts.push(event.originator.user.name, event.originator.user.id)
+        }
+      }
+      if (event) { event._search.push({ language: locale, text: searchParts.filter(Boolean).join(' ') }) }
     }
     eventsBulkOp.insert(event)
 
@@ -95,3 +105,17 @@ export const postEvents = async (events: Event[], extraSubscriptionsFilter?: Fil
     await sendNotification(notification, true)
   }
 }
+
+export const cleanEvent = (event: LocalizedEvent, sessionState: SessionStateAuthenticated) => {
+  if (event.originator) {
+    if (sessionState.account.type === event.sender.type && sessionState.account.id === event.sender.id) {
+      if (event.originator.organization) {
+        // hide the user if the event is sent from another organization
+        if (sessionState.organization?.id !== event.originator.organization.id) {
+          delete event.originator.user
+        }
+      }
+    }
+  }
+  return event
+}

api/src/notifications/service.ts

@@ -20,6 +20,8 @@ const directoryUrl = config.privateDirectoryUrl
 
 export const prepareSubscriptionNotification = (event: FullEvent, subscription: Subscription): Notification => {
   const localizedEvent = localizeEvent(event, subscription.locale)
+  delete localizedEvent.resource
+  delete localizedEvent.originator
   delete localizedEvent.urlParams
   const notification: Notification = {
     icon: subscription.icon || config.theme.notificationIcon || config.theme.logo || (subscription.origin + '/events/logo-192x192.png'),

dev/scripts/send-notifications.ts

@@ -1,16 +1,22 @@
 import type { PostEventReq } from '../../api/doc/events/post-req/index.js'
-import { axiosBuilder } from '@data-fair/lib/node/axios.js'
+import { axiosBuilder } from '@data-fair/lib-node/axios.js'
 
 const ax = axiosBuilder({ params: { key: 'SECRET_EVENTS' }, baseURL: 'http://localhost:8082' })
 
-const postEvent = async (event: PostEventReq['body']) => {
-  await ax.post('/events/api/v1/events', event)
+const postEvent = async (events: PostEventReq['body']) => {
+  await ax.post('/events/api/events', events)
 }
 
-await postEvent({
+await postEvent([{
   title: 'A notification ' + new Date().toISOString(),
   sender: { type: 'organization', id: 'orga1' },
-  topic: { key: 'topic1', title: 'Topic 1' }
-})
+  topic: { key: 'topic1', title: 'Topic 1' },
+  date: new Date().toISOString(),
+  resource: { type: 'dataset', id: 'dataset1', title: 'Dataset 1' },
+  originator: {
+    user: { id: 'user1', name: 'User 2' },
+    organization: { id: 'orga1', name: 'Organization 1' }
+  }
+}])
 
 process.exit()

package-lock.json

@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19.2.2",
-    "@data-fair/lib-node": "^2.2.0",
+    "@data-fair/lib-node": "^2.5.1",
     "@types/config": "^3.3.3",
     "@types/debug": "^4.1.12",
     "commitlint": "^19.2.2",

package.json

@@ -30,15 +30,33 @@ describe('events', () => {
       topic: { key: 'topic1' },
       title: 'a notification',
       sender: { type: 'user', id: 'user1', name: 'User 1' }
+    }, {
+      date: new Date().toISOString(),
+      topic: { key: 'topic1' },
+      title: 'another notification',
+      sender: { type: 'user', id: 'user1', name: 'User 1' }
+    }, {
+      date: new Date().toISOString(),
+      topic: { key: 'topic1' },
+      title: 'anotherone',
+      sender: { type: 'user', id: 'user1', name: 'User 1' }
     }])
     res = await admin1.get('/api/events')
     assert.equal(res.data.results.length, 0)
     res = await user1.get('/api/events')
-    assert.equal(res.data.results.length, 1)
+    assert.equal(res.data.results.length, 3)
     res = await user1.get('/api/events?q=notification')
-    assert.equal(res.data.results.length, 1)
+    assert.equal(res.data.results.length, 2)
     res = await user1.get('/api/events?q=test')
     assert.equal(res.data.results.length, 0)
+    res = await user1.get('/api/events', { params: { size: 2 } })
+    assert.equal(res.data.results.length, 2)
+    assert.ok(res.data.next)
+    const id1 = res.data.results[0]._id
+    res = await user1.get(res.data.next)
+    assert.equal(res.data.results.length, 1)
+    assert.notEqual(res.data.results[0]._id, id1)
+    assert.ok(!res.data.next)
   })
 
   it('should send an internationalized event', async () => {

test-it/01-events.ts

@@ -10,6 +10,7 @@ declare module 'vue' {
     ConfirmMenu: typeof import('./src/components/confirm-menu.vue')['default']
     DeviceCard: typeof import('./src/components/device-card.vue')['default']
     ErrorAlert: typeof import('./src/components/error-alert.vue')['default']
+    EventsActions: typeof import('./src/components/events-actions.vue')['default']
     RegisterDevice: typeof import('./src/components/register-device.vue')['default']
     RouterLink: typeof import('vue-router')['RouterLink']
     RouterView: typeof import('vue-router')['RouterView']

ui/components.d.ts

@@ -12,8 +12,8 @@
     "lint-fix": "eslint --fix ."
   },
   "dependencies": {
-    "@data-fair/frame": "^0.8.1",
-    "@data-fair/lib-vue": "^1.15.5",
+    "@data-fair/frame": "^0.12.0",
+    "@data-fair/lib-vue": "^1.19.0",
     "@data-fair/lib-vuetify": "^1.9.1",
     "@intlify/unplugin-vue-i18n": "^5.2.0",
     "@koumoul/v-iframe": "^2.4.4",