@platformatic/sql-events 0.5.0

package/test/helper.js

@@ -0,0 +1,66 @@
+'use strict'
+
+// Needed to work with dates & postgresql
+// See https://node-postgres.com/features/types/
+process.env.TZ = 'UTC'
+
+const connInfo = {}
+
+if (!process.env.DB || process.env.DB === 'postgresql') {
+  connInfo.connectionString = 'postgres://postgres:postgres@127.0.0.1/postgres'
+  module.exports.isPg = true
+} else if (process.env.DB === 'mariadb') {
+  connInfo.connectionString = 'mysql://root@127.0.0.1:3307/graph'
+  connInfo.poolSize = 10
+  module.exports.isMysql = true
+} else if (process.env.DB === 'mysql') {
+  connInfo.connectionString = 'mysql://root@127.0.0.1/graph'
+  connInfo.poolSize = 10
+  module.exports.isMysql = true
+} else if (process.env.DB === 'mysql8') {
+  connInfo.connectionString = 'mysql://root@127.0.0.1:3308/graph'
+  connInfo.poolSize = 10
+  module.exports.isMysql = true
+} else if (process.env.DB === 'sqlite') {
+  connInfo.connectionString = 'sqlite://:memory:'
+  module.exports.isSQLite = true
+}
+
+module.exports.connInfo = connInfo
+
+module.exports.clear = async function (db, sql) {
+  try {
+    await db.query(sql`DROP TABLE pages`)
+  } catch (err) {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE categories`)
+  } catch {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE posts`)
+  } catch {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE simple_types`)
+  } catch {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE owners`)
+  } catch {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE users`)
+  } catch {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE versions`)
+  } catch {
+  }
+}

package/test/hooks.test.js

