Docusign envelopes Syncing API getting success but entering to syncingFailed notification

[JacobVnu]

Hi team,

Am using the Docusign V 3.0.3. In my app I was testing the app in lower network. And I was getting the success response for envelope synching the API, but in the code it's entering the notification method of failing.

 NotificationCenter.default.addObserver(self, selector: #selector(syncingFailed), name: NSNotification.Name.DSMEnvelopeSyncingFailed, object: nil)

 @objc private func syncingFailed(notification: NSNotification) {
        dLog(logType: .docusign, "Docusign SDK envelope syncing failed")
    }

Because of its entering the failed case, the envelope synching API will retry for 5 times, even if its gets success.
I can see that the API call duration showing 51,47,47,46,47 Seconds.

Is there any limit that it will retry only 5 times?
Could you please tell me why the failed notification method getting calling even if I got the success response and valid envelopId?

Thanks,
Jacob

[InbarGazit]

Can you try to upgrade to the latest version of the SDK and see if it's any better?

[JacobVnu]

Hi @InbarGazit

I have already raised an issue related while signing the template,
#177
Because of that I couldn't able to update it. Waiting for the next version release.

[JacobVnu]

Hi @InbarGazit
I have updated the SDK to latest version 4.0.1 and checked this issue. Still the issue is there.

Thanks

[ashokds]

Hi @JacobVnu -
Please add the errorCode and message received in the notification.
We updated the SDK to v4.1 - Could you try with that.
Thanks.

[JacobVnu]

Hi @ashokds

I have updated the version to 4.1.0. In this version also am facing the issue.
Scenario:
I kept the network speed for the Docusign domain to low network.
Sign the form and I can see the envelop API called after sometime.
The API got the success response, but in the code it was going inside the syncingFailed function.

        NotificationCenter.default.addObserver(self, selector: #selector(syncingFailed), name: NSNotification.Name.DSMEnvelopeSyncingFailed, object: nil)

    @objc private func syncingFailed(notification: NSNotification) {
        print("syncingFailed(notification:::\(notification)")
        dLog(logType: .docusign, "Docusign SDK envelope syncing failed")
    }

The Envelop API will be calling 5 times. All the 5 times the API will get the success response and it will enter the syncingFailed method. And after the 5 attempts it will not retry the envelop API.

Some of our users are signing the form in lower network and still their forms are in the Queue for Docusign Envelop Syncing.
Could you please tell me the solution to get those queue cleared?

As you requested the failed notification object details are follows.

syncingFailed(notification:::NSConcreteNotification 0x600001907700 {name = DSMEnvelopeSyncingFailedNotification; userInfo = {
    cacheURI = "ASDF1234-ASDF-1234-ASDF-1234";
    combinedDocumentSize = "0.26";
    envelopeId = "ASDF1234-ASDF-1234-ASDF-1234";
    errorCode = "";
    errorReason = "server error";
    excludedFromAutoSync = 0;
    templateId = Valid Template ID;
    transactionId = "ASDF1234-ASDF-1234-ASDF-1234";
}

Here the cacheURI, envelopeId and transactionId are the same value which is the transactionId we are passing in the request body.

Thanks.

[JacobVnu]

Hi @InbarGazit @ashok

Any update on this?

Thanks.

[ashokds]

Hi @JacobVnu -
Taking a look. Thanks for adding the details.

[ashokds]

Hi @JacobVnu :

Would it be possible to get the network log that results in the envelope sync to fail, say for envelope with Id: ASDF1234-ASDF-1234-ASDF-1234? and also, share the Sync Success Notification data to compare the id (envelopeIds, transactionIds, etc) for envelopes in a session.

At times, some envelopes does fail always to sync, while the others in the queue would get synced fine. The stuck envelope would continue to fail until it's deleted if it's in permanent error condition. You could use DSMEnvelopesManager to clear the envelope that is failing to sync.

/*!
 * @discussion Remove a cached envelope. This call can be made when device is offline.
 * @param envelopeId An Id of the envelope to be removed.
 */
- (void)removeCachedEnvelopeWithId:(NSString *)envelopeId;

Thanks

[JacobVnu]

Hi @ashokds

I have shared the requested documents via Sharefile. Could you please have a look into it.
I replicated the issue by keeping the network speed 2G (Edge).
And I have attached the failure envelop synch API request, response and Sync Failure Notification and success API request, response and Sync Success Notification.

If any other details required feel free to ask.

Thanks,
Jacob

[ashokds]

Hi @JacobVnu ,

We have officially released the public version of v4.1.1. You can review the changes here: #190.

This release includes fixes to address out-of-sync notifications, which we expect will resolve the issues encountered during throttled network testing. Please note that additional updates will be incorporated into a future release.

Our next version, v4.2, is planned to include more extensive upgrades focused on the data and network layers.

Thanks,