Subscribe

.gitignore

@@ -6,4 +6,4 @@ node_modules
 *.iml
 *.code-workspace
 .DS_Store
-sakila.db
+

package.json

@@ -36,6 +36,7 @@
   "scripts": {
     "build": "rimraf dist && tsc",
     "test": "jest --runInBand --coverage",
+    "testOnly": "jest --runInBand",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
     "lint": "eslint src",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -79,6 +80,7 @@
     "graphql": "15.1.0",
     "graphql-middleware": "4.0.2",
     "graphql-scalars": "1.1.5",
+    "graphql-subscriptions": "^1.1.0",
     "graphql-tag": "2.10.3",
     "husky": "4.2.5",
     "jest": "26.0.1",
@@ -95,4 +97,4 @@
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0"
   }
-}
+}

src/__tests__/postgres/client.ts

@@ -1,4 +1,5 @@
 import { createSqlmancerClient } from '../../'
 import { SqlmancerClient } from './sqlmancer'
+import { PubSub } from 'graphql-subscriptions'
 
-export const client = createSqlmancerClient<SqlmancerClient>(__dirname + '/schema.ts', require('./knex'))
+export const client = createSqlmancerClient<SqlmancerClient>(__dirname + '/schema.ts', require('./knex'), new PubSub())

src/__tests__/postgres/integration.test.ts

@@ -1,7 +1,7 @@
 /* eslint-disable jest/require-top-level-describe */
 /* eslint-disable no-useless-escape */
-import { graphql, validateSchema } from 'graphql'
-import { schema, client } from './schema'
+import { graphql, validateSchema, subscribe, parse, ExecutionResult } from 'graphql'
+import { schema, client, pubSub } from './schema'
 
 const describeMaybeSkip = process.env.DB && !process.env.DB.split(' ').includes('postgres') ? describe.skip : describe
 
@@ -394,4 +394,62 @@ describeMaybeSkip('integration (postgres)', () => {
     expect(errors).toBeUndefined()
     expect(data?.films.some((f: any) => f.sequel && f.sequel.id)).toBe(true)
   })
+
+  test('subscriptions', async () => {
+    const document = parse(`
+      subscription {
+        create 
+      }
+    `)
+
+    const sub = <AsyncIterator<ExecutionResult>>await subscribe(schema, document)
+    expect(sub.next).toBeDefined()
+
+    const next = sub.next() // grab the promise
+    pubSub.publish('CREATE_ONE', { create: 'FLUM!' }) //publish
+    const {
+      value: { errors, data },
+    } = await next // await the promise
+
+    expect(errors).toBeUndefined()
+    expect(data).toBeDefined()
+    expect(data.create).toBe('FLUM!')
+  })
+
+  // this skipped test is returning "GraphQLError: Cannot return null for non-nullable field Subscription.create" at `expect(subErrors).toBeUndefined()`
+  test('subscription triggered by mutation', async () => {
+    const document = parse(`
+      subscription {
+        create 
+      }
+    `)
+
+    const query = `mutation {
+      deleteCustomer(id: 1009)
+
+      createCustomer (input: {
+          id: 1009
+          firstName: "Morty"
+          lastName: "Blinkers"
+          email: "[email protected]"
+      }) {
+        id
+      }
+    }`
+
+    const sub = <AsyncIterator<ExecutionResult>>await subscribe(schema, document)
+    expect(sub.next).toBeDefined()
+
+    const next = sub.next()
+
+    const { data, errors } = await graphql(schema, query)
+    expect(errors).toBeUndefined()
+    expect(data).toBeDefined()
+
+    const {
+      value: { errors: subErrors, data: subData },
+    } = await next
+    expect(subErrors).toBeUndefined()
+    expect(subData).toBeDefined()
+  }, 10000)
 })

src/__tests__/postgres/schema.ts

@@ -5,12 +5,17 @@ import { IResolvers } from 'graphql-tools'
 import knex from './knex'
 import { createSqlmancerClient, makeSqlmancerSchema } from '../..'
 import { SqlmancerClient } from './sqlmancer'
+import { PubSub } from 'graphql-subscriptions'
 
 const typeDefs = gql`
   scalar DateTime
   scalar JSON
   scalar JSONObject
 
+  type Subscription {
+    create: String!
+  }
+
   type Query
     @sqlmancer(
       dialect: POSTGRES
@@ -243,14 +248,24 @@ const typeDefs = gql`
   }
 `
 
-export const client = createSqlmancerClient<SqlmancerClient>(__filename, knex)
+const pubSub = new PubSub()
+export const client = createSqlmancerClient<SqlmancerClient>(__filename, knex, pubSub)
 
 const { Film, Actor, Customer, Address, Movie, Person } = client.models
 
 const resolvers: IResolvers = {
   DateTime: GraphQLDateTime,
   JSON: GraphQLJSON,
   JSONObject: GraphQLJSONObject,
+
+  Subscription: {
+    create: {
+      subscribe: () => {
+        return pubSub.asyncIterator('CREATE_ONE')
+      },
+    },
+  },
+
   Query: {
     actors: (_root, _args, _ctx, info) => {
       return Actor.findMany().resolveInfo(info).execute()
@@ -291,7 +306,7 @@ const resolvers: IResolvers = {
   },
   Mutation: {
     createCustomer: async (_root, args, _ctx, info) => {
-      const id = await Customer.createOne(args.input).execute()
+      const id = await Customer.createOne(args.input).publish().execute()
       return Customer.findById(id).resolveInfo(info).execute()
     },
     createCustomers: async (_root, args, _ctx, info) => {
@@ -339,3 +354,4 @@ export const schema = makeSqlmancerSchema({
   typeDefs,
   resolvers,
 })
+export { pubSub }

src/client/createSqlmancerClient.ts

@@ -38,7 +38,8 @@ export type GenericSqlmancerClient = Knex & {
 
 export function createSqlmancerClient<T extends GenericSqlmancerClient = GenericSqlmancerClient>(
   glob: string,
-  knex: Knex
+  knex: Knex,
+  pubSub?: any
 ): T {
   const typeDefs = getTypeDefsFromGlob(glob)
 
@@ -51,7 +52,7 @@ export function createSqlmancerClient<T extends GenericSqlmancerClient = Generic
 
   return Object.assign(knex, {
     models: _.mapValues(models, (model: Model) => {
-      const options = { knex, dialect }
+      const options = { knex, dialect, pubSub }
       const { builders, readOnly } = model
       return {
         findById: (id: ID) => new builders.findById(options, id),

src/queryBuilder/createOne.ts

@@ -10,6 +10,16 @@ export class CreateOneBuilder<TCreateFields extends Record<string, any>> extends
     this._data = data
   }
 
+  /**
+   * Publishes and event notifying subscriber of Change
+   */
+  public publish(): this {
+    if (this._options.pubSub) {
+      this._options.pubSub.publish('CREATE_ONE', { create: 'TEST' })
+    }
+    return this
+  }
+
   /**
    * Executes the query and returns a Promise that will resolve to the ID of the created row.
    */

src/types.ts

@@ -74,6 +74,7 @@ export type Association = {
 export type BuilderOptions = {
   knex: Knex
   dialect: Dialect
+  pubSub?: any
 }
 
 export type QueryBuilderContext = {