161 use google analytics onetrust module (#490)

* Adding Github workflow * ADDING A read me * Remove the docker openshift file * Update README.md * Update README.md * configure github action * 161 use Google Analytics + OneTrust module, Upgrade react, react-dom * updated package tag, gh actions build * adjust workflow * add img-src, privacy redirect for banner link * drop repo owner change * drop branch * last workflow change to remove * package update --------- Co-authored-by: Pushyami Gundala <[email protected]> Co-authored-by: Pushyami Gundala <[email protected]>
tl-its-umich-edu · Nov 18, 2024 · 200bd63 · 200bd63
1 parent 0ac8eb4
commit 200bd63
Show file tree

Hide file tree

Showing 12 changed files with 539 additions and 79 deletions.
diff --git a/.github/workflows/ccm.yml b/.github/workflows/ccm.yml
@@ -51,7 +51,7 @@ jobs:
     
   release: 
      # Making sure that release only runs for tag pushes
-    if: startsWith(github.ref, 'refs/tags/') && github.repository_owner == 'tl-its-umich-edu'
+    if: startsWith(github.ref, 'refs/tags/') && (github.repository_owner == 'tl-its-umich-edu')
     needs: build # This ensures the build job finishes successfully before starting this job
     runs-on: ubuntu-latest
     steps:

diff --git a/ccm_web/client/src/App.tsx b/ccm_web/client/src/App.tsx
@@ -9,6 +9,7 @@ import ErrorAlert from './components/ErrorAlert.js'
 import Layout from './components/Layout.js'
 import useGlobals from './hooks/useGlobals.js'
 import usePromise from './hooks/usePromise.js'
+import { useGoogleAnalytics, UseGoogleAnalyticsParams } from '@tl-its-umich-edu/react-ga-onetrust-consent'
 import { CanvasCourseBase } from './models/canvas.js'
 import allFeatures from './models/FeatureUIData.js'
 import Home from './pages/Home.js'
@@ -22,6 +23,13 @@ function App (): JSX.Element {
 
   const [globals, csrfToken, isAuthenticated, isLoading, globalsError, csrfTokenCookieError] = useGlobals()
 
+  const googleAnalyticsConfig: UseGoogleAnalyticsParams = {
+    googleAnalyticsId: globals?.googleAnalyticsId ?? '',
+    oneTrustScriptDomain: globals?.oneTrustScriptDomain ?? '',
+    debug: false
+  }
+  useGoogleAnalytics(googleAnalyticsConfig);
+
   const [course, setCourse] = useState<undefined|CanvasCourseBase>(undefined)
   const [doLoadCourse, isCourseLoading, getCourseError] = usePromise<CanvasCourseBase|undefined, typeof getCourse>(
     async (courseId: number): Promise<CanvasCourseBase> => {

diff --git a/ccm_web/client/src/index.tsx b/ccm_web/client/src/index.tsx
@@ -1,7 +1,7 @@
 import { SnackbarProvider } from 'notistack'
 import React from 'react'
 import { createRoot } from 'react-dom/client'
-import { BrowserRouter, Route, Routes } from 'react-router-dom'
+import { BrowserRouter as Router, Route, Routes } from 'react-router-dom'
 import { ThemeProvider, StyledEngineProvider } from '@mui/material'
 
 import App from './App.js'
@@ -21,13 +21,13 @@ root.render(
    <StyledEngineProvider injectFirst>
      <ThemeProvider theme={ccmTheme}>
       <SnackbarProvider maxSnack={3}>
-        <BrowserRouter>
+        <Router>
           <Routes>
             <Route path='/access-denied' element={<AccessDenied {...helpContactProps} />}/>
             <Route path='/launch-error' element={<LaunchError {...helpContactProps} />}/>
             <Route path='*' element={<App />}/>
           </Routes>
-        </BrowserRouter>
+        </Router>
       </SnackbarProvider>
      </ThemeProvider>
    </StyledEngineProvider>

diff --git a/ccm_web/client/src/models/models.ts b/ccm_web/client/src/models/models.ts
@@ -42,6 +42,8 @@ export interface Globals {
   user: User
   course: Course
   baseHelpURL: string
+  googleAnalyticsId: string;
+  oneTrustScriptDomain: string;
 }
 
 export interface CsrfToken {