Merge pull request #4164 from mozilla/MNTOR-2908

MNTOR-2899: rework the UTM for guided experience and settings

src/app/(proper_react)/(redesign)/(authenticated)/user/(dashboard)/dashboard/fix/data-broker-profiles/automatic-remove/page.tsx

@@ -21,6 +21,7 @@ import {
   getSubscriptionBillingAmount,
   getPremiumSubscriptionUrl,
 } from "../../../../../../../../../functions/server/getPremiumSubscriptionInfo";
+import { getAttributionsFromCookiesOrDb } from "../../../../../../../../../functions/server/attributions";
 
 const monthlySubscriptionUrl = getPremiumSubscriptionUrl({ type: "monthly" });
 const yearlySubscriptionUrl = getPremiumSubscriptionUrl({ type: "yearly" });
@@ -32,6 +33,10 @@ export default async function AutomaticRemovePage() {
     redirect("/user/dashboard/");
   }
 
+  const additionalSubplatParams = await getAttributionsFromCookiesOrDb(
+    session.user.subscriber.id,
+  );
+
   const profileId = await getOnerepProfileId(session.user.subscriber.id);
   const scanData = await getLatestOnerepScanResults(profileId);
   const subBreaches = await getSubscriberBreaches(session.user);
@@ -50,8 +55,8 @@ export default async function AutomaticRemovePage() {
       subscriberEmails={subscriberEmails}
       nextStep={getNextGuidedStep(data, "Scan")}
       currentSection="data-broker-profiles"
-      monthlySubscriptionUrl={monthlySubscriptionUrl}
-      yearlySubscriptionUrl={yearlySubscriptionUrl}
+      monthlySubscriptionUrl={`${monthlySubscriptionUrl}&${additionalSubplatParams.toString()}`}
+      yearlySubscriptionUrl={`${yearlySubscriptionUrl}&${additionalSubplatParams.toString()}`}
       subscriptionBillingAmount={getSubscriptionBillingAmount()}
     />
   );

src/app/(proper_react)/(redesign)/(authenticated)/user/(dashboard)/dashboard/page.tsx

@@ -2,7 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { headers, cookies } from "next/headers";
+import { headers } from "next/headers";
 import { redirect } from "next/navigation";
 import { getServerSession } from "next-auth";
 import { View } from "./View";
