Skip to content

UTM Awareness #35

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

Merged
rockwellll merged 4 commits into from
Sep 13, 2025
Merged

UTM Awareness #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
764552f
add new UTM class
rockwellll Sep 12, 2025
7daf6f0
pass the UTM params back to the server when tracking an event
rockwellll Sep 12, 2025
6bc6779
add a new Page object
rockwellll Sep 13, 2025
ad8783c
merge with master
rockwellll Sep 13, 2025
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
234 changes: 136 additions & 98 deletions __tests__/hellotext_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Hellotext from "../src/hellotext";
import { Business } from "../src/models"
import { Business } from "../src/models";

const getCookieValue = name => document.cookie.match('(^|;)\\s*' + name + '\\s*=\\s*([^;]+)')?.pop()

Expand All @@ -20,7 +20,7 @@ describe("when trying to call methods before initializing the class", () => {
expect(Hellotext.track("page.viewed")).rejects.toThrowError()
});
})
//

describe("when the class is initialized successfully", () => {
const business_id = "xy76ks"

Expand Down Expand Up @@ -64,6 +64,35 @@ describe("when the class is initialized successfully", () => {

expect(response.failed).toEqual(true)
});

it("includes UTM parameters in the request body", async () => {
global.fetch = jest.fn().mockResolvedValue({
json: jest.fn().mockResolvedValue({received: "success"}),
status: 200
})

await Hellotext.track("page.viewed", { test_param: "test_value" })

// Check that fetch was called
expect(global.fetch).toHaveBeenCalled()

// Get the fetch call arguments
const fetchCall = global.fetch.mock.calls[0]
const requestOptions = fetchCall[1]
const requestBody = JSON.parse(requestOptions.body)

// Verify that utm_params is included in the request body
expect(requestBody).toHaveProperty('utm_params')

// Since we're using mock window.location.search = "?hello_session=session",
// there are no UTM params, so it should be an empty object
expect(requestBody.utm_params).toEqual({})

// Verify other expected fields are present
expect(requestBody).toHaveProperty('action', 'page.viewed')
expect(requestBody).toHaveProperty('session', 'session')
expect(requestBody).toHaveProperty('test_param', 'test_value')
});
});
});

Expand Down Expand Up @@ -98,100 +127,109 @@ describe("when the class is initialized successfully", () => {
}, 1000)
})
});

