fix: using reorganized analytics library (#519)

Uniswap · Dec 22, 2022 · 311ed31 · 311ed31 · vercel · Dec 22, 2022
1 parent ed928df
commit 311ed31
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 30 deletions.
diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
     "@mdx-js/react": "^1.6.21",
     "@types/react": "^17.0.11",
     "@uniswap/analytics": "1.1.0",
-    "@uniswap/analytics-events": "1.1.1",
+    "@uniswap/analytics-events": "2.0.0",
     "algoliasearch": "^4.9.1",
     "clsx": "^1.1.1",
     "hast-util-is-element": "1.1.0",

diff --git a/src/components/SentimentTracking/index.tsx b/src/components/SentimentTracking/index.tsx
@@ -1,6 +1,6 @@
 import styled from '@emotion/styled'
 import { TraceEvent } from '@uniswap/analytics'
-import { BrowserEvent, DocsSentiment, DocsSentimentSection, EventName } from '@uniswap/analytics-events'
+import { BrowserEvent, DocsSentiment, DocsSentimentSection, SharedEventName } from '@uniswap/analytics-events'
 import React, { useCallback, useState } from 'react'
 import { Frown, Meh, Smile } from 'react-feather'
 
@@ -66,7 +66,7 @@ export default function SentimentTracking({ analyticsSection }: { analyticsSecti
       <StyledTextDiv>Helpful?</StyledTextDiv>
       <TraceEvent
         element={DocsSentiment.POSITIVE_SENTIMENT}
-        name={EventName.SENTIMENT_SUBMITTED}
+        name={SharedEventName.SENTIMENT_SUBMITTED}
         events={[BrowserEvent.onClick]}
         section={analyticsSection}
       >
@@ -79,7 +79,7 @@ export default function SentimentTracking({ analyticsSection }: { analyticsSecti
       </TraceEvent>
       <TraceEvent
         element={DocsSentiment.NEUTRAL_SENTIMENT}
-        name={EventName.SENTIMENT_SUBMITTED}
+        name={SharedEventName.SENTIMENT_SUBMITTED}
         events={[BrowserEvent.onClick]}
         section={analyticsSection}
       >
@@ -92,7 +92,7 @@ export default function SentimentTracking({ analyticsSection }: { analyticsSecti
       </TraceEvent>
       <TraceEvent
         element={DocsSentiment.NEGATIVE_SENTIMENT}
-        name={EventName.SENTIMENT_SUBMITTED}
+        name={SharedEventName.SENTIMENT_SUBMITTED}
         events={[BrowserEvent.onClick]}
         section={analyticsSection}
       >

diff --git a/src/pages/index.tsx b/src/pages/index.tsx
@@ -14,7 +14,7 @@ import {
   BrowserEvent,
   DocsHomepageElementName as ElementName,
   DocsSectionName as SectionName,
-  EventName,
+  SharedEventName,
 } from '@uniswap/analytics-events'
 import React from 'react'
 import { ArrowUpRight as LinkIcon, BookOpen, HelpCircle, Info, MessageCircle } from 'react-feather'
@@ -332,7 +332,7 @@ export default function Home() {
                 key={action.to}
                 element={action.to}
                 events={[BrowserEvent.onClick]}
-                name={EventName.PAGE_CLICKED}
+                name={SharedEventName.PAGE_CLICKED}
                 section={SectionName.WELCOME_LINKS}
               >
                 <Link style={{ textDecoration: 'none' }} to={action.to}>
@@ -368,7 +368,7 @@ export default function Home() {
                   key={action.to}
                   element={action.to}
                   events={[BrowserEvent.onClick]}
-                  name={EventName.PAGE_CLICKED}
+                  name={SharedEventName.PAGE_CLICKED}
                   section={SectionName.DAPP_LINKS}
                 >
                   <Link style={{ textDecoration: 'none' }} key={action.title} to={action.to}>
@@ -397,7 +397,7 @@ export default function Home() {
                   key={action.to}
                   element={action.to}
                   events={[BrowserEvent.onClick]}
-                  name={EventName.PAGE_CLICKED}
+                  name={SharedEventName.PAGE_CLICKED}
                   section={SectionName.SMART_CONTRACT_LINKS}
                 >
                   <Link style={{ textDecoration: 'none' }} key={action.title} to={action.to}>
@@ -438,7 +438,7 @@ export default function Home() {
               <TraceEvent
                 key={action.href}
                 element={action.href}
-                name={EventName.PAGE_CLICKED}
+                name={SharedEventName.PAGE_CLICKED}
                 events={[BrowserEvent.onClick]}
                 section={SectionName.DEVELOPER_LINKS}
               >
@@ -469,7 +469,7 @@ export default function Home() {
             events={[BrowserEvent.onClick]}
             element={ElementName.DISCORD}
             section={SectionName.BOTTOM_MENU_LINKS}
-            name={EventName.PAGE_CLICKED}
+            name={SharedEventName.PAGE_CLICKED}
           >
             <Link style={{ textDecoration: 'none' }} href={'https://discord.gg/ybKVQUWb4s'}>
               <CenterCard>
@@ -485,7 +485,7 @@ export default function Home() {
             events={[BrowserEvent.onClick]}
             element={ElementName.GRANTS}
             section={SectionName.BOTTOM_MENU_LINKS}
-            name={EventName.PAGE_CLICKED}
+            name={SharedEventName.PAGE_CLICKED}
           >
             <Link style={{ textDecoration: 'none' }} href={'https://gov.uniswap.org/'}>
               <CenterCard>
@@ -501,7 +501,7 @@ export default function Home() {
             events={[BrowserEvent.onClick]}
             section={SectionName.BOTTOM_MENU_LINKS}
             element={ElementName.GITHUB}
-            name={EventName.PAGE_CLICKED}
+            name={SharedEventName.PAGE_CLICKED}
           >
             <Link style={{ textDecoration: 'none' }} href={'https://github.com/Uniswap'}>
               <CenterCard>

diff --git a/src/theme/DocSidebarItem.tsx b/src/theme/DocSidebarItem.tsx
@@ -1,6 +1,6 @@
 import OriginalDocSidebarItem from '@theme-original/DocSidebarItem'
 import { TraceEvent } from '@uniswap/analytics'
-import { BrowserEvent, EventName } from '@uniswap/analytics-events'
+import { BrowserEvent, SharedEventName } from '@uniswap/analytics-events'
 import React from 'react'
 
 const DOCUSAURUS_LINK_ITEM_TYPE = 'link'
@@ -11,7 +11,7 @@ export default function DocSidebarItem(props: { item }) {
       <TraceEvent
         events={[BrowserEvent.onClick]}
         element={props.item.href}
-        name={EventName.MENU_CLICKED}
+        name={SharedEventName.MENU_CLICKED}
         shouldLogImpression={props.item.type === DOCUSAURUS_LINK_ITEM_TYPE}
       >
         {/* Required for onClick to register */}

diff --git a/src/theme/NavbarItem.tsx b/src/theme/NavbarItem.tsx
@@ -1,7 +1,7 @@
 import { useLocation } from '@docusaurus/router'
 import OriginalNavBarItem from '@theme-original/NavbarItem'
 import { TraceEvent } from '@uniswap/analytics'
-import { BrowserEvent, DocsProtocolVersion, EventName } from '@uniswap/analytics-events'
+import { BrowserEvent, DocsProtocolVersion, SharedEventName } from '@uniswap/analytics-events'
 import React from 'react'
 
 enum ProtocolVersion {
@@ -54,7 +54,7 @@ export default function NavbarItem(props: { className: string; label: string })
       <TraceEvent
         events={[BrowserEvent.onClick]}
         element={props.label}
-        name={EventName.NAVBAR_CLICKED}
+        name={SharedEventName.NAVBAR_CLICKED}
         section={getSection(selectedDocVersion)}
       >
         <OriginalNavBarItem {...props} className={getClassName(props.className, selectedDocVersion)} />

diff --git a/src/theme/Root.tsx b/src/theme/Root.tsx
@@ -1,7 +1,7 @@
 import { useLocation } from '@docusaurus/router'
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
 import { initializeAnalytics, OriginApplication, sendAnalyticsEvent, Trace, user } from '@uniswap/analytics'
-import { CustomUserProperties, EventName, getBrowser } from '@uniswap/analytics-events'
+import { CustomUserProperties, getBrowser, SharedEventName } from '@uniswap/analytics-events'
 import React, { useEffect } from 'react'
 import { getCLS, getFCP, getFID, getLCP, Metric } from 'web-vitals'
 
@@ -32,20 +32,22 @@ export default function Root({ children }: React.PropsWithChildren<{ open: boole
 
   // Fires on initial render of the page
   useEffect(() => {
-    sendAnalyticsEvent(EventName.APP_LOADED)
+    sendAnalyticsEvent(SharedEventName.APP_LOADED)
     user.set(CustomUserProperties.USER_AGENT, navigator.userAgent)
     user.set(CustomUserProperties.BROWSER, getBrowser())
     user.set(CustomUserProperties.SCREEN_RESOLUTION_HEIGHT, window.screen.height)
     user.set(CustomUserProperties.SCREEN_RESOLUTION_WIDTH, window.screen.width)
-    getCLS(({ delta }: Metric) => sendAnalyticsEvent(EventName.WEB_VITALS, { cumulative_layout_shift: delta }))
-    getFCP(({ delta }: Metric) => sendAnalyticsEvent(EventName.WEB_VITALS, { first_contentful_paint_ms: delta }))
-    getFID(({ delta }: Metric) => sendAnalyticsEvent(EventName.WEB_VITALS, { first_input_delay_ms: delta }))
-    getLCP(({ delta }: Metric) => sendAnalyticsEvent(EventName.WEB_VITALS, { largest_contentful_paint_ms: delta }))
+    getCLS(({ delta }: Metric) => sendAnalyticsEvent(SharedEventName.WEB_VITALS, { cumulative_layout_shift: delta }))
+    getFCP(({ delta }: Metric) => sendAnalyticsEvent(SharedEventName.WEB_VITALS, { first_contentful_paint_ms: delta }))
+    getFID(({ delta }: Metric) => sendAnalyticsEvent(SharedEventName.WEB_VITALS, { first_input_delay_ms: delta }))
+    getLCP(({ delta }: Metric) =>
+      sendAnalyticsEvent(SharedEventName.WEB_VITALS, { largest_contentful_paint_ms: delta })
+    )
   }, [])
 
   // Fires on route change
   useEffect(() => {
-    sendAnalyticsEvent(EventName.PAGE_VIEWED, {
+    sendAnalyticsEvent(SharedEventName.PAGE_VIEWED, {
       page: pathname,
     })
   }, [pathname])

diff --git a/src/theme/SearchBar.tsx b/src/theme/SearchBar.tsx
@@ -1,12 +1,12 @@
 import OriginalSearchBar from '@theme-original/SearchBar'
 import { TraceEvent } from '@uniswap/analytics'
-import { BrowserEvent, EventName } from '@uniswap/analytics-events'
+import { BrowserEvent, SharedEventName } from '@uniswap/analytics-events'
 import React from 'react'
 
 export default function SearchBarWithAnalytics(props) {
   return (
     <>
-      <TraceEvent events={[BrowserEvent.onClick]} name={EventName.SEARCH_BAR_CLICKED}>
+      <TraceEvent events={[BrowserEvent.onClick]} name={SharedEventName.SEARCH_BAR_CLICKED}>
         {/* Required for onClick to register */}
         <div>
           <OriginalSearchBar {...props} />

diff --git a/yarn.lock b/yarn.lock
@@ -3146,10 +3146,10 @@
     "@typescript-eslint/types" "5.42.1"
     eslint-visitor-keys "^3.3.0"
 
-"@uniswap/analytics-events@1.1.1":
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/@uniswap/analytics-events/-/analytics-events-1.1.1.tgz#7514f45ec4936fb44f94c691b977ba3f741a54b3"
-  integrity sha512-B8cIbBdpqv3do4mO+/bu6WGsIuTuQqjtYDGZthhCrmdiN3ImE8HVGXKzVV3t9CyG1vPssxCtRSeSgyPVOm/4vA==
+"@uniswap/analytics-events@2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@uniswap/analytics-events/-/analytics-events-2.0.0.tgz#5370421c916f900900965a5f8da5316dbb39c674"
+  integrity sha512-Cmr+1H0VJX+vdxGwpZpL5hOkRw49j8hu2uLddiXChP64HHihjiYljC3tckkCJpkpW6NHHlfX9U+D2Wy0MiVaDw==
 
 "@uniswap/analytics@1.1.0":
   version "1.1.0"