@@ -32,10 +32,7 @@ import {
 import { refreshStoredScanResults } from "../../../../../../functions/server/refreshStoredScanResults";
 import { getEnabledFeatureFlags } from "../../../../../../../db/tables/featureFlags";
 import { parseIso8601Datetime } from "../../../../../../../utils/parse";
-import {
-  addAttributionForSubscriber,
-  getLatestAttributionForSubscriberWithType,
-} from "../../../../../../../db/tables/attributions";
+import { getAttributionsFromCookiesOrDb } from "../../../../../../functions/server/attributions";
 import { getUserId } from "../../../../../../functions/server/getUserId";
 
 export default async function DashboardPage() {
@@ -45,7 +42,6 @@ export default async function DashboardPage() {
   }
 
   const headersList = headers();
-  const cookiesList = cookies();
   const countryCode = getCountryCode(headersList);
 
   const profileId = await getOnerepProfileId(session.user.subscriber.id);
@@ -117,50 +113,10 @@ export default async function DashboardPage() {
   const yearlySubscriptionUrl = getPremiumSubscriptionUrl({ type: "yearly" });
   const fxaSettingsUrl = process.env.FXA_SETTINGS_URL!;
   const profileStats = await getProfilesStats();
-  let additionalSubplatParams = new URLSearchParams(
-    cookiesList.get("attributionsLastTouch")?.value,
+  const additionalSubplatParams = await getAttributionsFromCookiesOrDb(
+    session.user.subscriber.id,
   );
 
-  // store utm attributions if present in cookies
-  if (cookiesList.get("attributionsFirstTouch")?.value) {
-    const searchParams = new URLSearchParams(
-      cookiesList.get("attributionsFirstTouch")?.value,
-    );
-    const attribution = {
-      type: "firstTouch",
-      entrypoint: searchParams.get("entrypoint") ?? "",
-      utm_campaign: searchParams.get("utm_campaign") ?? "",
-      utm_medium: searchParams.get("utm_medium") ?? "",
-      utm_source: searchParams.get("utm_source") ?? "",
-      utm_term: searchParams.get("utm_term") ?? "",
-    };
-    await addAttributionForSubscriber(session.user.subscriber.id, attribution);
-  }
-
-  if (additionalSubplatParams.size > 0) {
-    const attribution = {
-      type: "lastTouch",
-      entrypoint: additionalSubplatParams.get("entrypoint") ?? "",
-      utm_campaign: additionalSubplatParams.get("utm_campaign") ?? "",
-      utm_medium: additionalSubplatParams.get("utm_medium") ?? "",
-      utm_source: additionalSubplatParams.get("utm_source") ?? "",
-      utm_term: additionalSubplatParams.get("utm_term") ?? "",
-    };
-    await addAttributionForSubscriber(session.user.subscriber.id, attribution);
-  } else {
-    // if "attributionsLastTouch" cookie isn't present, try to load the attribution from the db
-    const attributionLastTouch =
-      await getLatestAttributionForSubscriberWithType(
-        session.user.subscriber.id,
-        "lastTouch",
-      );
-    if (attributionLastTouch) {
-      additionalSubplatParams = new URLSearchParams(
-        attributionLastTouch as Record<string, string>,
-      );
-    }
-  }
-
   return (
     <View
       user={session.user}

src/app/(proper_react)/(redesign)/(authenticated)/user/(dashboard)/settings/page.tsx

@@ -15,6 +15,7 @@ import { getUserEmails } from "../../../../../../../db/tables/emailAddresses";
 import { getBreaches } from "../../../../../../functions/server/getBreaches";
 import { getBreachesForEmail } from "../../../../../../../utils/hibp";
 import { getSha1 } from "../../../../../../../utils/fxa";
+import { getAttributionsFromCookiesOrDb } from "../../../../../../functions/server/attributions";
 
 export default async function SettingsPage() {
   const session = await getServerSession(authOptions);
@@ -28,7 +29,9 @@ export default async function SettingsPage() {
   const yearlySubscriptionUrl = getPremiumSubscriptionUrl({ type: "yearly" });
   const fxaSettingsUrl = process.env.FXA_SETTINGS_URL!;
   const fxaSubscriptionsUrl = process.env.FXA_SUBSCRIPTIONS_URL!;
-
+  const additionalSubplatParams = await getAttributionsFromCookiesOrDb(
+    session.user.subscriber.id,
+  );
   const allBreaches = await getBreaches();
   const breachCountByEmailAddress: Record<string, number> = {};
   const emailAddressStrings = emailAddresses.map(
@@ -52,8 +55,8 @@ export default async function SettingsPage() {
       breachCountByEmailAddress={breachCountByEmailAddress}
       fxaSettingsUrl={fxaSettingsUrl}
       fxaSubscriptionsUrl={fxaSubscriptionsUrl}
-      monthlySubscriptionUrl={monthlySubscriptionUrl}
-      yearlySubscriptionUrl={yearlySubscriptionUrl}
+      monthlySubscriptionUrl={`${monthlySubscriptionUrl}&${additionalSubplatParams.toString()}`}
+      yearlySubscriptionUrl={`${yearlySubscriptionUrl}&${additionalSubplatParams.toString()}`}
       subscriptionBillingAmount={getSubscriptionBillingAmount()}
     />
   );

src/app/functions/server/attributions.ts

@@ -0,0 +1,57 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { cookies } from "next/headers";
+import {
+  addAttributionForSubscriber,
+  getLatestAttributionForSubscriberWithType,
+} from "../../../db/tables/attributions";
+
+export async function getAttributionsFromCookiesOrDb(subscriberId: number) {
+  const cookiesList = cookies();
+  let additionalSubplatParams = new URLSearchParams(
+    cookiesList.get("attributionsLastTouch")?.value,
+  );
+
+  // store utm attributions if present in cookies
+  if (cookiesList.get("attributionsFirstTouch")?.value) {
+    const searchParams = new URLSearchParams(
+      cookiesList.get("attributionsFirstTouch")?.value,
+    );
+    const attribution = {
+      type: "firstTouch",
+      entrypoint: searchParams.get("entrypoint") ?? "",
+      utm_campaign: searchParams.get("utm_campaign") ?? "",
+      utm_medium: searchParams.get("utm_medium") ?? "",
+      utm_source: searchParams.get("utm_source") ?? "",
+      utm_term: searchParams.get("utm_term") ?? "",
+    };
+    await addAttributionForSubscriber(subscriberId, attribution);
+  }
+
+  if (additionalSubplatParams.size > 0) {
+    const attribution = {
+      type: "lastTouch",
+      entrypoint: additionalSubplatParams.get("entrypoint") ?? "",
+      utm_campaign: additionalSubplatParams.get("utm_campaign") ?? "",
+      utm_medium: additionalSubplatParams.get("utm_medium") ?? "",
+      utm_source: additionalSubplatParams.get("utm_source") ?? "",
+      utm_term: additionalSubplatParams.get("utm_term") ?? "",
+    };
+    await addAttributionForSubscriber(subscriberId, attribution);
+  } else {
+    // if "attributionsLastTouch" cookie isn't present, try to load the attribution from the db
+    const attributionLastTouch =
+      await getLatestAttributionForSubscriberWithType(
+        subscriberId,
+        "lastTouch",
+      );
+    if (attributionLastTouch) {
+      additionalSubplatParams = new URLSearchParams(
+        attributionLastTouch as Record<string, string>,
+      );
+    }
+  }
+  return additionalSubplatParams;
+}

src/db/tables/attributions.ts

@@ -60,7 +60,10 @@ async function addAttributionForSubscriber(
     res = await knex("attributions").insert(attribution).returning("*");
   } catch (e) {
     if ((e as Error).message.includes("violates unique constraint")) {
-      logger.info("Ignoring unique constraints");
+      logger.info("addAttributionForSubscriber", {
+        subscriberId,
+        error: (e as Error).message,
+      });
     } else {
       logger.error(e);
     }