@platformatic/sql-graphql 0.4.0 → 0.5.1

package/index.js

@@ -5,6 +5,7 @@ const constructGraph = require('./lib/entity-to-type')
 const mercurius = require('mercurius')
 const graphql = require('graphql')
 const establishRelations = require('./lib/relationship')
+const setupSubscriptions = require('./lib/subscriptions')
 const scalars = require('graphql-scalars')
 
 async function mapperToGraphql (app, opts) {
@@ -24,6 +25,8 @@ async function mapperToGraphql (app, opts) {
     federationReplacements,
     federationMetadata: opts.federationMetadata
   }
+  const metaMap = new Map()
+
   if (Object.keys(mapper.entities).length === 0) {
     // no schema
     queryTopFields.hello = { type: graphql.GraphQLString }
@@ -31,7 +34,6 @@ async function mapperToGraphql (app, opts) {
       hello: () => 'Hello Platformatic!'
     }
   } else {
-    const metaMap = new Map()
     for (const entity of Object.values(mapper.entities)) {
       relations.push(...entity.relations)
       const meta = constructGraph(app, entity, graphOpts)
@@ -85,7 +87,21 @@ async function mapperToGraphql (app, opts) {
     delete resolvers.Mutation
   }
 
-  let sdl = graphql.printSchema(new graphql.GraphQLSchema({ query, mutation }))
+  let subscription
+  if (app.platformatic.mq) {
+    const entitiesList = Object.keys(app.platformatic.entities)
+    const ignoreList = opts.subscriptionIgnore || []
+
+    if (entitiesList.length - ignoreList.length > 0) {
+      opts.subscription = {
+        emitter: app.platformatic.mq
+      }
+      // TODO support ignoring some of those
+      subscription = setupSubscriptions(app, metaMap, resolvers, ignoreList)
+    }
+  }
+
+  let sdl = graphql.printSchema(new graphql.GraphQLSchema({ query, mutation, subscription }))
 
   if (opts.federationMetadata) {
     for (const replacement of federationReplacements) {
@@ -108,6 +124,7 @@ async function mapperToGraphql (app, opts) {
   }
 
   opts.graphiql = opts.graphiql !== false
+
   await app.register(mercurius, {
     ...opts,
     schema: sdl,

package/lib/entity-to-type.js

@@ -229,6 +229,7 @@ function constructGraph (app, entity, opts) {
     type,
     entity,
     loadMany,
+    getFields,
     fields
   }
 

package/lib/relationship.js

@@ -16,6 +16,7 @@ module.exports = function establishRelations (app, relations, resolvers, loaders
   for (const relation of relations) {
     assert(relation.table_name, 'table_name is required')
     assert(relation.foreign_table_name, 'foreign_table_name is required')
+    assert(relation.column_name.toLowerCase().endsWith('id'), 'The column with id reference must be ended with `id` postfix')
 
     const current = tablesTypeMap[relation.table_name]
     const foreign = tablesTypeMap[relation.foreign_table_name]
@@ -23,7 +24,6 @@ module.exports = function establishRelations (app, relations, resolvers, loaders
 
     // current to foreign
     {
-      assert(relation.column_name.toLowerCase().endsWith('id'), 'The column with id reference must be ended with `id` postfix')
       const lowered = lowerCaseFirst(camelcase(cutOutIdEnding(relation.column_name)))
       if (!relationships[current.type] || relationships[current.type][lowered] !== false) {
         current.fields[lowered] = { type: foreign.type }
@@ -79,7 +79,7 @@ function lowerCaseFirst (str) {
 
 function cutOutIdEnding (str) {
   str = str.toString()
-  return str.slice(0, str.toLowerCase().indexOf('id'))
+  return str.slice(0, str.toLowerCase().lastIndexOf('id'))
 }
 
 function findPrimaryColumnName (camelCasedFields) {

package/lib/subscriptions.js

@@ -0,0 +1,89 @@
+'use strict'
+
+const graphql = require('graphql')
+
+function setupSubscriptions (app, metaMap, resolvers, ignores) {
+  const fields = {}
+  resolvers.Subscription = {}
+  for (const [field, meta] of metaMap) {
+    if (ignores.indexOf(field.singularName) >= 0) {
+      continue
+    }
+    const { type } = meta
+    const saved = `${field.singularName}Saved`
+    fields[saved] = {
+      type
+    }
+    resolvers.Subscription[saved] = {
+      subscribe: async function * (_, query, ctx, info) {
+        const log = ctx.reply.request.log
+        const { pubsub } = ctx
+        const entity = app.platformatic.entities[field.singularName]
+        const topic = await entity.getSubscriptionTopic({ action: 'save', ctx })
+        log.trace({ topic }, 'subscribed')
+        const res = await pubsub.subscribe(topic)
+        const primaryKey = entity.primaryKey
+        const fields = meta.getFields([{ info }])
+
+        for await (const msg of res) {
+          // TODO optimize this by not calling find() if the subscriber is only asking for the id.
+          try {
+            log.trace({ msg, entity: field.singularName }, 'graphql subscription augmenting data')
+            // The alternative to augmenting the data is installing a resolver for every type
+            // of a given entity that loads up the type via a dataloader.
+            const found = await entity.find({ where: { [primaryKey]: { eq: msg[primaryKey] } }, fields, ctx })
+            // The following could happen in case of a race condition
+            // testing it would be very hard, so we skip it for now
+            /* istanbul ignore next */
+            if (found.length === 0) {
+              log.warn({ ...msg.payload, entity: field.singularName }, 'graphql subscription could not find element')
+              continue
+            }
+            const toYield = { [saved]: found[0] }
+            log.trace({ yield: toYield, entity: field.singularName }, 'graphql subscription augmented data')
+            yield toYield
+          } catch (err) {
+            /* istanbul ignore next */
+            log.warn({ err, entity: field.singularName }, 'graphql subscription error')
+          }
+        }
+      }
+    }
+
+    const deleted = `${field.singularName}Deleted`
+    fields[deleted] = {
+      type: new graphql.GraphQLObjectType({
+        name: `${field.name}Deleted`,
+        fields: {
+          [field.primaryKey]: {
+            type: meta.fields[field.primaryKey].type
+          }
+        }
+      })
+    }
+    resolvers.Subscription[deleted] = {
+      subscribe: async (_, query, ctx, info) => {
+        const { pubsub } = ctx
+        const entity = app.platformatic.entities[field.singularName]
+        const topic = await entity.getSubscriptionTopic({ action: 'delete', ctx })
+        const res = await pubsub.subscribe(topic)
+        ctx.reply.request.log.trace({ topic }, 'subscribed')
+        return wrap(res, deleted)
+      }
+    }
+  }
+  const subscription = new graphql.GraphQLObjectType({
+    name: 'Subscription',
+    fields
+  })
+
+  return subscription
+}
+
+async function * wrap (iterator, key) {
+  for await (const msg of iterator) {
+    yield { [key]: msg }
+  }
+}
+
+module.exports = setupSubscriptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-graphql",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "Map SQL dbs to GraphQL",
   "main": "index.js",
   "repository": {
@@ -14,12 +14,14 @@
   },
   "homepage": "https://github.com/plaformatic/platformatic#readme",
   "devDependencies": {
-    "@platformatic/sql-mapper": "0.4.0",
+    "@platformatic/sql-events": "0.5.1",
+    "@platformatic/sql-mapper": "0.5.1",
     "fastify": "^4.6.0",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.24.0"
+    "tsd": "^0.24.0",
+    "ws": "^8.9.0"
   },
   "dependencies": {
     "camelcase": "^6.0.0",
@@ -28,7 +30,7 @@
     "graphql-scalars": "^1.13.1",
     "graphql-type-json": "^0.3.2",
     "inflected": "^2.1.0",
-    "mercurius": "^11.0.0"
+    "mercurius": "^11.2.0"
   },
   "tsd": {
     "directory": "test/types"

package/test/helper.js

@@ -77,4 +77,13 @@ module.exports.clear = async function (db, sql) {
     await db.query(sql`DROP TABLE authors`)
   } catch (err) {
   }
+
+  try {
+    await db.query(sql`DROP TABLE organizations`)
+  } catch (err) {
+  }
+  try {
+    await db.query(sql`DROP TABLE individuals`)
+  } catch (err) {
+  }
 }

package/test/relations.test.js

@@ -239,3 +239,148 @@ test('should handle multi references', async ({ pass, teardown, same, equal }) =
     }, 'query authors response')
   }
 })
+
+test('cut out id exactly from ending when forming a name of relation', async ({ pass, teardown, same, equal }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+
+      if (isMysql) {
+        await db.query(sql`
+          CREATE TABLE individuals (
+            id SERIAL PRIMARY KEY,
+            name VARCHAR(255)
+          );
+          CREATE TABLE organizations (
+            id SERIAL PRIMARY KEY,
+            name VARCHAR(42),
+            individual_id BIGINT UNSIGNED,
+            FOREIGN KEY (individual_id) REFERENCES individuals(id) ON DELETE CASCADE
+          );
+        `)
+      } else if (isSQLite) {
+        await db.query(sql`
+          CREATE TABLE individuals (
+            id INTEGER PRIMARY KEY,
+            name VARCHAR(255)
+          );
+        `)
+        await db.query(sql`
+          CREATE TABLE organizations (
+            id INTEGER PRIMARY KEY,
+            name VARCHAR(42),
+            individual_id BIGINT UNSIGNED,
+            FOREIGN KEY (individual_id) REFERENCES individuals(id) ON DELETE CASCADE
+          );
+        `)
+      } else {
+        await db.query(sql`
+          CREATE TABLE individuals (
+            id SERIAL PRIMARY KEY,
+            name VARCHAR(42)
+          );
+          CREATE TABLE organizations (
+            id SERIAL PRIMARY KEY,
+            name VARCHAR(42),
+            individual_id INTEGER REFERENCES individuals(id)
+          );
+        `)
+      }
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  const individuals = [{
+    id: 1,
+    name: 'Mark'
+  }]
+
+  const organization = [{
+    id: 1,
+    name: 'Platformatic',
+    individualId: 1
+  }]
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+            mutation batch($inputs : [IndividualInput]!) {
+              insertIndividuals(inputs: $inputs) {
+                id
+                name
+              }
+            }
+          `,
+        variables: {
+          inputs: individuals
+        }
+      }
+    })
+    equal(res.statusCode, 200, 'individuals status code')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+            mutation batch($inputs : [OrganizationInput]!) {
+              insertOrganizations(inputs: $inputs) {
+                id
+                name
+              }
+            }
+          `,
+        variables: {
+          inputs: organization
+        }
+      }
+    })
+    equal(res.statusCode, 200, 'organization status code')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+            query {
+              organizations {
+                id
+                name
+                individual {
+                  id
+                  name
+                }
+              }
+            }
+          `
+      }
+    })
+    equal(res.statusCode, 200, 'query organization')
+    same(res.json(), {
+      data: {
+        organizations: [{
+          id: 1,
+          name: 'Platformatic',
+          individual: {
+            id: 1,
+            name: 'Mark'
+          }
+        }]
+      }
+    }, 'query organization response')
+  }
+})

package/test/subscription.test.js

@@ -0,0 +1,336 @@
+'use strict'
+
+const { test } = require('tap')
+const Fastify = require('fastify')
+const WebSocket = require('ws')
+const { once } = require('events')
+const sqlGraphQL = require('..')
+const sqlMapper = require('@platformatic/sql-mapper')
+const sqlEvents = require('@platformatic/sql-events')
+const { clear, connInfo, isSQLite } = require('./helper')
+const stream = require('stream')
+const graphql = require('graphql')
+
+async function createBasicPages (db, sql) {
+  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(42)
+    );`)
+  }
+}
+
+function createWebSocketClient (t, app) {
+  const ws = new WebSocket('ws://localhost:' + (app.server.address()).port + '/graphql', 'graphql-ws')
+  const client = WebSocket.createWebSocketStream(ws, { encoding: 'utf8', objectMode: true })
+  t.teardown(client.destroy.bind(client))
+  client.setEncoding('utf8')
+  return { client, ws }
+}
+
+test('subscription - crud', { only: true }, async t => {
+  const app = Fastify()
+  t.teardown(() => app.close())
+
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlEvents)
+  app.register(sqlGraphQL)
+
+  await app.listen({ port: 0 })
+
+  const { client } = createWebSocketClient(t, app)
+
+  client.write(JSON.stringify({
+    type: 'connection_init'
+  }))
+
+  {
+    const query = `subscription {
+      pageSaved {
+        id
+        title
+      }
+    }`
+    client.write(JSON.stringify({
+      id: 1,
+      type: 'start',
+      payload: {
+        query
+      }
+    }))
+  }
+
+  {
+    const query = `subscription {
+      pageDeleted {
+        id
+      }
+    }`
+    client.write(JSON.stringify({
+      id: 1,
+      type: 'start',
+      payload: {
+        query
+      }
+    }))
+  }
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.equal(data.type, 'connection_ack')
+  }
+
+  t.comment('sending mutation')
+
+  await app.inject({
+    method: 'POST',
+    url: '/graphql',
+    body: {
+      query: `
+        mutation {
+          savePage(input: { title: "Hello World" }) {
+            id
+          }
+        }
+      `
+    }
+  })
+
+  t.comment('mutation sent')
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.same(data, {
+      id: 1,
+      type: 'data',
+      payload: {
+        data: {
+          pageSaved: {
+            id: '1',
+            title: 'Hello World'
+          }
+        }
+      }
+    })
+  }
+
+  t.comment('updating entity')
+
+  await app.inject({
+    method: 'POST',
+    url: '/graphql',
+    body: {
+      query: `
+        mutation {
+          savePage(input: { id: 1, title: "Harry Potter" }) {
+            id
+          }
+        }
+      `
+    }
+  })
+
+  t.comment('entity updated')
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.same(data, {
+      id: 1,
+      type: 'data',
+      payload: {
+        data: {
+          pageSaved: {
+            id: '1',
+            title: 'Harry Potter'
+          }
+        }
+      }
+    })
+  }
+
+  t.comment('deleting entity')
+
+  await app.inject({
+    method: 'POST',
+    url: '/graphql',
+    body: {
+      query: `
+        mutation {
+          deletePages(where: { id: { eq: 1 } }) {
+            id
+          }
+        }
+      `
+    }
+  })
+
+  t.comment('entity deleted')
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.same(data, {
+      id: '1',
+      type: 'data',
+      payload: {
+        data: {
+          pageDeleted: {
+            id: '1'
+          }
+        }
+      }
+    })
+  }
+
+  t.comment('sending mutation')
+
+  {
+    const [
+      received,
+      stored
+    ] = await Promise.all(([
+      (async function () {
+        const res = await app.inject({
+          method: 'POST',
+          url: '/graphql',
+          body: {
+            query: `
+            mutation batch($inputs : [PageInput]!) {
+              insertPages (inputs: $inputs) {
+                id
+                title
+              }
+            }
+          `,
+            variables: {
+              inputs: [
+                { title: 'Page 1' },
+                { title: 'Page 2' },
+                { title: 'Page 3' }
+              ]
+            }
+          }
+        })
+        t.comment('mutation sent')
+        const pages = res.json().data.insertPages
+        t.comment(JSON.stringify(pages, null, 2))
+        return pages
+      })(),
+      (async function () {
+        const pages = []
+        const second = new stream.PassThrough({ objectMode: true })
+        client.pipe(second)
+        for await (const chunk of second) {
+          const data = JSON.parse(chunk)
+          pages.push(data.payload.data.pageSaved)
+          if (pages.length === 3) {
+            break
+          }
+        }
+        t.comment('received all pages', JSON.stringify(pages, null, 2))
+        return pages
+      })()
+    ]))
+
+    t.same(received, stored)
+  }
+})
+
+test('subscription - ignore', async t => {
+  const app = Fastify()
+  t.teardown(() => app.close())
+
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlEvents)
+  app.register(sqlGraphQL, {
+    subscriptionIgnore: ['page']
+  })
+
+  await app.ready()
+  t.equal(graphql.printSchema(app.graphql.schema).indexOf('type Subscription'), -1)
+})
+
+test('subscription - crud with two schemas and a ignore', async t => {
+  const app = Fastify()
+  t.teardown(() => app.close())
+
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+
+      if (isSQLite) {
+        await db.query(sql`CREATE TABLE categories (
+          id INTEGER PRIMARY KEY,
+          name VARCHAR(42)
+        );`)
+      } else {
+        await db.query(sql`CREATE TABLE categories (
+          id SERIAL PRIMARY KEY,
+          name VARCHAR(42)
+        );`)
+      }
+    }
+  })
+  app.register(sqlEvents)
+  app.register(sqlGraphQL, {
+    subscriptionIgnore: ['category']
+  })
+
+  await app.listen({ port: 0 })
+
+  const { client } = createWebSocketClient(t, app)
+  t.teardown(() => client.destroy())
+
+  client.write(JSON.stringify({
+    type: 'connection_init'
+  }))
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.equal(data.type, 'connection_ack')
+  }
+
+  {
+    const query = `subscription {
+      categorySaved {
+        id
+      }
+    }`
+    client.write(JSON.stringify({
+      id: 1,
+      type: 'start',
+      payload: {
+        query
+      }
+    }))
+  }
+
+  {
+    const [chunk] = await once(client, 'data')
+    const data = JSON.parse(chunk)
+    t.equal(data.payload, 'The subscription field "categorySaved" is not defined.')
+  }
+})