@platformatic/sql-graphql 0.45.0 → 0.46.1

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.0",
+  "version": "0.46.1",
   "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.0",
-    "@platformatic/sql-mapper": "0.45.0"
+    "@platformatic/sql-events": "0.46.1",
+    "@platformatic/sql-mapper": "0.46.1"
   },
   "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.1"
   },
   "tsd": {
     "directory": "test/types"

package/test/ignore.test.js

@@ -129,7 +129,7 @@ test('ignore a table via sql-graphql option', async ({ pass, teardown, equal })
   })
   app.register(sqlGraphQL, {
     ignore: {
-      categories: true
+      category: true
     }
   })
   teardown(app.close.bind(app))
@@ -158,6 +158,46 @@ test('ignore a table via sql-graphql option', async ({ pass, teardown, equal })
   }
 })
 
+test('show a warning if there is no ignored entity', async ({ plan, pass, teardown }) => {
+  plan(2)
+
+  const app = fastify({
+    logger: {
+      info () {},
+      debug () {},
+      trace () {},
+      fatal () {},
+      error () {},
+      child () {
+        return this
+      },
+      warn (msg) {
+        if (msg === 'Ignored graphql entity "missingEntityPages" not found. Did you mean "page"?') {
+          pass('warning message is shown')
+        }
+      }
+    }
+  })
+
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL, {
+    ignore: {
+      missingEntityPages: true
+    }
+  })
+  teardown(app.close.bind(app))
+
+  await app.ready()
+})
+
 test('ignore a column via sql-graphql option', async ({ pass, teardown, equal }) => {
   const app = fastify()
   app.register(sqlMapper, {
@@ -171,7 +211,7 @@ test('ignore a column via sql-graphql option', async ({ pass, teardown, equal })
   })
   app.register(sqlGraphQL, {
     ignore: {
-      categories: {
+      category: {
         name: true
       }
     }
@@ -205,3 +245,45 @@ test('ignore a column via sql-graphql option', async ({ pass, teardown, equal })
     equal(Category.fields.find((f) => f.name === 'name'), undefined, 'name column is ignored')
   }
 })
+
+test('show a warning if there is no ignored entity field', async ({ plan, pass, teardown }) => {
+  plan(2)
+
+  const app = fastify({
+    logger: {
+      info () {},
+      debug () {},
+      trace () {},
+      fatal () {},
+      error () {},
+      child () {
+        return this
+      },
+      warn (msg) {
+        if (msg === 'Ignored graphql field "missingFieldName" not found in entity "category". Did you mean "name"?') {
+          pass('warning message is shown')
+        }
+      }
+    }
+  })
+
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  app.register(sqlGraphQL, {
+    ignore: {
+      category: {
+        missingFieldName: true
+      }
+    }
+  })
+  teardown(app.close.bind(app))
+
+  await app.ready()
+})