@platformatic/sql-graphql 0.10.0 → 0.11.0

package/index.js

@@ -118,7 +118,21 @@ async function mapperToGraphql (app, opts) {
     }
   }
 
-  let sdl = graphql.printSchema(new graphql.GraphQLSchema({ query, mutation, subscription }))
+  let sdl = ''
+  try {
+    sdl = graphql.printSchema(new graphql.GraphQLSchema({ query, mutation, subscription }))
+  } catch (error) {
+    // The next lines are excluded from test coverage:
+    // it's quite hard to test the following lines for all of the DB types
+    /* istanbul ignore next */
+    app.log.debug({ query, mutation, subscription }, 'GraphQL input schema')
+    /* istanbul ignore next */
+    const newError = new Error('Error printing the GraphQL schema')
+    /* istanbul ignore next */
+    newError.cause = error
+    /* istanbul ignore next */
+    throw newError
+  }
 
   if (opts.federationMetadata) {
     for (const replacement of federationReplacements) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-graphql",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Map SQL dbs to GraphQL",
   "main": "index.js",
   "repository": {
@@ -14,14 +14,14 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@platformatic/sql-events": "0.10.0",
-    "@platformatic/sql-mapper": "0.10.0",
     "fastify": "^4.6.0",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
     "tsd": "^0.25.0",
-    "ws": "^8.9.0"
+    "ws": "^8.9.0",
+    "@platformatic/sql-events": "0.11.0",
+    "@platformatic/sql-mapper": "0.11.0"
   },
   "dependencies": {
     "camelcase": "^6.0.0",

package/test/created_updated_at.test.js

@@ -0,0 +1,517 @@
+'use strict'
+
+const { test } = require('tap')
+const sqlGraphQL = require('..')
+const sqlMapper = require('@platformatic/sql-mapper')
+const fastify = require('fastify')
+const { clear, connInfo, isSQLite, isMysql } = require('./helper')
+const { setTimeout } = require('timers/promises')
+
+async function createBasicPages (db, sql) {
+  if (isSQLite) {
+    await db.query(sql`CREATE TABLE pages (
+      id INTEGER PRIMARY KEY,
+      title VARCHAR(42),
+      created_at TIMESTAMP,
+      updated_at TIMESTAMP
+    );`)
+  } else if (isMysql) {
+    await db.query(sql`CREATE TABLE pages (
+      id SERIAL PRIMARY KEY,
+      title VARCHAR(42),
+      created_at TIMESTAMP NULL DEFAULT NULL,
+      updated_at TIMESTAMP NULL DEFAULT NULL
+    );`)
+  } else {
+    await db.query(sql`CREATE TABLE pages (
+      id SERIAL PRIMARY KEY,
+      title VARCHAR(42),
+      created_at TIMESTAMP,
+      updated_at TIMESTAMP
+    );`)
+  }
+}
+
+test('created_at updated_at happy path', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  let original
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { title: "Hello" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const data = res.json().data
+    not(data.savePage.createdAt, null, 'createdAt')
+    not(data.savePage.updatedAt, null, 'updatedAt')
+    comment(`createdAt: ${data.savePage.createdAt}`)
+    comment(`updatedAt: ${data.savePage.updatedAt}`)
+    original = data.savePage
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          query {
+            getPageById(id: 1) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'pages status code')
+    const data = res.json().data
+    equal(data.getPageById.createdAt, original.createdAt, 'createdAt')
+    equal(data.getPageById.updatedAt, original.updatedAt, 'updatedAt')
+    comment(`createdAt: ${data.getPageById.createdAt}`)
+    comment(`updatedAt: ${data.getPageById.updatedAt}`)
+  }
+
+  await setTimeout(1000) // await 1s
+
+  let updated
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { id: 1, title: "Hello World" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    const data = res.json().data
+    equal(data.savePage.createdAt, original.createdAt, 'createdAt')
+    not(data.savePage.updatedAt, original.updatedAt, 'updatedAt')
+    updated = data.savePage
+    comment(`createdAt: ${data.savePage.createdAt}`)
+    comment(`updatedAt: ${data.savePage.updatedAt}`)
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          query {
+            getPageById(id: 1) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'pages status code')
+    const data = res.json().data
+    equal(data.getPageById.createdAt, updated.createdAt, 'createdAt')
+    equal(data.getPageById.updatedAt, updated.updatedAt, 'updatedAt')
+    comment(`createdAt: ${data.getPageById.createdAt}`)
+    comment(`updatedAt: ${data.getPageById.updatedAt}`)
+  }
+})
+
+test('cannot set created_at', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { title: "Hello", createdAt: "${new Date().toISOString()}" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 400, 'savePage status code')
+    const data = res.json()
+    equal(data.errors[0].message, 'Field "createdAt" is not defined by type "PageInput".')
+  }
+})
+
+test('cannot set updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { title: "Hello" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const data = res.json().data
+    not(data.savePage.createdAt, null, 'createdAt')
+    not(data.savePage.updatedAt, null, 'updatedAt')
+    comment(`createdAt: ${data.savePage.createdAt}`)
+    comment(`updatedAt: ${data.savePage.updatedAt}`)
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { id: 1, title: "Hello World", updatedAt: "${new Date().toISOString()}" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 400, 'savePage status code')
+    const data = res.json()
+    equal(data.errors[0].message, 'Field "updatedAt" is not defined by type "PageInput".')
+  }
+})
+
+test('do not assign created_at updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    autoTimestamp: false,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { title: "Hello" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const data = res.json().data
+    equal(data.savePage.createdAt, null, 'createdAt')
+    equal(data.savePage.updatedAt, null, 'updatedAt')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          query {
+            getPageById(id: 1) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'pages status code')
+    const data = res.json().data
+    equal(data.getPageById.createdAt, null, 'createdAt')
+    equal(data.getPageById.updatedAt, null, 'updatedAt')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { id: 1, title: "Hello World" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    const data = res.json().data
+    equal(data.savePage.createdAt, null, 'createdAt')
+    equal(data.savePage.updatedAt, null, 'updatedAt')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          query {
+            getPageById(id: 1) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'pages status code')
+    const data = res.json().data
+    equal(data.getPageById.createdAt, null, 'createdAt')
+    equal(data.getPageById.updatedAt, null, 'updatedAt')
+  }
+})
+
+test('bulk insert adds created_at updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation {
+            savePage(input: { title: "Hello" }) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const data = res.json().data
+    not(data.savePage.createdAt, null, 'createdAt')
+    not(data.savePage.updatedAt, null, 'updatedAt')
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation batch($inputs : [PageInput]!) {
+            insertPages (inputs: $inputs) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `,
+        variables: {
+          inputs: [
+            { title: 'Page 1' },
+            { title: 'Page 2' },
+            { title: 'Page 3' }
+          ]
+        }
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const pages = res.json().data.insertPages
+    for (const page of pages) {
+      not(page.createdAt, null, 'createdAt')
+      not(page.updatedAt, null, 'updatedAt')
+      equal(page.createdAt, page.updatedAt, 'createdAt === updatedAt')
+    }
+  }
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          query {
+            pages {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `
+      }
+    })
+    equal(res.statusCode, 200, 'pages status code')
+    const pages = res.json().data.pages
+    for (const page of pages) {
+      not(page.createdAt, null, 'createdAt')
+      not(page.updatedAt, null, 'updatedAt')
+      equal(page.createdAt, page.updatedAt, 'createdAt === updatedAt')
+    }
+  }
+})
+
+test('bulk insert with autoTimestamp=false do not had created_at updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    autoTimestamp: false,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const res = await app.inject({
+      method: 'POST',
+      url: '/graphql',
+      body: {
+        query: `
+          mutation batch($inputs : [PageInput]!) {
+            insertPages (inputs: $inputs) {
+              id
+              title
+              createdAt
+              updatedAt
+            }
+          }
+        `,
+        variables: {
+          inputs: [
+            { title: 'Page 1' },
+            { title: 'Page 2' },
+            { title: 'Page 3' }
+          ]
+        }
+      }
+    })
+    equal(res.statusCode, 200, 'savePage status code')
+    const pages = res.json().data.insertPages
+    for (const page of pages) {
+      equal(page.createdAt, null, 'createdAt')
+      equal(page.updatedAt, null, 'updatedAt')
+    }
+  }
+})

