💸 Tech Debt - Migrate CRMService (#1496)

* Added allsettled * Added scope as argument * Created basic tester endpoint * Added error handling * schema changes * Schema addition * Created working Dynamics fetching * Migrated internal speakers service to v3 Next.js API * Removed log * Added key vault secrets to pipeline * Added warning for missing env variables * Removed redundant try-catch, removed potentially exposing error messages * Moved Dynamics scopes to const
SSWConsulting · Oct 11, 2023 · 3254a7d · 3254a7d
1 parent 3c8fd38
commit 3254a7d
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 31 deletions.
diff --git a/.env.example b/.env.example
@@ -38,6 +38,10 @@ SHAREPOINT_SITE_ID=***
 SHAREPOINT_EVENTS_LIST_ID=***
 SHAREPOINT_EXTERNAL_PRESENTERS_LIST_ID=***
 
+# Dynamics - Fetching Internal Speakers for Events
+DYNAMICS_CLIENT_ID=***
+DYNAMICS_CLIENT_SECRET=***
+
 # Turn on the NextJS bundle analyzer (https://www.npmjs.com/package/@next/bundle-analyzer)
 BUNDLE_ANALYSE=false
 
diff --git a/.github/workflows/template-build.yml b/.github/workflows/template-build.yml
@@ -97,7 +97,9 @@ jobs:
               "MICROSOFT_OAUTH_CLIENT_SECRET": "MICROSOFT-OAUTH-CLIENT-SECRET",
               "SHAREPOINT_SITE_ID": "SHAREPOINT-SITE-ID",
               "SHAREPOINT_EVENTS_LIST_ID": "SHAREPOINT-EVENTS-LIST-ID",
-              "SHAREPOINT_EXTERNAL_PRESENTERS_LIST_ID": "SHAREPOINT-EXTERNAL-PRESENTERS-LIST-ID"
+              "SHAREPOINT_EXTERNAL_PRESENTERS_LIST_ID": "SHAREPOINT-EXTERNAL-PRESENTERS-LIST-ID",
+              "DYNAMICS_CLIENT_ID": "DYNAMICS-CLIENT-ID",
+              "DYNAMICS_CLIENT_SECRET": "DYNAMICS-CLIENT-SECRET"
             }
 
       - name: AppInsight - Connection Strings

diff --git a/infra/appSerivce-create-slot.bicep b/infra/appSerivce-create-slot.bicep
@@ -68,6 +68,14 @@ var appSettings = [
     name: 'RECAPTCHA_BYPASS_SECRET'
     value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/SECRET-KEY-TO-BYPASS-RECAPTCHA)'
   }
+  {
+    name: 'DYNAMICS_CLIENT_ID'
+    value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/DYNAMICS-CLIENT-ID)'
+  }
+  {
+    name: 'DYNAMICS_CLIENT_SECRET'
+    value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/DYNAMICS-CLIENT-SECRET)'
+  }
 ]
 
 

diff --git a/infra/appService.bicep b/infra/appService.bicep
@@ -113,6 +113,14 @@ var appSettings = [
     name: 'RECAPTCHA_BYPASS_SECRET'
     value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/SECRET-KEY-TO-BYPASS-RECAPTCHA)'
   }
+  {
+    name: 'DYNAMICS_CLIENT_ID'
+    value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/DYNAMICS-CLIENT-ID)'
+  }
+  {
+    name: 'DYNAMICS_CLIENT_SECRET'
+    value: '@Microsoft.KeyVault(SecretUri=https://${keyVaultName}.vault.azure.net/secrets/DYNAMICS-CLIENT-SECRET)'
+  }
 ]
 
 resource appService 'Microsoft.Web/sites@2022-03-01' = {

diff --git a/pages/api/get-past-events.ts b/pages/api/get-past-events.ts
@@ -66,7 +66,7 @@ export default async function handler(
         properties,
         severity: appInsights.Contracts.SeverityLevel.Error,
       });
