Merge pull request #783 from DTS-STN/typescript-conversion

Allow AEM folder to be specified
DTS-STN · Dec 20, 2024 · e515e95 · e515e95
2 parents 7ed55bf + bba713f
commit e515e95
Show file tree

Hide file tree

Showing 14 changed files with 147 additions and 131 deletions.
diff --git a/.env.example b/.env.example
@@ -1,4 +1,6 @@
 AEM_GRAPHQL_ENDPOINT = "test.com"
+# Code suggests this is optional but it is actually not because of changes in the structure of the response
+AEM_GRAPHQL_FOLDER = "test_folder/path"
 LOGGING_LEVEL = " info or debug" 
 MSCA_BASE_URL = "MSCA base url"
 MSCA_EQ_BASE_URL = "MSCA base url with eq extension"

diff --git a/.github/workflows/dast.yml b/.github/workflows/dast.yml
@@ -19,16 +19,18 @@ jobs:
           CI: true
 
       - name: Docker Build
-        run: docker build --build-arg AEM_GRAPHQL_ENDPOINT=${{secrets.AEM_GRAPHQL_ENDPOINT}} -t secure-client-hub .
+        run: docker build --build-arg AEM_GRAPHQL_ENDPOINT=${{secrets.AEM_GRAPHQL_ENDPOINT}} AEM_GRAPHQL_FOLDER=${{secrets.AEM_GRAPHQL_FOLDER}} -t secure-client-hub .
         env:
           CI: true
           AEM_GRAPHQL_ENDPOINT: ${{secrets.AEM_GRAPHQL_ENDPOINT}}
+          AEM_GRAPHQL_FOLDER: ${{secrets.AEM_GRAPHQL_FOLDER}}
 
       - name: Docker run
         run: docker run -d -p 3000:3000 secure-client-hub
         env:
           CI: true
           AEM_GRAPHQL_ENDPOINT: ${{secrets.AEM_GRAPHQL_ENDPOINT}}
+          AEM_GRAPHQL_FOLDER: ${{secrets.AEM_GRAPHQL_FOLDER}}
 
       - name: OWASP ZAP FULL Scan
         uses: zaproxy/[email protected]

diff --git a/.github/workflows/default-tests.yml b/.github/workflows/default-tests.yml
@@ -78,6 +78,7 @@ jobs:
         env:
           CI: true
           AEM_GRAPHQL_ENDPOINT: ${{secrets.AEM_GRAPHQL_ENDPOINT}}
+          AEM_GRAPHQL_FOLDER: ${{secrets.AEM_GRAPHQL_FOLDER}}
           AUTH_DISABLED: true
 
       - name: Cypress end-to-end 🧪
@@ -86,6 +87,7 @@ jobs:
           CI: true
           NODE_ENV: production
           AEM_GRAPHQL_ENDPOINT: ${{secrets.AEM_GRAPHQL_ENDPOINT}}
+          AEM_GRAPHQL_FOLDER: ${{secrets.AEM_GRAPHQL_FOLDER}}
           NEXTAUTH_SECRET: ${{secrets.NEXTAUTH_SECRET}}
           NEXTAUTH_URL: ${{secrets.NEXTAUTH_URL}}
           CLIENT_SECRET: ${{secrets.CLIENT_SECRET}}

diff --git a/Dockerfile b/Dockerfile
@@ -17,6 +17,8 @@ ARG LOGGING_LEVEL=info
 ENV LOGGING_LEVEL=$LOGGING_LEVEL
 ARG AEM_GRAPHQL_ENDPOINT=https://www.canada.ca/graphql/execute.json/decd-endc/
 ENV AEM_GRAPHQL_ENDPOINT=$AEM_GRAPHQL_ENDPOINT
+ARG AEM_GRAPHQL_FOLDER
+ENV AEM_GRAPHQL_FOLDER=$AEM_GRAPHQL_FOLDER
 ARG AUTH_ECAS_BASE_URL
 ENV AUTH_ECAS_BASE_URL=$AUTH_ECAS_BASE_URL
 ARG MSCA_BASE_URL
