Merge pull request #180 from AbsaOSS/remove-msg-type/GET_MSGS_BY_CONNS

Drop support for deprecated message type GET_MSGS_BY_CONNS

Author: mirgee

ci/docker-compose.agency-ca.yml

@@ -38,7 +38,6 @@ services:
       - MYSQL_DATABASE_WALLET_CONNECTION_LIMIT=50
 
       - SERVER_ENABLE_TLS=false
-      - DEV_MODE=true
     networks:
       - absadocker
     ports:

ci/docker-compose.agency-ea.yml

@@ -37,7 +37,6 @@ services:
       - MYSQL_DATABASE_WALLET_CONNECTION_LIMIT=50
 
       - SERVER_ENABLE_TLS=false
-      - DEV_MODE=true
     networks:
       - absadocker
     ports:

vcxagency-client/package.json

@@ -16,6 +16,7 @@
     "test:unit": "jest --runInBand ./test/unit",
     "test:e2e:ea": "jest --runInBand ./test/e2e/ea ./test/e2e/shared",
     "test:e2e:ca": "jest --runInBand ./test/e2e/ca ./test/e2e/shared",
+    "test:e2e:shared": "jest --runInBand ./test/e2e/shared",
     "test:e2e:ca:longpoll": "jest --runInBand ./test/e2e/ca/longpoll.spec.js",
     "test:perf": "jest --runInBand ./test/perf",
     "test:perf:onboarding": "jest --runInBand  ./test/perf/onboarding.perf.spec.js",

vcxagency-client/src/agency-flows.js

@@ -21,7 +21,6 @@ const { buildAriesFwdMessage } = require('./messaging/aries/aries-msg')
 const { buildAriesBasicMessage } = require('./messaging/aries/aries-msg')
 const { buildAgencyFwdMessage } = require('./messaging/client2agency/general')
 const { buildMsgVcxV2UpdateMsgStatusByConns } = require('./messaging/client2agency/msgs-agent')
-const { buildMsgVcxV2MsgGetMsgsByConns } = require('./messaging/client2agency/msgs-agent')
 const { buildMsgVcxV2GetMsgs } = require('./messaging/client2agency/msgs-agentconn')
 const { buildMsgVcxV2CreateKey } = require('./messaging/client2agency/onboarding')
 const { buildMsgVcxV2CreateAgent } = require('./messaging/client2agency/onboarding')
@@ -125,28 +124,6 @@ async function vcxFlowGetMsgsFromAgentConn (clientWh, sendToAgency, recipientAge
   return parseAgencyResponse(clientWh, resEncrypted)
 }
 
