All files / src/hooks/common useFingerprint.ts

19.04% Statements 8/42
7.14% Branches 2/28
25% Functions 2/8
19.51% Lines 8/41

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220                                                                                                                                  126x 126x       126x   11x       11x     11x   11x                                                                   126x                                                                                                                                                                                                                
import { getFingerprint, setOption } from "@thumbmarkjs/thumbmarkjs";
import { useEffect, useState } from "react";
import * as Sentry from "@sentry/react";
 
type FingerprintData = {
  audio: {
    sampleHash: number;
    oscillator: string;
    maxChannels: number;
    channelCountMode: string;
  };
  canvas: { commonImageDataHash: string };
  fonts: any;
  hardware: {
    videocard: {
      vendor: string;
      renderer: string;
      version: string;
      shadingLanguageVersion: string;
    };
    architecture: number;
    deviceMemory: string;
    jsHeapSizeLimit: number;
  };
  locales: { languages: string; timezone: string };
  permissions: any;
  plugins: any;
  screen: {
    is_touchscreen: boolean;
    maxTouchPoints: number;
    colorDepth: number;
    mediaMatches: string[];
  };
  system: {
    platform: string;
    cookieEnabled: boolean;
    productSub: string;
    product: string;
    useragent: string;
    hardwareConcurrency: number;
    browser: { name: string; version: string };
    applePayVersion?: number;
  };
  webgl: { commonImageHash: string };
  math: {
    acos: number;
    asin: number;
    atan: number;
    cos: number;
    cosh: number;
    e: number;
    largeCos: number;
    largeSin: number;
    largeTan: number;
    log: number;
    pi: number;
    sin: number;
    sinh: number;
    sqrt: number;
    tan: number;
    tanh: number;
  };
};
 
export function useFingerprint() {
  const [fingerprint, setFingerprint] = useState("");
  const [fingerprintData, setFingerprintData] = useState<
    FingerprintData | undefined
  >(undefined);
 
  useEffect(() => {
    // Wrap in try-catch to handle any synchronous errors
    try {
      // permissions: checking seems to cause issues especially on mobile devices, its better to exclude for better accuracy
      // canvas: throws SecurityError due to CORS tainting from cross-origin images
      // We still have sufficient uniqueness from audio, webgl, hardware, fonts, screen, system, and math fingerprinting
      setOption("exclude", ["permissions", "canvas"]);
 
      // Use a promise wrapper to ensure errors are always caught
      const fingerprintPromise = getFingerprint(true);
 
      Iif (fingerprintPromise && typeof fingerprintPromise.then === "function") {
        fingerprintPromise
          .then((result) => {
            if (result?.hash) {
              setFingerprint(result.hash);
              setFingerprintData(result.data as FingerprintData);
            }
          })
          .catch((error) => {
            // Handle fingerprint errors gracefully
            // Log to Sentry for monitoring browser compatibility issues
            const errorInfo = getErrorInfo(error);
            logFingerprintError(error, "fingerprint_fetch_error", {
              type: "fingerprint_library_error",
              errorName: errorInfo.name,
              errorMessage: errorInfo.message,
              browser: navigator.userAgent,
              url: window.location.href,
            });
          });
      }
    } catch (error) {
      // Handle any synchronous errors from setOption or getFingerprint
      const errorInfo = getErrorInfo(error);
      logFingerprintError(error, "fingerprint_init_error", {
        type: "synchronous_initialization_error",
        errorName: errorInfo.name,
        errorMessage: errorInfo.message,
        browser: navigator.userAgent,
        url: window.location.href,
      });
    }
  }, []);
 
  return { fingerprint, fingerprintData };
}
 
/**
 * Determines if an error is an OperationError (browser storage limitation)
 */
function isOperationError(error: unknown): boolean {
  if (!error || typeof error !== "object") return false;
 
  const errorObj = error as Record<string, unknown>;
  return (
    errorObj.name === "OperationError" ||
    errorObj.constructor?.name === "OperationError" ||
    (typeof errorObj.message === "string" &&
      errorObj.message.includes("OperationError"))
  );
}
 
/**
 * Extracts error information for logging
 */
function getErrorInfo(error: unknown): {
  name: string;
  message: string;
  isErrorInstance: boolean;
} {
  if (error instanceof Error) {
    return {
      name: error.name,
      message: error.message,
      isErrorInstance: true,
    };
  }
 
  const errorObj = error as Record<string, unknown> | null;
  return {
    name: errorObj?.name ? String(errorObj.name) : "Unknown",
    message: errorObj?.message ? String(errorObj.message) : String(error),
    isErrorInstance: false,
  };
}
 
type ErrorContext = {
  type: string;
  errorName?: string;
  errorMessage?: string;
  browser: string;
  url: string;
  message?: string;
};
 
/**
 * Logs fingerprint errors to Sentry with appropriate context
 */
function logFingerprintError(
  error: unknown,
  errorType: "fingerprint_fetch_error" | "fingerprint_init_error",
  context: ErrorContext,
): void {
  const errorInfo = getErrorInfo(error);
  const isOpError = isOperationError(error);
 
  Sentry.withScope((scope) => {
    scope.setTag("error_type", errorType);
    scope.setTag("component", "useFingerprint");
 
    if (errorType === "fingerprint_fetch_error") {
      scope.setTag("browserStorageError", true);
 
      // Set level based on error type
      if (isOpError) {
        // OperationError is a browser limitation, log at info level
        scope.setLevel("info");
        scope.setContext("fingerprint_error", {
          ...context,
          type: "browser_storage_limitation",
          message: "IndexedDB storage unavailable or corrupted",
        });
      } else {
        // Other fingerprint errors - log at warning level
        scope.setLevel("warning");
        scope.setContext("fingerprint_error", {
          ...context,
          type: "fingerprint_library_error",
        });
      }
    } else {
      // Synchronous initialization errors
      scope.setLevel("warning");
      scope.setContext("fingerprint_error", context);
    }
 
    // Capture the error
    if (errorInfo.isErrorInstance) {
      Sentry.captureException(error as Error);
    } else {
      const errorMessage =
        errorType === "fingerprint_fetch_error"
          ? `Fingerprint fetch failed: ${errorInfo.message}`
          : `Fingerprint initialization failed: ${errorInfo.message}`;
      Sentry.captureException(new Error(errorMessage));
    }
  });
}