Skip to content

Commit

Permalink
feat: Remove unneeded utm tracking code (#3082)
Browse files Browse the repository at this point in the history
  • Loading branch information
calvin-codecov authored Jul 31, 2024
1 parent 9d973f4 commit 92b0845
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 186 deletions.
3 changes: 0 additions & 3 deletions src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import EnterpriseLoginLayout from 'layouts/EnterpriseLoginLayout'
import LoginLayout from 'layouts/LoginLayout'
import { useLocationParams } from 'services/navigation'
import { ToastNotificationProvider } from 'services/toastNotification'
import { useUTM } from 'services/tracking/utm'
import { useInternalUser, useUser } from 'services/user'
import { isProvider } from 'shared/api/helpers'

Expand Down Expand Up @@ -176,8 +175,6 @@ const MainAppRoutes = () => (
)

function App() {
useUTM()

return (
<>
<ToastNotificationProvider>
Expand Down
21 changes: 2 additions & 19 deletions src/services/navigation/useNavLinks/useNavLinks.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import Cookie from 'js-cookie'
import qs from 'qs'
import { useParams } from 'react-router-dom'

Expand All @@ -17,11 +16,6 @@ export function useNavLinks() {
path: pa,
} = useParams()

const utmCookie = Cookie.get('utmParams')
const utmCookieObj = qs.parse(utmCookie, {
ignoreQueryPrefix: true,
})

return {
signOut: {
text: 'Sign Out',
Expand All @@ -33,25 +27,14 @@ export function useNavLinks() {
signIn: {
text: 'Log in',
path: ({ provider = p, to } = { provider: p }) => {
const query = qs.stringify(
{
to,
...utmCookieObj,
},
{ addQueryPrefix: true }
)
const query = qs.stringify({ to }, { addQueryPrefix: true })
return `${config.API_URL}/login/${provider}${query}`
},
isExternalLink: true,
},
signUp: {
text: 'Sign Up',
path: () => {
const params = qs.stringify(utmCookieObj, {
addQueryPrefix: true,
})
return `${config.MARKETING_BASE_URL}/sign-up/${params}`
},
path: () => `${config.MARKETING_BASE_URL}/sign-up/`,
isExternalLink: true,
},
oktaLogin: {
Expand Down
51 changes: 0 additions & 51 deletions src/services/navigation/useNavLinks/useNavLinks.spec.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
import { renderHook } from '@testing-library/react'
import Cookie from 'js-cookie'
import { MemoryRouter, Route } from 'react-router-dom'

import config from 'config'

import { useNavLinks } from './useNavLinks'

const wrapper =
Expand Down Expand Up @@ -91,27 +88,6 @@ describe('useNavLinks', () => {
'/login/gl?to=https%3A%2F%2Fapp.codecov.io%2Fgh%2Fcodecov'
)
})

it('forwards the utm tags', () => {
Cookie.set(
'utmParams',
'utm_source=a&utm_medium=b&utm_campaign=c&utm_term=d&utm_content=e'
)

const { result } = renderHook(() => useNavLinks(), {
wrapper: wrapper('/gh/doggo/squirrel-locator'),
})

const path = result.current.signIn.path({
to: 'https://app.codecov.io/gh/codecov',
})

expect(path).toBe(
'/login/gh?to=https%3A%2F%2Fapp.codecov.io%2Fgh%2Fcodecov&utm_source=a&utm_medium=b&utm_campaign=c&utm_term=d&utm_content=e'
)

Cookie.remove('utmParams')
})
})

describe('owner link', () => {
Expand Down Expand Up @@ -1185,33 +1161,6 @@ describe('useNavLinks', () => {
})
})

describe('signup forward the marketing link', () => {
beforeEach(() => {
Cookie.set(
'utmParams',
'utm_source=a&utm_medium=b&utm_campaign=c&utm_term=d&utm_content=e'
)
})

afterEach(() => {
Cookie.remove('utmParams')
})

it('returns the correct url', () => {
const { result } = renderHook(() => useNavLinks(), {
wrapper: wrapper(
'/gh?utm_source=a&utm_medium=b&utm_campaign=c&utm_term=d&utm_content=e&not=f'
),
})

const path = result.current.signUp.path({ pathname: 'random/path/name' })
expect(path).toBe(
config.MARKETING_BASE_URL +
'/sign-up/?utm_source=a&utm_medium=b&utm_campaign=c&utm_term=d&utm_content=e'
)
})
})

describe('pull detail', () => {
it('returns the correct link with nothing passed', () => {
const { result } = renderHook(() => useNavLinks(), {
Expand Down
23 changes: 0 additions & 23 deletions src/services/tracking/utm.js

This file was deleted.

49 changes: 0 additions & 49 deletions src/services/tracking/utm.spec.js

This file was deleted.

26 changes: 1 addition & 25 deletions src/shared/utils/url.spec.ts
Original file line number Diff line number Diff line change
@@ -1,28 +1,4 @@
import {
forwardMarketingTag,
getFileExtension,
getFilenameFromPath,
getFilePathParts,
} from './url'

describe('forwardMarketingTag', () => {
it('returns an object containing the specified utm parameters only', () => {
const queryParams =
'?utm_medium=social%20media&utm_source=twitter&utm_campaign=organic_social&utm_department=marketing'
expect(forwardMarketingTag(queryParams)).toStrictEqual({
utm_campaign: 'organic_social',
utm_department: 'marketing',
utm_medium: 'social media',
utm_source: 'twitter',
})
})

it('returns an empty object if no utm parameters are present in a query string', () => {
const queryParams =
'?ashton=barbarian&laudna=warlock&FCG=cleric&chetney=rogue&orym=fighter&fearne=druid&dorian=bard&imogen=sorcerer'
expect(forwardMarketingTag(queryParams)).toStrictEqual({})
})
})
import { getFileExtension, getFilenameFromPath, getFilePathParts } from './url'

describe('getFilesNamesFromFilePath', () => {
it('returns an array containing files names', () => {
Expand Down
16 changes: 0 additions & 16 deletions src/shared/utils/url.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,10 @@
import isString from 'lodash/isString'
import pick from 'lodash/pick'
import qs from 'qs'

export const formatPathPrefix = (pathname: string) =>
pathname.charAt(pathname.length - 1) === '/'
? pathname.slice(0, pathname.length - 1)
: pathname

export function forwardMarketingTag(search: string) {
const queryParams = qs.parse(search, {
ignoreQueryPrefix: true,
})
return pick(queryParams, [
'utm_source',
'utm_medium',
'utm_campaign',
'utm_term',
'utm_content',
'utm_department',
])
}

export function getFilenameFromFilePath(path: string) {
return path.split('/').pop()
}
Expand Down

0 comments on commit 92b0845

Please sign in to comment.