Rename decrypted_payload, modify its format #173

Patrik-Stas · 2020-10-26T10:42:10Z

Previously, the format of single message within output vcx_messages_download was JSON with following structure

{
   "statusCode": <data>
   "payload": <data>
   "uid": <data>
   "refMsgId": <data>
   "deliveryDetails": <data>
   "decryptedMsg": <data>
}

And the content of decrypted_payload was string-encoded JSON with structure

{
	"@type" : {
      "name" : <data>
      "ver" : <data>
      "fmt" : <data>
	}
	"@msg": <Stringified JSON Aries message>
}

This PR deletes field "decrypted_payload", and introduces instead new field "decrypted_msg"

{
   "statusCode": <data>
   "payload": <data>
   "uid": <data>
   "refMsgId": <data>
   "deliveryDetails": <data>
   "decryptedPayload": <data>
}

whereas the decrypted_msg contains directly stringified Aries JSON message. Example:

{
    "statusCode": "MS-106",
    "payload": null,
    "uid": "c17da501-6c71-498c-a471-3409a3cb160d",
    "refMsgId": null,
    "deliveryDetails": [],
    "decryptedMsg": "{\"@id\":\"fcdc8068-97c4-459f-84ff-da9dd9089b42\",\"@type\":\"did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/ack\",\"status\":\"OK\",\"~thread\":{\"received_orders\":{},\"sender_order\":0,\"thid\":\"32e407a0-e32b-4870-9583-079daeb8414d\"}}"
  }

Signed-off-by: Patrik Stas patrik.stas@absa.africa

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

lgtm-com · 2020-10-26T10:49:00Z

This pull request fixes 1 alert when merging faf1b9a into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

lgtm-com · 2020-10-26T12:59:04Z

This pull request fixes 1 alert when merging bd9579d into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

lgtm-com · 2020-10-26T14:48:40Z

This pull request fixes 1 alert when merging dc3bcb8 into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

codecov-io · 2020-10-26T15:28:06Z

Codecov Report

Merging #173 into master will increase coverage by 0.01%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master     #173      +/-   ##
==========================================
+ Coverage   51.15%   51.16%   +0.01%     
==========================================
  Files         150      150              
  Lines       22899    22900       +1     
  Branches     6046     6047       +1     
==========================================
+ Hits        11713    11716       +3     
+ Misses       7580     7578       -2     
  Partials     3606     3606

Flag	Coverage Δ
#unittests	`51.16% <0.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
libvcx/src/aries/handlers/connection/mod.rs	`68.57% <ø> (ø)`
libvcx/src/aries/mod.rs	`8.12% <0.00%> (-0.03%)`	⬇️
libvcx/src/connection.rs	`62.25% <ø> (ø)`
libvcx/src/messages/get_message.rs	`33.77% <0.00%> (ø)`
libvcx/src/lib.rs	`33.48% <0.00%> (+0.09%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84ec0b6...0f7c90d. Read the comment docs.

mirgee · 2020-10-27T07:50:58Z

agents/node/vcxagent-core/demo/alice.js

+  assert(payload["@id"])
+  assert(payload["@type"])
+
+  const msgs2 = await vcxAgent.serviceConnections.getMessagesV2(connectionId)


I will extract the asserts to separate function and run them on the return value of getMessagesV2 as well

mirgee · 2020-10-27T07:52:58Z

agents/node/vcxagent-core/test/utils/faber.js

@@ -135,7 +135,16 @@ module.exports.createFaber = async function createFaber () {
    return isValid
  }

+  async function downloadReceivedMessages () {
+    logger.info('Faber is going to download messages wit')


I fixed the typo in my PR so please don't change to avoid conflicts

mirgee · 2020-10-27T07:59:33Z

libvcx/src/aries/mod.rs

            if filter_msg_type == msg_type {
                return VcxAgencyMessage {
                    uid: message.uid,
-                    decrypted_payload: msg_content.into(),
+                    decrypted_payload: decrypted_msg.clone(),


While we are already doing breaking changes, should this field be rather called decrypted_msg?

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

lgtm-com · 2020-10-27T09:10:59Z

This pull request fixes 1 alert when merging bdb0d30 into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

lgtm-com · 2020-10-27T10:28:41Z

This pull request fixes 1 alert when merging 0f7c90d into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

* Decrypt download_messages_v2 payload Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com> * Add downloadReceivedMessagesV2 test to agent-core Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com>

lgtm-com · 2020-10-27T12:42:35Z

This pull request fixes 1 alert when merging 000c58d into 84ec0b6 - view on LGTM.com

fixed alerts:

1 for Syntax error

Patrik-Stas added 2 commits October 26, 2020 11:39

Keep breaking change on decrypted payload format

9ace93b

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Add messaging tests + JS fixes

faf1b9a

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Fix compile error in test

bd9579d

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Fix test

dc3bcb8

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

mirgee reviewed Oct 27, 2020

View reviewed changes

Patrik-Stas changed the title ~~Keep breaking change on decrypted payload format~~ Rename decrypted_payload, modify its format Oct 27, 2020

Rename decrypted_payload to decrypted_msg

bdb0d30

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Fixes for nodejs tests

0f7c90d

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Decrypt download_messages_v2 payload (#172)

000c58d

* Decrypt download_messages_v2 payload Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com> * Add downloadReceivedMessagesV2 test to agent-core Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com>

Patrik-Stas requested a review from mirgee October 27, 2020 12:38

mirgee approved these changes Oct 27, 2020

View reviewed changes

mirgee merged commit 7f17f81 into master Oct 27, 2020

mirgee deleted the keep-decryption-changes branch October 27, 2020 12:41

mirgee added the breaking label Oct 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename decrypted_payload, modify its format #173

Rename decrypted_payload, modify its format #173

Patrik-Stas commented Oct 26, 2020 •

edited

Loading

lgtm-com bot commented Oct 26, 2020

lgtm-com bot commented Oct 26, 2020

lgtm-com bot commented Oct 26, 2020

codecov-io commented Oct 26, 2020 •

edited

Loading

mirgee Oct 27, 2020

mirgee Oct 27, 2020

mirgee Oct 27, 2020

lgtm-com bot commented Oct 27, 2020

lgtm-com bot commented Oct 27, 2020

lgtm-com bot commented Oct 27, 2020

Rename decrypted_payload, modify its format #173

Rename decrypted_payload, modify its format #173

Conversation

Patrik-Stas commented Oct 26, 2020 • edited Loading

lgtm-com bot commented Oct 26, 2020

lgtm-com bot commented Oct 26, 2020

lgtm-com bot commented Oct 26, 2020

codecov-io commented Oct 26, 2020 • edited Loading

Codecov Report

mirgee Oct 27, 2020

Choose a reason for hiding this comment

mirgee Oct 27, 2020

Choose a reason for hiding this comment

mirgee Oct 27, 2020

Choose a reason for hiding this comment

lgtm-com bot commented Oct 27, 2020

lgtm-com bot commented Oct 27, 2020

lgtm-com bot commented Oct 27, 2020

Patrik-Stas commented Oct 26, 2020 •

edited

Loading

codecov-io commented Oct 26, 2020 •

edited

Loading