-      res.status(500).json({ message: err.message });
+      res.status(500).json({ message: "SharePoint request failed" });
     }
   } else {
     res.status(405).json({ message: "Unsupported method" });

diff --git a/pages/api/get-speakers.ts b/pages/api/get-speakers.ts
@@ -69,7 +69,7 @@ export default async function handler(
         properties,
         severity: appInsights.Contracts.SeverityLevel.Error,
       });
-      res.status(500).json({ message: err.message });
+      res.status(500).json({ message: "Speaker request failed" });
     }
   } else {
     res.status(405).json({ message: "Unsupported method" });

diff --git a/pages/api/get-upcoming-events.ts b/pages/api/get-upcoming-events.ts
@@ -72,7 +72,7 @@ export default async function handler(
         properties,
         severity: appInsights.Contracts.SeverityLevel.Error,
       });
-      res.status(500).json({ message: err.message });
+      res.status(500).json({ message: "SharePoint request failed" });
     }
   } else {
     res.status(405).json({ message: "Unsupported method" });

diff --git a/services/server/events.ts b/services/server/events.ts
@@ -6,19 +6,26 @@ const EVENTS_LIST_ID = process.env.SHAREPOINT_EVENTS_LIST_ID;
 const EXTERNAL_PRESENTERS_LIST_ID =
   process.env.SHAREPOINT_EXTERNAL_PRESENTERS_LIST_ID;
 
-export const getToken = async () => {
+const SHAREPOINT_SCOPES = ["https://graph.microsoft.com/.default"];
+const DYNAMICS_SCOPES = ["https://ssw.crm6.dynamics.com/.default"];
+
+export const getToken = async (
+  scopes: string[],
+  clientId: string,
+  clientSecret
+) => {
   const clientConfig = {
     auth: {
-      clientId: process.env.MICROSOFT_OAUTH_CLIENT_ID,
+      clientId,
       authority: `https://login.microsoftonline.com/${process.env.MICROSOFT_OAUTH_TENANT_ID}`,
-      clientSecret: process.env.MICROSOFT_OAUTH_CLIENT_SECRET,
+      clientSecret,
     },
   };
 
   const clientApp = new msal.ConfidentialClientApplication(clientConfig);
 
   const authParams = {
-    scopes: ["https://graph.microsoft.com/.default"],
+    scopes,
   };
 
   const authRes = await clientApp.acquireTokenByClientCredential(authParams);
@@ -37,7 +44,11 @@ export const getEvents = async (odataFilter: string): Promise<EventInfo[]> => {
     return [];
   }
 
-  const token = await getToken();
+  const token = await getToken(
+    SHAREPOINT_SCOPES,
+    process.env.MICROSOFT_OAUTH_CLIENT_ID,
+    process.env.MICROSOFT_OAUTH_CLIENT_SECRET
+  );
 
   const eventsRes = await axios.get<{ value: { fields: EventInfo }[] }>(
     `https://graph.microsoft.com/v1.0/sites/${SITE_ID}/lists/${EVENTS_LIST_ID}/items?expand=fields&${odataFilter}`,
@@ -69,7 +80,11 @@ export const getSpeakersInfo = async (ids?: number[], emails?: string[]) => {
   }
 
   if (ids?.length) {
-    const token = await getToken();
+    const token = await getToken(
+      SHAREPOINT_SCOPES,
+      process.env.MICROSOFT_OAUTH_CLIENT_ID,
+      process.env.MICROSOFT_OAUTH_CLIENT_SECRET
+    );
 
     const idSpeakers: SpeakerInfo[] = await Promise.all(
       ids.map(async (id) => {
@@ -94,35 +109,88 @@ export const getSpeakersInfo = async (ids?: number[], emails?: string[]) => {
   }
 
   if (emails?.length) {
-    await Promise.all(
-      emails.map(async (email) => {
-        const internalSpeakerRes = await axios.get<InternalSpeakerInfo>(
-          "https://www.ssw.com.au/ssw/CRMService.aspx",
-          {
-            params: { odata: encodeURIComponent(email) },
-          }
-        );
+    const internalSpeakers = await getInternalSpeakers(emails);
 
-        if (internalSpeakerRes.status === 200 && internalSpeakerRes.data) {
-          const internalSpeaker = internalSpeakerRes.data;
-          speakers.push({
-            Title: internalSpeaker.Nickname
-              ? `${internalSpeaker.FirstName} (${internalSpeaker.Nickname}) ${internalSpeaker.LastName}`
-              : `${internalSpeaker.FirstName} ${internalSpeaker.LastName}`,
-            PresenterProfileImage: {
-              Url: internalSpeaker.PhotoURL,
-            },
-            PresenterShortDescription: internalSpeaker.ShortDescription,
-            PresenterProfileLink: internalSpeaker.ProfileURL,
-          });
-        }
+    const internalSpeakersInfo: SpeakerInfo[] = internalSpeakers.map(
+      (internalSpeaker) => ({
+        Title: internalSpeaker.Nickname
+          ? `${internalSpeaker.FirstName} (${internalSpeaker.Nickname}) ${internalSpeaker.LastName}`
+          : `${internalSpeaker.FirstName} ${internalSpeaker.LastName}`,
+        PresenterProfileImage: {
+          Url: internalSpeaker.PhotoURL,
+        },
+        PresenterShortDescription: internalSpeaker.ShortDescription,
+        PresenterProfileLink: internalSpeaker.ProfileURL,
       })
     );
+
+    speakers.push(...internalSpeakersInfo);
   }
 
   return speakers;
 };
 
+export const getInternalSpeakers = async (
+  emails: string[]
+): Promise<InternalSpeakerInfo[]> => {
+  if (
+    process.env.NODE_ENV === "development" &&
+    (!process.env.DYNAMICS_CLIENT_ID || !process.env.DYNAMICS_CLIENT_SECRET)
+  ) {
+    console.warn(
+      "⚠️ You are missing the Dynamics 365 environment variables required for speakers. Please see the .env.example file for the required variables."
+    );
+    return [];
+  }
+
+  const accessToken = await getToken(
+    DYNAMICS_SCOPES,
+    process.env.DYNAMICS_CLIENT_ID,
+    process.env.DYNAMICS_CLIENT_SECRET
+  );
+
+  let odataFilter = "";
+
+  emails.forEach((email, index) => {
+    if (index === emails.length - 1) {
+      odataFilter += `internalemailaddress eq '${email}'`;
+    } else {
+      odataFilter += `internalemailaddress eq '${email}' or `;
+    }
+  });
+
+  const internalSpeakersRes = await axios.get(
+    "https://ssw.crm6.dynamics.com/api/data/v9.2/systemusers?$select=firstname,lastname,nickname,photourl,ssw_githuburl,ssw_publicprofileurl,ssw_shortdescription,internalemailaddress&$filter=" +
+      odataFilter,
+    {
+      headers: {
+        Authorization: "Bearer " + accessToken,
+        Accept: "application/json",
+        "OData-MaxVersion": "4.0",
+        "OData-Version": "4.0",
+      },
+    }
+  );
+
+  if (internalSpeakersRes?.data?.value?.length > 0) {
+    const speakers: InternalSpeakerInfo[] = internalSpeakersRes.data.value.map(
+      (user) => ({
+        FirstName: user.firstname,
+        LastName: user.lastname,
+        Nickname: user.nickname,
+        PhotoURL: user.photourl,
+        GitHubURL: user.ssw_githuburl,
+        ProfileURL: user.ssw_publicprofileurl,
+        ShortDescription: user.ssw_shortdescription,
+      })
+    );
+
+    return speakers;
+  } else {
+    return [];
+  }
+};
+
 export type BookingFormSubmissionData = {
   Name: string;
   Topic: string;