feat: Automatic version check when an action fails

Signed-off-by: Tanel Metsar <[email protected]>

Author: taneltm

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "web-eid-webextension",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "",
   "main": "src/index.js",
   "scripts": {

package.json

@@ -24,28 +24,29 @@ import Action from "@web-eid.js/models/Action";
 import { NativeAuthenticateRequest } from "@web-eid.js/models/message/NativeRequest";
 import { NativeAuthenticateResponse } from "@web-eid.js/models/message/NativeResponse";
 import UserTimeoutError from "@web-eid.js/errors/UserTimeoutError";
-import { serializeError } from "@web-eid.js/utils/errorSerializer";
 
 import { ExtensionAuthenticateResponse, ExtensionFailureResponse } from "@web-eid.js/models/message/ExtensionResponse";
 import { MessageSender } from "../../models/Browser/Runtime";
 import NativeAppService from "../services/NativeAppService";
 import UnknownError from "@web-eid.js/errors/UnknownError";
+import actionErrorHandler from "../../shared/actionErrorHandler";
 import config from "../../config";
 import { getSenderUrl } from "../../shared/utils/sender";
 import { throwAfterTimeout } from "../../shared/utils/timing";
 
 export default async function authenticate(
   challengeNonce: string,
   sender: MessageSender,
+  libraryVersion: string,
   userInteractionTimeout: number,
   lang?: string,
 ): Promise<ExtensionAuthenticateResponse | ExtensionFailureResponse> {
   let nativeAppService: NativeAppService | undefined;
+  let nativeAppStatus: { version: string } | undefined;
 
   try {
     nativeAppService = new NativeAppService();
-
-    const nativeAppStatus = await nativeAppService.connect();
+    nativeAppStatus  = await nativeAppService.connect();
 
     config.DEBUG && console.log("Authenticate: connected to native", nativeAppStatus);
 
@@ -85,10 +86,7 @@ export default async function authenticate(
   } catch (error) {
     console.error("Authenticate:", error);
 
-    return {
-      action: Action.AUTHENTICATE_FAILURE,
-      error:  serializeError(error),
-    };
+    return actionErrorHandler(Action.AUTHENTICATE_FAILURE, error, libraryVersion, nativeAppStatus?.version);
   } finally {
     nativeAppService?.close();
   }

src/background/actions/authenticate.ts

@@ -25,7 +25,6 @@ import { NativeGetSigningCertificateRequest } from "@web-eid.js/models/message/N
 import { NativeGetSigningCertificateResponse } from "@web-eid.js/models/message/NativeResponse";
 import UnknownError from "@web-eid.js/errors/UnknownError";
 import UserTimeoutError from "@web-eid.js/errors/UserTimeoutError";
-import { serializeError } from "@web-eid.js/utils/errorSerializer";
 
 import {
   ExtensionFailureResponse,
@@ -34,19 +33,23 @@ import {
 
 import { MessageSender } from "../../models/Browser/Runtime";
 import NativeAppService from "../services/NativeAppService";
+import actionErrorHandler from "../../shared/actionErrorHandler";
 import config from "../../config";
 import { getSenderUrl } from "../../shared/utils/sender";
 import { throwAfterTimeout } from "../../shared/utils/timing";
 
 export default async function getSigningCertificate(
   sender: MessageSender,
+  libraryVersion: string,
   userInteractionTimeout: number,
   lang?: string,
 ): Promise<ExtensionGetSigningCertificateResponse | ExtensionFailureResponse> {
-  const nativeAppService = new NativeAppService();
+  let nativeAppService: NativeAppService | undefined;
+  let nativeAppStatus: { version: string } | undefined;
 
   try {
-    const nativeAppStatus = await nativeAppService.connect();
+    nativeAppService = new NativeAppService();
+    nativeAppStatus = await nativeAppService.connect();
 
     config.DEBUG && console.log("getSigningCertificate: connected to native", nativeAppStatus);
 
@@ -78,11 +81,8 @@ export default async function getSigningCertificate(
   } catch (error: any) {
     console.error("GetSigningCertificate:", error);
 
-    return {
-      action: Action.GET_SIGNING_CERTIFICATE_FAILURE,
-      error:  serializeError(error),
-    };
+    return actionErrorHandler(Action.GET_SIGNING_CERTIFICATE_FAILURE, error, libraryVersion, nativeAppStatus?.version);
   } finally {
-    nativeAppService.close();
+    nativeAppService?.close();
   }
 }

src/background/actions/getSigningCertificate.ts

@@ -30,10 +30,10 @@ import { NativeSignRequest } from "@web-eid.js/models/message/NativeRequest";
 import { NativeSignResponse } from "@web-eid.js/models/message/NativeResponse";
 import UnknownError from "@web-eid.js/errors/UnknownError";
 import UserTimeoutError from "@web-eid.js/errors/UserTimeoutError";
-import { serializeError } from "@web-eid.js/utils/errorSerializer";
 
 import { MessageSender } from "../../models/Browser/Runtime";
 import NativeAppService from "../services/NativeAppService";
+import actionErrorHandler from "../../shared/actionErrorHandler";
 import config from "../../config";
 import { getSenderUrl } from "../../shared/utils/sender";
 import { throwAfterTimeout } from "../../shared/utils/timing";
@@ -44,15 +44,16 @@ export default async function sign(
   hash: string,
   hashFunction: string,
   sender: MessageSender,
+  libraryVersion: string,
   userInteractionTimeout: number,
   lang?: string,
 ): Promise<ExtensionSignResponse | ExtensionFailureResponse> {
   let nativeAppService: NativeAppService | undefined;
+  let nativeAppStatus: { version: string } | undefined;
 
   try {
     nativeAppService = new NativeAppService();
-
-    const nativeAppStatus = await nativeAppService.connect();
+    nativeAppStatus  = await nativeAppService.connect();
 
     config.DEBUG && console.log("Sign: connected to native", nativeAppStatus);
 
@@ -90,10 +91,7 @@ export default async function sign(
   } catch (error) {
     console.error("Sign:", error);
 
-    return {
-      action: Action.SIGN_FAILURE,
-      error:  serializeError(error),
-    };
+    return actionErrorHandler(Action.SIGN_FAILURE, error, libraryVersion, nativeAppStatus?.version);
   } finally {
     nativeAppService?.close();
   }

src/background/actions/sign.ts

@@ -39,13 +39,15 @@ async function onAction(message: ExtensionRequest, sender: MessageSender): Promi
         message.challengeNonce,
 
         sender,
+        message.libraryVersion,
         message.options?.userInteractionTimeout || libraryConfig.DEFAULT_USER_INTERACTION_TIMEOUT,
         message.options?.lang
       );
 
     case Action.GET_SIGNING_CERTIFICATE:
       return await getSigningCertificate(
         sender,
+        message.libraryVersion,
         message.options?.userInteractionTimeout || libraryConfig.DEFAULT_USER_INTERACTION_TIMEOUT,
         message.options?.lang
       );
@@ -57,6 +59,7 @@ async function onAction(message: ExtensionRequest, sender: MessageSender): Promi
         message.hashFunction,
 
         sender,
+        message.libraryVersion,
         message.options?.userInteractionTimeout || libraryConfig.DEFAULT_USER_INTERACTION_TIMEOUT,
         message.options?.lang
       );

src/background/background.ts

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2020-2021 Estonian Information System Authority
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import Action from "@web-eid.js/models/Action";
+import ErrorCode from "@web-eid.js/errors/ErrorCode";
+import { ExtensionFailureResponse } from "@web-eid.js/models/message/ExtensionResponse";
+import VersionMismatchError from "@web-eid.js/errors/VersionMismatchError";
+import { serializeError } from "@web-eid.js/utils/errorSerializer";
+
+import checkCompatibility from "./utils/checkCompatibility";
+import config from "../config";
+
+export default function actionErrorHandler(
+  action:
+  | Action.AUTHENTICATE_FAILURE
+  | Action.GET_SIGNING_CERTIFICATE_FAILURE
+  | Action.SIGN_FAILURE,
+
+  originalError: any,
+  libraryVersion: string,
+  nativeAppVersion?: string,
+): ExtensionFailureResponse {
+  let error;
+
+  /**
+   * Always show the original error when native app version is unavailable.
+   * The native app might not be available (ERR_WEBEID_NATIVE_UNAVAILABLE)
+   * or an error ocurred in the extension before native app version could be detected.
+   * In addition, if the native app version is missing, checkCompatibility(...) would throw an "Invalid SemVer string" error.
+   *
+   * Always show the original error when the error code is ERR_WEBEID_USER_CANCELLED.
+   * In this case the user cancelled the operation in native app UI, which means the native app API had to be compatible for this action.
+   */
+  if (!nativeAppVersion || originalError?.code === ErrorCode.ERR_WEBEID_USER_CANCELLED) {
+    error = originalError;
+
+  } else {
+    const versions = {
+      extension: config.VERSION,
+      library:   libraryVersion,
+      nativeApp: nativeAppVersion,
+    };
+
+    const requiresUpdate = checkCompatibility(versions);
+
+    error = (
+      (requiresUpdate.extension || requiresUpdate.nativeApp)
+        ? new VersionMismatchError(undefined, versions, requiresUpdate)
+        : originalError
+    );
+  }
+
+  return {
+    action,
+    error: serializeError(error),
+  };
+}