Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Amplitude] Page view and session tracking client side #4232

Merged
merged 2 commits into from
Mar 11, 2024
Merged

[Amplitude] Page view and session tracking client side #4232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1da3c87
[Amplitude] Page view and session tracking client side
lasryaric Mar 9, 2024
229ef55
Revert vscode settings
lasryaric Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions front/components/sparkle/AppLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import type {
} from "@app/components/sparkle/navigation";
import { topNavigation } from "@app/components/sparkle/navigation";
import WorkspacePicker from "@app/components/WorkspacePicker";
import { getBrowserClient } from "@app/lib/amplitude/browser";
import { useUser } from "@app/lib/swr";
import { classNames } from "@app/lib/utils";

Expand Down Expand Up @@ -243,11 +244,24 @@ export default function AppLayout({
}) {
const { sidebarOpen, setSidebarOpen } = useContext(SidebarContext);
const [loaded, setLoaded] = useState(false);
const router = useRouter();
const user = useUser();

useEffect(() => {
setLoaded(true);
}, []);

useEffect(() => {
const amplitude = getBrowserClient();
if (user?.user?.id) {
const userId = `user-${user?.user?.id}`;
amplitude.identify(userId);
amplitude.pageViewed({
pathname: router.pathname,
});
}
}, [router.pathname, user?.user?.id]);

return (
<>
<Head>
Expand Down
2 changes: 1 addition & 1 deletion front/lib/amplitude/browser/ampli.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
"Language": "TypeScript",
"SDK": "@amplitude/analytics-browser@^1.0",
"Path": "./generated"
}
}
85 changes: 54 additions & 31 deletions front/lib/amplitude/browser/generated/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,57 +17,49 @@
* [Full Setup Instructions](https://data.amplitude.com/dust-tt/dust-prod/implementation/dust-browser-prod)
*/

import * as amplitude from "@amplitude/analytics-browser";
import * as amplitude from '@amplitude/analytics-browser';

export type Environment = "dustprod";
export type Environment = 'dustprod';

export const ApiKey: Record<Environment, string> = {
dustprod: "940c526d7c7c91a38c267be75c958890",
dustprod: '940c526d7c7c91a38c267be75c958890'
};

/**
* Default Amplitude configuration options. Contains tracking plan information.
*/
export const DefaultConfiguration: BrowserOptions = {
plan: {
version: "2",
branch: "main",
source: "dust-browser-prod",
versionId: "4e855190-0d49-4fdc-a164-e1e974880832",
version: '2',
branch: 'main',
source: 'dust-browser-prod',
versionId: '4e855190-0d49-4fdc-a164-e1e974880832'
},
...{
ingestionMetadata: {
sourceName: "browser-typescript-ampli",
sourceVersion: "2.0.0",
},
},
sourceName: 'browser-typescript-ampli',
sourceVersion: '2.0.0'
}
}
};

export interface LoadOptionsBase {
disabled?: boolean;
}
export interface LoadOptionsBase { disabled?: boolean }

export type LoadOptionsWithEnvironment = LoadOptionsBase & {
environment: Environment;
client?: { configuration?: BrowserOptions };
};
export type LoadOptionsWithApiKey = LoadOptionsBase & {
client: { apiKey: string; configuration?: BrowserOptions };
};
export type LoadOptionsWithClientInstance = LoadOptionsBase & {
client: { instance: BrowserClient };
};
export type LoadOptionsWithEnvironment = LoadOptionsBase & { environment: Environment; client?: { configuration?: BrowserOptions; }; };
export type LoadOptionsWithApiKey = LoadOptionsBase & { client: { apiKey: string; configuration?: BrowserOptions; } };
export type LoadOptionsWithClientInstance = LoadOptionsBase & { client: { instance: BrowserClient; } };

export type LoadOptions =
| LoadOptionsWithEnvironment
| LoadOptionsWithApiKey
| LoadOptionsWithClientInstance;
export type LoadOptions = LoadOptionsWithEnvironment | LoadOptionsWithApiKey | LoadOptionsWithClientInstance;

export interface IdentifyProperties {
email?: string;
SignupDate?: string;
}

export interface PageViewedProperties {
pathname: string;
}

export interface QuickGuideViewedProperties {
/**
* | Rule | Value |
Expand All @@ -82,15 +74,29 @@ export interface QuickGuideViewedProperties {
export class Identify implements BaseEvent {
event_type = amplitude.Types.SpecialEventType.IDENTIFY;

constructor(public event_properties?: IdentifyProperties) {
constructor(
public event_properties?: IdentifyProperties,
) {
this.event_properties = event_properties;
}
}

export class PageViewed implements BaseEvent {
event_type = 'PageViewed';

constructor(
public event_properties: PageViewedProperties,
) {
this.event_properties = event_properties;
}
}

export class QuickGuideViewed implements BaseEvent {
event_type = "QuickGuideViewed";
event_type = 'QuickGuideViewed';

constructor(public event_properties: QuickGuideViewedProperties) {
constructor(
public event_properties: QuickGuideViewedProperties,
) {
this.event_properties = event_properties;
}
}
Expand Down Expand Up @@ -212,6 +218,23 @@ export class Ampli {
return this.amplitude!.track(event, undefined, options);
}

/**
* PageViewed
*
* [View in Tracking Plan](https://data.amplitude.com/dust-tt/dust-prod/events/main/latest/PageViewed)
*
* Event has no description in tracking plan.
*
* @param properties The event's properties (e.g. pathname)
* @param options Amplitude event options.
*/
pageViewed(
properties: PageViewedProperties,
options?: EventOptions,
) {
return this.track(new PageViewed(properties), options);
}

/**
* QuickGuideViewed
*
Expand Down
8 changes: 7 additions & 1 deletion front/lib/amplitude/browser/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ export function getBrowserClient() {
client: {
apiKey: AMPLITUDE_PUBLIC_API_KEY,
configuration: {
defaultTracking: false,
defaultTracking: {
attribution: true,
fileDownloads: false,
formInteractions: true,
pageViews: false,
sessions: true,
},
},
},
});
Expand Down
Loading