feat: add timestamps to client events

package.json

@@ -2,10 +2,6 @@
   "name": "blockchain-event-notifier",
   "license": "Apache-2.0",
   "private": true,
-  "engines": {
-    "node": "18.* || 20.*",
-    "npm": "8.* || 9.*"
-  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "start": "node --trace-warnings --abort-on-uncaught-exception --unhandled-rejections=strict dist/index.js",
@@ -20,7 +16,7 @@
     "@dcl/catalyst-contracts": "^4.4.2",
     "@dcl/crypto": "^3.4.5",
     "@dcl/platform-server-commons": "^0.0.4",
-    "@dcl/schemas": "^14.0.0",
+    "@dcl/schemas": "^16.1.0",
     "@well-known-components/env-config-provider": "^1.2.0",
     "@well-known-components/http-server": "^2.1.0",
     "@well-known-components/interfaces": "^1.4.3",

src/adapters/event-parser.ts

@@ -43,13 +43,17 @@ export function createEventParserComponent({ logs }: Pick<AppComponents, 'logs'>
         return {
           type: Events.Type.CLIENT,
           subType: Events.SubType.Client.MOVE_TO_PARCEL,
-          timestamp: new Date(event.timestamp).getTime(),
+          timestamp: Date.now(),
           key: event.messageId,
           metadata: {
             authChain: JSON.parse(event.context.auth_chain),
             userAddress: event.context.dcl_eth_address,
             sessionId: event.context.session_id,
             timestamp: event.sentAt,
+            timestamps: {
+              receivedAt: new Date(event.receivedAt).getTime(),
+              reportedAt: new Date(event.timestamp).getTime()
+            },
             realm: event.context.realm,
             parcel: {
               isEmptyParcel: event.properties.is_empty_parcel,
@@ -65,13 +69,17 @@ export function createEventParserComponent({ logs }: Pick<AppComponents, 'logs'>
         return {
           type: Events.Type.CLIENT,
           subType: Events.SubType.Client.USED_EMOTE,
-          timestamp: new Date(event.timestamp).getTime(),
+          timestamp: Date.now(),
           key: event.messageId,
           metadata: {
             authChain: JSON.parse(event.context.auth_chain),
             userAddress: event.context.dcl_eth_address,
             sessionId: event.context.session_id,
             timestamp: event.sentAt,
+            timestamps: {
+              receivedAt: new Date(event.receivedAt).getTime(),
+              reportedAt: new Date(event.timestamp).getTime()
+            },
             realm: event.context.realm,
             emote: {
               emoteIndex: event.properties.emote_index,
@@ -87,13 +95,17 @@ export function createEventParserComponent({ logs }: Pick<AppComponents, 'logs'>
         return {
           type: Events.Type.CLIENT,
           subType: Events.SubType.Client.PASSPORT_OPENED,
-          timestamp: new Date(event.timestamp).getTime(),
+          timestamp: Date.now(),
           key: event.messageId,
           metadata: {
             authChain: JSON.parse(event.context.auth_chain),
             userAddress: event.context.dcl_eth_address,
             sessionId: event.context.session_id,
             timestamp: event.sentAt,
+            timestamps: {
+              receivedAt: new Date(event.receivedAt).getTime(),
+              reportedAt: new Date(event.timestamp).getTime()
+            },
             realm: event.context.realm,
             passport: {
               receiver: event.properties.receiver_id
@@ -106,13 +118,17 @@ export function createEventParserComponent({ logs }: Pick<AppComponents, 'logs'>
         return {
           type: Events.Type.CLIENT,
           subType: Events.SubType.Client.WALKED_DISTANCE,
-          timestamp: new Date(event.timestamp).getTime(),
+          timestamp: Date.now(),
           key: event.messageId,
           metadata: {
             authChain: JSON.parse(event.context.auth_chain),
             userAddress: event.context.dcl_eth_address,
             sessionId: event.context.session_id,
             timestamp: event.sentAt,
+            timestamps: {
+              receivedAt: new Date(event.receivedAt).getTime(),
+              reportedAt: new Date(event.timestamp).getTime()
+            },
             realm: event.context.realm,
             distance: event.properties.distance,
             stepCount: event.properties.step_count
@@ -124,13 +140,17 @@ export function createEventParserComponent({ logs }: Pick<AppComponents, 'logs'>
         return {
           type: Events.Type.CLIENT,
           subType: Events.SubType.Client.VERTICAL_HEIGHT_REACHED,
-          timestamp: new Date(event.timestamp).getTime(),
+          timestamp: Date.now(),
           key: event.messageId,
           metadata: {
             authChain: JSON.parse(event.context.auth_chain),
             userAddress: event.context.dcl_eth_address,
             sessionId: event.context.session_id,
             timestamp: event.sentAt,
+            timestamps: {
+              receivedAt: new Date(event.receivedAt).getTime(),
+              reportedAt: new Date(event.timestamp).getTime()
+            },
             realm: event.context.realm,
             height: event.properties.height
           }

src/controllers/handlers/forward-explorer-events.ts

@@ -33,11 +33,11 @@ async function validateAuthChain(authChain: AuthChain, address: EthAddress): Pro
 
 export async function setForwardExplorerEventsHandler(
   context: Pick<
-    HandlerContextWithPath<'eventPublisher' | 'eventParser' | 'config' | 'logs', '/forward'>,
+    HandlerContextWithPath<'eventPublisher' | 'eventParser' | 'config' | 'logs' | 'metrics', '/forward'>,
     'params' | 'request' | 'components'
   >
 ) {
-  const { logs, config, eventParser, eventPublisher } = context.components
+  const { logs, config, eventParser, eventPublisher, metrics } = context.components
   const logger = logs.getLogger('forward-explorer-events')
   const segmentSignigKey = await config.requireString('SEGMENT_SIGNING_KEY')
 
@@ -107,6 +107,34 @@ export async function setForwardExplorerEventsHandler(
     parsedEvent: JSON.stringify(parsedEvent)
   })
 
+  if (
+    (parsedEvent as ClientEvent).metadata.timestamps.reportedAt <
+    (parsedEvent as ClientEvent).metadata.timestamps.receivedAt
+  ) {
+    const eventDelayBetweenExplorerAndSegment =
+      (castedClientEvent.metadata.timestamps.receivedAt - castedClientEvent.metadata.timestamps.reportedAt) / 1000
+    const eventDelayBetweenSegmentAndWebhook =
+      (castedClientEvent.timestamp - castedClientEvent.metadata.timestamps.receivedAt) / 1000
+
+    metrics.increment('handled_explorer_events_count', {
+      event_type: parsedEvent.subType
+    })
+    metrics.increment(
+      'explorer_segment_event_delay_in_seconds_total',
+      {
+        event_type: parsedEvent.subType
+      },
+      eventDelayBetweenExplorerAndSegment
+    )
+    metrics.increment(
+      'segment_webhook_event_delay_in_seconds_total',
+      {
+        event_type: parsedEvent.subType
+      },
+      eventDelayBetweenSegmentAndWebhook
+    )
+  }
+
   return {
     status: 200,
     body: {

src/metrics.ts

@@ -3,12 +3,28 @@ import { validateMetricsDeclaration } from '@well-known-components/metrics'
 import { metricDeclarations as pgMetricDeclarations } from '@well-known-components/pg-component'
 import { metricDeclarations as theGraphMetricDeclarations } from '@well-known-components/thegraph-component'
 import { getDefaultHttpMetrics } from '@well-known-components/http-server'
+import { IMetricsComponent } from '@well-known-components/interfaces'
 
 export const metricDeclarations = {
   ...getDefaultHttpMetrics(),
   ...logMetricDeclarations,
   ...pgMetricDeclarations,
-  ...theGraphMetricDeclarations
+  ...theGraphMetricDeclarations,
+  explorer_segment_event_delay_in_seconds_total: {
+    type: IMetricsComponent.CounterType,
+    help: 'Delay between segment event and explorer event',
+    labelNames: ['event_type']
+  },
+  segment_webhook_event_delay_in_seconds_total: {
+    type: IMetricsComponent.CounterType,
+    help: 'Delay between segment webhook event and explorer event',
+    labelNames: ['event_type']
+  },
+  handled_explorer_events_count: {
+    type: IMetricsComponent.CounterType,
+    help: 'Number of explorer events',
+    labelNames: ['event_type']
+  }
 }
 
 // type assertions

yarn.lock

@@ -783,10 +783,10 @@
     "@well-known-components/interfaces" "^1.4.2"
     node-fetch "^2.7.0"
 
-"@dcl/schemas@^14.0.0":
-  version "14.0.0"
-  resolved "https://registry.yarnpkg.com/@dcl/schemas/-/schemas-14.0.0.tgz#d967a41046186090f9e3db0a725cff38cd5bdaf3"
-  integrity sha512-w3P/5g/gkYcBUB6+eN1PYdQBaiS8nLh7ldGfUI6GuiHQKvPIC3wS26Dx5i2ukwHrds2koOaqhFdLzHLVDDitQg==
+"@dcl/schemas@^16.1.0":
+  version "16.1.0"
+  resolved "https://registry.yarnpkg.com/@dcl/schemas/-/schemas-16.1.0.tgz#fbffbb1fb7b319bb42fc63ae15cc62b393f9a0fc"
+  integrity sha512-dMr68jzL+pHP6b5u4dJhwGDFUOJ7TfCC3uvq+jpeP/UIUilcfjP+4U9dFGpmgSFwfKELX7AJPr1ImlkKVNiN6w==
   dependencies:
     ajv "^8.11.0"
     ajv-errors "^3.0.0"