describe("when UTM parameters are present in the URL", () => {
const business_id = "xy76ks"

beforeAll(() => {
const windowMock = {
location: {
search: "?utm_source=google&utm_medium=cpc&utm_campaign=summer_sale&utm_term=shoes&utm_content=ad1",
href: "https://example.com/?utm_source=google&utm_medium=cpc&utm_campaign=summer_sale&utm_term=shoes&utm_content=ad1",
pathname: "/"
},
}

jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)

// Mock document.title
Object.defineProperty(document, 'title', {
value: 'Test Page Title',
writable: true
})

Hellotext.initialize(business_id)
})

afterEach(() => {
jest.clearAllMocks()
})

it("includes UTM parameters from URL in track request body", async () => {
global.fetch = jest.fn().mockResolvedValue({
json: jest.fn().mockResolvedValue({received: "success"}),
status: 200
})

await Hellotext.track("page.viewed", { custom_param: "custom_value" })

// Check that fetch was called
expect(global.fetch).toHaveBeenCalled()

// Get the fetch call arguments
const fetchCall = global.fetch.mock.calls[0]
const requestOptions = fetchCall[1]
const requestBody = JSON.parse(requestOptions.body)

// Verify that utm_params contains the expected UTM data
expect(requestBody).toHaveProperty('utm_params')
expect(requestBody.utm_params).toEqual({
source: 'google',
medium: 'cpc',
campaign: 'summer_sale',
term: 'shoes',
content: 'ad1'
})

// Verify other expected fields are present
expect(requestBody).toHaveProperty('action', 'page.viewed')
expect(requestBody).toHaveProperty('custom_param', 'custom_value')

// Verify page object contains all expected properties
expect(requestBody).toHaveProperty('page.url', 'https://example.com/?utm_source=google&utm_medium=cpc&utm_campaign=summer_sale&utm_term=shoes&utm_content=ad1')
expect(requestBody).toHaveProperty('page.title', 'Test Page Title')
expect(requestBody).toHaveProperty('page.path', '/')
});

it("includes partial UTM parameters when only some are present", async () => {
const windowMockPartial = {
location: {
search: "?utm_source=facebook&utm_medium=social",
href: "https://example.com/?utm_source=facebook&utm_medium=social",
pathname: "/social-page"
},
}

jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMockPartial)

// Update document title for this test
document.title = 'Social Media Page'

// Reinitialize with partial UTM params
await Hellotext.initialize(business_id)

global.fetch = jest.fn().mockResolvedValue({
json: jest.fn().mockResolvedValue({received: "success"}),
status: 200
})

await Hellotext.track("button.clicked")

// Get the fetch call arguments
const fetchCall = global.fetch.mock.calls[0]
const requestOptions = fetchCall[1]
const requestBody = JSON.parse(requestOptions.body)

// Verify that utm_params contains only the present UTM parameters
expect(requestBody.utm_params).toEqual({
source: 'facebook',
medium: 'social'
})

// Verify page object contains all expected properties with updated values
expect(requestBody).toHaveProperty('page.url', 'https://example.com/?utm_source=facebook&utm_medium=social')
expect(requestBody).toHaveProperty('page.title', 'Social Media Page')
expect(requestBody).toHaveProperty('page.path', '/social-page')
});
});
});
//
// describe(".isInitialized", () => {
// describe("when session is set", () => {
// beforeAll(() => {
// const windowMock = {location: { search: "?hello_session=session" }}
// jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
// Hellotext.initialize("123")
// })
//
// it("is true", () => {
// expect(Hellotext.isInitialized).toEqual(true)
// });
// });
// });
//
// describe(".on", () => {
// const business_id = "xy76ks"
//
// beforeAll(() => {
// const windowMock = {location: { search: "" },}
// jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
// })
//
// it("registers a callback that is called when the session is set", function () {
// global.fetch = jest.fn().mockResolvedValue({
// json: jest.fn().mockResolvedValue({id: "generated_token"}),
// status: 200
// })
//
// const callback = jest.fn()
//
// Hellotext.on("session-set", callback)
// Hellotext.initialize(business_id)
//
// expect(callback).toHaveBeenCalledTimes(1)
// });
//
// it("throws an error when event is invalid", () => {
// expect(
// () => Hellotext.on("undefined-event", () => {})
// ).toThrowError()
// });
// });
//
// describe("when session is stored in the cookie", function () {
// beforeAll(() => {
// document.cookie = `hello_session=12345`
// Hellotext.initialize(123)
// })
//
// it("Assigns session from cookie", function () {
// expect(Hellotext.session).toEqual("12345")
// });
// });
//
//
// describe(".removeEventListener", () => {
// beforeAll(() => {
// const windowMock = {location: { search: "?hello_session=123" },}
// jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
//
// Hellotext.initialize(123)
// })
//
// it("throws an error when event is invalid", () => {
// expect(
// () => Hellotext.removeEventListener("undefined-event", () => {})
// ).toThrowError()
// });
//
// it("removes the callback from the subscribers and will not be notified again", () => {
// const callback = jest.fn()
//
// Hellotext.on("session-set", callback)
// Hellotext.removeEventListener("session-set", callback)
//
// expect(callback).toHaveBeenCalledTimes(0)
// });
// })
//
// describe("when hello_preview query parameter is present", () => {
// beforeAll(() => {
// const windowMock = {location: { search: "?hello_preview" },}
// jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
//
// expireSession()
// Hellotext.initialize(123)
// })
//
// describe(".track", () => {
// it("returns a success response without interacting with the API", async () => {
// const response = await Hellotext.track("page.viewed")
// expect(response.succeeded).toEqual(true)
// });
// })
// })
Loading