@platformatic/sql-mapper 0.36.0 → 0.37.0

package/lib/clean-up.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const { tableName } = require('./utils')
+const { Sorter } = require('@hapi/topo')
+
+function buildCleanUp (db, sql, logger, entities) {
+  return async function cleanUp () {
+    logger.trace('cleaning up')
+    await db.tx(async tx => {
+      const topo = new Sorter()
+      const lookup = new Map()
+
+      for (const entity of Object.values(entities)) {
+        /* istanbul ignore next */
+        const relations = entity.relations.map(relation => {
+          // there is a name clash here with tables with the
+          // same name in different schemas
+          return relation.foreign_table_name
+        })
+        lookup.set(entity.table, entity)
+
+        const name = entity.table
+
+        topo.add(name, { before: relations, group: name })
+      }
+
+      for (const name of topo.nodes) {
+        const entity = lookup.get(name)
+        const toDelete = tableName(sql, entity.table, entity.schema)
+        await tx.query(sql`DELETE FROM ${toDelete}`)
+      }
+    })
+  }
+}
+
+module.exports = buildCleanUp

package/mapper.d.ts

@@ -331,6 +331,11 @@ export interface SQLMapperPluginInterface {
    * Adds hooks to the entity.
    */
   addEntityHooks<EntityFields>(entityName: string, hooks: EntityHooks<EntityFields>): any
+
+  /**
+   * Clean up all the data in all entities
+   */
+  cleanUpAllEntities(): Promise<void>
 }
 
 // Extend the PlatformaticApp interface,
@@ -353,6 +358,10 @@ declare module '@platformatic/types' {
      * Adds hooks to the entity.
      */
     addEntityHooks<EntityFields>(entityName: string, hooks: EntityHooks<EntityFields>): any
+    /**
+     * Clean up all the data in all entities
+     */
+    cleanUpAllEntities(): Promise<void>
   }
 }
 

package/mapper.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const buildEntity = require('./lib/entity')
+const buildCleanUp = require('./lib/clean-up')
 const queriesFactory = require('./lib/queries')
 const fp = require('fastify-plugin')
 const { areSchemasSupported } = require('./lib/utils')
