Added comments to multiple files as well as changed a couple of type any

Co-authored-by: Elena Atencio
<[email protected]>
Co-authored-by: Iris Wong
<[email protected]>
Co-authored-by: John Donato
<[email protected]>

Author: Jrcrz

app/context/ApplicationContext.tsx

@@ -87,6 +87,7 @@ const ApplicationContextProvider: React.FC<AppContextProps> = React.memo(props =
 
   /**
    * @function getSavedMetrics - a function that will wait for backend `savedMetricsResponse` to update metrics using `setSavedMetrics`
+   * Trying to find what the data type needs to be. 
    */
   const getSavedMetrics = useCallback(() => {
     ipcRenderer.send('savedMetricsRequest');

app/context/CommsContext.tsx

@@ -37,6 +37,12 @@ const CommsContextProvider: React.FC<Props> = React.memo((props) => {
     return false;
   }
 
+
+  /**
+   * @function fetchCommsData - uses useCallback Hook returns a memoized callback function.
+   * One reason to use useCallback is to prevent a component from re-rendering unless its props have changed.
+   * fetches the data
+   */
   const fetchCommsData = useCallback((app: string, live: boolean) => {
 
     if (app !== currentApp || live) {
@@ -47,6 +53,7 @@ const CommsContextProvider: React.FC<Props> = React.memo((props) => {
         let result: any;
         if (tryParseJSON(data)) result = JSON.parse(data);
         console.log('communication data from fetch request is: ', result);
+        console.log(data); 
         setCommsData(result);
       });
     }

app/context/EventContext.tsx

@@ -34,6 +34,14 @@ const EventContextProvider: React.FC<Props> = React.memo(({ children }) => {
     return false;
   }
 
+  /**
+   * @function fetchEventData - takes parameter arg. 
+   * Checks if arg is strictly equals to 'kafkametrics', if so removes the event listerner suing the ipcRenderer.removeAllListeners. 
+   * Sends a message using 'ipcRenderer.send'. 
+   * This function seems to be fetching event data and updating the state accordingly. 
+   * Problem: trying to change type any to something some concrete. 
+   */
+
   const fetchEventData = useCallback((arg: any) => {
     if (arg === 'kafkametrics') {
       ipcRenderer.removeAllListeners('kafkaResponse');

app/context/HealthContext.tsx

@@ -34,10 +34,15 @@ const HealthContextProvider: React.FC<Props> = React.memo(({ children }) => {
     return false;
   }
 
+
+  /**
+   * @function fetchEventData - sending a request to the backend to retrieve data. 
+   * Data is then parsed and the setHealthData is then set. 
+   */
   const fetchHealthData = useCallback(serv => {
     ipcRenderer.removeAllListeners('healthResponse');
 
-    let temp: any[] = [];
+    let temp: string[] = [];
     console.log('the cb being passed into fetch health data from graphscontainer is: ', serv);
 
     Promise.all(

electron/routes/data.ts

@@ -193,7 +193,6 @@ ipcMain.on('dockerRequest', async (message, service) => {
 ipcMain.on('savedMetricsRequest', async (message: Electron.IpcMainEvent) => {
   try {
     let result: any = {};
-
     // Mongo Database
     if (currentDatabaseType === 'MongoDB') {
       // Get all documents from the services collection