-/**
- Downloads messages from agent accross multiple agent connections
- * @param {string} clientWh - wallet handle of agency client
- * @param {object} sendToAgency - function which passes final message to an agency
- * @param {string} clientVkey - verkey the client uses to talk to Agency
- * @param {string} recipientAgentDid - DID of the Agent
- * @param {string} recipientAgentVerkey - Verkey of the Agent
- * @param {string} userPwDids - filter connection by these userPwDids
- * @param {array} uids - filter messages by these msg UIDs
- * @param {string} statusCodes - filter messages by status
- */
-async function vcxFlowGetMsgsFromAgent (clientWh, sendToAgency, recipientAgentDid, recipientAgentVerkey, clientVkey, userPwDids, uids, statusCodes) {
-  const msgGetMsgs = await packAsUtf8(
-    clientWh,
-    objectToBuffer(buildMsgVcxV2MsgGetMsgsByConns(userPwDids, uids, statusCodes)),
-    recipientAgentVerkey,
-    clientVkey
-  )
-  const resEncrypted = await sendToAgency(wrapWithAgencyFwd(recipientAgentDid, msgGetMsgs))
-  return parseAgencyResponse(clientWh, resEncrypted)
-}
-
 /**
  Update statusCode of messages specified by UIDs per Agent-Connections
  * @param {string} clientWh - wallet handle of agency client
@@ -223,7 +200,6 @@ module.exports = {
   vcxFlowGetMsgsFromAgentConn,
 
   // msgs across agent
-  vcxFlowGetMsgsFromAgent,
   vcxFlowUpdateMsgsFromAgent,
 
   // webhooks

vcxagency-client/src/messaging/client2agency/msgs-agent.js

@@ -16,23 +16,11 @@
 
 'use strict'
 
-const MSGTYPE_GET_MSGS_BY_CONNS = 'did:sov:123456789abcdefghi1234;spec/pairwise/1.0/GET_MSGS_BY_CONNS'
-const MSGTYPE_MSGS_BY_CONNS = 'did:sov:123456789abcdefghi1234;spec/pairwise/1.0/MSGS_BY_CONNS'
 const MSGTYPE_UPDATE_MSG_STATUS_BY_CONNS = 'did:sov:123456789abcdefghi1234;spec/pairwise/1.0/UPDATE_MSG_STATUS_BY_CONNS'
 const MSGTYPE_MSG_STATUS_UPDATED_BY_CONNS = 'did:sov:123456789abcdefghi1234;spec/pairwise/1.0/MSG_STATUS_UPDATED_BY_CONNS'
 const MSGTYPE_UPDATE_COM_METHOD = 'did:sov:123456789abcdefghi1234;spec/configs/1.0/UPDATE_COM_METHOD'
 const MSGTYPE_COM_METHOD_UPDATED = 'did:sov:123456789abcdefghi1234;spec/configs/1.0/COM_METHOD_UPDATED'
 
-function buildMsgVcxV2MsgGetMsgsByConns (pairwiseDIDs, uids, statusCodes) {
-  const msg = {
-    '@type': MSGTYPE_GET_MSGS_BY_CONNS,
-    uids, // should be array like ["b7vh36XiTe"]
-    pairwiseDIDs, // array like ["Fp4eVWcjyRawjNWgnJmJWD"]}
-    statusCodes // ["MS-102","MS-103","MS-104","MS-105","MS-106"]
-  }
-  return msg
-}
-
 function buildVcxV2AgencyMsg (payload, senderDID, statusCode, uid) {
   return {
     payload,
@@ -50,15 +38,6 @@ function buildVcxV2AgencyMsgsByConn (agencyMsgs, pairwiseDid) {
     msgs: agencyMsgs
   }
 }
-
-function buildMsgVcxV2MsgsByConns (msgsByConns) {
-  const msg = {
-    '@type': MSGTYPE_MSGS_BY_CONNS,
-    msgsByConns
-  }
-  return msg
-}
-
 function buildVcxV2UidsByConn (pairwiseDid, uids) {
   return {
     pairwiseDID: pairwiseDid,
@@ -106,10 +85,8 @@ function buildMsgCommMethodUpdated (id) {
 
 module.exports = {
   // get msgs: for many agent-connections (recipient is agent entity)
-  buildMsgVcxV2MsgGetMsgsByConns, // req
   buildVcxV2AgencyMsg,
   buildVcxV2AgencyMsgsByConn,
-  buildMsgVcxV2MsgsByConns, // res
 
   // update by connections (message for agent)
   buildMsgVcxV2UpdateMsgStatusByConns, // req
@@ -119,9 +96,6 @@ module.exports = {
   buildMsgVcxV2UpdateWebhookUrl,
   buildMsgCommMethodUpdated,
 
-  MSGTYPE_GET_MSGS_BY_CONNS,
-  MSGTYPE_MSGS_BY_CONNS,
-
   MSGTYPE_UPDATE_MSG_STATUS_BY_CONNS,
   MSGTYPE_MSG_STATUS_UPDATED_BY_CONNS,
 

vcxagency-client/test/e2e/ca/longpoll.spec.js

@@ -22,8 +22,7 @@ const { indyCreateAndStoreMyDid } = require('easy-indysdk')
 const uuid = require('uuid')
 const rimraf = require('rimraf')
 const os = require('os')
-const { vcxFlowSendAriesMessage } = require('../../../src')
-const { vcxFlowGetMsgsFromAgent } = require('../../../src')
+const { vcxFlowSendAriesMessage, vcxFlowGetMsgsFromAgentConn } = require('../../../src')
 const { buildAgencyClientNetwork } = require('../../common')
 const { vcxFlowCreateAgentConnection } = require('vcxagency-client/src')
 const { vcxFlowFullOnboarding } = require('vcxagency-client/src')
@@ -105,11 +104,13 @@ describe('longpoll', () => {
     // create agent connection, both alice and bob
     console.log(`Alice is going to create agent connection. aliceAgentDid=${aliceAgentDid} aliceVerkey=${aliceVerkey} aliceUserPairwiseDid=${aliceUserPairwiseDid} aliceUserPairwiseVerkey=${aliceUserPairwiseVerkey}`)
     const alicesAconn = await vcxFlowCreateAgentConnection(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, aliceUserPairwiseDid, aliceUserPairwiseVerkey)
+    const alicesRoutingAgentDid = alicesAconn.withPairwiseDID
     const alicesRoutingAgentVerkey = alicesAconn.withPairwiseDIDVerKey
+
     console.log('Alice created agent connection!')
     await vcxFlowCreateAgentConnection(bobWh, sendToAgency, bobAgentDid, bobAgentVerkey, bobVerkey, bobUserPairwiseDid, bobUserPairwiseVerkey)
 
-    const aliceAllMsgs1 = await vcxFlowGetMsgsFromAgent(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, [], [], [])
+    const aliceAllMsgs1 = await vcxFlowGetMsgsFromAgentConn(aliceWh, sendToAgency, alicesRoutingAgentDid, alicesRoutingAgentVerkey, aliceUserPairwiseVerkey, [], [])
     console.log(`Alice queries agency for all messages, she should have none. Response = ${JSON.stringify(aliceAllMsgs1)}`)
     {
       let hasLongpollTimedOut = false

vcxagency-client/test/e2e/shared/agency-flows.spec.js

@@ -25,7 +25,6 @@ const os = require('os')
 const { vcxFlowUpdateMsgsFromAgent } = require('../../../src')
 const { vcxFlowGetMsgsFromAgentConn } = require('../../../src')
 const { vcxFlowSendAriesMessage } = require('../../../src')
-const { vcxFlowGetMsgsFromAgent } = require('../../../src')
 const { buildAgencyClientNetwork } = require('../../common')
 const { vcxFlowCreateAgentConnection } = require('vcxagency-client/src')
 const { vcxFlowFullOnboarding } = require('vcxagency-client/src')
@@ -102,51 +101,56 @@ afterEach(async () => {
 describe('onboarding', () => {
   it('should exchange messages between alice and bob via agency', async () => {
     // arrange
-    const { agentDid: aliceAgentDid, agentVerkey: aliceAgentVerkey } = await vcxFlowFullOnboarding(aliceWh, sendToAgency, agencyDid, agencyVerkey, aliceDid, aliceVerkey)
+    const {
+      agentDid: aliceAgentDid,
+      agentVerkey: aliceAgentVerkey
+    } = await vcxFlowFullOnboarding(aliceWh, sendToAgency, agencyDid, agencyVerkey, aliceDid, aliceVerkey)
     const { did: aliceUserPairwiseDid, vkey: aliceUserPairwiseVerkey } = await indyCreateAndStoreMyDid(aliceWh)
     console.log('Alice was onboarded.')
 
-    const { agentDid: bobAgentDid, agentVerkey: bobAgentVerkey } = await vcxFlowFullOnboarding(bobWh, sendToAgency, agencyDid, agencyVerkey, bobDid, bobVerkey)
+    const {
+      agentDid: bobAgentDid,
+      agentVerkey: bobAgentVerkey
+    } = await vcxFlowFullOnboarding(bobWh, sendToAgency, agencyDid, agencyVerkey, bobDid, bobVerkey)
     const { did: bobUserPairwiseDid, vkey: bobUserPairwiseVerkey } = await indyCreateAndStoreMyDid(bobWh)
     console.log('Bob was onboarded.')
 
     // create agent connection, both alice and bob
     console.log(`Alice is going to create agent connection. aliceAgentDid=${aliceAgentDid} aliceVerkey=${aliceVerkey} aliceUserPairwiseDid=${aliceUserPairwiseDid} aliceUserPairwiseVerkey=${aliceUserPairwiseVerkey}`)
     const alicesAconn = await vcxFlowCreateAgentConnection(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, aliceUserPairwiseDid, aliceUserPairwiseVerkey)
-    const alicesRoutingAgentDid = alicesAconn.withPairwiseDID
-    const alicesRoutingAgentVerkey = alicesAconn.withPairwiseDIDVerKey
+    const aconnAlice2BobDid = alicesAconn.withPairwiseDID
+    const aconnAlice2BobVk = alicesAconn.withPairwiseDIDVerKey
     console.log('Alice created agent connection!')
     await vcxFlowCreateAgentConnection(bobWh, sendToAgency, bobAgentDid, bobAgentVerkey, bobVerkey, bobUserPairwiseDid, bobUserPairwiseVerkey)
 
-    const aliceAllMsgs1 = await vcxFlowGetMsgsFromAgent(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, [], [], [])
+    const aliceAllMsgs1 = await vcxFlowGetMsgsFromAgentConn(aliceWh, sendToAgency, aconnAlice2BobDid, aconnAlice2BobVk, aliceUserPairwiseVerkey, [], [], [])
+    expect(aliceAllMsgs1['@type']).toBe('did:sov:123456789abcdefghi1234;spec/pairwise/1.0/MSGS')
+    expect(aliceAllMsgs1.msgs.length).toBe(0)
     console.log(`Alice queries agency for all messages, she should have none. Response = ${JSON.stringify(aliceAllMsgs1)}`)
 
     // bobs sends message to alices routing agent
-    const bobSendMsgRes1 = await vcxFlowSendAriesMessage(bobWh, sendToAgency, aliceUserPairwiseVerkey, alicesRoutingAgentVerkey, bobUserPairwiseVerkey, 'This is Bob!')
+    const bobSendMsgRes1 = await vcxFlowSendAriesMessage(bobWh, sendToAgency, aliceUserPairwiseVerkey, aconnAlice2BobVk, bobUserPairwiseVerkey, 'This is Bob!')
     console.log(`Bob sends aries message to Alice's agent. Response = ${JSON.stringify(bobSendMsgRes1)}`)
 
     // alice fetches messages
-    const aliceAllMsgs2 = await vcxFlowGetMsgsFromAgent(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, [], [], [])
+    const aliceAllMsgs2 = await vcxFlowGetMsgsFromAgentConn(aliceWh, sendToAgency, aconnAlice2BobDid, aconnAlice2BobVk, aliceUserPairwiseVerkey, [], [], [])
     console.log(`Alice queries agency for all messages, she should have one. Response = ${JSON.stringify(aliceAllMsgs2)}`)
-
-    const aliceToBoMsgs = await vcxFlowGetMsgsFromAgentConn(aliceWh, sendToAgency, alicesRoutingAgentDid, alicesRoutingAgentVerkey, aliceUserPairwiseVerkey, [], [])
-    console.log(`Alice queries agency for alice2bob messages, she should have one. Response = ${JSON.stringify(aliceToBoMsgs)}`)
+    expect(aliceAllMsgs2.msgs.length).toBe(1)
+    expect(aliceAllMsgs2.msgs[0].statusCode).toBe('MS-103')
 
     // alice updates message status
     const aliceMsgsByConns = [
-      { pairwiseDID: aliceUserPairwiseDid, uids: [aliceToBoMsgs.msgs[0].uid] }
+      { pairwiseDID: 'unused-attribute', uids: [aliceAllMsgs2.msgs[0].uid] }
     ]
-    const aliceNewMsgStatus = 'MS-104'
+    const aliceNewMsgStatus = 'MS-106'
     const updateResponse = await vcxFlowUpdateMsgsFromAgent(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, aliceMsgsByConns, aliceNewMsgStatus)
     console.log(`Alice run msg status update for msgs ${JSON.stringify(aliceMsgsByConns)} to status ${aliceNewMsgStatus}. Response = ${JSON.stringify(updateResponse)}`)
 
-    // alice tries to update msg status on connection she doesn't have
-    const updateMsgForNonExistingUserPwDid = [
-      { pairwiseDID: '4aA6TyH2Cgq7gg2wGFiRXS', uids: [aliceToBoMsgs.msgs[0].uid] }
-    ]
-    const aliceNewMsgStatus2 = 'MS-105'
-    const updateResponse2 = await vcxFlowUpdateMsgsFromAgent(aliceWh, sendToAgency, aliceAgentDid, aliceAgentVerkey, aliceVerkey, updateMsgForNonExistingUserPwDid, aliceNewMsgStatus2)
-    console.log(`Alice run msg status update for agent connection which does not exists on her agent. Response = ${JSON.stringify(updateResponse2)}`)
+    // alice fetches messages
+    const aliceAllMsgs3 = await vcxFlowGetMsgsFromAgentConn(aliceWh, sendToAgency, aconnAlice2BobDid, aconnAlice2BobVk, aliceUserPairwiseVerkey, [], [], [])
+    console.log(`Alice queries agency for all messages, she should have one. Response = ${JSON.stringify(aliceAllMsgs3)}`)
+    expect(aliceAllMsgs3.msgs.length).toBe(1)
+    expect(aliceAllMsgs3.msgs[0].statusCode).toBe('MS-106')
   })
 })
 

vcxagency-client/test/perf/messaging.perf.spec.js

@@ -22,8 +22,7 @@ const { indyCreateAndStoreMyDid } = require('easy-indysdk')
 const uuid = require('uuid')
 const rimraf = require('rimraf')
 const os = require('os')
-const { vcxFlowUpdateMsgsFromAgent } = require('../../src')
-const { vcxFlowGetMsgsFromAgent } = require('../../src')
+const { vcxFlowUpdateMsgsFromAgent, vcxFlowGetMsgsFromAgentConn } = require('../../src')
 const { vcxFlowSendAriesMessage } = require('../../src')
 const { buildAgencyClientNetwork } = require('../common')
 const { vcxFlowCreateAgentConnection } = require('vcxagency-client')
@@ -103,7 +102,8 @@ describe('onboarding', () => {
     const { agentDid: aliceAgentDid, agentVerkey: aliceAgentVerkey } = await vcxFlowFullOnboarding(clientAlice.wh, sendToAgency, agencyDid, agencyVerkey, clientAlice.client2AgencyDid, clientAlice.client2AgencyVerkey)
     const aliceAconnAlice2Bob = await vcxFlowCreateAgentConnection(
       clientAlice.wh, sendToAgency, aliceAgentDid, aliceAgentVerkey, clientAlice.client2AgencyVerkey, aliceUserPwDid2Bob, aliceUserPwVerkey2Bob)
-    const aliceRoutingKeyAlice2Bob = aliceAconnAlice2Bob.withPairwiseDIDVerKey
+    const aconnAlice2BobDid = aliceAconnAlice2Bob.withPairwiseDID
+    const aconnAlice2BobVk = aliceAconnAlice2Bob.withPairwiseDIDVerKey
 
     const bobsUserPwVkey = clientBob.userPwDids[0].vkey
 
@@ -116,18 +116,16 @@ describe('onboarding', () => {
         }
         const promises = []
         for (let j = 0; j < OPS_IN_ROUND; j++) {
-          promises.push(vcxFlowSendAriesMessage(clientBob.wh, sendToAgency, aliceUserPwVerkey2Bob, aliceRoutingKeyAlice2Bob, bobsUserPwVkey, uuid.v4()))
+          promises.push(vcxFlowSendAriesMessage(clientBob.wh, sendToAgency, aliceUserPwVerkey2Bob, aconnAlice2BobVk, bobsUserPwVkey, uuid.v4()))
         }
         await Promise.all(promises)
         if (i === 0) {
-          // update all messages received so farr to MS-106 statusCode
-          const msgs = await vcxFlowGetMsgsFromAgent(clientAlice.wh, sendToAgency, aliceAgentDid, aliceAgentVerkey, clientAlice.client2AgencyVerkey, [aliceUserPwDid2Bob], [], [])
-          console.log(JSON.stringify(msgs))
-          const receivedMsgUids = msgs.msgsByConns[0].msgs.map(msg => msg.uid)
-          console.log(JSON.stringify(receivedMsgUids))
+          // update all messages received so far to MS-106 statusCode
+          const res = await vcxFlowGetMsgsFromAgentConn(clientAlice.wh, sendToAgency, aconnAlice2BobDid, aconnAlice2BobVk, aliceUserPwVerkey2Bob, [], [])
+          console.log(JSON.stringify(res))
+          const receivedMsgUids = res.msgs.map(msg => msg.uid)
           await vcxFlowUpdateMsgsFromAgent(clientAlice.wh, sendToAgency, aliceAgentDid, aliceAgentVerkey, clientAlice.client2AgencyVerkey,
             [{ pairwiseDID: aliceUserPwDid2Bob, uids: receivedMsgUids }], 'MS-106')
-          // const msgs2 = await vcxFlowGetMsgsFromAgent(clientAlice.wh, sendToAgency, aliceAgentDid, aliceAgentVerkey, clientAlice.client2AgencyVerkey, [aliceUserPwDid2Bob], [], [])
         }
       }
       const tFinish = performance.now()
@@ -147,7 +145,7 @@ describe('onboarding', () => {
         const promises = []
         for (let j = 0; j < OPS_IN_ROUND; j++) {
           promises.push(
-            vcxFlowGetMsgsFromAgent(clientAlice.wh, sendToAgency, aliceAgentDid, aliceAgentVerkey, clientAlice.client2AgencyVerkey, [aliceUserPwDid2Bob], [], ['MS-106'])
+            vcxFlowGetMsgsFromAgentConn(clientAlice.wh, sendToAgency, aconnAlice2BobDid, aconnAlice2BobVk, aliceUserPwVerkey2Bob, ['MS-106'], [])
           )
         }
         await Promise.all(promises)

vcxagency-node/package.json

@@ -24,6 +24,8 @@
     "test:unit:configuration": "SILENT_WINSTON=true jest --runInBand ./test/unit/configuration",
     "test:unit:entities": "SILENT_WINSTON=true jest --runInBand ./test/unit/entities",
     "test:unit:messaging": "SILENT_WINSTON=true jest --runInBand ./test/unit/messaging",
+    "test:unit:messaging:agent": "SILENT_WINSTON=true jest --runInBand ./test/unit/messaging/agent-msgs.spec.js",
+    "test:unit:messaging:aconn": "SILENT_WINSTON=true jest --runInBand ./test/unit/messaging/aconn-msgs.spec.js",
     "test:unit:notifications": "SILENT_WINSTON=true jest --runInBand ./test/unit/notifications",
     "test:unit:state": "SILENT_WINSTON=true jest --runInBand ./test/unit/state",
     "test:unit:storage": "SILENT_WINSTON=true jest --runInBand ./test/unit/storage/"

vcxagency-node/src/configuration/app-config.js

@@ -132,7 +132,6 @@ const OP_MODES = {
       ..._walletValidationRules(),
       ..._applicationValidationRules(),
       AGENCY_DID: Joi.string().required(),
-      DEV_MODE: Joi.boolean().default(false),
       ECS_CONTAINER_METADATA_URI_V4: Joi.string().uri()
     }
   }