@@ -172,6 +173,7 @@ async function connect ({ connectionString, log, onDatabaseLoad, poolSize = 10,
       db,
       sql,
       entities,
+      cleanUpAllEntities: buildCleanUp(db, sql, log, entities, queries),
       addEntityHooks,
       dbschema
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "description": "A data mapper utility for SQL databases",
   "main": "mapper.js",
   "types": "mapper.d.ts",
@@ -25,11 +25,12 @@
     "@databases/mysql": "^6.0.0",
     "@databases/pg": "^5.4.1",
     "@databases/sql": "^3.3.0",
+    "@hapi/topo": "^6.0.2",
     "@matteo.collina/sqlite-pool": "^0.3.0",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.0",
     "inflected": "^2.1.0",
-    "@platformatic/types": "0.36.0"
+    "@platformatic/types": "0.37.0"
   },
   "tsd": {
     "directory": "test/types"

package/test/helper.js

@@ -35,6 +35,11 @@ if (!process.env.DB || process.env.DB === 'postgresql') {
 module.exports.connInfo = connInfo
 
 module.exports.clear = async function (db, sql) {
+  try {
+    await db.query(sql`DROP TABLE graphs`)
+  } catch {
+  }
+
   try {
     await db.query(sql`DROP TABLE editors`)
   } catch {
@@ -45,6 +50,11 @@ module.exports.clear = async function (db, sql) {
   } catch (err) {
   }
 
+  try {
+    await db.query(sql`DROP TABLE comments`)
+  } catch (err) {
+  }
+
   try {
     await db.query(sql`DROP TABLE categories`)
   } catch {

package/test/mapper.test.js

@@ -235,3 +235,91 @@ test('platformatic decorator already present', async ({ teardown }) => {
   })
   await app.ready()
 })
+
+test('clean up all tables', async ({ teardown, has, equal, same }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(async () => await clear(db, sql))
+    teardown(() => db.dispose())
+
+    await db.query(sql`CREATE TABLE IF NOT EXISTS pages (
+      id SERIAL PRIMARY KEY,
+      title VARCHAR(255) NOT NULL
+    );`)
+  }
+  const mapper = await connect({
+    connectionString: connInfo.connectionString,
+    log: fakeLogger,
+    onDatabaseLoad
+  })
+
+  const res = await mapper.entities.page.save({ input: { title: 'hello' } })
+
+  same(await mapper.entities.page.find(), [res])
+
+  await mapper.cleanUpAllEntities()
+
+  const pages = await mapper.entities.page.find()
+  equal(pages.length, 0)
+})
+
+test('clean up all tables with foreign keys', async ({ teardown, has, equal, same }) => {
+  async function onDatabaseLoad (db, sql) {
+    await clear(db, sql)
+    teardown(async () => await clear(db, sql))
+    teardown(() => db.dispose())
+
+    if (db.isSQLite) {
+      await db.query(sql`CREATE TABLE IF NOT EXISTS pages (
+        id INTEGER PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+      await db.query(sql`CREATE TABLE IF NOT EXISTS comments (
+        id INTEGER PRIMARY KEY,
+        text VARCHAR(255) NOT NULL,
+        page_id INTEGER NOT NULL REFERENCES pages(id)
+      );`)
+    } else if (db.isPg) {
+      await db.query(sql`CREATE TABLE IF NOT EXISTS pages (
+        id SERIAL PRIMARY KEY,
+        title VARCHAR(255) NOT NULL
+      );`)
+      await db.query(sql`CREATE TABLE IF NOT EXISTS comments (
+        id SERIAL PRIMARY KEY,
+        text VARCHAR(255) NOT NULL,
+        page_id INTEGER NOT NULL REFERENCES pages(id)
+      );`)
+    } else {
+      await db.query(sql`CREATE TABLE IF NOT EXISTS pages (
+        id INTEGER PRIMARY KEY AUTO_INCREMENT,
+        title VARCHAR(255) NOT NULL
+      );`)
+      await db.query(sql`CREATE TABLE IF NOT EXISTS comments (
+        id INTEGER PRIMARY KEY AUTO_INCREMENT,
+        text VARCHAR(255) NOT NULL,
+        page_id INTEGER NOT NULL REFERENCES pages(id)
+      );`)
+    }
+  }
+  const mapper = await connect({
+    connectionString: connInfo.connectionString,
+    log: fakeLogger,
+    onDatabaseLoad
+  })
+
+  {
+    const p1 = await mapper.entities.page.save({ input: { title: 'hello' } })
+    same(await mapper.entities.page.find(), [p1])
+
+    const c1 = await mapper.entities.comment.save({ input: { text: 'foo', pageId: p1.id } })
+    same(await mapper.entities.comment.find(), [c1])
+  }
+
+  await mapper.cleanUpAllEntities()
+
+  const pages = await mapper.entities.page.find()
+  equal(pages.length, 0)
+
+  const comments = await mapper.entities.comment.find()
+  equal(comments.length, 0)
+})

package/test/types/mapper.test-d.ts

@@ -17,6 +17,8 @@ expectType<Database>(pluginOptions.db)
 expectType<SQL>(pluginOptions.sql)
 expectType<{ [entityName: string]: Entity }>(pluginOptions.entities)
 
+expectType<Promise<void>>(pluginOptions.cleanUpAllEntities())
+
 interface EntityFields {
   id: number,
   name: string,
@@ -88,6 +90,7 @@ instance.register((instance) => {
     const ctx = request.platformaticContext
     expectType<FastifyInstance>(ctx.app)
     expectType<FastifyReply>(ctx.reply)
+    await instance.platformatic.cleanUpAllEntities()
   })
 })