@@ -99,6 +101,8 @@ ARG LOGGING_LEVEL=info
 ENV LOGGING_LEVEL=$LOGGING_LEVEL
 ARG AEM_GRAPHQL_ENDPOINT
 ENV AEM_GRAPHQL_ENDPOINT=$AEM_GRAPHQL_ENDPOINT
+ARG AEM_GRAPHQL_FOLDER
+ENV AEM_GRAPHQL_FOLDER=$AEM_GRAPHQL_FOLDER
 ARG MSCA_BASE_URL
 ENV MSCA_BASE_URL=$MSCA_BASE_URL
 ARG MSCA_EQ_BASE_URL

diff --git a/graphql/mappers/auth-modals.ts b/graphql/mappers/auth-modals.ts
@@ -1,10 +1,11 @@
 import { cachified } from 'cachified'
 import { lruCache as cache, defaultTtl as ttl } from '../../lib/cache-utils'
+import { buildAemUri } from '../../lib/links'
 
-interface GetSchAuthModalsV1 {
+interface GetSchAuthModalsV2 {
   data: {
     staySignedIn: {
-      item: {
+      items: Array<{
         _path: string
         scId: string
         scHeadingEn: string
@@ -38,10 +39,10 @@ interface GetSchAuthModalsV1 {
           scLinkTextEn: string
           scLinkTextFr: string
         }>
-      }
+      }>
     }
     youHaveBeenSignedOut: {
-      item: {
+      items: Array<{
         _path: string
         scId: string
         scHeadingEn: string
@@ -71,7 +72,7 @@ interface GetSchAuthModalsV1 {
           scDestinationURLEn?: string
           scDestinationURLFr?: string
         }>
-      }
+      }>
     }
   }
 }
@@ -80,21 +81,20 @@ const getCachedContent = () => {
   return cachified({
     key: `content-auth-modals`,
     cache,
-    getFreshValue: async () => {
-      const response = await fetch(
-        `${process.env.AEM_GRAPHQL_ENDPOINT}getSchAuthModalsV1`,
-      )
+    getFreshValue: async (): Promise<GetSchAuthModalsV2 | null> => {
+      const targetUri = buildAemUri('getSchAuthModalsV2')
+      const response = await fetch(targetUri)
       if (!response.ok) return null
-      return (await response.json()) as GetSchAuthModalsV1
+      return await response.json()
     },
     ttl,
   })
 }
 
 export async function getAuthModalsContent(): Promise<AuthModalsContent> {
   const response = await getCachedContent()
-  const resSignedOutContent = response?.data.youHaveBeenSignedOut.item
-  const resStaySignedIn = response?.data.staySignedIn.item
+  const resSignedOutContent = response?.data.youHaveBeenSignedOut.items[0]
+  const resStaySignedIn = response?.data.staySignedIn.items[0]
 
   const mappedPopupSignedOut = {
     en: {

diff --git a/graphql/mappers/contact-us-pages-dynamic.ts b/graphql/mappers/contact-us-pages-dynamic.ts
@@ -1,5 +1,6 @@
 import { cachified } from 'cachified'
 import { lruCache as cache, defaultTtl as ttl } from '../../lib/cache-utils'
+import { buildAemUri } from '../../lib/links'
 
 interface GetSchContactUsDynamicV1 {
   data: {
@@ -120,13 +121,11 @@ const getCachedContent = () => {
   return cachified({
     key: `content-dynamic-contact-us`,
     cache,
-    getFreshValue: async () => {
-      const response = await fetch(
-        `${process.env.AEM_GRAPHQL_ENDPOINT}getSchContactUsDynamicV1`
-      )
-
+    getFreshValue: async (): Promise<GetSchContactUsDynamicV1 | null> => {
+      const targetUri = buildAemUri('getSchContactUsDynamicV1')
+      const response = await fetch(targetUri)
       if (!response.ok) return null
-      return (await response.json()) as GetSchContactUsDynamicV1
+      return await response.json()
     },
     ttl,
   })
@@ -143,7 +142,7 @@ export type GetContactUsPageReturnType = Awaited<
 export async function getContactUsPage(id: string) {
   const response = await getCachedContent()
   const queryData = response?.data.schPageV1List.items.find(
-    ({ scId }) => scId === id
+    ({ scId }) => scId === id,
   )
 
   // Fail fast if a non-existent page is queried
@@ -202,7 +201,7 @@ export async function getContactUsPage(id: string) {
                                 button: destination.scButtonType,
                               }
                             }
-                          }
+                          },
                         )[0] ?? {}),
                       }
                     } else {
@@ -280,7 +279,7 @@ export async function getContactUsPage(id: string) {
                                 button: destination.scButtonType,
                               }
                             }
-                          }
+                          },
                         )[0] ?? {}),
                       }
                     } else {

diff --git a/graphql/mappers/contact-us.ts b/graphql/mappers/contact-us.ts
@@ -1,10 +1,11 @@
 import { cachified } from 'cachified'
 import { lruCache as cache, defaultTtl as ttl } from '../../lib/cache-utils'
+import { buildAemUri } from '../../lib/links'
 
-interface GetSchContactUsV1 {
+interface GetSchContactUsV2 {
   data: {
-    schPageV1ByPath: {
-      item: {
+    schPageV1List: {
+      items: Array<{
         _path: string
         scPageNameEn: string
         scPageNameFr: string
@@ -61,9 +62,8 @@ interface GetSchContactUsV1 {
           scLinkTextAssistiveFr?: string
           scDestinationURLEn?: string
           scDestinationURLFr?: string
-          schBetaPopUp?: boolean
         }>
-      }
+      }>
     }
   }
 }
@@ -72,12 +72,11 @@ const getCachedContent = () => {
   return cachified({
     key: `content-contact-landing-page`,
     cache,
-    getFreshValue: async () => {
-      const response = await fetch(
-        `${process.env.AEM_GRAPHQL_ENDPOINT}getSchContactUsV1`,
-      )
+    getFreshValue: async (): Promise<GetSchContactUsV2 | null> => {
+      const targetUri = buildAemUri('getSchContactUsV2')
+      const response = await fetch(targetUri)
       if (!response.ok) return null
-      return (await response.json()) as GetSchContactUsV1
+      return await response.json()
     },
     ttl,
   })
@@ -104,16 +103,16 @@ export async function getContactUsContent() {
   const mappedSecurity = {
     en: {
       breadcrumb:
-        response?.data.schPageV1ByPath.item.scBreadcrumbParentPages.map(
+        response?.data.schPageV1List.items[0].scBreadcrumbParentPages.map(
           (level) => {
             return {
               link: level.scPageNameEn,
               text: level.scTitleEn,
             }
           },
         ),
-      pageName: response?.data.schPageV1ByPath.item.scPageNameEn,
-      heading: response?.data.schPageV1ByPath.item.scTitleEn,
+      pageName: response?.data.schPageV1List.items[0].scPageNameEn,
+      heading: response?.data.schPageV1List.items[0].scTitleEn,
       subHeading: introFragment?.scContentEn?.json[0].content[0].value,
       links: [
         {
@@ -124,7 +123,6 @@ export async function getContactUsContent() {
           linkDescription: cdcpContactFragment?.scDescriptionEn?.json
             ? cdcpContactFragment.scDescriptionEn.json[0].content[0].value
             : '',
-          schBetaPopup: cdcpContactFragment?.schBetaPopUp,
         },
         {
           linkId: eiContactFragment?.scId,
@@ -134,7 +132,6 @@ export async function getContactUsContent() {
           linkDescription: eiContactFragment?.scDescriptionEn?.json
             ? eiContactFragment.scDescriptionEn.json[0].content[0].value
             : '',
-          schBetaPopup: eiContactFragment?.schBetaPopUp,
         },
         {
           linkId: cppContactFragment?.scId,
@@ -144,7 +141,6 @@ export async function getContactUsContent() {
           linkDescription: cppContactFragment?.scDescriptionEn?.json
             ? cppContactFragment.scDescriptionEn.json[0].content[0].value
             : '',
-          schBetaPopup: cppContactFragment?.schBetaPopUp,
         },
         {
           linkId: oasContactFragment?.scId,
@@ -154,7 +150,6 @@ export async function getContactUsContent() {
           linkDescription: oasContactFragment?.scDescriptionEn?.json
             ? oasContactFragment.scDescriptionEn.json[0].content[0].value
             : '',
-          schBetaPopup: oasContactFragment?.schBetaPopUp,
         },
         {
           linkId: sinContactFragment?.scId,
@@ -164,22 +159,21 @@ export async function getContactUsContent() {
           linkDescription: sinContactFragment?.scDescriptionEn?.json
             ? sinContactFragment.scDescriptionEn.json[0].content[0].value
             : '',
-          schBetaPopup: sinContactFragment?.schBetaPopUp,
         },
       ],
     },
     fr: {
       breadcrumb:
-        response?.data.schPageV1ByPath.item.scBreadcrumbParentPages.map(
+        response?.data.schPageV1List.items[0].scBreadcrumbParentPages.map(
           (level) => {
             return {
               link: level.scPageNameFr,
               text: level.scTitleFr,
             }
           },
         ),
-      pageName: response?.data.schPageV1ByPath.item.scPageNameFr,
-      heading: response?.data.schPageV1ByPath.item.scTitleFr,
+      pageName: response?.data.schPageV1List.items[0].scPageNameFr,
+      heading: response?.data.schPageV1List.items[0].scTitleFr,
       subHeading: introFragment?.scContentFr?.json[0].content[0].value,
       links: [
         {
@@ -190,7 +184,6 @@ export async function getContactUsContent() {
           linkDescription: cdcpContactFragment?.scDescriptionFr?.json
             ? cdcpContactFragment.scDescriptionFr.json[0].content[0].value
             : '',
-          schBetaPopup: cdcpContactFragment?.schBetaPopUp,
         },
         {
           linkId: eiContactFragment?.scId,
@@ -200,7 +193,6 @@ export async function getContactUsContent() {
           linkDescription: eiContactFragment?.scDescriptionFr?.json
             ? eiContactFragment.scDescriptionFr.json[0].content[0].value
             : '',
-          schBetaPopup: eiContactFragment?.schBetaPopUp,
         },
         {
           linkId: cppContactFragment?.scId,
@@ -210,7 +202,6 @@ export async function getContactUsContent() {
           linkDescription: cppContactFragment?.scDescriptionFr?.json
             ? cppContactFragment.scDescriptionFr.json[0].content[0].value
             : '',
-          schBetaPopup: cppContactFragment?.schBetaPopUp,
         },
         {
           linkId: oasContactFragment?.scId,
@@ -220,7 +211,6 @@ export async function getContactUsContent() {
           linkDescription: oasContactFragment?.scDescriptionFr?.json
             ? oasContactFragment.scDescriptionFr.json[0].content[0].value
             : '',
-          schBetaPopup: oasContactFragment?.schBetaPopUp,
         },
         {
           linkId: sinContactFragment?.scId,
@@ -230,17 +220,16 @@ export async function getContactUsContent() {
           linkDescription: sinContactFragment?.scDescriptionFr?.json
             ? sinContactFragment.scDescriptionFr.json[0].content[0].value
             : '',
-          schBetaPopup: sinContactFragment?.schBetaPopUp,
         },
       ],
     },
   }
   return mappedSecurity
 }
 
-const findFragmentByScId = (res: GetSchContactUsV1 | null, id: string) => {
+const findFragmentByScId = (res: GetSchContactUsV2 | null, id: string) => {
   return (
-    res?.data.schPageV1ByPath.item.scFragments.find(
+    res?.data.schPageV1List.items[0].scFragments.find(
       ({ scId }) => scId === id,
     ) ?? null
   )