fix: Use XML Date Format in Notifications

Using XML Date format instead of Internet Date format for Solid-PREP Notifications.

Author: CxRes

lib/handlers/notify.js

@@ -38,6 +38,21 @@ function getParentActivity (method, status) {
   return 'Update'
 }
 
+function filterMillseconds (isoDate) {
+  return `${isoDate.substring(0, 19)}${isoDate.substring(23)}`
+}
+
+function getDate (date) {
+  if (date) {
+    const eventDate = new Date(date)
+    if (!isNaN(eventDate.valueOf())) {
+      return filterMillseconds(eventDate.toISOString())
+    }
+  }
+  const now = new Date()
+  return filterMillseconds(now.toISOString())
+}
+
 function handler (req, res, next) {
   const { trigger, defaultNotification } = res.events.prep
 
@@ -48,8 +63,7 @@ function handler (req, res, next) {
 
   // Date is a hack since node does not seem to provide access to send date.
   // Date needs to be shared with parent notification
-  const eventDate = res._header.match(/^Date: (.*?)$/m)?.[1] ||
-    new Date().toUTCString()
+  const eventDate = getDate(res._header.match(/^Date: (.*?)$/m)?.[1])
 
   // If the resource itself newly created,
   // it could not have been subscribed for notifications already

test/integration/prep-test.js

@@ -5,6 +5,8 @@ const { parseDictionary } = require('structured-headers')
 const prepFetch = require('prep-fetch').default
 const { createServer } = require('../utils')
 
+const dateTimeRegex = /^-?\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{3})?(?:Z|(?:\+|-)\d{2}:\d{2})$/
+
 const samplePath = path.join(__dirname, '../resources', 'sampleContainer')
 const sampleFile = fs.readFileSync(path.join(samplePath, 'example1.ttl'))
 
@@ -92,7 +94,8 @@ describe('Per Resource Events Protocol', function () {
         const { value } = await notificationsIterator.next()
         expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
         const notification = await value.json()
-        expect(notification).to.haveOwnProperty('published')
+        expect(notification.published).to.match(dateTimeRegex)
+        expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
         expect(notification.type).to.equal('Add')
         expect(notification.target).to.match(/sampleContainer\/example-prep\.ttl$/)
         expect(notification.object).to.match(/sampleContainer\/$/)
@@ -111,7 +114,8 @@ solid:inserts { <u> <v> <z>. }.`
         const { value } = await notificationsIterator.next()
         expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
         const notification = await value.json()
-        expect(notification).to.haveOwnProperty('published')
+        expect(notification.published).to.match(dateTimeRegex)
+        expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
         expect(notification.type).to.equal('Update')
         expect(notification.object).to.match(/sampleContainer\/$/)
       })
@@ -124,7 +128,8 @@ solid:inserts { <u> <v> <z>. }.`
           const { value } = await notificationsIterator.next()
           expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
           const notification = await value.json()
-          expect(notification).to.haveOwnProperty('published')
+          expect(notification.published).to.match(dateTimeRegex)
+          expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
           expect(notification.type).to.equal('Remove')
           expect(notification.object).to.match(/sampleContainer\/$/)
           expect(notification.origin).to.match(/sampleContainer\/.*example-prep.ttl$/)
@@ -140,7 +145,8 @@ solid:inserts { <u> <v> <z>. }.`
         const { value } = await notificationsIterator.next()
         expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
         const notification = await value.json()
-        expect(notification).to.haveOwnProperty('published')
+        expect(notification.published).to.match(dateTimeRegex)
+        expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
         expect(notification.type).to.equal('Add')
         expect(notification.target).to.match(/sampleContainer\/example-prep\/$/)
         expect(notification.object).to.match(/sampleContainer\/$/)
@@ -153,7 +159,8 @@ solid:inserts { <u> <v> <z>. }.`
         const { value } = await notificationsIterator.next()
         expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
         const notification = await value.json()
-        expect(notification).to.haveOwnProperty('published')
+        expect(notification.published).to.match(dateTimeRegex)
+        expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
         expect(notification.type).to.equal('Remove')
         expect(notification.origin).to.match(/sampleContainer\/example-prep\/$/)
         expect(notification.object).to.match(/sampleContainer\/$/)
@@ -172,7 +179,8 @@ solid:inserts { <u> <v> <z>. }.`
           const { value } = await notificationsIterator.next()
           expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
           const notification = await value.json()
-          expect(notification).to.haveOwnProperty('published')
+          expect(notification.published).to.match(dateTimeRegex)
+          expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
           expect(notification.type).to.equal('Add')
           expect(notification.object).to.match(/sampleContainer\/$/)
           expect(notification.target).to.match(/sampleContainer\/.*example-post\/$/)
@@ -191,7 +199,8 @@ solid:inserts { <u> <v> <z>. }.`
           const { value } = await notificationsIterator.next()
           expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
           const notification = await value.json()
-          expect(notification).to.haveOwnProperty('published')
+          expect(notification.published).to.match(dateTimeRegex)
+          expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
           expect(notification.type).to.equal('Add')
           expect(notification.object).to.match(/sampleContainer\/$/)
           expect(notification.target).to.match(/sampleContainer\/.*example-prep.ttl$/)
@@ -254,7 +263,8 @@ solid:inserts { <u> <v> <z>. }.`
         const { value } = await notificationsIterator.next()
         expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
         const notification = await value.json()
-        expect(notification).to.haveOwnProperty('published')
+        expect(notification.published).to.match(dateTimeRegex)
+        expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
         expect(notification).to.haveOwnProperty('state')
         expect(notification.type).to.equal('Update')
         expect(notification.object).to.match(/sampleContainer\/example-prep\.ttl$/)
@@ -268,7 +278,8 @@ solid:inserts { <u> <v> <z>. }.`
           const { value } = await notificationsIterator.next()
           expect(value.headers.get('content-type')).to.match(/application\/ld\+json/)
           const notification = await value.json()
-          expect(notification).to.haveOwnProperty('published')
+          expect(notification.published).to.match(dateTimeRegex)
+          expect(isNaN((new Date(notification.published)).valueOf())).to.equal(false)
           expect(notification).to.haveOwnProperty('state')
           expect(notification.type).to.equal('Delete')
           expect(notification.object).to.match(/sampleContainer\/example-prep\.ttl$/)