Merge pull request #13 from ks-labs/feat-save-only-different-values

✨ feat: saving only the values ​​that have changed

.eslintrc.js

@@ -1,19 +1,26 @@
 module.exports = {
-  env: {
+  'env': {
     node: true,
   },
-  globals: {
+  'globals': {
     use: true,
   },
-  extends: ['semistandard', 'prettier'],
-  plugins: ['prettier'],
-  parserOptions: {
+  'extends': ['semistandard', 'prettier'],
+  'plugins': ['prettier'],
+  'parserOptions': {
     ecmaVersion: 11,
   },
+  'prettier/prettier': [
+    'error',
+    {
+      singleQuote: true,
+      parser: 'flow',
+    },
+  ],
   // "off" or 0 - turn the rule off
   // "warn" or 1 - turn the rule on as a warning (doesn't affect exit code)
   // "error" or 2 - turn the rule on as an error (exit code is 1 when triggered)
-  rules: {
+  'rules': {
     'no-unused-vars': 0,
     'prettier/prettier': ['error'],
   },

src/Traits/Auditable.js

@@ -5,6 +5,28 @@ const { AuditableInvalidRelationshipError } = require('../Exceptions')
 /** @type {typeof import('../../templates/Audit')} */
 const Audit = use('App/Models/Audit')
 
+/**
+ * Return only the values ​​that have changed
+ * @param {*} objectA
+ * @param {*} objectB
+ * @returns {Object, Object} Object
+ */
+
+function differenceObj(objectA, objectB) {
+  let result = { oldValue: {}, newValue: {} }
+  for (let prop in objectA) {
+    if (objectB.hasOwnProperty(prop)) {
+      const value1 = objectA[prop]
+      const value2 = objectB[prop]
+      if (value1 !== value2) {
+        result.oldValue[prop] = value1
+        result.newValue[prop] = value2
+      }
+    }
+  }
+  return result
+}
+
 /**
  * Validates all relations and raise appropiate exceptions when missing
  * this indeed to be used as validation function
@@ -99,6 +121,7 @@ function createWithAudit(ctx, opts, relationFn) {
       { event, auditable, auditableId, newData },
       Object.assign(ctx || {}, opts, { trx })
     )
+
     return resetRelatedState(newModel, syncRelated)
   }
 }
@@ -160,6 +183,10 @@ function updateWithAudit(ctx, opts, relationsFn) {
       return persisted
     }
 
+    const { oldValue, newValue } = differenceObj(oldData, newData)
+    oldData = oldValue
+    newData = newValue
+
     // update / patch are shared
     const event = Audit.events.UPDATE
 

test/auditable-models.test.js

@@ -80,8 +80,10 @@ test.group('Integration Tests', (group) => {
 
   test('Audit correctly on UPDATE Model', async (assert) => {
     await User.audit().create(dummyData.djikstra)
+    const email = 'foo@gmail.com'
+    const username = 'Anton'
     const user = await User.first()
-    await user.audit().update({ username: 'Anton' })
+    await user.audit().update({ username, email })
     const auditData = await ioc
       .use('Adonis/Src/Database')
       .table('audits')
@@ -91,10 +93,26 @@ test.group('Integration Tests', (group) => {
     assert.isNotEmpty(auditData)
     assert.equal(auditData.event, 'update')
     assert.equal(auditData.auditable_id, user.id)
+
     const oldData = JSON.parse(auditData.old_data)
     const newData = JSON.parse(auditData.new_data)
     assert.equal(oldData.username, dummyData.djikstra.username)
-    assert.equal(newData.username, 'Anton')
+    assert.equal(newData.username, username)
+    assert.equal(oldData.email, dummyData.djikstra.email)
+    assert.equal(newData.email, email)
+  })
+
+  test('Audit correctly on update without change values', async (assert) => {
+    await User.audit().create(dummyData.djikstra)
+    const user = await User.first()
+    await user.audit().update({ username: dummyData.djikstra.username })
+    const auditData = await ioc
+      .use('Adonis/Src/Database')
+      .table('audits')
+      .orderBy('id', 'desc')
+      .first()
+
+    assert.isFalse(auditData.event == 'update')
   })
 
   // test('Should audit RELATION between User and Industry', async (assert) => {