@robotical/webapp-types 3.20.0 → 3.21.0

package/dist-types/src/services/logger/Logger.js

@@ -8,6 +8,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 import { AppSentMessage } from "../../types/communication-between-apps/wrapper-communication";
+import { addLoggerWarningBreadcrumb, captureLoggerError, } from "../observability/Observability";
 var SHOW_LOGS_GLOBAL = true;
 var ONLY_SHOW_VIP_LOGS = false;
 var Logger = /** @class */ (function () {
@@ -25,6 +26,7 @@ var Logger = /** @class */ (function () {
         for (var _i = 2; _i < arguments.length; _i++) {
             messages[_i - 2] = arguments[_i];
         }
+        captureLoggerError(tag, messages);
         SHOW_LOGS_GLOBAL && !ONLY_SHOW_VIP_LOGS && SHOW_LOGS && console.error.apply(console, __spreadArray(['\x1b[31m%s\x1b[0m', "ERROR: ".concat(tag)], messages, false)); // Red color for error logs
     };
     Logger.debug = function (SHOW_LOGS, tag) {
@@ -39,6 +41,7 @@ var Logger = /** @class */ (function () {
         for (var _i = 2; _i < arguments.length; _i++) {
             messages[_i - 2] = arguments[_i];
         }
+        addLoggerWarningBreadcrumb(tag, messages);
         SHOW_LOGS_GLOBAL && !ONLY_SHOW_VIP_LOGS && SHOW_LOGS && console.warn.apply(console, __spreadArray(['\x1b[33m%s\x1b[0m', "WARN: ".concat(tag)], messages, false)); // Yellow color for warning logs
     };
     Logger.phoneAppLog = function (SHOW_LOGS, tag) {

package/dist-types/src/services/observability/Observability.d.ts

@@ -0,0 +1,5 @@
+export type AppRuntime = "web-app" | "phone-webview";
+export declare function initializeObservability(): boolean;
+export declare function isObservabilityTransportUrl(url: string): boolean;
+export declare function captureLoggerError(tag: string, messages: unknown[]): void;
+export declare function addLoggerWarningBreadcrumb(tag: string, messages: unknown[]): void;

package/dist-types/src/services/observability/Observability.js

@@ -0,0 +1,190 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import * as Sentry from "@sentry/react";
+import packageInfo from "../../../package.json";
+import isPhoneApp from "../../utils/phone-app-communication/is-phone-app";
+import { getSafeErrorType, redactTelemetryText, sanitizeTelemetryValue, } from "./sanitizeTelemetry";
+var appVersion = packageInfo.version;
+var getRuntime = function () {
+    try {
+        return isPhoneApp() ? "phone-webview" : "web-app";
+    }
+    catch (_a) {
+        return "web-app";
+    }
+};
+var getSafeAppSnapshot = function () {
+    var applicationManager = window.applicationManager;
+    var connectedRafts = (applicationManager === null || applicationManager === void 0 ? void 0 : applicationManager.connectedRafts)
+        ? Object.values(applicationManager.connectedRafts)
+        : [];
+    var connectedRaftTypes = Array.from(new Set(connectedRafts
+        .map(function (raft) { return raft === null || raft === void 0 ? void 0 : raft.type; })
+        .filter(function (type) { return type !== undefined; })
+        .map(function (type) { return String(type); })));
+    var deviceInfo = applicationManager === null || applicationManager === void 0 ? void 0 : applicationManager.deviceInfo;
+    return sanitizeTelemetryValue({
+        appVersion: appVersion,
+        runtime: getRuntime(),
+        route: window.location.pathname,
+        online: navigator.onLine,
+        language: navigator.language,
+        viewport: {
+            width: window.innerWidth,
+            height: window.innerHeight,
+            devicePixelRatio: window.devicePixelRatio || 1,
+        },
+        connectedRaftCount: connectedRafts.length,
+        connectedRaftTypes: connectedRaftTypes,
+        wrapper: deviceInfo
+            ? {
+                appVersion: deviceInfo.appVersion,
+                buildNumber: deviceInfo.buildNumber,
+                systemName: deviceInfo.systemName,
+                systemVersion: deviceInfo.systemVersion,
+            }
+            : undefined,
+    });
+};
+var sanitizeEvent = function (event) {
+    var _a, _b;
+    var eventWithPrivateData = event;
+    delete eventWithPrivateData.user;
+    delete eventWithPrivateData.request;
+    (_b = (_a = eventWithPrivateData.exception) === null || _a === void 0 ? void 0 : _a.values) === null || _b === void 0 ? void 0 : _b.forEach(function (exception) {
+        if (exception.type) {
+            exception.type = getSafeErrorType(exception.type);
+        }
+        if (exception.value) {
+            exception.value = "[REDACTED]";
+        }
+    });
+    return sanitizeTelemetryValue(eventWithPrivateData);
+};
+export function initializeObservability() {
+    var _a;
+    var dsn = (_a = process.env.REACT_APP_SENTRY_DSN) === null || _a === void 0 ? void 0 : _a.trim();
+    if (!dsn || Sentry.isInitialized()) {
+        return Sentry.isInitialized();
+    }
+    Sentry.init({
+        dsn: dsn,
+        environment: process.env.REACT_APP_SENTRY_ENVIRONMENT || process.env.NODE_ENV,
+        release: process.env.REACT_APP_SENTRY_RELEASE || "marty-web-app@".concat(appVersion),
+        sendDefaultPii: false,
+        attachStacktrace: true,
+        maxBreadcrumbs: 75,
+        integrations: [
+            Sentry.breadcrumbsIntegration({
+                console: false,
+                dom: false,
+                fetch: false,
+                history: false,
+                sentry: false,
+                xhr: false,
+            }),
+        ],
+        beforeBreadcrumb: function (breadcrumb) {
+            return sanitizeTelemetryValue(breadcrumb);
+        },
+        beforeSend: function (event) {
+            event.tags = __assign(__assign({}, event.tags), { app_runtime: getRuntime(), app_version: appVersion });
+            event.contexts = __assign(__assign({}, event.contexts), { app_snapshot: getSafeAppSnapshot() });
+            return sanitizeEvent(event);
+        },
+    });
+    Sentry.setTags({
+        app_runtime: getRuntime(),
+        app_version: appVersion,
+    });
+    return true;
+}
+export function isObservabilityTransportUrl(url) {
+    var _a;
+    var dsn = (_a = process.env.REACT_APP_SENTRY_DSN) === null || _a === void 0 ? void 0 : _a.trim();
+    if (!dsn)
+        return false;
+    try {
+        return new URL(url, window.location.href).hostname === new URL(dsn).hostname;
+    }
+    catch (_b) {
+        return false;
+    }
+}
+var serializeLogArguments = function (messages) {
+    return messages.map(function (message) { return sanitizeTelemetryValue(message); });
+};
+var getLogMessage = function (messages) {
+    var message = messages
+        .map(function (item) {
+        if (item instanceof Error)
+            return getSafeErrorType(item);
+        if (typeof item === "string")
+            return item;
+        try {
+            return JSON.stringify(sanitizeTelemetryValue(item));
+        }
+        catch (_a) {
+            return String(item);
+        }
+    })
+        .join(" ")
+        .trim();
+    return redactTelemetryText(message || "Unknown error");
+};
+export function captureLoggerError(tag, messages) {
+    if (!Sentry.isInitialized())
+        return;
+    try {
+        var error_1 = messages.find(function (message) { return message instanceof Error; });
+        var safeTag_1 = redactTelemetryText(tag).slice(0, 100);
+        var safeMessage_1 = getLogMessage(messages);
+        Sentry.withScope(function (scope) {
+            scope.setLevel("error");
+            scope.setTag("logger_tag", safeTag_1);
+            scope.setContext("logger", {
+                message: safeMessage_1,
+                arguments: serializeLogArguments(messages),
+            });
+            scope.setContext("app_snapshot", getSafeAppSnapshot());
+            if (error_1) {
+                Sentry.captureException(error_1);
+            }
+            else {
+                Sentry.captureMessage("".concat(safeTag_1, ": ").concat(safeMessage_1), "error");
+            }
+        });
+    }
+    catch (_a) {
+        // Monitoring must never interrupt the application path it observes.
+    }
+}
+export function addLoggerWarningBreadcrumb(tag, messages) {
+    if (!Sentry.isInitialized())
+        return;
+    try {
+        var safeTag = redactTelemetryText(tag).slice(0, 100);
+        Sentry.addBreadcrumb({
+            category: "app.warning",
+            level: "warning",
+            message: "".concat(safeTag, ": ").concat(getLogMessage(messages)),
+            data: {
+                loggerTag: safeTag,
+                route: window.location.pathname,
+                runtime: getRuntime(),
+            },
+        });
+    }
+    catch (_a) {
+        // Monitoring must never interrupt the application path it observes.
+    }
+}

package/dist-types/src/services/observability/sanitizeTelemetry.d.ts

@@ -0,0 +1,7 @@
+export declare const isSensitiveTelemetryKey: (key: string) => boolean;
+export declare const getSafeErrorType: (value: unknown) => string;
+export declare const getSafeErrorMetadata: (error: unknown) => {
+    errorType: string;
+};
+export declare function redactTelemetryText(value: string): string;
+export declare function sanitizeTelemetryValue(value: unknown, depth?: number, seen?: WeakSet<object>): unknown;

package/dist-types/src/services/observability/sanitizeTelemetry.js

@@ -0,0 +1,136 @@
+var REDACTED = "[REDACTED]";
+var MAX_DEPTH = 12;
+var MAX_ARRAY_ITEMS = 100;
+var MAX_OBJECT_KEYS = 100;
+var MAX_STRING_LENGTH = 4000;
+var SAFE_ERROR_TYPES = new Set([
+    "AbortError",
+    "AggregateError",
+    "DOMException",
+    "Error",
+    "EvalError",
+    "NetworkError",
+    "NotAllowedError",
+    "RangeError",
+    "ReferenceError",
+    "SecurityError",
+    "SyntaxError",
+    "TimeoutError",
+    "TypeError",
+    "URIError",
+]);
+var SENSITIVE_KEYS = new Set([
+    "authorization",
+    "authtoken",
+    "base64",
+    "bleaddress",
+    "bssid",
+    "cookie",
+    "cookies",
+    "credential",
+    "credentials",
+    "connectionlocator",
+    "dataurl",
+    "deviceid",
+    "devicename",
+    "email",
+    "filecontents",
+    "friendlyname",
+    "ipaddress",
+    "locator",
+    "macaddress",
+    "password",
+    "passphrase",
+    "raftid",
+    "robotid",
+    "secret",
+    "serial",
+    "serialno",
+    "serialnumber",
+    "ssid",
+    "streamcontents",
+    "token",
+    "username",
+    "wifipassword",
+    "wifimac",
+    "wifiusername",
+]);
+var normalizeKey = function (key) {
+    return key.replace(/[^a-z0-9]/gi, "").toLowerCase();
+};
+export var isSensitiveTelemetryKey = function (key) {
+    return SENSITIVE_KEYS.has(normalizeKey(key));
+};
+export var getSafeErrorType = function (value) {
+    var errorType = value instanceof Error ? value.name : value;
+    return typeof errorType === "string" && SAFE_ERROR_TYPES.has(errorType)
+        ? errorType
+        : "Error";
+};
+export var getSafeErrorMetadata = function (error) { return ({
+    errorType: error instanceof Error ? getSafeErrorType(error) : typeof error,
+}); };
+export function redactTelemetryText(value) {
+    var redacted = value
+        .replace(/\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}\b/gi, REDACTED)
+        .replace(/\b(password|passphrase|token|authorization|cookie|secret|ssid|serial(?:\s*(?:number|no))?|device\s*id|device\s*name|robot\s*id|robot\s*name|raft(?:\s+with)?\s*id|mac\s*address|ble\s*address)\s*(?::|=|\s)\s*[^\s,;]+/gi, function (_match, label) { return "".concat(label, ": ").concat(REDACTED); })
+        .replace(/\bWi-?Fi\s+network\s+[^\s,;]+/gi, "Wi-Fi network ".concat(REDACTED))
+        .replace(/https:\/\/hooks\.slack\.com\/services\/[^\s"']+/gi, REDACTED)
+        .replace(/([?&][^=&#\s]+)=([^&#\s]*)/g, "$1=".concat(REDACTED))
+        .replace(/\b[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\b/gi, REDACTED)
+        .replace(/\b(?:[0-9a-f]{2}:){5}[0-9a-f]{2}\b/gi, REDACTED);
+    return redacted.length > MAX_STRING_LENGTH
+        ? "".concat(redacted.slice(0, MAX_STRING_LENGTH), "\u2026")
+        : redacted;
+}
+export function sanitizeTelemetryValue(value, depth, seen) {
+    if (depth === void 0) { depth = 0; }
+    if (seen === void 0) { seen = new WeakSet(); }
+    if (typeof value === "string") {
+        return redactTelemetryText(value);
+    }
+    if (value === null ||
+        value === undefined ||
+        typeof value === "boolean" ||
+        typeof value === "number") {
+        return value;
+    }
+    if (typeof value === "bigint" || typeof value === "symbol") {
+        return String(value);
+    }
+    if (typeof value === "function") {
+        return "[Function]";
+    }
+    if (depth >= MAX_DEPTH) {
+        return "[Truncated]";
+    }
+    if (value instanceof Error) {
+        return {
+            name: getSafeErrorType(value),
+            message: REDACTED,
+        };
+    }
+    if (value instanceof Date) {
+        return value.toISOString();
+    }
+    if (typeof value !== "object") {
+        return redactTelemetryText(String(value));
+    }
+    if (seen.has(value)) {
+        return "[Circular]";
+    }
+    seen.add(value);
+    if (Array.isArray(value)) {
+        return value
+            .slice(0, MAX_ARRAY_ITEMS)
+            .map(function (item) { return sanitizeTelemetryValue(item, depth + 1, seen); });
+    }
+    var sanitized = {};
+    for (var _i = 0, _a = Object.entries(value).slice(0, MAX_OBJECT_KEYS); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], item = _b[1];
+        sanitized[key] = isSensitiveTelemetryKey(key)
+            ? REDACTED
+            : sanitizeTelemetryValue(item, depth + 1, seen);
+    }
+    return sanitized;
+}

package/dist-types/src/utils/feedback/submitFeedback.js

@@ -46,6 +46,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import Logger from "../../services/logger/Logger";
+import { getSafeErrorMetadata } from "../../services/observability/sanitizeTelemetry";
 import { FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE, getActiveFeedbackRobotConnection, isRobotConnectionRequiredForFeedbackSource, } from "./feedbackConnectionEligibility";
 import randomHashGenerator from "../helpers/randomHashGenerator";
 import isPhoneApp from "../phone-app-communication/is-phone-app";
@@ -241,7 +242,7 @@ export function createFeedbackRecord(input) {
 export function submitFeedback(input) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var requiresRobotConnection, robotConnection, record, feedbackId, firebaseUpdates, _i, _c, screenshot, firebaseResponse, errorText, slackDelivered, slackResponse, errorText, error_1;
+        var requiresRobotConnection, robotConnection, record, feedbackId, firebaseUpdates, _i, _c, screenshot, firebaseResponse, slackDelivered, slackResponse, error_1;
         var _d;
         return __generator(this, function (_e) {
             switch (_e.label) {
@@ -273,17 +274,14 @@ export function submitFeedback(input) {
                         })];
                 case 1:
                     firebaseResponse = _e.sent();
-                    if (!!firebaseResponse.ok) return [3 /*break*/, 3];
-                    return [4 /*yield*/, firebaseResponse.text()];
-                case 2:
-                    errorText = _e.sent();
-                    Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Firebase: ".concat(firebaseResponse.status, " ").concat(errorText));
-                    throw new Error("Failed to submit feedback");
-                case 3:
+                    if (!firebaseResponse.ok) {
+                        Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Firebase", { status: firebaseResponse.status });
+                        throw new Error("Failed to submit feedback");
+                    }
                     slackDelivered = true;
-                    _e.label = 4;
-                case 4:
-                    _e.trys.push([4, 8, , 9]);
+                    _e.label = 2;
+                case 2:
+                    _e.trys.push([2, 4, , 5]);
                     return [4 /*yield*/, fetch(WEB_APP_FEEDBACK_SLACK_WEBHOOK_URL, {
                             method: "POST",
                             headers: {
@@ -291,20 +289,18 @@ export function submitFeedback(input) {
                             },
                             body: JSON.stringify({ text: record.text }),
                         })];
-                case 5:
+                case 3:
                     slackResponse = _e.sent();
-                    if (!!slackResponse.ok) return [3 /*break*/, 7];
-                    return [4 /*yield*/, slackResponse.text()];
-                case 6:
-                    errorText = _e.sent();
-                    throw new Error("Failed Slack response: ".concat(slackResponse.status, " ").concat(errorText));
-                case 7: return [3 /*break*/, 9];
-                case 8:
+                    if (!slackResponse.ok) {
+                        throw new Error("Failed Slack response with status ".concat(slackResponse.status));
+                    }
+                    return [3 /*break*/, 5];
+                case 4:
                     error_1 = _e.sent();
                     slackDelivered = false;
-                    Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Slack", error_1);
-                    return [3 /*break*/, 9];
-                case 9: return [2 /*return*/, {
+                    Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Slack", getSafeErrorMetadata(error_1));
+                    return [3 /*break*/, 5];
+                case 5: return [2 /*return*/, {
                         record: record,
                         slackDelivered: slackDelivered,
                     }];

package/dist-types/src/utils/warranty-service/warranty-service-utils.js

@@ -35,6 +35,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import Logger from "../../services/logger/Logger";
+import { getSafeErrorMetadata } from "../../services/observability/sanitizeTelemetry";
 import { getOnboardingCookie, isOnboardingCookieExpired } from "./cookies";
 import WarranyFacade from "@robotical/appv2-warranty-service-lib";
 var SHOW_LOGS = true;
@@ -62,7 +63,7 @@ export function shouldShowOnboardingModal(serialNo) {
                 case 3: return [3 /*break*/, 5];
                 case 4:
                     error_1 = _a.sent();
-                    Logger.error(SHOW_LOGS, TAG, "Error checking if should show onboarding modal: " + error_1);
+                    Logger.error(SHOW_LOGS, TAG, "Error checking if onboarding should be shown", getSafeErrorMetadata(error_1));
                     // Don't show the modal if there was an error (probably no internet connection)
                     return [2 /*return*/, false];
                 case 5: return [2 /*return*/, shouldShowModal];
@@ -108,7 +109,7 @@ export function registerUser(email, establishment, serialNumbers) {
                 return [2 /*return*/, WarranyFacade.registerUser(email, establishment, serialNumbers)];
             }
             catch (error) {
-                Logger.error(SHOW_LOGS, TAG, "Error registering user: " + error);
+                Logger.error(SHOW_LOGS, TAG, "Error registering user", getSafeErrorMetadata(error));
                 return [2 /*return*/, false];
             }
             return [2 /*return*/];
@@ -129,7 +130,7 @@ export function isUserRegistered(email) {
                 case 2: return [2 /*return*/, !!(_a.sent())];
                 case 3:
                     error_2 = _a.sent();
-                    Logger.error(SHOW_LOGS, TAG, "Error checking if user is registered: " + error_2);
+                    Logger.error(SHOW_LOGS, TAG, "Error checking if user is registered", getSafeErrorMetadata(error_2));
                     return [2 /*return*/, false];
                 case 4: return [2 /*return*/];
             }
@@ -152,7 +153,7 @@ export function getUserGivenEmail(email) {
                     return [2 /*return*/, user];
                 case 3:
                     error_3 = _a.sent();
-                    Logger.error(SHOW_LOGS, TAG, "Error getting user given email: " + error_3);
+                    Logger.error(SHOW_LOGS, TAG, "Error getting user", getSafeErrorMetadata(error_3));
                     return [2 /*return*/, null];
                 case 4: return [2 /*return*/];
             }
@@ -166,7 +167,7 @@ export var isSerialNumberRegistered = function (serialNo) { return __awaiter(voi
             return [2 /*return*/, WarranyFacade.isSerialNumberRegistered(serialNo)];
         }
         catch (error) {
-            Logger.error(SHOW_LOGS, TAG, "Error checking if serial number is registered: " + error);
+            Logger.error(SHOW_LOGS, TAG, "Error checking if serial number is registered", getSafeErrorMetadata(error));
             return [2 /*return*/, false];
         }
         return [2 /*return*/];
@@ -190,7 +191,7 @@ export var createTicket = function (serialNo, title, description, robotName, rob
             case 4: return [2 /*return*/, false];
             case 5:
                 error_4 = _a.sent();
-                Logger.error(SHOW_LOGS, TAG, "Error creating ticket: " + error_4);
+                Logger.error(SHOW_LOGS, TAG, "Error creating ticket", getSafeErrorMetadata(error_4));
                 return [2 /*return*/, false];
             case 6: return [2 /*return*/];
         }
@@ -211,7 +212,7 @@ export var getEmailGivenSerialNumber = function (serialNo) { return __awaiter(vo
                 return [2 /*return*/, serialNumber === null || serialNumber === void 0 ? void 0 : serialNumber.email];
             case 3:
                 error_5 = _a.sent();
-                Logger.error(SHOW_LOGS, TAG, "Error getting email given serial number: " + error_5);
+                Logger.error(SHOW_LOGS, TAG, "Error getting email for serial number", getSafeErrorMetadata(error_5));
                 return [2 /*return*/, undefined];
             case 4: return [2 /*return*/];
         }
@@ -224,7 +225,7 @@ export var addRobotNameToSerialNumber = function (serialNo, name) { return __awa
             return [2 /*return*/, WarranyFacade.addRobotNameToSerialNumber(serialNo, name)];
         }
         catch (error) {
-            Logger.error(SHOW_LOGS, TAG, "Error adding robot name to serial number: " + error);
+            Logger.error(SHOW_LOGS, TAG, "Error adding robot name to serial number", getSafeErrorMetadata(error));
             return [2 /*return*/, false];
         }
         return [2 /*return*/];