@platformatic/sql-mapper 1.1.1 → 1.3.0

package/lib/cache.js

@@ -0,0 +1,46 @@
+'use strict'
+const { createCache } = require('async-cache-dedupe')
+
+function setupCache (res, opts) {
+  // TODO validate opts
+  if (opts === true) {
+    opts = { ttl: 0 }
+  } else {
+    // ttl=0 means dedupe only
+    // TODO remove it to implement full cache features
+    opts.ttl = 0
+  }
+  const { entities, addEntityHooks } = res
+
+  const cache = createCache(opts)
+  for (const entity of Object.values(entities)) {
+    const fnName = `${entity.name}Find`
+    const originalFn = entity.find
+
+    cache.define(fnName, {
+      serialize (query) {
+        const serialized = {
+          ...query,
+          ctx: undefined
+        }
+        return serialized
+      }
+    }, async function (query) {
+      const res = await originalFn.call(entity, query)
+      return res
+    })
+
+    addEntityHooks(entity.singularName, {
+      find (originalFn, query) {
+        if (query.tx) {
+          return originalFn(query)
+        }
+        return cache[fnName](query)
+      }
+    })
+  }
+
+  return cache
+}
+
+module.exports = setupCache

package/mapper.d.ts

@@ -1,6 +1,9 @@
 import { FastifyPluginAsync, FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
 import { SQL, SQLQuery } from '@databases/sql'
 import { FastifyError } from '@fastify/error'
+import { createCache } from 'async-cache-dedupe'
+
+type cacheOptions = (Parameters<typeof createCache>[0]) | boolean
 
 interface ILogger {
   trace(): any,
@@ -347,6 +350,11 @@ export interface SQLMapperPluginOptions extends BasePoolOptions {
    * An async function that is called after the connection is established.
    */
   onDatabaseLoad?(db: Database, sql: SQL): any,
+  /**
+   * Query caching Configuration
+   * @default false
+   */
+  cache?: cacheOptions
 }
 
 export interface Entities {

package/mapper.js

@@ -1,12 +1,13 @@
 'use strict'
 
+const fp = require('fastify-plugin')
 const { findNearestString } = require('@platformatic/utils')
 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')
 const errors = require('./lib/errors')
+const setupCache = require('./lib/cache')
 
 // Ignore the function as it is only used only for MySQL and PostgreSQL
 /* istanbul ignore next */
@@ -97,7 +98,7 @@ async function createConnectionPool ({ log, connectionString, poolSize }) {
   return { db, sql }
 }
 
-async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignore = {}, autoTimestamp = true, hooks = {}, schema, limit = {}, dbschema }) {
+async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignore = {}, autoTimestamp = true, hooks = {}, schema, limit = {}, dbschema, cache }) {
   if (typeof autoTimestamp === 'boolean' && autoTimestamp === true) {
     autoTimestamp = defaultAutoTimestampFields
   }
@@ -197,7 +198,7 @@ async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignor
       }
     }
 
-    return {
+    const res = {
       db,
       sql,
       entities,
@@ -205,6 +206,12 @@ async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignor
       addEntityHooks,
       dbschema
     }
+
+    if (cache) {
+      res.cache = setupCache(res, cache)
+    }
+
+    return res
   } catch (err) /* istanbul ignore next */ {
     db.dispose()
     throw err

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "A data mapper utility for SQL databases",
   "main": "mapper.js",
   "types": "mapper.d.ts",
@@ -28,10 +28,11 @@
     "@fastify/error": "^3.3.0",
     "@hapi/topo": "^6.0.2",
     "@matteo.collina/sqlite-pool": "^0.3.0",
+    "async-cache-dedupe": "^2.0.0",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.1",
     "inflected": "^2.1.0",
-    "@platformatic/utils": "1.1.1"
+    "@platformatic/utils": "1.3.0"
   },
   "tsd": {
     "directory": "test/types"