package/test/helper.js

@@ -96,4 +96,19 @@ module.exports.clear = async function (db, sql) {
     await db.query(sql`DROP Type simple_enum`)
   } catch (err) {
   }
+
+  try {
+    await db.query(sql`DROP TABLE "myschema"."mytable"`)
+  } catch (err) {
+  }
+
+  try {
+    await db.query(sql`DROP TABLE "myschema"."template"`)
+  } catch (err) {
+  }
+
+  try {
+    await db.query(sql`DROP SCHEMA "myschema"`)
+  } catch (err) {
+  }
 }

package/test/inserted_updated_at.test.js

@@ -36,6 +36,10 @@ test('inserted_at updated_at happy path', async ({ pass, teardown, same, equal,
   const app = fastify()
   app.register(sqlMapper, {
     ...connInfo,
+    autoTimestamp: {
+      createdAt: 'inserted_at',
+      updatedAt: 'updated_at'
+    },
     async onDatabaseLoad (db, sql) {
       pass('onDatabaseLoad called')
 
@@ -159,6 +163,10 @@ test('cannot set inserted_at', async ({ pass, teardown, same, equal, not, commen
   const app = fastify()
   app.register(sqlMapper, {
     ...connInfo,
+    autoTimestamp: {
+      createdAt: 'inserted_at',
+      updatedAt: 'updated_at'
+    },
     async onDatabaseLoad (db, sql) {
       pass('onDatabaseLoad called')
 
@@ -198,6 +206,10 @@ test('cannot set updated_at', async ({ pass, teardown, same, equal, not, comment
   const app = fastify()
   app.register(sqlMapper, {
     ...connInfo,
+    autoTimestamp: {
+      createdAt: 'inserted_at',
+      updatedAt: 'updated_at'
+    },
     async onDatabaseLoad (db, sql) {
       pass('onDatabaseLoad called')
 
@@ -371,6 +383,10 @@ test('bulk insert adds inserted_at updated_at', async ({ pass, teardown, same, e
   const app = fastify()
   app.register(sqlMapper, {
     ...connInfo,
+    autoTimestamp: {
+      createdAt: 'inserted_at',
+      updatedAt: 'updated_at'
+    },
     async onDatabaseLoad (db, sql) {
       pass('onDatabaseLoad called')
 
@@ -466,7 +482,7 @@ test('bulk insert adds inserted_at updated_at', async ({ pass, teardown, same, e
   }
 })
 
-test('bulk insert with autoTimestamp=false do not hadd inserted_at updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
+test('bulk insert with autoTimestamp=false do not had inserted_at updated_at', async ({ pass, teardown, same, equal, not, comment }) => {
   const app = fastify()
   app.register(sqlMapper, {
     ...connInfo,

package/test/schema-error.test.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const { test } = require('tap')
+const sqlGraphQL = require('..')
+const sqlMapper = require('@platformatic/sql-mapper')
+const fastify = require('fastify')
+const { clear, connInfo, isPg } = require('./helper')
+
+const connInfoWithSchema = {
+  ...connInfo,
+  schema: ['public', 'myschema']
+}
+
+test('should catch GraphQL print schema errors', { skip: !isPg }, async ({ pass, teardown, same }) => {
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfoWithSchema,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+
+      await db.query(sql`
+      CREATE SCHEMA IF NOT EXISTS "myschema";
+
+      CREATE TABLE IF NOT EXISTS "myschema"."template" (
+          "id" uuid NOT NULL,
+          PRIMARY KEY ("id")
+      );
+      
+      CREATE TABLE IF NOT EXISTS "myschema"."mytable" (
+          "id" int4 NOT NULL,
+          "template_id" uuid,
+          CONSTRAINT "mytable_template" FOREIGN KEY ("template_id") REFERENCES "myschema"."template"("id"),
+          PRIMARY KEY ("id")
+      );`)
+    }
+  })
+
+  app.register(sqlGraphQL)
+  teardown(app.close.bind(app))
+
+  try {
+    await app.ready()
+    same(true, false, 'We check that this line never runs, since we should catch the previous error')
+  } catch (error) {
+    same(error.name, 'Error')
+    same(error.message, 'Error printing the GraphQL schema')
+    same(error.cause, new Error('MyschemaTemplate.mytable field config must be an object.'))
+  }
+})