@superhero/eventflow-db 4.8.0 → 4.8.2-rc.0.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+---
+#### v4.8.1
+---\n\nVersion alignment...
+
 ---
 ## Version: 4.8.0
 ---

package/index.js

@@ -1,6 +1,7 @@
 
 import Gateway            from '@superhero/db'
 import AdapterFactory     from '@superhero/db/adapter/mysql2/factory.js'
+import Serde              from './serde.js'
 import mysql2             from 'mysql2'
 import path               from 'node:path'
 import { fileURLToPath }  from 'node:url'
@@ -16,6 +17,8 @@ export function locate(locator)
  */
 export default class DB
 {
+  serde = new Serde()
+
   escape = mysql2.escape
 
   constructor(config)
@@ -177,13 +180,18 @@ export default class DB
     return Date.now().toString(36) + '-' + Math.random().toString(36).slice(2)
   }
 
-  async persistEvent(event)
+  async persistEvent(event, serialize = false)
   {
     try
     {
-      const
-        id    = event.id ?? this.#generateEventId(),
-        data  = JSON.stringify(event.data ?? {})
+      const id = event.id ?? this.#generateEventId()
+
+      let data = event.data ?? {}
+
+      if(serialize)
+      {
+        data = this.serde.serialize(data)
+      }
 
       await this.gateway.query('event/persist', { ...event, id, data })
 
@@ -231,7 +239,7 @@ export default class DB
     } 
   }
 
-  async readEvent(id)
+  async readEvent(id, deserialize = false)
   {
     let result
 
@@ -255,10 +263,12 @@ export default class DB
     }
 
     const event = result[0]
-    return event
+    return deserialize 
+      ? this.serde.deserialize(event) 
+      : event
   }
 
-  async readEventsByDomainAndPid(domain, pid)
+  async readEventsByDomainAndPid(domain, pid, deserialize = false)
   {
     let result
 
@@ -274,10 +284,12 @@ export default class DB
       throw error
     } 
 
-    return result
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
-  async readEventsByDomainAndPidBetweenTimestamps(domain, pid, timestampMin, timestampMax)
+  async readEventsByDomainAndPidBetweenTimestamps(domain, pid, timestampMin, timestampMax, deserialize = false)
   {
     let result
 
@@ -293,10 +305,12 @@ export default class DB
       throw error
     } 
 
-    return result
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
-  async readEventsByDomainAndPidAndNames(domain, pid, names)
+  async readEventsByDomainAndPidAndNames(domain, pid, names, deserialize = false)
   {
     let result
 
@@ -313,7 +327,9 @@ export default class DB
       throw error
     }
 
-    return result
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
   async readDistinctPidByDomain(domain)
@@ -386,11 +402,13 @@ export default class DB
     return result.map(({ domain, cpid }) => ({ domain, cpid }))
   }
 
-  async readEventsByDomainAndCpid(domain, cpid)
+  async readEventsByDomainAndCpid(domain, cpid, deserialize = false)
   {
+    let result
+    
     try
     {
-      return await this.gateway.query('event_cpid/read-by-cpid-domain', cpid, domain)
+      result = await this.gateway.query('event_cpid/read-by-cpid-domain', cpid, domain)
     }
     catch(reason)
     {
@@ -399,6 +417,10 @@ export default class DB
       error.cause = reason
       throw error
     }
+
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
   async persistEventEid(event_id, eid)
@@ -452,11 +474,13 @@ export default class DB
     return result.map((row) => row.eid)
   }
 
-  async readEventsByEid(eid)
+  async readEventsByEid(eid, deserialize = false)
   {
+    let result
+
     try
     {
-      return await this.gateway.query('event_eid/read-by-eid', eid)
+      result = await this.gateway.query('event_eid/read-by-eid', eid)
     }
     catch(reason)
     {
@@ -465,13 +489,19 @@ export default class DB
       error.cause = reason
       throw error
     }
+
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
-  async readEventsByDomainAndEid(domain, eid)
+  async readEventsByDomainAndEid(domain, eid, deserialize = false)
   {
+    let result
+
     try
     {
-      return await this.gateway.query('event_eid/read-by-eid-domain', eid, domain)
+      result = await this.gateway.query('event_eid/read-by-eid-domain', eid, domain)
     }
     catch(reason)
     {
@@ -479,7 +509,11 @@ export default class DB
       error.code  = 'E_EVENTFLOW_DB_EVENTS_READ_BY_DOMAIN_AND_EID'
       error.cause = reason
       throw error
-    } 
+    }
+
+    return deserialize
+      ? result.map(event => this.serde.deserialize(event))
+      : result
   }
 
   async persistEventPublished(publishedEvent)
