[IMP] point_of_sale: improve IoT error messages

This commit improves the error messages in the following scenarios when
receipt printing fails:
- If the user if offline, we get a message telling them to reconnect to
  the internet.
- If the IoT box responds but the printer cannot be found, we explain
  this to the user and ask them to check the printer.
- If we fail to connect to the IoT box at all, we assume there is a
  HTTPS problem and tell the user to set up their subscription.

task-4787508

closes odoo#209541

X-original-commit: 7b0d177
Related: odoo/enterprise#85332
Signed-off-by: Yaroslav Soroko (yaso) <[email protected]>
Signed-off-by: Max Whale (mawh) <[email protected]>

Author: MaxTheWhale

addons/point_of_sale/static/src/app/components/popups/retry_print_popup/retry_print_popup.js

@@ -8,12 +8,14 @@ export class RetryPrintPopup extends Component {
     static props = {
         title: { type: String, optional: true },
         message: { type: String, optional: true },
+        canRetry: { type: Boolean, optional: true },
         download: Function,
         retry: Function,
         close: Function,
     };
     static defaultProps = {
         title: _t("Printing error"),
+        message: _t("An unknown error occurred. Do you want to download the receipt instead?"),
     };
 
     onClickDownload() {

addons/point_of_sale/static/src/app/components/popups/retry_print_popup/retry_print_popup.xml

@@ -3,11 +3,10 @@
 
     <t t-name="point_of_sale.RetryPrintPopup">
         <Dialog size="'md'" title="props.title">
-            <p t-if="props.message" t-out="props.message"/>
-            <p>Do you want to retry printing, or download it instead?</p>
+            <p t-if="props.message" t-out="props.message" class="text-prewrap"/>
             <t t-set-slot="footer">
-                <button class="btn btn-primary btn-lg" t-on-click="onClickRetry">Retry</button>
-                <button class="btn btn-secondary btn-lg" t-on-click="onClickDownload">Download</button>
+                <button t-if="props.canRetry" class="btn btn-primary btn-lg" t-on-click="onClickRetry">Retry</button>
+                <button class="btn btn-lg" t-att-class="{ 'btn-secondary': props.canRetry, 'btn-primary': !props.canRetry }" t-on-click="onClickDownload">Download</button>
                 <button class="btn btn-secondary btn-lg" t-on-click="props.close">Discard</button>
             </t>
         </Dialog>

addons/point_of_sale/static/src/app/services/pos_printer_service.js

@@ -45,6 +45,7 @@ export class PosPrinterService extends PrinterService {
             this.dialog.add(RetryPrintPopup, {
                 title: error.title,
                 message: error.body,
+                canRetry: error.canRetry,
                 retry: () => {
                     this.printHtml(...arguments);
                 },

addons/point_of_sale/static/src/app/services/printer_service.js

@@ -36,6 +36,7 @@ export class PrinterService extends Reactive {
         throw {
             title: printResult.message.title || "Error",
             body: printResult.message.body,
+            canRetry: printResult.canRetry,
             errorCode: printResult.errorCode,
         };
     }

addons/point_of_sale/static/src/app/utils/printer/base_printer.js

@@ -1,4 +1,5 @@
 import { _t } from "@web/core/l10n/translation";
+import { ConnectionLostError } from "@web/core/network/rpc";
 import { htmlToCanvas } from "@point_of_sale/app/services/render_service";
 /**
  * Implements basic printer functions.
@@ -30,9 +31,12 @@ export class BasePrinter {
             );
             try {
                 printResult = await this.sendPrintingJob(image);
-            } catch {
+            } catch (error) {
                 // Error in communicating to the IoT box.
                 this.receiptQueue.length = 0;
+                if (error instanceof ConnectionLostError) {
+                    return this.getOfflineError();
+                }
                 return this.getActionError();
             }
             // rpc call is okay but printing failed because
@@ -66,11 +70,45 @@ export class BasePrinter {
      * if it failed to connect to the IoT box.
      */
     getActionError() {
+        if (window.isSecureContext) {
+            // We assume if we get a network error over HTTPS that it is a certificate issue.
+            return {
+                successful: false,
+                canRetry: false,
+                message: {
+                    title: _t("Connection to IoT Box failed"),
+                    body: _t(
+                        "Your database is not registered.\n" +
+                            "Buy a subscription, or register your subscription code, then retry.\n\n" +
+                            "You can still download the receipt and print it manually."
+                    ),
+                },
+            };
+        } else {
+            return {
+                successful: false,
+                canRetry: true,
+                message: {
+                    title: _t("Connection to IoT Box failed"),
+                    body: _t(
+                        "Please ensure the IoT box is turned on and connected to the network before retrying."
+                    ),
+                },
+            };
+        }
+    }
+
+    /**
+     * Return value of this method will be the result of calling `printReceipt`
+     * if it failed due to the client being offline.
+     */
+    getOfflineError() {
         return {
             successful: false,
+            canRetry: true,
             message: {
-                title: _t("Connection to IoT Box failed"),
-                body: _t("Please check if the IoT Box is still connected."),
+                title: _t("No Internet Connection"),
+                body: _t("Please ensure you are connected to the internet before retrying."),
             },
         };
     }
@@ -82,13 +120,11 @@ export class BasePrinter {
     getResultsError(_printResult) {
         return {
             successful: false,
+            canRetry: true,
             message: {
                 title: _t("Connection to the printer failed"),
                 body: _t(
-                    "Please check if the printer is still connected. \n" +
-                        "Some browsers don't allow HTTP calls from websites to devices in the network (for security reasons). " +
-                        "If it is the case, you will need to follow Odoo's documentation for " +
-                        "'Self-signed certificate for ePOS printers' and 'Secure connection (HTTPS)' to solve the issue. "
+                    "Your IoT box cannot find the printer, please ensure it is connected and turned on before retrying."
                 ),
             },
         };