Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

code improvements

Pedro Ladeira7ce75e35d1dd
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/tracking/installation-section.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/tracking/installation-section.tsx
index bfad318343..1ff9c46d1e 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/tracking/installation-section.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/tracking/installation-section.tsx
@@ -3,7 +3,7 @@
import useWorkspace from "@/lib/swr/use-workspace";
import { useWorkspaceStore } from "@/lib/swr/use-workspace-store";
import { buildTrackingSetup } from "@/lib/tracking/build-tracking-setup";
-import { useMemo } from "react";
+import { useEffect, useMemo, useRef } from "react";
import { SectionCard } from "./section-card";
import {
DeveloperGuides,
@@ -13,24 +13,46 @@ import {
import { TrackingSettingsRow } from "./tracking-settings-row";
import { VerifyInstall } from "./verify-install";
+const DEFAULT_STACK = ["custom"] as const;
+
export function InstallationSection() {
- const { allowedHostnames, publishableKey } = useWorkspace();
- const [savedStack] = useWorkspaceStore<string[]>(
- "analyticsSettingsSelectedStack",
- );
+ const {
+ allowedHostnames,
+ publishableKey,
+ loading: workspaceLoading,
+ } = useWorkspace();
+ const [savedStack, setSavedStack, { loading: stackLoading }] =
+ useWorkspaceStore<string[]>("analyticsSettingsSelectedStack");
const [siteVisitEnabled] = useWorkspaceStore<boolean>(
"analyticsSettingsSiteVisitTrackingEnabled",
);
const [outboundEnabled] = useWorkspaceStore<boolean>(
"analyticsSettingsOutboundDomainTrackingEnabled",
);
- const [conversionEnabled] = useWorkspaceStore<boolean>(
- "analyticsSettingsConversionTrackingEnabled",
- );
const stack = savedStack ?? [];
const hostnames = allowedHostnames ?? [];
const ready = isSetupInstructionsReady(stack, hostnames.length > 0);
+ const seedingRef = useRef(false);
+
+ useEffect(() => {
+ if (workspaceLoading || stackLoading || seedingRef.current) {
+ return;
+ }
+
+ if (savedStack !== undefined || hostnames.length === 0) {
+ return;
+ }
+
+ seedingRef.current = true;
+ void setSavedStack([...DEFAULT_STACK]);
+ }, [
+ workspaceLoading,
+ stackLoading,
+ savedStack,
+ hostnames.length,
+ setSavedStack,
+ ]);
const setup = useMemo(
() =>
@@ -40,16 +62,8 @@ export function InstallationSection() {
publishableKey: publishableKey ?? null,
siteVisitEnabled: Boolean(siteVisitEnabled),
outboundEnabled: Boolean(outboundEnabled),
- conversionEnabled: Boolean(conversionEnabled),
}),
- [
- stack,
- hostnames,
- publishableKey,
- siteVisitEnabled,
- outboundEnabled,
- conversionEnabled,
- ],
+ [stack, hostnames, publishableKey, siteVisitEnabled, outboundEnabled],
);
return (
diff --git a/apps/web/lib/tracking/build-tracking-setup.ts b/apps/web/lib/tracking/build-tracking-setup.ts
index 8afc63cf59..a9e0c08b12 100644
--- a/apps/web/lib/tracking/build-tracking-setup.ts
+++ b/apps/web/lib/tracking/build-tracking-setup.ts
@@ -26,6 +26,15 @@ const FALLBACK_CLIENT_STEP = {
const ANALYTICS_SCRIPT_BASE = "https://www.dubcdn.com/analytics/script.js";
+const REACT_PACKAGE_LINE =
+ "Use the @dub/analytics package with this workspace's publishable key. Do not add the Dub script tag unless a guide says to.";
+
+const KEY_PRESENT_FOOTER =
+ "Use the workspace values above. Do not invent a different publishable key or hostname.";
+
+const KEY_MISSING_FOOTER =
+ "Generate a publishable key in Tracking settings before tracking conversion events. Do not invent a key.";
+
export type TrackingSetupStep = {
type: IntegrationType;
typeLabel: string;
@@ -43,7 +52,6 @@ export type BuildTrackingSetupInput = {
publishableKey: string | null;
siteVisitEnabled: boolean;
outboundEnabled: boolean;
- conversionEnabled: boolean;
};
export type TrackingSetup = {
@@ -122,18 +130,24 @@ export function resolveTrackingSetupSteps(
return steps;
}
+export function isReactOnlyClientStep(steps: TrackingSetupStep[]) {
+ const clientSteps = steps.filter((step) => step.type === "client-sdk");
+
+ return clientSteps.length === 1 && clientSteps[0]?.guideKey === "react";
+}
+
export function getAnalyticsScriptUrl({
siteVisitEnabled,
outboundEnabled,
- conversionEnabled,
+ publishableKey,
}: Pick<
BuildTrackingSetupInput,
- "siteVisitEnabled" | "outboundEnabled" | "conversionEnabled"
+ "siteVisitEnabled" | "outboundEnabled" | "publishableKey"
>) {
const segments = [
siteVisitEnabled ? "site-visit" : null,
outboundEnabled ? "outbound-domains" : null,
- conversionEnabled ? "conversion-tracking" : null,
+ publishableKey ? "conversion-tracking" : null,
].filter(Boolean);
if (segments.length === 0) {
@@ -149,20 +163,22 @@ export function composeTrackingSetupPrompt({
publishableKey,
siteVisitEnabled,
outboundEnabled,
- conversionEnabled,
}: {
steps: TrackingSetupStep[];
} & Omit<BuildTrackingSetupInput, "stack">) {
+ const reactOnlyClient = isReactOnlyClientStep(steps);
const workspaceLines = [
hostnames.length > 0 ? `- Hostnames: ${hostnames.join(", ")}` : null,
publishableKey
? `- Publishable key (client-side): ${publishableKey}`
: null,
- `- Analytics script: ${getAnalyticsScriptUrl({
- siteVisitEnabled,
- outboundEnabled,
- conversionEnabled,
- })}`,
+ reactOnlyClient
+ ? null
+ : `- Analytics script: ${getAnalyticsScriptUrl({
+ siteVisitEnabled,
+ outboundEnabled,
+ publishableKey,
+ })}`,
].filter(Boolean);
const hasDuplicateTypes = STEP_TYPES.some(
@@ -181,6 +197,7 @@ export function composeTrackingSetupPrompt({
"",
"Workspace:",
...workspaceLines,
+ ...(reactOnlyClient ? ["", REACT_PACKAGE_LINE] : []),
"",
"Implement these steps in order:",
...stepLines,
@@ -191,7 +208,7 @@ export function composeTrackingSetupPrompt({
]
: []),
"",
- "Use the workspace values above. Do not invent a different publishable key or hostname.",
+ publishableKey ? KEY_PRESENT_FOOTER : KEY_MISSING_FOOTER,
].join("\n");
}
@@ -208,7 +225,6 @@ export function buildTrackingSetup(
publishableKey: input.publishableKey,
siteVisitEnabled: input.siteVisitEnabled,
outboundEnabled: input.outboundEnabled,
- conversionEnabled: input.conversionEnabled,
}),
};
}