This commit is contained in:
commit
ee35c10454
2 files changed
+163
-14
No files matched your search
@@ -1,11 +1,13 @@
|
||||
'use client';
|
||||
|
||||
import { useEffect } from 'react';
|
||||
import { useEffect, useRef } from 'react';
|
||||
import { usePathname } from 'next/navigation';
|
||||
|
||||
declare global {
|
||||
interface Window {
|
||||
dataLayer?: any[];
|
||||
clarity?: any;
|
||||
gtag?: (...args: any[]) => void;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,12 +18,46 @@ interface AnalyticsDeferredProps {
|
||||
}
|
||||
|
||||
export default function AnalyticsDeferred({ gtmId, gaId, clarityId }: AnalyticsDeferredProps) {
|
||||
const pathname = usePathname();
|
||||
const loadedRef = useRef(false);
|
||||
const initialPathRef = useRef<string | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
if (!initialPathRef.current && pathname) {
|
||||
initialPathRef.current = pathname;
|
||||
}
|
||||
}, [pathname]);
|
||||
|
||||
// Track client-side page views on Next.js route transitions
|
||||
useEffect(() => {
|
||||
if (!pathname || !loadedRef.current) return;
|
||||
if (pathname === initialPathRef.current) return;
|
||||
|
||||
// 1. Google Analytics 4 page_view event on client navigation
|
||||
if (gaId && typeof window !== 'undefined' && typeof window.gtag === 'function') {
|
||||
window.gtag('event', 'page_view', {
|
||||
page_path: pathname,
|
||||
page_location: window.location.href,
|
||||
page_title: typeof document !== 'undefined' ? document.title : '',
|
||||
});
|
||||
}
|
||||
|
||||
// 2. Google Tag Manager page_view event on client navigation
|
||||
if (gtmId && typeof window !== 'undefined' && Array.isArray(window.dataLayer)) {
|
||||
window.dataLayer.push({
|
||||
event: 'page_view',
|
||||
page_path: pathname,
|
||||
});
|
||||
}
|
||||
}, [pathname, gaId, gtmId]);
|
||||
|
||||
useEffect(() => {
|
||||
let loaded = false;
|
||||
|
||||
const loadAnalytics = () => {
|
||||
if (loaded) return;
|
||||
loaded = true;
|
||||
loadedRef.current = true;
|
||||
|
||||
// Clean up event listeners
|
||||
window.removeEventListener('scroll', loadAnalytics);
|
||||
@@ -42,10 +78,12 @@ export default function AnalyticsDeferred({ gtmId, gaId, clarityId }: AnalyticsD
|
||||
// 2. Google Analytics 4 (ensures GA4 hits fire directly even if GTM container lacks GA4 config tag)
|
||||
if (gaId) {
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(...args: any[]) {
|
||||
window.dataLayer?.push(args);
|
||||
function gtag(..._args: any[]) {
|
||||
// Note: Google's gtag.js specifically expects the native `arguments` object.
|
||||
// Pushing an ES6 Array causes gtag.js to silently ignore tracking commands.
|
||||
window.dataLayer?.push(arguments);
|
||||
}
|
||||
(window as any).gtag = gtag;
|
||||
window.gtag = gtag;
|
||||
gtag('js', new Date());
|
||||
gtag('config', gaId, { page_path: window.location.pathname });
|
||||
|
||||
@@ -94,6 +132,7 @@ export default function AnalyticsDeferred({ gtmId, gaId, clarityId }: AnalyticsD
|
||||
|
||||
return () => {
|
||||
loaded = true;
|
||||
loadedRef.current = false;
|
||||
clearTimeout(timer);
|
||||
if (idleId !== undefined) window.cancelIdleCallback(idleId);
|
||||
window.removeEventListener('scroll', loadAnalytics);
|
||||
|
||||
@@ -2,13 +2,123 @@ import React from 'react';
|
||||
import {render,fireEvent,act,cleanup} from '@testing-library/react';
|
||||
import {vi,beforeEach,afterEach,it,expect} from 'vitest';
|
||||
import AnalyticsDeferred from '../AnalyticsDeferred';
|
||||
beforeEach(()=>{vi.useFakeTimers();document.head.innerHTML='';delete window.dataLayer;delete window.clarity;});
|
||||
afterEach(()=>{cleanup();vi.useRealTimers();vi.unstubAllGlobals();});
|
||||
it('defers tags until interaction and loads only once',()=>{render(<AnalyticsDeferred gtmId="GTM-test" gaId="G-test" clarityId="test"/>);expect(document.scripts).toHaveLength(0);fireEvent.scroll(window);fireEvent.keyDown(window);act(()=>vi.advanceTimersByTime(3500));expect(document.scripts).toHaveLength(3);expect(window.dataLayer).toEqual(expect.arrayContaining([['config','G-test',{page_path:'/'}]]));});
|
||||
it.each(['scroll','touchstart','mousemove','keydown'])('loads on %s',event=>{render(<AnalyticsDeferred gtmId="GTM-test"/>);fireEvent(window,new Event(event));expect(document.scripts).toHaveLength(1);});
|
||||
it('loads clarity when no script exists',()=>{render(<AnalyticsDeferred clarityId="solo"/>);fireEvent.scroll(window);expect(document.querySelector('script')?.src).toBe('https://www.clarity.ms/tag/solo');});
|
||||
it('preserves the existing clarity implementation',()=>{const clarity=vi.fn();window.clarity=clarity;render(<AnalyticsDeferred clarityId="existing"/>);fireEvent.scroll(window);expect(window.clarity).toBe(clarity);expect(document.querySelector('script')?.src).toBe('https://www.clarity.ms/tag/existing');});
|
||||
it('queues clarity calls before its script initializes',()=>{render(<AnalyticsDeferred clarityId="queued"/>);fireEvent.scroll(window);window.clarity('event','checkout');expect(window.clarity.q).toEqual([['event','checkout']]);});
|
||||
it('falls back after 3500ms and reuses existing GA script',()=>{const s=document.createElement('script');s.src='https://www.googletagmanager.com/gtag/js?id=G-test';document.head.append(s);render(<AnalyticsDeferred gaId="G-test"/>);act(()=>vi.advanceTimersByTime(3499));expect(window.dataLayer).toBeUndefined();act(()=>vi.advanceTimersByTime(1));expect(document.scripts).toHaveLength(1);});
|
||||
it('cancels idle work on unmount',()=>{let cb:()=>void=()=>{};vi.stubGlobal('requestIdleCallback',vi.fn(fn=>{cb=fn;return 9;}));vi.stubGlobal('cancelIdleCallback',vi.fn());const v=render(<AnalyticsDeferred gtmId="GTM-test"/>);act(()=>vi.advanceTimersByTime(3500));v.unmount();act(()=>cb());expect(document.scripts).toHaveLength(0);expect(cancelIdleCallback).toHaveBeenCalledWith(9);});
|
||||
it('unmount removes event and timeout callbacks',()=>{const v=render(<AnalyticsDeferred gtmId="GTM-test"/>);v.unmount();fireEvent.scroll(window);act(()=>vi.advanceTimersByTime(4000));expect(document.scripts).toHaveLength(0);});
|
||||
|
||||
let mockPathname = '/';
|
||||
vi.mock('next/navigation', () => ({
|
||||
usePathname: () => mockPathname,
|
||||
}));
|
||||
|
||||
beforeEach(()=>{
|
||||
vi.useFakeTimers();
|
||||
mockPathname = '/';
|
||||
document.head.innerHTML='';
|
||||
delete (window as any).dataLayer;
|
||||
delete (window as any).clarity;
|
||||
delete (window as any).gtag;
|
||||
});
|
||||
afterEach(()=>{
|
||||
cleanup();
|
||||
vi.useRealTimers();
|
||||
vi.unstubAllGlobals();
|
||||
});
|
||||
|
||||
it('pushes genuine native arguments object for gtag commands so gtag.js processes them',()=>{
|
||||
render(<AnalyticsDeferred gaId="G-test"/>);
|
||||
fireEvent.scroll(window);
|
||||
act(()=>vi.advanceTimersByTime(3500));
|
||||
expect(window.dataLayer).toBeDefined();
|
||||
const configEntry = window.dataLayer?.find(entry => {
|
||||
return Object.prototype.toString.call(entry) === '[object Arguments]' && entry[0] === 'config';
|
||||
});
|
||||
expect(configEntry).toBeDefined();
|
||||
expect(configEntry[1]).toBe('G-test');
|
||||
});
|
||||
|
||||
it('defers tags until interaction and loads only once',()=>{
|
||||
render(<AnalyticsDeferred gtmId="GTM-test" gaId="G-test" clarityId="test"/>);
|
||||
expect(document.scripts).toHaveLength(0);
|
||||
fireEvent.scroll(window);
|
||||
fireEvent.keyDown(window);
|
||||
act(()=>vi.advanceTimersByTime(3500));
|
||||
expect(document.scripts).toHaveLength(3);
|
||||
const hasConfig = window.dataLayer?.some(entry => entry[0] === 'config' && entry[1] === 'G-test');
|
||||
expect(hasConfig).toBe(true);
|
||||
});
|
||||
|
||||
it('tracks client-side route changes when pathname changes',()=>{
|
||||
const {rerender} = render(<AnalyticsDeferred gaId="G-test" gtmId="GTM-test"/>);
|
||||
fireEvent.scroll(window);
|
||||
act(()=>vi.advanceTimersByTime(3500));
|
||||
|
||||
// Simulate navigation to blog
|
||||
mockPathname = '/blog/test-article';
|
||||
rerender(<AnalyticsDeferred gaId="G-test" gtmId="GTM-test"/>);
|
||||
|
||||
const gtmPageView = window.dataLayer?.find(entry => entry.event === 'page_view' && entry.page_path === '/blog/test-article');
|
||||
expect(gtmPageView).toBeDefined();
|
||||
|
||||
const gaPageView = window.dataLayer?.find(entry => {
|
||||
return Object.prototype.toString.call(entry) === '[object Arguments]' && entry[0] === 'event' && entry[1] === 'page_view';
|
||||
});
|
||||
expect(gaPageView).toBeDefined();
|
||||
expect(gaPageView[2].page_path).toBe('/blog/test-article');
|
||||
});
|
||||
|
||||
it.each(['scroll','touchstart','mousemove','keydown'])('loads on %s',event=>{
|
||||
render(<AnalyticsDeferred gtmId="GTM-test"/>);
|
||||
fireEvent(window,new Event(event));
|
||||
expect(document.scripts).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('loads clarity when no script exists',()=>{
|
||||
render(<AnalyticsDeferred clarityId="solo"/>);
|
||||
fireEvent.scroll(window);
|
||||
expect(document.querySelector('script')?.src).toBe('https://www.clarity.ms/tag/solo');
|
||||
});
|
||||
|
||||
it('preserves the existing clarity implementation',()=>{
|
||||
const clarity=vi.fn();
|
||||
(window as any).clarity=clarity;
|
||||
render(<AnalyticsDeferred clarityId="existing"/>);
|
||||
fireEvent.scroll(window);
|
||||
expect((window as any).clarity).toBe(clarity);
|
||||
expect(document.querySelector('script')?.src).toBe('https://www.clarity.ms/tag/existing');
|
||||
});
|
||||
|
||||
it('queues clarity calls before its script initializes',()=>{
|
||||
render(<AnalyticsDeferred clarityId="queued"/>);
|
||||
fireEvent.scroll(window);
|
||||
(window as any).clarity('event','checkout');
|
||||
expect((window as any).clarity.q).toEqual([['event','checkout']]);
|
||||
});
|
||||
|
||||
it('falls back after 3500ms and reuses existing GA script',()=>{
|
||||
const s=document.createElement('script');
|
||||
s.src='https://www.googletagmanager.com/gtag/js?id=G-test';
|
||||
document.head.append(s);
|
||||
render(<AnalyticsDeferred gaId="G-test"/>);
|
||||
act(()=>vi.advanceTimersByTime(3499));
|
||||
expect(window.dataLayer).toBeUndefined();
|
||||
act(()=>vi.advanceTimersByTime(1));
|
||||
expect(document.scripts).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('cancels idle work on unmount',()=>{
|
||||
let cb:()=>void=()=>{};
|
||||
vi.stubGlobal('requestIdleCallback',vi.fn(fn=>{cb=fn;return 9;}));
|
||||
vi.stubGlobal('cancelIdleCallback',vi.fn());
|
||||
const v=render(<AnalyticsDeferred gtmId="GTM-test"/>);
|
||||
act(()=>vi.advanceTimersByTime(3500));
|
||||
v.unmount();
|
||||
act(()=>cb());
|
||||
expect(document.scripts).toHaveLength(0);
|
||||
expect(cancelIdleCallback).toHaveBeenCalledWith(9);
|
||||
});
|
||||
|
||||
it('unmount removes event and timeout callbacks',()=>{
|
||||
const v=render(<AnalyticsDeferred gtmId="GTM-test"/>);
|
||||
v.unmount();
|
||||
fireEvent.scroll(window);
|
||||
act(()=>vi.advanceTimersByTime(4000));
|
||||
expect(document.scripts).toHaveLength(0);
|
||||
});
|
||||
Reference in new issue
Block a user