@platformatic/sql-mapper 0.45.1 → 0.46.2

package/lib/entity.js

@@ -8,6 +8,7 @@ const {
   sanitizeLimit
 } = require('./utils')
 const { singularize } = require('inflected')
+const { findNearestString } = require('@platformatic/utils')
 const errors = require('./errors')
 
 function lowerCaseFirst (str) {
@@ -369,6 +370,14 @@ function createMapper (defaultDb, sql, log, table, fields, primaryKeys, relation
 }
 
 function buildEntity (db, sql, log, table, queries, autoTimestamp, schema, useSchemaInName, ignore, limitConfig, schemaList, columns, constraintsList) {
+  const columnsNames = columns.map(c => c.column_name)
+  for (const ignoredColumn of Object.keys(ignore)) {
+    if (!columnsNames.includes(ignoredColumn)) {
+      const nearestColumn = findNearestString(columnsNames, ignoredColumn)
+      log.warn(`Ignored column "${ignoredColumn}" not found. Did you mean "${nearestColumn}"?`)
+    }
+  }
+
   // Compute the columns
   columns = columns.filter((c) => !ignore[c.column_name])
   const fields = columns.reduce((acc, column) => {

package/mapper.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { findNearestString } = require('@platformatic/utils')
 const buildEntity = require('./lib/entity')
 const buildCleanUp = require('./lib/clean-up')
 const queriesFactory = require('./lib/queries')
@@ -158,6 +159,18 @@ async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignor
       }
     }
 
+    const schemaTables = dbschema.map(table => table.table)
+    for (const ignoredTable of Object.keys(ignore)) {
+      if (!schemaTables.includes(ignoredTable)) {
+        const nearestTable = findNearestString(schemaTables, ignoredTable)
+        let warningMessage = `Ignored table "${ignoredTable}" not found.`
+        if (nearestTable) {
+          warningMessage += ` Did you mean "${nearestTable}"?`
+        }
+        log.warn(warningMessage)
+      }
+    }
+
     for (const { table, schema, columns, constraints } of dbschema) {
       // The following line is a safety net when developing this module,
       // it should never happen.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "0.45.1",
+  "version": "0.46.2",
   "description": "A data mapper utility for SQL databases",
   "main": "mapper.js",
   "types": "mapper.d.ts",
@@ -30,7 +30,8 @@
     "@matteo.collina/sqlite-pool": "^0.3.0",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.0",
-    "inflected": "^2.1.0"
+    "inflected": "^2.1.0",
+    "@platformatic/utils": "0.46.2"
   },
   "tsd": {
     "directory": "test/types"

package/test/composite.test.js

@@ -1,162 +0,0 @@
-'use strict'
-
-const { clear, connInfo, isSQLite, isMysql, isPg } = require('./helper')
-const { test } = require('tap')
-const { connect } = require('..')
-const fakeLogger = {
-  trace: () => {},
-  // trace: console.log,
-  error: () => {}
-}
-
-test('composite primary keys', async ({ equal, same, teardown, rejects }) => {
-  /* https://github.com/platformatic/platformatic/issues/299 */
-  async function onDatabaseLoad (db, sql) {
-    await clear(db, sql)
-    teardown(() => db.dispose())
-
-    if (isSQLite) {
-      await db.query(sql`CREATE TABLE pages (
-        id INTEGER PRIMARY KEY,
-        the_title VARCHAR(42)
-      );`)
-
-      await db.query(sql`CREATE TABLE users (
-        id INTEGER PRIMARY KEY,
-        username VARCHAR(255) NOT NULL
-      );`)
-
-      await db.query(sql`CREATE TABLE editors (
-        page_id INTEGER NOT NULL,
-        user_id INTEGER NOT NULL,
-        role VARCHAR(255) NOT NULL,
-        CONSTRAINT fk_editor_pages FOREIGN KEY (page_id) REFERENCES pages(id),
-        CONSTRAINT fk_editor_users FOREIGN KEY (user_id) REFERENCES users(id),
-        PRIMARY KEY (page_id, user_id)
-      );`)
-    } else if (isPg) {
-      await db.query(sql`CREATE TABLE pages (
-        id SERIAL PRIMARY KEY,
-        the_title VARCHAR(255) NOT NULL
-      );`)
-
-      await db.query(sql`CREATE TABLE users (
-        id SERIAL PRIMARY KEY,
-        username VARCHAR(255) NOT NULL
-      );`)
-
-      await db.query(sql`CREATE TABLE editors (
-        page_id INTEGER NOT NULL,
-        user_id INTEGER NOT NULL,
-        role VARCHAR(255) NOT NULL,
-        CONSTRAINT fk_editor_pages FOREIGN KEY (page_id) REFERENCES pages(id),
-        CONSTRAINT fk_editor_users FOREIGN KEY (user_id) REFERENCES users(id),
-        PRIMARY KEY (page_id, user_id)
-      );`)
-    } else if (isMysql) {
-      await db.query(sql`CREATE TABLE pages (
-        id INTEGER PRIMARY KEY AUTO_INCREMENT,
-        the_title VARCHAR(255) NOT NULL
-      );`)
-
-      await db.query(sql`CREATE TABLE users (
-        id INTEGER PRIMARY KEY AUTO_INCREMENT,
-        username VARCHAR(255) NOT NULL
-      );`)
-
-      await db.query(sql`CREATE TABLE editors (
-        page_id INTEGER NOT NULL,
-        user_id INTEGER NOT NULL,
-        role VARCHAR(255) NOT NULL,
-        CONSTRAINT \`fk_editor_pages\` FOREIGN KEY (page_id) REFERENCES pages (id) ON DELETE CASCADE ON UPDATE RESTRICT,
-        CONSTRAINT \`fk_editor_users\` FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ON UPDATE RESTRICT,
-        PRIMARY KEY (page_id, user_id)
-      );`)
-    }
-  }
-  const mapper = await connect({
-    connectionString: connInfo.connectionString,
-    log: fakeLogger,
-    onDatabaseLoad,
-    ignore: {},
-    hooks: {}
-  })
-  const pageEntity = mapper.entities.page
-  const userEntity = mapper.entities.user
-  const editorEntity = mapper.entities.editor
-
-  const page = await pageEntity.save({
-    input: { theTitle: 'foobar' }
-  })
-  same(page, { id: '1', theTitle: 'foobar' })
-
-  const user = await userEntity.save({
-    input: { username: 'mcollina' }
-  })
-  same(user, { id: '1', username: 'mcollina' })
-
-  const user2 = await userEntity.save({
-    input: { username: 'lucamaraschi' }
-  })
-  same(user2, { id: '2', username: 'lucamaraschi' })
-
-  const editor1 = await editorEntity.save({
-    input: {
-      pageId: '1',
-      userId: '1',
-      role: 'admin'
-    }
-  })
-  same(editor1, { pageId: '1', userId: '1', role: 'admin' })
-
-  const editor2 = await editorEntity.save({
-    input: {
-      pageId: '1',
-      userId: '2',
-      role: 'author'
-    }
-  })
-  same(editor2, { pageId: '1', userId: '2', role: 'author' })
-
-  await editorEntity.save({
-    input: {
-      pageId: '1',
-      userId: '1',
-      role: 'captain'
-    }
-  })
-
-  const editors = await editorEntity.find({ orderBy: [{ field: 'userId', direction: 'ASC' }] })
-  same(editors, [{
-    pageId: '1',
-    userId: '1',
-    role: 'captain'
-  }, {
-    pageId: '1',
-    userId: '2',
-    role: 'author'
-  }])
-
-  await editorEntity.delete({})
-
-  const editorsInserted = await editorEntity.insert({
-    inputs: [{
-      pageId: '1',
-      userId: '1',
-      role: 'admin'
-    }, {
-      pageId: '1',
-      userId: '2',
-      role: 'author'
-    }]
-  })
-  same(editorsInserted, [{
-    pageId: '1',
-    userId: '1',
-    role: 'admin'
-  }, {
-    pageId: '1',
-    userId: '2',
-    role: 'author'
-  }])
-})

package/test/create-connection.test.js

@@ -1,39 +0,0 @@
-'use strict'
-
-const { test } = require('tap')
-const { clear, connInfo, isSQLite } = require('./helper')
-const { createConnectionPool } = require('..')
-const fakeLogger = {
-  trace: () => {},
-  error: () => {}
-}
-
-test('createConnectionPool', async ({ equal, same, teardown, rejects }) => {
-  const { db, sql } = await createConnectionPool({
-    connectionString: connInfo.connectionString,
-    log: fakeLogger
-  })
-  await clear(db, sql)
-  teardown(() => db.dispose())
-  if (isSQLite) {
-    await db.query(sql`CREATE TABLE pages (
-        id INTEGER PRIMARY KEY,
-        the_title VARCHAR(42),
-        is_published BOOLEAN NOT NULL
-      );`)
-  } else {
-    await db.query(sql`CREATE TABLE pages (
-        id SERIAL PRIMARY KEY,
-        the_title VARCHAR(255) NOT NULL,
-        is_published BOOLEAN NOT NULL
-      );`)
-  }
-  await db.query(sql`INSERT INTO pages (the_title, is_published) VALUES ('foo', true)`)
-
-  const res = await db.query(sql`SELECT * FROM pages`)
-  same(res, [{
-    id: 1,
-    the_title: 'foo',
-    is_published: true
-  }])
-})