ac-useractionlog-connector 4.0.25

package/test/test.js

@@ -0,0 +1,255 @@
+const { expect } = require('chai')
+const _ = require('lodash')
+const ual = require('../index')
+const connector = new ual({}) 
+
+const string1001 = new Array(600000).join('b')
+
+
+describe('Tests', () => {
+  it('Test properties', async() => {
+    const req = {
+      method: 'post',
+      options: {
+        controller: 'search',
+        action: 'search',
+      },
+      authInfo: {
+        token: 'x-token-123',
+        clientId: 'x-client-abc',
+        deviceIdentifier: 'x-my-device',
+        clientVersion: 'app_11.04.235'
+      },
+      headers: {
+        'user-agent': 'Mozilla',
+      },
+      allParams: () => {
+        return 
+      }
+    }
+    const params = {
+      ip: '1.1.1.1',
+      statusCode: 200,
+      processingTime: 12,
+      userId: 123,
+      customerId: 147,
+      mediaContainerId: 46758,
+      platform: 'APIv5',
+      requestPayload: { searchTerm: 'abc' },
+      responsePayload: { hits: 0 },
+      loginuid: '1234567890abcdef',
+    }
+    const response = await connector.log(params, req)
+    _.forEach(params, (val, prop) => {
+      if (prop === 'requestPayload') {
+        expect(response).to.have.property('payload', JSON.stringify(params[prop]))
+      }
+      else if (prop === 'responsePayload') {
+        expect(response).to.have.property('response', JSON.stringify(params[prop]))
+      }
+      else if (prop === 'platform') {
+        expect(response).to.have.property('platform', 'apiv5')
+      }
+      else {
+        expect(response).to.have.property(prop, val)
+      }
+    })
+
+    _.forEach(req.options, (val, prop) => {
+        expect(response).to.have.property(prop, val)
+    })
+
+    _.forEach(req.authInfo, (val, prop) => {
+      if (prop === 'token') {
+        expect(response).not.to.have.property(prop)      
+      }
+      else {
+        expect(response).to.have.property(prop, val)
+      }
+    })
+
+    expect(response).to.have.property('userAgent', _.get(req, 'headers.user-agent'))
+    expect(response).to.have.property('method', _.get(req, 'method'))
+  })
+
+  it('Check truncated payload > 1MB - truncated', async() => {
+    const req = {
+      method: 'post',
+      options: {
+        controller: 'metadata',
+        action: 'create',
+      },
+      authInfo: {
+        token: 'x-token-123',
+        clientId: 'x-client-abc',
+        deviceIdentifier: 'x-my-device',
+        clientVersion: 'app_11.04.235'
+      },
+      headers: {
+        'user-agent': 'Mozilla',
+      },
+      allParams: () => {
+        return 
+      }
+    }
+    const params = {
+      ip: '1.1.1.1',
+      statusCode: 200,
+      processingTime: 12,
+      userId: 123,
+      customerId: 147,
+      mediaContainerId: 46758,
+      platform: 'APIv5',
+      requestPayload: { content: string1001 },
+      responsePayload: { content: string1001 }
+    }
+    const response = await connector.log(params, req)
+
+    expect(response).to.have.property('truncatedResponse', true)
+    expect(response.payload).to.be.a('string')
+    expect(response.response).to.be.a('string')
+
+    // response is trimmed to valid JSON, payload preserved where possible
+    expect(() => JSON.parse(response.response)).to.not.throw()
+    expect(() => JSON.parse(response.payload)).to.not.throw()
+
+    const totalSize = Buffer.byteLength(JSON.stringify(response), 'utf8')
+    expect(totalSize).to.be.lessThan(1024000)
+
+    _.forEach(req.options, (val, prop) => {
+        expect(response).to.have.property(prop, val)
+    })
+
+    _.forEach(req.authInfo, (val, prop) => {
+      if (prop === 'token') {
+        expect(response).not.to.have.property(prop)      
+      }
+      else {
+        expect(response).to.have.property(prop, val)
+      }
+    })
+
+    expect(response).to.have.property('userAgent', _.get(req, 'headers.user-agent'))
+    expect(response).to.have.property('method', _.get(req, 'method'))
+  })
+
+  it('Check truncated payload with nested arrays - new limitJSONPayload', async() => {
+    const req = {
+      method: 'post',
+      options: {
+        controller: 'metadata',
+        action: 'create',
+      },
+      authInfo: {
+        clientId: 'x-client-abc',
+        deviceIdentifier: 'x-my-device',
+        clientVersion: 'app_11.04.235'
+      },
+      headers: {
+        'user-agent': 'Mozilla',
+      },
+      allParams: () => {
+        return 
+      }
+    }
+    
+    const largeString = new Array(1100000).join('x')
+    
+    const params = {
+      ip: '1.1.1.1',
+      statusCode: 200,
+      processingTime: 12,
+      userId: 123,
+      customerId: 147,
+      platform: 'APIv5',
+      requestPayload: { 
+        ids: [1002],
+        metadata: [
+          { title: 'meta_detectedContent', content: largeString },
+          { title: 'other', content: 'small' }
+        ]
+      },
+      responsePayload: { ok: true }
+    }
+    
+    const response = await connector.log(params, req)
+    
+    expect(response).to.have.property('truncatedResponse', true)
+
+    // payload trimmed to valid JSON
+    expect(() => JSON.parse(response.payload)).to.not.throw()
+    const payload = JSON.parse(response.payload)
+    expect(payload.metadata[0].content.length).to.be.lessThan(largeString.length)
+    expect(payload.metadata[1].content).to.equal('small')
+    
+    const totalSize = Buffer.byteLength(JSON.stringify(response), 'utf8')
+    expect(totalSize).to.be.lessThan(1024000)
+  })
+
+  it('Check truncated array-of-strings in response', async() => {
+    const req = {
+      method: 'post',
+      options: { controller: 'metadata', action: 'create' },
+      authInfo: { clientId: 'x-client-abc', deviceIdentifier: 'x-my-device', clientVersion: 'app_11.04.235' },
+      headers: { 'user-agent': 'Mozilla' },
+      allParams: () => null
+    }
+    const params = {
+      ip: '1.1.1.1',
+      statusCode: 200,
+      platform: 'APIv5',
+      requestPayload: { small: 'data' },
+      responsePayload: { items: new Array(2000).fill('x'.repeat(600)) }
+    }
+    const response = await connector.log(params, req)
+
+    expect(response).to.have.property('truncatedResponse', true)
+    expect(Buffer.byteLength(JSON.stringify(response), 'utf8')).to.be.lessThan(1024000)
+    // payload untouched
+    expect(response.payload).to.equal(JSON.stringify(params.requestPayload))
+    // response valid JSON with shorter array
+    expect(() => JSON.parse(response.response)).to.not.throw()
+    const parsed = JSON.parse(response.response)
+    expect(parsed.items).to.be.an('array')
+    expect(parsed.items.length).to.be.lessThan(2000)
+  })
+
+  it('Check obscured password', async() => {
+    const req = {
+      method: 'post',
+      options: {
+        controller: 'login',
+        action: 'login',
+      },
+      authInfo: {
+        token: 'x-token-123',
+        clientId: 'x-client-abc',
+        deviceIdentifier: 'x-my-device',
+        clientVersion: 'app_11.04.235'
+      },
+      headers: {
+        'user-agent': 'Mozilla',
+      },
+      allParams: () => {
+        return
+      }
+    }
+    const params = {
+      platform: 'AUTHv4',
+      requestPayload: {  email: 'myuser@admiralcloud.com', password: 'my_good!password@admiracloud' },
+      responsePayload: { ok: true }
+    }
+    const response = await connector.log(params, req)
+    const test = {}
+    _.map(response, (val, key) => {
+      try {
+        val = JSON.parse(val)
+      }
+      catch {
+        // do nothing
+      }
+      _.set(test, key, val)
+    })
+    expect(test.payload).to.have.property('password', 'XXXX-XXXX')
+  })
+})