Add onFinishSigning prop & upgrade all minor version deps #5

Winggo · 2021-10-19T23:50:00Z

Description of the change

Add onFinishSigning as a prop of AnvilSignatureFrame that calls after signing.

Very similar to the onFinish func prop, except it takes a payload as input instead of the redirectURL.
The payload is constructed from redirectURL query params.

Updated docs with onFinishSigning and removed onFinish.

Example:

onFinishSigning={(payload) => console.log(payload)}

/*
{
  action: "signerComplete"
  documentGroupEid: "9fQnvfy51p7oKrEYajMh"
  documentGroupStatus: "partial"
  etchPacketEid: "J1phQTO6WQH6gZcMJAG5"
  nextSignerEid: "HRLhx4khticpfxsUFSpj"
  signerEid: "kJzR6mcIWKoZs6KOxV4w"
  signerStatus: "completed"
  weldDataEid: undefined
}
*/

Also bumped minor versions for dependencies, seeing a lot of vulnerabilities: https://github.com/anvilco/react-ui/security/dependabot

Type of change

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Related issues

Fixes anvilco/anvil#2733

Dev Checklist

The code changed/added as part of this pull request has been covered with tests
All tests related to the changed code pass in development
No previous tests unrelated to the changed code fail in development

benogle · 2021-10-20T00:06:20Z

packages/react-signature-frame/src/index.js

+
+      // parse query params into an object
+      const searchStr = data.split('?')[1]
+      const searchObj = JSON.parse('{"' + decodeURI(searchStr).replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g, '":"') + '"}')


I think I'd do 2 things here that feel a little safer

Use URLSearchParams if it exists. You can do something like if (typeof URLSearchParams !== 'undefined') {...} then use it

Fallback to what you have. It also feels safer to decodeURI on each value component after you have the object, since often URLs will have their non-alpha characters encoded like %20

FWIW, IE doesnt support URLSearchParams, so IE users would fallback to the json parse

Implemented

benogle · 2021-10-20T00:08:56Z

packages/react-signature-frame/src/index.js

+      const searchStr = data.split('?')[1]
+      const searchObj = JSON.parse('{"' + decodeURI(searchStr).replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g, '":"') + '"}')
+      const { signerStatus, signerEid, nextSignerEid, documentGroupStatus, documentGroupEid, etchPacketEid, weldDataEid } = searchObj
+      this.props.onFinishSigning({


Can you also make sure there is no error or errorType in the searchObj before calling this? This callback should only be called on signer success. I'll add an error handler mirroring this in the next pass

benogle · 2021-10-20T00:11:14Z

package.json

-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/preset-env": "^7.12.1",
-    "@babel/preset-react": "^7.12.5",
+    "@babel/core": "^7.15.8",


yay for upgraded deps!

benogle · 2021-10-20T00:17:23Z

README.md

@@ -53,14 +53,27 @@ Example:
 onLoad={() => setLoading(false)}
 ```

-#### onFinish


I think you should keep onFinish in the docs, but say it is deprecated as people are still using it. I'd also remove the redirect bits from the example, and maybe just log it as an example

Left onFinish in docs and noted as deprecated

benogle

I think just need to address the error case on URLSearchParams, but other than that, good to go

benogle · 2021-10-20T17:30:46Z

packages/react-signature-frame/src/index.js

+        }
+      }
+
+      if (!searchObj.error && !searchObj.errorType) this.props.onFinishSigning(payload)


Does this work in the URLSearchParams case? Or would it need to call .get()? Would it make more sense to put those things into the payload?

Yeah, would need to call .get(). Good catch. Fixed!

Winggo · 2021-10-20T18:54:09Z

Tested the new components with onFinishSigning on a local release in anvil-etch-example. Looks good and merged. Making a minor release...

Winggo · 2021-10-20T18:59:54Z

@anvilco/react-signature-frame v1.5.0 & @anvilco/react-signature-modal v1.5.0 released. v1.4.6 -> v1.5.0

https://www.npmjs.com/package/@anvilco/react-signature-frame
https://www.npmjs.com/package/@anvilco/react-signature-modal

Winggo added 8 commits October 14, 2021 17:48

all minor upgrades

ce50a7b

add onFinishSigning callback

7f0471e

pass onFinishSigning into AnvilSignatureModal

481af16

onFinish default should be empty function

96e7e77

update docs

86b810e

add nextSignerEid to onFinishSigning payload

0e94c07

add example payload to docs

e7766a4

comment

932e329

Winggo added the enhancement New feature or request label Oct 19, 2021

Winggo requested a review from benogle October 19, 2021 23:50

Winggo self-assigned this Oct 19, 2021

Winggo changed the title ~~Add onFinishSigning prop~~ Add onFinishSigning prop & update all minor version deps Oct 19, 2021

Winggo changed the title ~~Add onFinishSigning prop & update all minor version deps~~ Add onFinishSigning prop & upgrade all minor version deps Oct 19, 2021

benogle reviewed Oct 20, 2021

View reviewed changes

Winggo added 4 commits October 19, 2021 18:26

use URLSearchParams

1362e33

only call onFinishSigning on success

68780fb

remove sentence

2bac3ba

docs for onFinish deprecated

8b6f47e

benogle approved these changes Oct 20, 2021

View reviewed changes

add hasError

ffb070b

benogle approved these changes Oct 20, 2021

View reviewed changes

Winggo merged commit f0dafc1 into main Oct 20, 2021

Winggo deleted the wt/add-onFinishSigning branch October 20, 2021 18:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add onFinishSigning prop & upgrade all minor version deps #5

Add onFinishSigning prop & upgrade all minor version deps #5

Uh oh!

Winggo commented Oct 19, 2021 •

edited

Loading

Uh oh!

benogle Oct 20, 2021

Uh oh!

benogle Oct 20, 2021

Uh oh!

Winggo Oct 20, 2021

Uh oh!

benogle Oct 20, 2021

Uh oh!

Winggo Oct 20, 2021

Uh oh!

benogle Oct 20, 2021

Uh oh!

benogle Oct 20, 2021

Uh oh!

Winggo Oct 20, 2021

Uh oh!

benogle left a comment

Uh oh!

benogle Oct 20, 2021

Uh oh!

Winggo Oct 20, 2021 •

edited

Loading

Uh oh!

Winggo commented Oct 20, 2021

Uh oh!

Winggo commented Oct 20, 2021 •

edited

Loading

Uh oh!

Uh oh!

Add onFinishSigning prop & upgrade all minor version deps #5

Add onFinishSigning prop & upgrade all minor version deps #5

Uh oh!

Conversation

Winggo commented Oct 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the change

Type of change

Related issues

Dev Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benogle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Winggo Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Winggo commented Oct 20, 2021

Uh oh!

Winggo commented Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Winggo commented Oct 19, 2021 •

edited

Loading

Winggo Oct 20, 2021 •

edited

Loading

Winggo commented Oct 20, 2021 •

edited

Loading