Skip to content

GitLab

Merged
Created by Juan Jose Lopez@jjlopezMaintainer3 of 13 tasks completed3/13 tasks

Added option to conditionally show cancellation alerts during detections

🎯 Summary

There're some inconsistencies on the way we show cancellation alerts on the SDK: for unattended processes we always show an alert before cancelling, but on the standard (step-by-step) process we never show it.

🤔 Type

  • ✨ New feature
  • 🐛 Bug fix
  • 👷 Technical debt
  • ☢️ Breaking change (it breaks backward compatibility)
  • 📚 Requires a change in the docs

⚙️ Configuration

Related MRs:

TestFlight apps:

⚗️ Solution

Added the isCancellationDialogEnabled property to MSConfiguration so the user is in charge of deciding if an alert should or shouldn't be presented, and unified this behaviour on all processes.

🔬 Tests

  • Start a document detection with isCancellationDialogEnabled set to false (the default), and ensure that no alert is show when canceled.
  • Start a facial detection with isCancellationDialogEnabled set to false (the default), and ensure that no alert is show when canceled.
  • Start an unattended process with isCancellationDialogEnabled set to false (the default), and ensure that no alert is show when canceled during the document detection.
  • Start an unattended process with isCancellationDialogEnabled set to false (the default), and ensure that no alert is show when canceled during the facial detection.
  • Repeat the above setting isCancellationDialogEnabled set to true and ensure that an error alert is shown on every case.

🧐 Checklist:

  • The code follow the project guidelines.
  • The changes have been tested locally.
  • The code has internal docs.
  • Docs are updated (README, public docs, etc.)
  • Some tests have been added to check that the changes work as expected (unit, integration or e2e tests ...)
  • Unit tests are running without errors.
  • Other dependant changes have already been merged.
  • Changelog updated (if it applies)
Edited by Juan Jose Lopez