added v11.7.1

sMaltsevAcuant · sMaltsevAcuant · commit 7114ced19f5b · 2022-11-18T14:42:31.000-08:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Acuant JavaScript Web SDK v11.7.0
+# Acuant JavaScript Web SDK v11.7.1
 
-**July 2022**
+**November 2022**
 
 See [https://github.com/Acuant/JavascriptWebSDKV11/releases](https://github.com/Acuant/JavascriptWebSDKV11/releases) for release notes.
 
@@ -697,13 +697,17 @@ Starting and stopping Workers is a very slow operation, so you will see performa
 
 ## Known Issues/FAQ
 
+1. iPhone 13 Pro, 13 Pro Max, 14 Pro, and 14 Pro Max struggle to focus at close distances when running iOS 16.
+
+	11.7.1 adds a workaround for this issue by having those devices capture from further away. This is a workaround for an issue in iOS 16. There is a more detailed explanation of both the issue and the workaround in the 11.7.1 section of the [Migration Details](docs/MigrationDetails.md). We have been in contact with Apple and they tell us that they are now aware of the issue and are looking into it.
+
 1. iOS 15 has multiple issues that manifest themselves as GPU Highwater failures (ie system daemon used too much memory).
 
-	The reduced resolution of the camera in the latest version of the SDK has mitigated the issue. Unfortunately, because this is an iOS issue, we can’t provide a better solution other than reducing the capture resolution. This issue will be revisited in the next major iOS release to determine which changes have been made in that version.
+	The reduced resolution of the camera in the latest version of the SDK has mitigated the issue. Unfortunately, because this is an iOS issue, we can’t provide a better solution other than reducing the capture resolution. This issue was fixed in iOS 16.
 
 1. The camera preview has a low/throttled frame rate (as low as 10-15fps).
 
-	The frame rate is intentionally throttled because higher frame rates on iOS 15 can be unstable. For consistency, the frame rate is throttled on all devices. In our experience, the throttled frame rate is high enough to successfully perform Live Capture. We will continue to monitor this issue and will remove the throttle once we believe higher frame rates no longer cause instability.
+	The frame rate is intentionally throttled because higher frame rates on iOS 15 can be unstable. For consistency, the frame rate is throttled on all devices. In our experience, the throttled frame rate is high enough to successfully perform Live Capture. We will continue to monitor this issue and will remove the throttle once we believe higher frame rates no longer cause instability. This throttling was removed in 11.7.1
 
 1. Camera previews on iOS 15.0 and 15.1 can appear rotated
 
diff --git a/app/index.html b/app/index.html
@@ -109,7 +109,7 @@
 </head>
 
 <body>
-  <p id="desc"></p>
+  <p id="desc">11.7.1</p>
   <div id="acuant-loader" class="row text-center" style="display:none;">
     <div class="col-md-12">
       <div class="loader" style="margin: 20% auto 0 auto"></div>
diff --git a/docs/MigrationDetails.md b/docs/MigrationDetails.md
@@ -1,5 +1,28 @@
 # Migration Details JavaScript Web SDK
 
+## v11.7.1
+
+v11.7.1 is backwards compatible. This section provides details about the focus issues in iOS 16 and tools for more in-depth implementations. If you are not interested in this information, you can ignore this section.
+
+iOS 16 introduced issues that affect the iPhone 13 Pro, 13 Pro Max, 14 Pro, and 14 Pro Max. In the JS camera, iOS  exposes only a generic front and back camera. Apple's implementation of this generic back camera always selects the same (non-near focus) camera on multi-camera devices and does not re-select when that camera fails to focus. As a result, we have no way to select a camera that can focus at short distances. Apple also did not implement zoom control for cameras in JS, nor a way to know the camera's minimum focus distance. We have contacted Apple about this issue. However, in the meantime, we have provided a workaround.
+
+Forcing these devices to capture from farther away achieves adequate sharpness. Due to iOS 16's increased stability, we also were able to increase the capture resolution for the affected devices. As a result, even though these devices are capturing from farther away, the higher resolution results in a DPI similar to that of other devices. The main limitation to this workaround is the detection of the affected devices. Because modern browsers do not provide detailed information about the user's device inside of the UA, we have to use secondary characteristics to "fingerprint" these devices. The simplest method that results in a high success rate is to examine the device's viewport. If the viewport matches one of four hardcoded sizes, we instruct the device to run at a higher resolution and to capture from farther away.
+
+This method, however, can occasionally result in false positives and false negatives. There are several devices (the iPhone 12, 12 Pro, 12 Pro Max, 13, and 14) that share a viewport size with the affected devices. As a result, those devices also will be instructed to capture from farther away. This behavior is not a major concern because those devices can still capture a sharp image with adequate DPI at this increased distance. Additionally, if one of the affected devices is running with an nonstandard viewport size, the device will not be detected and likely will be unable to focus. We consider this to be a rare edge case, but it is possible.
+
+To help account for these cases, we provided the ability for the implementer to override this detection by setting one of the following cookies on the page:
+
+`AcuantForceRegularCapture=true` forces the capture to proceed at a normal distance, while
+
+`AcuantForceDistantCapture=true` forces the capture to use the far away capture.
+
+If both cookies are set, `AcuantForceRegularCapture=true` takes priority. If, as an implementer, you have additional knowledge about the user's device, you can use the cookies to guarantee that the user is instructed to capture at the correct distance. You also can use the cookies to, for example, send a user to distant capture if the user has captured a blurry image several times. Or, prompt the user by asking whether the user's device is one of the affected ones, and then use the cookies to send the user to the correct capture flow.
+
+On most devices manual capture also allows for capture of sharp, high resolution images, this is another alternative if a user is consistently getting low sharpness.
+
+We are hopeful that Apple will resolve this issue so we can return all devices to the regular capture.
+
+
 ## v11.7.0
 
 ### AcuantCamera
@@ -177,7 +200,7 @@ Remove the old html elements (canvas and video) and replace them with a single d
 
 	<div id="acuant-camera"></div>
       
-Most likely, you are already using a viewport meta tag for your Mobile page. Using a meta tag is now a requirement. If you don’t use the tag, the device will render at a much higher resolution and cause frequent GPU and memory failures.
+Most likely, you are already using a viewport meta tag for your Mobile page. Using a meta tag is now a requirement. If you don't use the tag, the device will render at a much higher resolution and cause frequent GPU and memory failures.
 
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 		
diff --git a/webSdk/AcuantCamera.js b/webSdk/AcuantCamera.js
@@ -1,5 +1,5 @@
-// eslint-disable-next-line no-unused-vars
-const AcuantCameraUI = (function () {
+// eslint-disable-next-line no-unused-vars, no-var
+var AcuantCameraUI = (function () {
   'use strict';
   let player = null;
 
@@ -39,7 +39,7 @@ const AcuantCameraUI = (function () {
     }
   };
 
-  const TRIGGER_TIME = 2000;
+  const TRIGGER_TIME = 3000;
   const DETECT_TIME_THRESHOLD = 400;//slightly increased from 300, 
   let minTime = Number.MAX_VALUE;
 
@@ -486,9 +486,8 @@ const AcuantCameraUI = (function () {
 
 })();
 
-/* eslint-disable no-unused-vars */
-// eslint-disable-next-line no-redeclare
-const AcuantCamera = (function () {
+// eslint-disable-next-line no-unused-vars, no-var
+var AcuantCamera = (function () {
   'use strict';
   let player = null;
   let uiCanvas = null;
@@ -594,7 +593,8 @@ const AcuantCamera = (function () {
 
           //This might help performance, especially on low end devices. Might be less important after apple fixes the ios 15 bug,
           // but right now we want to do as little redraws as possible to avoid GPU load.
-          frameRate: { min: 10, ideal: 15, max: 15 }
+          //20221110 update removing this as this did not seem to be relevant and might be negatively affecting firefox
+          //frameRate: { min: 10, ideal: 15, max: 15 }
         }
       }
     };
@@ -603,8 +603,26 @@ const AcuantCamera = (function () {
     // I believe this is because the true ratio of the camera is 4:3 so this ratio means people do not need to get as close
     // to the id to get good dpi. Cameras might struggle to focus at very close angles.
     if (isIOS()) {
-      config.primaryConstraints.video.aspectRatio = 4 / 3;
-      config.primaryConstraints.video.width = { min: MAX_VIDEO_WIDTH_IOS, ideal: MAX_VIDEO_WIDTH_IOS };
+      if (isDeviceAffectedByIOS16Issue()) {
+        // ios devices dont support zoom, because why would they?!
+        // config.primaryConstraints.video.zoom = 2;
+        //need to instead bump resolution since we will be capturing from further away, ios 16 seems to have fixed the issue so hopefully alright.
+        //also change aspect ratio to make it seem like the id is closer from user's pov.
+        config.primaryConstraints.video.aspectRatio = Math.max(window.innerWidth, window.innerHeight) * 1.0 / Math.min(window.innerWidth, window.innerHeight);
+        //unsure about the stability of pushing resolution this high, but I have not seen a crash thus far
+        config.primaryConstraints.video.height = { min: 1440, ideal: 2880 };
+      } else {
+        //1.3333 aspect ratio and lower ideal height seems to result in better focus and higher dpi on ios devices.
+        // I believe this is because the true ratio of the camera is 4:3 so this ratio means people do not need to get as close
+        // to the id to get good dpi. Cameras might struggle to focus at very close angles.
+        //20221110 update something like the ios 16 fix might work better for this, if we can detect those devices
+        config.primaryConstraints.video.aspectRatio = 4 / 3;
+        if (isiOS15()) {
+          config.primaryConstraints.video.width = { min: MAX_VIDEO_WIDTH_IOS, ideal: MAX_VIDEO_WIDTH_IOS };
+        } else {
+          config.primaryConstraints.video.height = { min: 1440, ideal: 1440 };
+        }
+      }
     } else {
       config.primaryConstraints.video.height = { min: 1440, ideal: 1440 };
       if (isSamsungNote10OrS10OrNewer()) {
@@ -895,7 +913,7 @@ const AcuantCamera = (function () {
           width = image.width,
           height = image.height;
 
-        if (isIOS()) {
+        if (isiOS15()) {
           MAX_WIDTH = MAX_VIDEO_WIDTH_IOS;
           MAX_HEIGHT = Math.floor(MAX_VIDEO_WIDTH_IOS * 3 / 4);
         }
@@ -1022,11 +1040,44 @@ const AcuantCamera = (function () {
     return ver && ver != -1 && ver.length >= 2 && ver[0] == 14 && ver[1] >= 4;
   }
 
-  function isiOS15Plus() {
+  function isiOS15() {
     let ver = iOSversion();
     return ver && ver != -1 && ver.length >= 1 && ver[0] == 15;
   }
 
+ function isiOS16() {
+    let ver = iOSversion();
+    return ver && ver != -1 && ver.length >= 1 && ver[0] == 16
+  }
+
+  function isDeviceAffectedByIOS16Issue() {
+    let decodedCookie = decodeURIComponent(document.cookie);
+    if (decodedCookie.includes('AcuantForceRegularCapture=true')) {
+      return false;
+    }
+    if (decodedCookie.includes('AcuantForceDistantCapture=true')) {
+      return true;
+    }
+    if (isiOS16()) {
+      let dims = [screen.width, screen.height];
+      let long = Math.max(...dims);
+      let short = Math.min(...dims);
+      if (long == 852 && short == 393) { //14 pro
+        return true;
+      }
+      if (long == 932 && short == 430) { //14 pro max
+        return true;
+      }
+      if (long == 844 && short == 390) { //13 pro
+        return true;
+      }
+      if (long == 926 && short == 428) { //13 pro max
+        return true;
+      }
+    }
+    return false;
+  }
+
   function isiPad13Plus() {
     return navigator.maxTouchPoints && navigator.maxTouchPoints >= 2 && /MacIntel/.test(navigator.platform);
   }
@@ -1260,13 +1311,6 @@ const AcuantCamera = (function () {
           }
         });
 
-        //cant seem to figure out the logic of the math here. Ideally if we get 600 dpi even far from the screen edges we 
-        //should still mark it as an okay doc, but I tried a couple different things and could not get the theoretical dpi 
-        //to match the real one.
-        //
-        //const dpi = response.dpi / userConfig.frameScale * userConfig.canvasScale;
-        //console.log("Response DPI: " + response.dpi + " Frame Scale: " + userConfig.frameScale + " Canvas Scale: " + userConfig.canvasScale + " Theoretical dpi: " + dpi)
-
         const minRatio = Math.min(response.dimensions.width, response.dimensions.height) / Math.min(hiddenCanvas.width, hiddenCanvas.height);
         const maxRatio = Math.max(response.dimensions.width, response.dimensions.height) / Math.max(hiddenCanvas.width, hiddenCanvas.height);
         const isPassport = response.type == 2;
@@ -1282,7 +1326,21 @@ const AcuantCamera = (function () {
         if (isIOS()) {
           minRatioLowerBoundThreshold = 0.65;
           maxRatioLowerBoundThreshold = 0.7;
-          if (isPassport) {
+          if (isDeviceAffectedByIOS16Issue()) {
+            if (isPassport) { //intentionally large to help address issues with cvml inaccuaretly detecting passports
+              minRatioUpperBoundThreshold = 0.72;
+              maxRatioUpperBoundThreshold = 0.77;
+              minRatioLowerBoundThreshold = 0.22;
+              maxRatioLowerBoundThreshold = 0.28;
+              // minRatioLowerBoundThreshold = 0.57;
+              // maxRatioLowerBoundThreshold = 0.53;
+            } else { //id
+              minRatioUpperBoundThreshold = 0.41;
+              maxRatioUpperBoundThreshold = 0.45;
+              minRatioLowerBoundThreshold = 0.22;
+              maxRatioLowerBoundThreshold = 0.28;
+            }
+          } else if (isPassport) {
             minRatioUpperBoundThreshold = 0.95;
             maxRatioUpperBoundThreshold = 1;
             minRatioLowerBoundThreshold = 0.7;
@@ -1459,7 +1517,7 @@ const AcuantCamera = (function () {
   }
 
   function sequenceBreak() {
-    if (isiOS15Plus() || isiPad13Plus()) {
+    if (isiOS15() || isiPad13Plus()) {
       callCameraError(SEQUENCE_BREAK_IOS_15, AcuantJavascriptWebSdk.SEQUENCE_BREAK_CODE);
     } else {
       callCameraError(SEQUENCE_BREAK_OTHER, AcuantJavascriptWebSdk.SEQUENCE_BREAK_CODE);
diff --git a/webSdk/AcuantCamera.min.js b/webSdk/AcuantCamera.min.js
diff --git a/webSdk/AcuantJavascriptWebSdk.min.js b/webSdk/AcuantJavascriptWebSdk.min.js
