@kravc/dos 1.6.1 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/dos",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Convention-based, easy-to-use library for building API-driven serverless services.",
   "keywords": [
     "Service",
@@ -25,7 +25,7 @@
   "author": "Alexander Kravets <a@kra.vc>",
   "license": "ISC",
   "dependencies": {
-    "@kravc/schema": "^2.4.0",
+    "@kravc/schema": "^2.5.1",
     "cookie": "^0.5.0",
     "js-yaml": "^4.1.0",
     "jsonwebtoken": "^9.0.2",

package/src/Document.js

@@ -64,6 +64,8 @@ class Document extends Component {
   }
 
   static async create(context, query, mutation) {
+    /* NOTE: existing document in the context allows to return document without
+             duplicate been created */
     const { document: existingDocument } = context
 
     if (existingDocument) {
@@ -169,13 +171,14 @@ class Document extends Component {
       await this.beforeUpdate(context, query, mutation)
     }
 
-    const updatedItem = await this._update(query, mutation)
+    /* NOTE: ensure that document to be updated exists and save it in the
+             context so can be referenced in the after action helper */
+    const originalDocument = await this.read(context, query)
 
-    if (!updatedItem) {
-      throw new DocumentNotFoundError(this, { query })
-    }
+    const updatedItem = await this._update(query, mutation)
 
     const document = new this(context, updatedItem)
+    document._originalDocument = originalDocument
 
     if (this.afterUpdate) {
       await this.afterUpdate(context, query, mutation, document)
@@ -184,9 +187,11 @@ class Document extends Component {
     return document
   }
 
-  static _update({ id = 'NONE' }, mutation) {
+  static _update({ id }, mutation) {
     const item = STORE[this.name][id]
 
+    /* istanbul ignore next: not used anymore by update interface as read
+                             operation throws an error if document not found */
     if (!item) {
       return false
     }
@@ -201,20 +206,24 @@ class Document extends Component {
       await this.beforeDelete(context, query)
     }
 
-    const isDeleted = await this._delete(query)
+    /* NOTE: ensure that document to be removed exists and save it in the
+             context so can be referenced in the after action helper */
+    const originalDocument = await this.read(context, query)
 
-    if (!isDeleted) {
-      throw new DocumentNotFoundError(this, { query })
-    }
+    await this._delete(query)
 
     if (this.afterDelete) {
-      await this.afterDelete(context, query)
+      await this.afterDelete(context, query, originalDocument)
     }
+
+    return originalDocument
   }
 
-  static _delete({ id = 'NONE' }) {
+  static _delete({ id }) {
     const item = STORE[this.name][id]
 
+    /* istanbul ignore next: not used anymore by delete interface as read
+                             operation throws an error if document not found */
     if (!item) {
       return false
     }
@@ -240,12 +249,32 @@ class Document extends Component {
     const document = await this.constructor.update(this.context, this._query, mutation)
 
     if (shouldMutate) {
-      this._attributes = document.attributes
+      this._attributes = document._attributes
+      this._originalDocument = document._originalDocument
     }
 
     return document
   }
 
+  get originalDocument() {
+    if (!this._originalDocument) {
+      throw new Error('Orginal document is undefined')
+    }
+
+    return this._originalDocument
+  }
+
+  hasAttributeChanged(attributePath) {
+    const { originalDocument } = this
+
+    const originalValue = get(originalDocument.attributes, attributePath)
+    const updatedValue = get(this.attributes, attributePath)
+
+    const hasChanged = originalValue !== updatedValue
+
+    return hasChanged
+  }
+
   get _query() {
     const { idKey } = this.constructor
 

package/src/Document.spec.js

@@ -23,12 +23,13 @@ Profile.schema = loadSync('examples/Profile.yaml')
 describe('Document', () => {
   const validator = new Validator([ Profile.schema ])
   const identity  = { accountId: 'ACCOUNT_ID' }
-  const context   = { validator, identity }
+  const getContext = () => ({ validator, identity })
 
   let id
 
   describe('Document.create(context, query, mutation)', () => {
     it('creates document', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, { name: 'Oleksandr' })
 
       expect(profile.id).to.exist
@@ -40,6 +41,7 @@ describe('Document', () => {
     })
 
     it('creates document via mutation', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, {}, { name: 'Olga' })
 
       expect(profile.id).to.exist
@@ -49,6 +51,7 @@ describe('Document', () => {
     })
 
     it('creates document with custom ID', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, {}, { id: 'CUSTOM_ID', name: 'Olga' })
 
       expect(profile.id).to.eql('CUSTOM_ID')
@@ -56,7 +59,8 @@ describe('Document', () => {
     })
 
     it('creates document without identity in context', async () => {
-      const profile = await Profile.create({ validator }, { name: 'Oleg' })
+      const context = { validator }
+      const profile = await Profile.create(context, { name: 'Oleg' })
 
       expect(profile.id).to.exist
       expect(profile.attributes.name).to.eql('Oleg')
@@ -65,6 +69,7 @@ describe('Document', () => {
     })
 
     it('returns exiting document from the context', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, { name: 'Volodymyr' })
       const existingProfile = await Profile.create({ ...context, document: profile }, { name: 'Volodymyr' })
 
@@ -72,6 +77,7 @@ describe('Document', () => {
     })
 
     it('throws "DocumentExistsError" if document already exists', async () => {
+      const context = getContext()
       const { id } = await Profile.create(context, {}, { name: 'Artem' })
       const error = await expectError(() => Profile.create(context, {}, { id, name: 'Liam' }))
 
@@ -82,6 +88,7 @@ describe('Document', () => {
 
   describe('Document.read(context, query)', () => {
     it('returns document', async () => {
+      const context = getContext()
       const profile = await Profile.read(context, { id })
 
       expect(profile).to.exist
@@ -98,6 +105,7 @@ describe('Document', () => {
 
   describe('Document.update(context, query, mutation)', () => {
     it('updates document', async () => {
+      const context = getContext()
       await Profile.update(context, { id }, { name: 'Margarita' })
 
       const profile = await Profile.read(context, { id })
@@ -108,9 +116,10 @@ describe('Document', () => {
     })
 
     it('updates document without identity in context', async () => {
-      const { id } = await Profile.create({ validator }, { name: 'Gustav' })
+      const context = { validator }
+      const { id } = await Profile.create(context, { name: 'Gustav' })
 
-      const profile = await Profile.update({ validator }, { id }, { name: 'Jack' })
+      const profile = await Profile.update(context, { id }, { name: 'Jack' })
 
       expect(profile.attributes.updatedAt).to.exist
       expect(profile.attributes.updatedBy).to.not.exist
@@ -127,6 +136,7 @@ describe('Document', () => {
 
   describe('Document.delete(context, query)', () => {
     it('deletes document', async () => {
+      const context = getContext()
       await Profile.delete(context, { id })
 
       try {
@@ -152,6 +162,7 @@ describe('Document', () => {
 
   describe('Document.index(context, query)', () => {
     it('returns documents', async () => {
+      const context = getContext()
       await Profile.reset()
 
       let result
@@ -162,7 +173,7 @@ describe('Document', () => {
       expect(result.count).to.eql(0)
 
       await Profile.create(context, { name: 'Oleksandr' })
-      await Profile.create(context, { name: 'Margarita' })
+      await Profile.create(context, { name: 'Dasha' })
       await Profile.create(context, { name: 'Veronica' })
 
       result = await Profile.index(context)
@@ -180,8 +191,10 @@ describe('Document', () => {
 
   describe('.delete()', () => {
     it('deletes document', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, { name: 'Oleksandr' })
-      const { id }  = profile
+
+      const { id } = profile
 
       await profile.delete()
 
@@ -200,6 +213,7 @@ describe('Document', () => {
 
   describe('.update(mutation, shouldMutate = false)', () => {
     it('updates document', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, { name: 'Oleksandr' })
 
       const updatedProfile = await profile.update({ name: 'Anton' })
@@ -209,6 +223,7 @@ describe('Document', () => {
     })
 
     it('updates and mutates document', async () => {
+      const context = getContext()
       const profile = await Profile.create(context, { name: 'Oleksandr' })
 
       await profile.update({ name: 'Anton' }, true)
@@ -252,6 +267,8 @@ describe('Document', () => {
       const validator = new Validator([ CustomProfile.schema ])
 
       const { id } = await CustomProfile.create({ validator }, { name: 'Irina' })
+
+      const context = getContext()
       await CustomProfile.update(context, { id, mutation: { name: 'Maria' } })
       await CustomProfile.delete(context, { id })
 
@@ -263,4 +280,42 @@ describe('Document', () => {
       expect(callbacks.afterDelete).to.exist
     })
   })
+
+  describe('.hasAttributeChanged(attributePath)', () => {
+    it('throws "Error" if context has no original document', async () => {
+      const context = getContext()
+      const profile = await Profile.create(context, { name: 'Sonya' })
+
+      try {
+        profile.hasAttributeChanged('name')
+
+      } catch (error) {
+        expect(error.message).to.eql('Orginal document is undefined')
+
+        return
+      }
+
+      throw new Error('Error has not been thrown')
+    })
+
+    it('returns true if attribute value has changed', async () => {
+      const context = getContext()
+      const profile = await Profile.create(context, { name: 'Sonya' })
+
+      await profile.update({ name: 'Sasha', age: 7 }, true)
+
+      expect(profile.hasAttributeChanged('name')).to.be.true
+      expect(profile.hasAttributeChanged('age')).to.be.true
+    })
+
+    it('returns false if attribute value has not changed', async () => {
+      const context = getContext()
+      const profile = await Profile.create(context, { name: 'Sonya' })
+
+      await profile.update({ name: 'Sonya', age: 5 }, true)
+      const hasNameChanged = profile.hasAttributeChanged('name')
+
+      expect(hasNameChanged).to.be.false
+    })
+  })
 })

package/src/Service.js

@@ -107,7 +107,8 @@ class Service {
       if (!Operation) { throw new OperationNotFoundError({ operationId, httpMethod, httpPath }) }
 
       context.identity = await authorize(Operation, context)
-      const parameters = this._getParameters(Operation.inputSchema, context)
+      const isUpdate = Operation.type === Operation.types.UPDATE
+      const parameters = this._getParameters(Operation.inputSchema, context, isUpdate)
 
       const operation = new Operation(context)
       response = await operation.exec(parameters)
@@ -143,7 +144,7 @@ class Service {
     return { statusCode, headers, multiValueHeaders, body }
   }
 
-  _getParameters(inputSchema, context) {
+  _getParameters(inputSchema, context, shouldNullifyEmptyValues) {
     if (!inputSchema) { return {} }
 
     const { query, mutation } = context
@@ -152,7 +153,7 @@ class Service {
     let result
 
     try {
-      result = this._validator.validate(input, inputSchema.id)
+      result = this._validator.validate(input, inputSchema.id, shouldNullifyEmptyValues)
 
     } catch (validationError) {
       throw new InvalidInputError(validationError, context)

package/src/errors/OperationError.yaml

@@ -30,3 +30,4 @@ error:
 
           path:
             description: Path of invalid attribute
+            type: array