@@ -727,7 +761,7 @@ export default class DB
   {
     try
     {
-      log.error = JSON.stringify(log.error ?? {})
+      log.error = log.error ? this.serde.serialize(log.error) : {}
       await this.gateway.query('log/persist', log)
     }
     catch(reason)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superhero/eventflow-db",
-  "version": "4.8.0",
+  "version": "4.8.2-rc.0.0",
   "description": "Eventflow db is a set of common database logic in the eventflow ecosystem.",
   "keywords": [
     "eventflow"
@@ -21,9 +21,9 @@
     "@superhero/db": "1.0.0"
   },
   "devDependencies": {
-    "@superhero/audit": "4.8.0",
+    "@superhero/audit": "4.8.1",
     "@superhero/syntax-check": "0.0.2",
-    "@superhero/locator": "4.8.0"
+    "@superhero/locator": "4.8.1"
   },
   "author": {
     "name": "Erik Landvall",

package/serde.js

@@ -0,0 +1,122 @@
+import util from 'node:util'
+
+export default class Serde
+{
+  transformers = new Map(
+  [
+    [
+      'Date',
+      {
+        type          : Date,
+        serializer    : (input) => input.toJSON(),
+        deserializer  : (input) => new Date(input)
+      }
+    ],
+    [
+      'Error',
+      {
+        type          : Error,
+        serializer    : (input) => 
+        {
+          const json = { name: input.name }
+
+          Object.getOwnPropertyNames(input)
+            .forEach((key) => json[key] = this.serialize(input[key]))
+
+          return json
+        },
+        deserializer  : (input) => 
+        {
+          const error = new Error
+
+          Object.getOwnPropertyNames(input)
+            .forEach((key) => error[key] = this.deserialize(input[key]))
+
+          return error
+        }
+      }
+    ],
+    [
+      'Map',
+      {
+        type          : Map,
+        serializer    : (input) => [...input.entries()].map(([key, value]) => [ this.serialize(key), this.serialize(value) ]),
+        deserializer  : (input) => new Map(input.map(([key, value]) => [ this.deserialize(key), this.deserialize(value) ]))
+      }
+    ],
+    [
+      'Set',
+      {
+        type          : Set,
+        serializer    : (input) => [...input.values()].map(value => this.serialize(value)),
+        deserializer  : (input) => new Set(input.map(value => this.deserialize(value)))
+      }
+    ],
+  ])
+
+  constructor(typeAttribute = '$type', valueAttribute = '$value') 
+  {
+    this.typeAttribute  = typeAttribute
+    this.valueAttribute = valueAttribute
+  }
+
+  serialize(input) 
+  {
+    for(const [key, { type, serializer }] of this.transformers)
+    {
+      if(input instanceof type)
+      {
+        return { [this.typeAttribute]  : key, 
+                 [this.valueAttribute] : serializer(input) }
+      }
+    }
+
+    if(Array.isArray(input))
+    {
+      return input.map(this.serialize.bind(this))
+    }
+
+    if('object' === typeof input && null !== input)
+    {
+      const serialized = {}
+      for (const [key, value] of Object.entries(input))
+      {
+        serialized[key] = this.serialize(value)
+      }
+      return serialized
+    }
+
+    return input
+  }
+
+  deserialize(input) 
+  {
+    if(input)
+    {
+      for(const [key, { deserializer }] of this.transformers)
+      {
+        if(key === input[this.typeAttribute])
+        {
+          return deserializer(input[this.valueAttribute])
+        }
+      }
+
+      if (Array.isArray(input))
+      {
+        return input.map(this.deserialize.bind(this))
+      }
+
+      if (typeof input === 'object') 
+      {
+        const deserialized = {}
+        for (const [key, value] of Object.entries(input))
+        {
+          deserialized[key] = this.deserialize(value)
+        }
+        return deserialized
+      }
+    }
+
+    return input
+  }
+}