@newtonschool/react_proctoring_library 0.0.132 → 0.0.133-beta.0

package/dist/components/secondaryDevice/index.js

@@ -10,6 +10,7 @@ var _proctoringStatusUtils = require("../../utils/proctoringStatusUtils");
 var _permission = require("../../utils/permission");
 var _breachUtils = require("../../utils/breachUtils");
 var _usePageActivity = _interopRequireDefault(require("../../hooks/usePageActivity"));
+var _proctoringDebugUtils = require("../../utils/proctoringDebugUtils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const SecondaryDevice = _ref => {
   let {
@@ -27,10 +28,36 @@ const SecondaryDevice = _ref => {
   const [secondaryDeviceOnline, setSecondaryDeviceOnline] = (0, _react.useState)(true);
   const [secondaryDeviceAllPermissionGranted, setSecondaryDeviceAllPermissionGranted] = (0, _react.useState)(true);
   const {
-    isActive: isCurrentDeviceActive
+    isActive: isCurrentDeviceActive,
+    isVisible,
+    isFocused,
+    isLifecycleActive
   } = (0, _usePageActivity.default)();
   const allPermissionGranted = (0, _permission.hasAllPermissions)((0, _breachUtils.getRequiredPermissionsFromProctorParams)(proctorParams), permissions);
   const effectiveAllPermissionGranted = allPermissionGranted && isCurrentDeviceActive;
+  (0, _react.useEffect)(() => {
+    if (!isSecondaryDevice) {
+      return;
+    }
+    (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_session_started', {
+      deviceType: 'secondary',
+      userUuid: (firebaseClient === null || firebaseClient === void 0 ? void 0 : firebaseClient.userUuid) || null,
+      requiredPermissions: (0, _breachUtils.getRequiredPermissionsFromProctorParams)(proctorParams),
+      userAgent: typeof navigator !== 'undefined' ? navigator.userAgent : 'unknown'
+    }, firebaseClient);
+  }, [firebaseClient === null || firebaseClient === void 0 ? void 0 : firebaseClient.userUuid, isSecondaryDevice, proctorParams]);
+  (0, _react.useEffect)(() => {
+    if (!isSecondaryDevice) {
+      return;
+    }
+    (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_page_activity_state_changed', {
+      deviceType: 'secondary',
+      isVisible,
+      isFocused,
+      isLifecycleActive,
+      isActive: isCurrentDeviceActive
+    }, firebaseClient);
+  }, [firebaseClient, isCurrentDeviceActive, isFocused, isLifecycleActive, isSecondaryDevice, isVisible]);
   (0, _react.useEffect)(() => {
     const cleanup = (0, _proctoringStatusUtils.setupDeviceStatusListeners)({
       firebaseClient,

package/dist/components/webcam-activity-tracker/web.js

@@ -20,6 +20,7 @@ var _webcamMicrophoneUtils = require("../../utils/webcamMicrophoneUtils");
 var _dom = require("../../constants/dom");
 var _useBreachData = require("../../hooks/useBreachData");
 var _proctoringStatusUtils = require("../../utils/proctoringStatusUtils");
+var _proctoringDebugUtils = require("../../utils/proctoringDebugUtils");
 var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
@@ -46,6 +47,7 @@ const WebWebCam = _ref => {
     references,
     permissions
   } = (0, _react.useContext)(proctoredContext);
+  const deviceType = isSecondaryDevice ? 'secondary' : 'primary';
   const recurringFetchIntervalRef = (0, _react.useRef)(null);
   const {
     recurring = false,
@@ -108,6 +110,13 @@ const WebWebCam = _ref => {
       screenshotFormat: "image/jpeg",
       ref: webcamReference,
       onUserMedia: () => {
+        if (isSecondaryDevice) {
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_webcam_user_media_succeeded', {
+            deviceType,
+            retryCount,
+            userUuid: (firebaseClient === null || firebaseClient === void 0 ? void 0 : firebaseClient.userUuid) || null
+          }, firebaseClient);
+        }
         setVideoPermission(true);
         if (firebaseClient) {
           if (isSecondaryDevice) {
@@ -118,6 +127,17 @@ const WebWebCam = _ref => {
         }
       },
       onUserMediaError: err => {
+        if (isSecondaryDevice) {
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_webcam_user_media_failed', {
+            deviceType,
+            retryCount,
+            userUuid: (firebaseClient === null || firebaseClient === void 0 ? void 0 : firebaseClient.userUuid) || null,
+            error: {
+              name: (err === null || err === void 0 ? void 0 : err.name) || null,
+              message: (err === null || err === void 0 ? void 0 : err.message) || String(err)
+            }
+          }, firebaseClient);
+        }
         logger("Retry Count = ".concat(retryCount, " | Webcam error, onUserMediaError | ").concat(err.toString()));
         if (retryCount === 0) {
           setVideoPermission(false);

package/dist/utils/proctoringDebugUtils.js

@@ -0,0 +1,92 @@
+"use strict";
+
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.emitProctoringDebugLog = void 0;
+require("core-js/modules/es.json.stringify.js");
+require("core-js/modules/es.promise.js");
+var _defaults = require("../constants/defaults");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+const DEBUG_LOG_PREFIX = '::[secondary-device-debug]';
+const WEB_REPORT_LOG_ENDPOINT = '/api/v1/user/report/web/';
+const safeJsonStringify = value => {
+  try {
+    return JSON.stringify(value);
+  } catch (error) {
+    return JSON.stringify({
+      ts: Date.now(),
+      serializationError: (error === null || error === void 0 ? void 0 : error.message) || String(error)
+    });
+  }
+};
+const postDebugMessage = message => {
+  if (typeof window === 'undefined') {
+    return;
+  }
+  try {
+    if (typeof navigator !== 'undefined' && typeof navigator.sendBeacon === 'function') {
+      const body = new Blob([safeJsonStringify({
+        message
+      })], {
+        type: 'application/json'
+      });
+      navigator.sendBeacon(WEB_REPORT_LOG_ENDPOINT, body);
+    } else if (typeof fetch === 'function') {
+      fetch(WEB_REPORT_LOG_ENDPOINT, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: safeJsonStringify({
+          message
+        }),
+        keepalive: true
+      }).catch(() => {});
+    }
+  } catch (_) {}
+};
+const isDebugLogEnabled = async firebaseClient => {
+  if (!(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.userUuid) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.myFirebaseDB) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.getRef) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.getValue)) {
+    return false;
+  }
+  const {
+    getRef: ref,
+    getValue
+  } = firebaseClient;
+  const debugEnabledRef = ref(firebaseClient.myFirebaseDB, "".concat(_defaults.PROCTORING_STATUS_PATH, "/").concat(firebaseClient.userUuid, "/isDebugEnabled"));
+  try {
+    return await new Promise(resolve => {
+      getValue(debugEnabledRef, snapshot => {
+        var _snapshot$val, _snapshot$val2;
+        const value = (_snapshot$val = snapshot === null || snapshot === void 0 ? void 0 : (_snapshot$val2 = snapshot.val) === null || _snapshot$val2 === void 0 ? void 0 : _snapshot$val2.call(snapshot)) !== null && _snapshot$val !== void 0 ? _snapshot$val : snapshot;
+        resolve(Boolean(value));
+      }, () => resolve(false), {
+        onlyOnce: true
+      });
+    });
+  } catch (_) {
+    return false;
+  }
+};
+const emitProctoringDebugLog = exports.emitProctoringDebugLog = function emitProctoringDebugLog(event) {
+  let payload = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  let firebaseClient = arguments.length > 2 ? arguments[2] : undefined;
+  const message = "".concat(DEBUG_LOG_PREFIX, " ").concat(event, " ").concat(safeJsonStringify(_objectSpread({
+    ts: Date.now()
+  }, payload)));
+  isDebugLogEnabled(firebaseClient).then(enabled => {
+    if (!enabled) {
+      return;
+    }
+    postDebugMessage(message);
+  });
+};

package/dist/utils/proctoringStatusUtils.js

@@ -5,8 +5,28 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.updateCurrentDeviceStatus = exports.setupDeviceStatusListeners = exports.setSecondaryDeviceConnected = exports.setPrimaryDeviceConnected = void 0;
 var _defaults = require("../constants/defaults");
+var _proctoringDebugUtils = require("./proctoringDebugUtils");
 const HEARTBEAT_INTERVAL_MS = 5000;
 const OTHER_DEVICE_HEARTBEAT_TIMEOUT_MS = 15000;
+const getErrorPayload = error => ({
+  name: (error === null || error === void 0 ? void 0 : error.name) || null,
+  message: (error === null || error === void 0 ? void 0 : error.message) || String(error)
+});
+const getObservedStatusPayload = function getObservedStatusPayload(status) {
+  let now = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : Date.now();
+  return {
+    connected: Boolean(status === null || status === void 0 ? void 0 : status.connected),
+    allPermissionGranted: typeof (status === null || status === void 0 ? void 0 : status.allPermissionGranted) === 'boolean' ? status.allPermissionGranted : null,
+    lastHeartbeatAt: typeof (status === null || status === void 0 ? void 0 : status.lastHeartbeatAt) === 'number' ? status.lastHeartbeatAt : null,
+    heartbeatAgeMs: typeof (status === null || status === void 0 ? void 0 : status.lastHeartbeatAt) === 'number' ? now - status.lastHeartbeatAt : null,
+    deviceId: (status === null || status === void 0 ? void 0 : status.deviceId) || null
+  };
+};
+const hasRelevantObservedChange = (previousStatus, nextStatus) => {
+  const previous = getObservedStatusPayload(previousStatus);
+  const next = getObservedStatusPayload(nextStatus);
+  return previous.connected !== next.connected || previous.allPermissionGranted !== next.allPermissionGranted || previous.deviceId !== next.deviceId;
+};
 
 /**
  * Marks the primary device as connected in Firebase. Call when desktop webcam
@@ -27,7 +47,7 @@ const setPrimaryDeviceConnected = firebaseClient => {
   const payload = {
     connected: true
   };
-  return update(primaryDeviceRef, payload).catch(error => {
+  return update(primaryDeviceRef, payload).then(() => {}).catch(error => {
     console.error('::[proctoringStatusUtils] Failed to set primary device status online:', error);
   });
 };
@@ -52,7 +72,13 @@ const setSecondaryDeviceConnected = firebaseClient => {
   const payload = {
     connected: true
   };
-  return update(secondaryDeviceRef, payload).catch(error => {
+  return update(secondaryDeviceRef, payload).then(() => {}).catch(error => {
+    (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_write_failed', {
+      deviceType: 'secondary',
+      userUuid: firebaseClient.userUuid,
+      payload,
+      error: getErrorPayload(error)
+    }, firebaseClient);
     console.error('::[proctoringStatusUtils] Failed to set secondary device status online:', error);
   });
 };
@@ -86,7 +112,16 @@ const updateCurrentDeviceStatus = _ref => {
   const payload = {
     allPermissionGranted
   };
-  return update(deviceStatusRef, payload).catch(error => {
+  return update(deviceStatusRef, payload).then(() => {}).catch(error => {
+    if (!isSecondaryDevice) {
+      return;
+    }
+    (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_write_failed', {
+      deviceType: 'secondary',
+      userUuid: firebaseClient.userUuid,
+      payload,
+      error: getErrorPayload(error)
+    }, firebaseClient);
     console.error('::[proctoringStatusUtils] Failed to update current device status:', error);
   });
 };
@@ -123,6 +158,7 @@ const setupDeviceStatusListeners = _ref2 => {
     onDisconnect,
     getValue: onValue
   } = firebaseClient || {};
+  const deviceType = isSecondaryDevice ? 'secondary' : 'primary';
   if (!userUuid || !firestoreAuthStatus || !ref || !set || !onDisconnect || !onValue) {
     return () => {};
   }
@@ -136,28 +172,52 @@ const setupDeviceStatusListeners = _ref2 => {
   // When this client disconnects (tab close, network loss)
   onDisconnect(currentDeviceStatusRef).update({
     connected: false
-  }).catch(err => {
+  }).then(() => {}).catch(err => {
+    if (!isSecondaryDevice) {
+      return;
+    }
+    (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_write_failed', {
+      deviceType,
+      userUuid,
+      payload: {
+        connected: false,
+        source: 'onDisconnect'
+      },
+      error: getErrorPayload(err)
+    }, firebaseClient);
     console.error('::[proctoringStatusUtils] Failed to mark current device disconnected:', err);
   });
 
   // Get initial values and update callbacks immediately
-  const applyPrimarySnapshot = snapshot => {
+  const applyPrimarySnapshot = function applyPrimarySnapshot(snapshot) {
     var _snapshot$val, _snapshot$val2;
+    let source = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'subscription';
+    const previousValue = latestPrimaryDeviceStatus;
     const val = (_snapshot$val = snapshot === null || snapshot === void 0 ? void 0 : (_snapshot$val2 = snapshot.val) === null || _snapshot$val2 === void 0 ? void 0 : _snapshot$val2.call(snapshot)) !== null && _snapshot$val !== void 0 ? _snapshot$val : snapshot;
     latestPrimaryDeviceStatus = val;
     onPrimaryDeviceStatusChange(Boolean(val === null || val === void 0 ? void 0 : val.connected));
   };
-  const applySecondarySnapshot = snapshot => {
+  const applySecondarySnapshot = function applySecondarySnapshot(snapshot) {
     var _snapshot$val3, _snapshot$val4;
+    let source = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'subscription';
+    const previousValue = latestSecondaryDeviceStatus;
     const val = (_snapshot$val3 = snapshot === null || snapshot === void 0 ? void 0 : (_snapshot$val4 = snapshot.val) === null || _snapshot$val4 === void 0 ? void 0 : _snapshot$val4.call(snapshot)) !== null && _snapshot$val3 !== void 0 ? _snapshot$val3 : snapshot;
     latestSecondaryDeviceStatus = val;
+    if (isSecondaryDevice && (source === 'initial_get' || hasRelevantObservedChange(previousValue, val))) {
+      (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_observed', {
+        deviceType,
+        observedDeviceType: 'secondary',
+        source,
+        observedStatus: getObservedStatusPayload(val)
+      }, firebaseClient);
+    }
     onSecondaryDeviceStatusChange(Boolean(val === null || val === void 0 ? void 0 : val.connected), val === null || val === void 0 ? void 0 : val.allPermissionGranted);
   };
   if (typeof (primaryDeviceStatusRef === null || primaryDeviceStatusRef === void 0 ? void 0 : primaryDeviceStatusRef.get) === 'function') {
-    primaryDeviceStatusRef.get().then(applyPrimarySnapshot).catch(() => {});
+    primaryDeviceStatusRef.get().then(snapshot => applyPrimarySnapshot(snapshot, 'initial_get')).catch(() => {});
   }
   if (typeof (secondaryDeviceStatusRef === null || secondaryDeviceStatusRef === void 0 ? void 0 : secondaryDeviceStatusRef.get) === 'function') {
-    secondaryDeviceStatusRef.get().then(applySecondarySnapshot).catch(() => {});
+    secondaryDeviceStatusRef.get().then(snapshot => applySecondarySnapshot(snapshot, 'initial_get')).catch(() => {});
   }
 
   // Subscribe to updates
@@ -177,14 +237,48 @@ const setupDeviceStatusListeners = _ref2 => {
         update(currentDeviceStatusRef, {
           connected: true,
           lastHeartbeatAt: now
-        }).catch(error => {
+        }).then(() => {}).catch(error => {
+          if (!isSecondaryDevice) {
+            return;
+          }
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_heartbeat_write_failed', {
+            deviceType,
+            userUuid,
+            isCurrentDeviceActive,
+            now,
+            isSecondaryDevice,
+            error: getErrorPayload(error)
+          }, firebaseClient);
           console.error('::[proctoringStatusUtils] Failed to send heartbeat for current device:', error);
         });
       }
       if (!isCurrentDeviceActive) {
         update(currentDeviceStatusRef, {
           connected: false
+        }).then(() => {
+          if (!isSecondaryDevice) {
+            return;
+          }
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_current_device_marked_inactive', {
+            deviceType,
+            userUuid,
+            now,
+            isSecondaryDevice
+          }, firebaseClient);
         }).catch(error => {
+          if (!isSecondaryDevice) {
+            return;
+          }
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_write_failed', {
+            deviceType,
+            userUuid,
+            now,
+            payload: {
+              connected: false,
+              source: 'inactive_page_state'
+            },
+            error: getErrorPayload(error)
+          }, firebaseClient);
           console.error('::[proctoringStatusUtils] Failed to mark current device inactive:', error);
         });
       }
@@ -196,7 +290,23 @@ const setupDeviceStatusListeners = _ref2 => {
       if (isConnected && typeof lastBeat === 'number' && now - lastBeat > OTHER_DEVICE_HEARTBEAT_TIMEOUT_MS) {
         update(otherDeviceStatusRef, {
           connected: false
-        }).catch(otherErr => {
+        }).then(() => {}).catch(otherErr => {
+          const isMarkingSecondaryDeviceStale = !isSecondaryDevice;
+          if (!isMarkingSecondaryDeviceStale) {
+            return;
+          }
+          (0, _proctoringDebugUtils.emitProctoringDebugLog)('secondary_device_status_write_failed', {
+            deviceType: 'secondary',
+            userUuid,
+            now,
+            payload: {
+              connected: false,
+              source: 'stale_other_device',
+              otherDeviceType: 'secondary',
+              otherDeviceStatus: getObservedStatusPayload(otherDeviceStatus, now)
+            },
+            error: getErrorPayload(otherErr)
+          }, firebaseClient);
           console.error('::[proctoringStatusUtils] Failed to mark other device disconnected due to stale heartbeat:', otherErr);
         });
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newtonschool/react_proctoring_library",
-  "version": "0.0.132",
+  "version": "0.0.133-beta.0",
   "description": "Used to proctor online tests",
   "author": "ayushkagrawal,shreyachandra,weastel",
   "main": "dist/index.js",