[PROD] - add some extra logging (#1522)

* Adding more logging
Stubbing out where stuff can go

* putting this back in

* not checking active so removing it

* cleaning up and adding comments

Author: travjenkins

src/services/types.ts

@@ -17,6 +17,7 @@ export enum CustomEvents {
     CAPTURE_MATERIALIZE_SUCCESS = 'Capture_Materialize_Success',
     CAPTURE_TEST = 'Capture_Test',
     COLLECTION_CREATE = 'Collection_Create',
+    CONNECTOR_VERSION_MISSING = 'Connector_Version:Missing',
     CONNECTOR_VERSION_UNSUPPORTED = 'Connector_Version:Unsupported',
     DATA_PLANE_SELECTOR = 'Data_Pane_Selector',
     DATE_TIME_PICKER_CHANGE = 'Date_Time_Picker:Change',

src/stores/DetailsForm/Hydrator.tsx

@@ -1,5 +1,6 @@
 import { useEntityType } from 'context/EntityContext';
 import { useEntityWorkflow } from 'context/Workflow';
+
 import { useEffectOnce } from 'react-use';
 import { logRocketConsole } from 'services/shared';
 import { BaseComponentProps } from 'types';

src/stores/DetailsForm/Store.ts

@@ -4,7 +4,7 @@ import { getLiveSpecs_detailsForm } from 'api/liveSpecsExt';
 import { GlobalSearchParams } from 'hooks/searchParams/useGlobalSearchParams';
 import produce from 'immer';
 import { isEmpty } from 'lodash';
-import { logRocketEvent } from 'services/shared';
+import { logRocketConsole, logRocketEvent } from 'services/shared';
 import { CustomEvents } from 'services/types';
 import { DATA_PLANE_SETTINGS } from 'settings/dataPlanes';
 import {
@@ -39,6 +39,9 @@ const getConnectorImage = async (
     connectorId: string,
     existingImageTag?: ConnectorVersionEvaluationOptions['existingImageTag']
 ): Promise<Details['data']['connectorImage'] | null> => {
+    logRocketConsole('DetailsFormHydrator>getConnectorImage', {
+        connectorId,
+    });
     const { data, error } = await getConnectors_detailsForm(connectorId);
 
     if (!error && data && data.length > 0) {
@@ -190,6 +193,9 @@ export const getInitialState = (
         set(
             produce((state: DetailsFormState) => {
                 if (connectorImage.id === '') {
+                    logRocketConsole(
+                        'DetailsFormHydrator>setDetails_connector>resetting'
+                    );
                     state.details.data.connectorImage =
                         getInitialStateData().details.data.connectorImage;
                 } else {
@@ -293,11 +299,24 @@ export const getInitialState = (
             workflow === 'capture_create' ||
             workflow === 'materialization_create';
 
+        logRocketConsole('DetailsFormHydrator>hydrateState', {
+            connectorId,
+            createWorkflow,
+            dataPlaneId,
+            liveSpecId,
+            searchParams: searchParams.toString(),
+            workflow,
+        });
+
         if (connectorId) {
             let dataPlaneOptions: DataPlaneOption[] = [];
 
             const dataPlaneResponse = await getDataPlaneOptions();
 
+            logRocketConsole(
+                'DetailsFormHydrator>hydrateState>getDataPlaneOptions'
+            );
+
             if (
                 !dataPlaneResponse.error &&
                 dataPlaneResponse.data &&
@@ -307,6 +326,9 @@ export const getInitialState = (
                     generateDataPlaneOption
                 );
 
+                logRocketConsole(
+                    'DetailsFormHydrator>hydrateState>setDataPlaneOptions'
+                );
                 get().setDataPlaneOptions(dataPlaneOptions);
             } else {
                 get().setHydrationError(
@@ -316,8 +338,25 @@ export const getInitialState = (
             }
 
             if (createWorkflow) {
+                logRocketConsole(
+                    'DetailsFormHydrator>hydrateState>createWorkflow'
+                );
                 const connectorImage = await getConnectorImage(connectorId);
+                logRocketConsole(
+                    'DetailsFormHydrator>hydrateState>createWorkflow>getConnectorImage',
+                    {
+                        connectorId: connectorImage?.connectorId,
+                        connectorImageId: connectorImage?.id,
+                    }
+                );
+
                 const dataPlane = getDataPlane(dataPlaneOptions, dataPlaneId);
+                logRocketConsole(
+                    'DetailsFormHydrator>hydrateState>createWorkflow>getDataPlane',
+                    {
+                        dataPlaneName: dataPlane?.dataPlaneName,
+                    }
+                );
 
                 if (!isProduction && connectorImage && dataPlane === null) {
                     get().setDetails_connector(connectorImage);
@@ -332,6 +371,10 @@ export const getInitialState = (
                         errors,
                     });
                 } else if (connectorImage && dataPlane !== null) {
+                    logRocketConsole(
+                        'DetailsFormHydrator>hydrateState>createWorkflow>setDetails_connector'
+                    );
+
                     get().setDetails_connector(connectorImage);
 
                     const {
@@ -345,6 +388,9 @@ export const getInitialState = (
                         errors,
                     });
                 } else {
+                    logRocketConsole(
+                        'DetailsFormHydrator>hydrateState>createWorkflow>setHydrationErrorsExist'
+                    );
                     get().setHydrationErrorsExist(true);
                 }
             } else if (liveSpecId) {
@@ -403,6 +449,13 @@ export const getInitialState = (
                 });
                 get().setHydrationErrorsExist(true);
             }
+        } else {
+            logRocketEvent(CustomEvents.CONNECTOR_VERSION_MISSING);
+            // TODO (details hydration) should really show an error here
+            // get().setHydrationError(
+            //     'Unable to locate selected connector. If the issue persists, please contact support.'
+            // );
+            // get().setHydrationErrorsExist(true);
         }
     },
 

src/stores/DetailsForm/types.ts

@@ -45,6 +45,14 @@ export interface Details extends Pick<JsonFormsCore, 'data' | 'errors'> {
     };
 }
 
+// TODO (search params) - need to stop getting search params from within zustand
+//  should pass in with optiosn like this one
+// export interface DetailsHydrateOptions {
+//     connectorId: string | null;
+//     dataPlaneId: string | null;
+//     liveSpecId: string | null;
+// }
+
 export interface DetailsFormState
     extends StoreWithHydration,
         StoreWithCustomErrors {