packages/shared/lib/mail/trackers.ts

   1 import { TidyURL } from '@protontech/tidy-url';
   2
   3 import { captureMessage } from '@proton/shared/lib/helpers/sentry';
   4 import type { MessageUTMTracker } from '@proton/shared/lib/models/mailUtmTrackers';
   5
   6 export const getUTMTrackersFromURL = (originalURL: string) => {
   7     // originalURL can be an mailto: link
   8     try {
   9         // Only parse http(s) URLs
  10         try {
  11             // new URL(originalURL) may crash if the URL is invalid on Safari
  12             const { protocol } = new URL(originalURL);
  13
  14             if (!protocol.includes('http')) {
  15                 return undefined;
  16             }
  17         } catch {
  18             return undefined;
  19         }
  20
  21         /**
  22          * Allow amp links. By default, they are being cleaned but too many links were broken.
  23          * For example:
  24          * - https://something.me/L0/https:%2F%2Fsomething-else.amazonaws.com%randomID
  25          * Was cleaned to:
  26          * - https://something-else.amazonaws.com/randomID
  27          * Which was not working as expected when being opened.
  28          */
  29         TidyURL.config.allowAMP = true;
  30
  31         const { url, info } = TidyURL.clean(originalURL);
  32         /*
  33          If we found removed elements or there is a difference between original link and cleaned link,
  34          we have a tracker that we need to display in the privacy dropdown.
  35          The original URL might also contain uppercase letters in the first part of the URL that will be updated by the library
  36          e.g. https://Proton.me would become https://proton.me, and we don't want it to be detected as a tracker
  37          */
  38         if (originalURL.toLowerCase() !== url.toLowerCase()) {
  39             const utmTracker: MessageUTMTracker = {
  40                 originalURL,
  41                 cleanedURL: url,
  42                 removed: info.removed,
  43             };
  44
  45             return { url, info, utmTracker };
  46         }
  47
  48         return { url: originalURL, info, utmTracker: undefined };
  49     } catch {
  50         captureMessage('Failed to parse URL with trackers');
  51         return undefined;
  52     }
  53 };