@@ -0,0 +1,317 @@
+'use strict'
+
+const { test } = require('tap')
+const sqlMapper = require('@platformatic/sql-mapper')
+const { connect } = sqlMapper
+const { clear, connInfo, isSQLite } = require('./helper')
+const sqlEvents = require('..')
+const { setupEmitter } = sqlEvents
+const MQEmitter = require('mqemitter')
+
+const fakeLogger = {
+  trace () {},
+  error () {}
+}
+
+test('get topics', async ({ equal, same, teardown }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+  const pageEntity = mapper.entities.page
+
+  const mq = MQEmitter()
+  equal(setupEmitter({ mapper, mq, log: fakeLogger }), undefined)
+  const queue = await mapper.subscribe([
+    await pageEntity.getSubscriptionTopic({ action: 'save' }),
+    await pageEntity.getSubscriptionTopic({ action: 'delete' })
+  ])
+  equal(mapper.mq, mq)
+
+  const expected = []
+
+  // save - new record
+  const page = await pageEntity.save({
+    input: { title: 'fourth page' }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  // save - update record
+  await pageEntity.save({
+    input: {
+      id: page.id,
+      title: 'fifth page'
+    }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  await pageEntity.delete({
+    where: {
+      id: {
+        eq: page.id
+      }
+    },
+    fields: ['id', 'title']
+  })
+
+  expected.push({
+    topic: '/entity/page/delete/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  for await (const ev of queue) {
+    same(ev, expected.shift())
+    if (expected.length === 0) {
+      break
+    }
+  }
+})
+
+test('hooks', async ({ equal, same, teardown }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+  const pageEntity = mapper.entities.page
+
+  const mq = MQEmitter()
+  equal(setupEmitter({ mapper, mq, log: fakeLogger }), undefined)
+  const queue = await mapper.subscribe([
+    await pageEntity.getSubscriptionTopic({ action: 'save' }),
+    await pageEntity.getSubscriptionTopic({ action: 'delete' })
+  ])
+  equal(mapper.mq, mq)
+
+  const expected = []
+
+  // save - new record
+  const page = await pageEntity.save({
+    input: { title: 'fourth page' }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  // save - update record
+  await pageEntity.save({
+    input: {
+      id: page.id,
+      title: 'fifth page'
+    }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  await pageEntity.delete({
+    where: {
+      id: {
+        eq: page.id
+      }
+    },
+    fields: ['id', 'title']
+  })
+
+  expected.push({
+    topic: '/entity/page/delete/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  for await (const ev of queue) {
+    same(ev, expected.shift())
+    if (expected.length === 0) {
+      break
+    }
+  }
+})
+
+test('get topics', async ({ equal, same, teardown }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+  mapper.addEntityHooks('page', {
+    async getSubscriptionTopic (original, { action }) {
+      equal('create', action)
+      return original({ action })
+    }
+  })
+
+  const pageEntity = mapper.entities.page
+
+  const mq = MQEmitter()
+  equal(setupEmitter({ mapper, mq, log: fakeLogger }), undefined)
+  await pageEntity.getSubscriptionTopic({ action: 'save' })
+})
+
+test('no events', async ({ equal, same, teardown, fail, comment }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+
+  const mq = MQEmitter()
+  equal(setupEmitter({ mapper, mq, log: fakeLogger }), undefined)
+
+  const pageEntity = mapper.entities.page
+
+  // disable publishing
+  pageEntity.getPublishTopic = function () {
+    return false
+  }
+
+  const queue = await mapper.subscribe([
+    await pageEntity.getSubscriptionTopic({ action: 'save' }),
+    await pageEntity.getSubscriptionTopic({ action: 'delete' })
+  ])
+  equal(mapper.mq, mq)
+
+  queue.on('data', function (msg) {
+    comment(JSON.stringify(msg, null, 2))
+    fail('no message')
+  })
+
+  // save - new record
+  const page = await pageEntity.save({
+    input: { title: 'fourth page' }
+  })
+
+  // save - update record
+  await pageEntity.save({
+    input: {
+      id: page.id,
+      title: 'fifth page'
+    }
+  })
+
+  // delete a record
+  await pageEntity.delete({
+    where: {
+      id: {
+        eq: page.id
+      }
+    },
+    fields: ['id', 'title']
+  })
+})
+
+test('wrong action', async ({ equal, rejects, teardown, fail, comment }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+
+  setupEmitter({ mapper, log: fakeLogger })
+
+  const pageEntity = mapper.entities.page
+
+  equal(await pageEntity.getPublishTopic({ action: 'foo', data: { id: 42 } }), false)
+  rejects(pageEntity.getPublishTopic({ action: 'foo', data: { } }))
+  rejects(pageEntity.getPublishTopic({ action: 'foo' }))
+  rejects(pageEntity.getSubscriptionTopic({ action: 'foo' }), 'no such action foo')
+})

package/test/redis.test.js

@@ -0,0 +1,116 @@
+'use strict'
+
+const { test } = require('tap')
+const sqlMapper = require('@platformatic/sql-mapper')
+const { connect } = sqlMapper
+const { clear, connInfo, isSQLite } = require('./helper')
+const sqlEvents = require('..')
+const { setupEmitter } = sqlEvents
+const MQEmitterRedis = require('mqemitter-redis')
+const { promisify } = require('util')
+const { PassThrough } = require('stream')
+
+const fakeLogger = {
+  trace () {},
+  error () {}
+}
+
+test('emit events', async ({ equal, same, teardown, comment }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(() => db.dispose())
+
+    if (isSQLite) {
+      await db.query(sql`CREATE TABLE pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(42)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+    }
+  }
+  const mapper = await connect({
+    log: fakeLogger,
+    ...connInfo,
+    onDatabaseLoad
+  })
+  const pageEntity = mapper.entities.page
+
+  equal(setupEmitter({ mapper, connectionString: 'redis://127.0.0.1:6379', log: fakeLogger }), undefined)
+  teardown(promisify(mapper.mq.close.bind(mapper.mq)))
+
+  const anotherMQ = new MQEmitterRedis()
+  teardown(() => anotherMQ.close())
+
+  const messages = new PassThrough({ objectMode: true })
+  await promisify(anotherMQ.on.bind(anotherMQ))('#', function (msg, cb) {
+    messages.write(msg, cb)
+  })
+
+  const queue = await mapper.subscribe([
+    '/entity/page/save/+',
+    '/entity/page/delete/+'
+  ])
+
+  const expected = []
+
+  // save - new record
+  const page = await pageEntity.save({
+    input: { title: 'fourth page' }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  // save - update record
+  await pageEntity.save({
+    input: {
+      id: page.id,
+      title: 'fifth page'
+    }
+  })
+  expected.push({
+    topic: '/entity/page/save/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  await pageEntity.delete({
+    where: {
+      id: {
+        eq: page.id
+      }
+    },
+    fields: ['id', 'title']
+  })
+
+  expected.push({
+    topic: '/entity/page/delete/' + page.id,
+    payload: {
+      id: page.id
+    }
+  })
+
+  let i = 0
+  for await (const ev of queue) {
+    same(ev, expected[i++])
+    if (i === expected.length) {
+      break
+    }
+  }
+
+  i = 0
+  for await (const ev of messages) {
+    same(ev, expected[i++])
+    if (i === expected.length) {
+      break
+    }
+  }
+})