@platformatic/sql-graphql 0.45.1 → 0.46.2

package/index.js

@@ -5,6 +5,7 @@ const constructGraph = require('./lib/entity-to-type')
 const mercurius = require('mercurius')
 const graphql = require('graphql')
 const { mercuriusFederationPlugin } = require('@mercuriusjs/federation')
+const { findNearestString } = require('@platformatic/utils')
 const establishRelations = require('./lib/relationship')
 const setupSubscriptions = require('./lib/subscriptions')
 const scalars = require('graphql-scalars')
@@ -37,12 +38,27 @@ async function mapperToGraphql (app, opts) {
       hello: () => 'Hello Platformatic!'
     }
   } else {
+    const entitiesNames = Object.values(mapper.entities)
+      .map(entity => entity.singularName)
+
+    for (const ignoredEntity of Object.keys(ignore)) {
+      if (!entitiesNames.includes(ignoredEntity)) {
+        const nearestEntity = findNearestString(entitiesNames, ignoredEntity)
+        let warningMessage = `Ignored graphql entity "${ignoredEntity}" not found.`
+        /* istanbul ignore next */
+        if (nearestEntity) {
+          warningMessage += ` Did you mean "${nearestEntity}"?`
+        }
+        app.log.warn(warningMessage)
+      }
+    }
+
     for (const entity of Object.values(mapper.entities)) {
-      if (ignore[entity.pluralName] === true) {
+      if (ignore[entity.singularName] === true) {
         continue
       }
       relations.push(...entity.relations)
-      const meta = constructGraph(app, entity, graphOpts, ignore[entity.pluralName] || {})
+      const meta = constructGraph(app, entity, graphOpts, ignore[entity.singularName] || {})
       metaMap.set(entity, meta)
     }
 

package/lib/entity-to-type.js

@@ -2,6 +2,7 @@
 
 const graphql = require('graphql')
 const camelcase = require('camelcase')
+const { findNearestString } = require('@platformatic/utils')
 const {
   sqlTypeToGraphQL,
   fromSelectionSet
@@ -37,6 +38,19 @@ function constructGraph (app, entity, opts, ignore) {
     loaders
   } = opts
 
+  const entityFieldsNames = Object.values(entity.fields)
+    .map(field => field.camelcase)
+
+  for (const ignoredField of Object.keys(ignore)) {
+    if (!entityFieldsNames.includes(ignoredField)) {
+      const nearestField = findNearestString(entityFieldsNames, ignoredField)
+      app.log.warn(
+      `Ignored graphql field "${ignoredField}" not found in entity "${entity.singularName}".` +
+      ` Did you mean "${nearestField}"?`
+      )
+    }
+  }
+
   const fields = {}
 
   for (const key of Object.keys(entity.fields)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-graphql",
-  "version": "0.45.1",
+  "version": "0.46.2",
   "description": "Map SQL dbs to GraphQL",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,8 +22,8 @@
     "tap": "^16.3.6",
     "tsd": "^0.29.0",
     "ws": "^8.13.0",
-    "@platformatic/sql-events": "0.45.1",
-    "@platformatic/sql-mapper": "0.45.1"
+    "@platformatic/sql-events": "0.46.2",
+    "@platformatic/sql-mapper": "0.46.2"
   },
   "dependencies": {
     "@fastify/error": "^3.2.1",
@@ -34,7 +34,8 @@
     "graphql-scalars": "^1.22.2",
     "graphql-type-json": "^0.3.2",
     "inflected": "^2.1.0",
-    "mercurius": "^13.0.0"
+    "mercurius": "^13.0.0",
+    "@platformatic/utils": "0.46.2"
   },
   "tsd": {
     "directory": "test/types"

package/test/array.test.js

@@ -1,372 +0,0 @@
-'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')
-
-test('array support', { skip: !isPg }, async ({ pass, teardown, same, equal }) => {
-  const app = fastify()
-  app.register(sqlMapper, {
-    ...connInfo,
-    async onDatabaseLoad (db, sql) {
-      pass('onDatabaseLoad called')
-
-      await clear(db, sql)
-      await db.query(sql`CREATE TABLE pages (
-      id SERIAL PRIMARY KEY,
-      title VARCHAR(42) NOT NULL,
-      tags VARCHAR(42)[] NOT NULL
-    );`)
-    }
-  })
-  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", tags: ["foo", "bar"] }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'savePage status code')
-    same(res.json(), {
-      data: {
-        savePage: {
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }
-      }
-    }, 'savePage response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            getPageById(id: 1) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        getPageById: {
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { any: "foo" } }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: [{
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }]
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { contains: ["foo"] } }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: [{
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }]
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { contained: ["foo", "bar"] } }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: [{
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }]
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { overlaps: ["foo"] } }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: [{
-          id: 1,
-          title: 'Hello',
-          tags: ['foo', 'bar']
-        }]
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { any: "baz" } }) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: []
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { contains: ["baz"] } }) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: []
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { contained: ["foo"] } }) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: []
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { overlaps: ["baz"] } }) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: []
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            pages(where: { tags: { all: "foo" } }) {
-              id
-              title,
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        pages: []
-      }
-    }, 'pages response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          mutation {
-            savePage(input: { id: 1, title: "Hello World", tags: ["foo", "bar", "baz"] }) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'savePage status code')
-    same(res.json(), {
-      data: {
-        savePage: {
-          id: 1,
-          title: 'Hello World',
-          tags: ['foo', 'bar', 'baz']
-        }
-      }
-    }, 'savePage response')
-  }
-
-  {
-    const res = await app.inject({
-      method: 'POST',
-      url: '/graphql',
-      body: {
-        query: `
-          query {
-            getPageById(id: 1) {
-              id
-              title
-              tags
-            }
-          }
-        `
-      }
-    })
-    equal(res.statusCode, 200, 'pages status code')
-    same(res.json(), {
-      data: {
-        getPageById: {
-          id: 1,
-          title: 'Hello World',
-          tags: ['foo', 'bar', 'baz']
-        }
-      }
-    }, 'pages response')
-  }
-})