feat(Add mock data generator modal container) (CLOUD-333848)

packages/compass-collection/src/components/mock-data-generator-modal/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_OUTPUT_DOCS_COUNT = 1000;

packages/compass-collection/src/components/mock-data-generator-modal/mock-generator-modal.tsx

@@ -0,0 +1,104 @@
+import React, { useState } from 'react';
+
+import { css } from '@mongodb-js/compass-components';
+
+import {
+  Button,
+  Modal,
+  ModalHeader,
+  ModalBody,
+  ModalFooter,
+  ButtonVariant,
+} from '@mongodb-js/compass-components';
+import { MockDataGeneratorSteps } from './types';
+import { DEFAULT_OUTPUT_DOCS_COUNT } from './constants';
+
+const footerStyles = css`
+  flex-direction: row;
+  justify-content: space-between;
+`;
+
+const rightButtonsStyles = css`
+  display: flex;
+  gap: 8px;
+  flex-direction: row;
+`;
+
+interface Props {
+  isOpen: boolean;
+  setIsOpen: (isOpen: boolean) => void;
+}
+
+const MockDataGeneratorModal = ({ isOpen, setIsOpen }: Props) => {
+  const [currentStep, setCurrentStep] = useState<MockDataGeneratorSteps>(
+    MockDataGeneratorSteps.AI_DISCLAIMER
+  );
+  const [rawSchema, setRawSchema] = useState<string | null>(null);
+  const [fakerSchema, setFakerSchema] = useState<string | null>(null);
+  const [outputDocsCount, setOutputDocsCount] = useState<number>(
+    DEFAULT_OUTPUT_DOCS_COUNT
+  );
+  const [validationRules, setValidationRules] = useState<string | null>(null);
+  const [sampleDoc, setSampleDoc] = useState<string | null>(null);
+
+  const resetState = () => {
+    setCurrentStep(MockDataGeneratorSteps.AI_DISCLAIMER);
+    setRawSchema(null);
+    setFakerSchema(null);
+    setOutputDocsCount(DEFAULT_OUTPUT_DOCS_COUNT);
+    setValidationRules(null);
+    setSampleDoc(null);
+  };
+
+  const onNext = () => {
+    if (currentStep < MockDataGeneratorSteps.GENERATE_DATA) {
+      setCurrentStep(currentStep + 1);
+    } else {
+      // Final step, close the modal
+      setIsOpen(false);
+      resetState();
+    }
+  };
+
+  const onBack = () => {
+    if (currentStep > MockDataGeneratorSteps.AI_DISCLAIMER) {
+      setCurrentStep(currentStep - 1);
+    }
+  };
+
+  const onCancel = () => {
+    setIsOpen(false);
+  };
+
+  return (
+    <Modal
+      open={isOpen}
+      setOpen={() => setIsOpen(false)}
+      data-testid="generate-mock-data-modal"
+    >
+      <ModalHeader title="Generate Mock Data" />
+      <ModalBody>
+        {currentStep === MockDataGeneratorSteps.AI_DISCLAIMER && <div></div>}
+        {currentStep === MockDataGeneratorSteps.SCHEMA_CONFIRMATION && (
+          <div></div>
+        )}
+        {currentStep === MockDataGeneratorSteps.SCHEMA_EDITOR && <div></div>}
+        {currentStep === MockDataGeneratorSteps.DOCUMENT_COUNT && <div></div>}
+        {currentStep === MockDataGeneratorSteps.PREVIEW_DATA && <div></div>}
+        {currentStep === MockDataGeneratorSteps.GENERATE_DATA && <div></div>}
+      </ModalBody>
+
+      <ModalFooter className={footerStyles}>
+        <Button onClick={onBack}>Back</Button>
+        <div className={rightButtonsStyles}>
+          <Button onClick={onCancel}>Cancel</Button>
+          <Button variant={ButtonVariant.Primary} onClick={onNext}>
+            Next
+          </Button>
+        </div>
+      </ModalFooter>
+    </Modal>
+  );
+};
+
+export default MockDataGeneratorModal;

packages/compass-collection/src/components/mock-data-generator-modal/types.ts

@@ -0,0 +1,8 @@
+export enum MockDataGeneratorSteps {
+  AI_DISCLAIMER = 1,
+  SCHEMA_CONFIRMATION = 2,
+  SCHEMA_EDITOR = 3,
+  DOCUMENT_COUNT = 4,
+  PREVIEW_DATA = 5,
+  GENERATE_DATA = 6,
+}

packages/compass-telemetry/src/experimentation-provider.tsx

@@ -0,0 +1,86 @@
+import React, { createContext, useContext, useMemo } from 'react';
+
+interface ExperimentAssignmentData {
+  variant: string | null;
+  isInSample: boolean;
+}
+
+interface ExperimentData {
+  assignmentDate: Date;
+  entityId: string;
+  entityType: string;
+  id: string;
+  tag: string;
+  testGroupDatabaseId: string;
+  testGroupId: string;
+  testId: string;
+  testName: string;
+}
+
+interface SDKAssignment {
+  assignmentData: ExperimentAssignmentData;
+  experimentData: ExperimentData | null;
+}
+
+interface UseAssignmentResponse {
+  assignment: SDKAssignment | null;
+  asyncStatus: 'LOADING' | 'SUCCESS' | 'ERROR';
+  error?: Error;
+}
+
+interface BasicAPICallingFunctionOptions {
+  timeoutMs?: number;
+  team?: string;
+}
+
+type UseAssignmentHookFn = (
+  experimentName: string,
+  trackIsInSample: boolean,
+  options?: BasicAPICallingFunctionOptions
+) => UseAssignmentResponse;
+
+type AssignExperimentFn = (
+  experimentName: string,
+  options?: BasicAPICallingFunctionOptions
+) => Promise<'SUCCESS' | 'ERROR' | null>;
+
+interface CompassExperimentationProviderContextValue {
+  useAssignment: UseAssignmentHookFn;
+  assignExperiment: AssignExperimentFn;
+}
+
+const ExperimentationContext =
+  createContext<CompassExperimentationProviderContextValue>({
+    useAssignment() {
+      return {
+        assignment: null,
+        asyncStatus: 'SUCCESS' as const,
+      };
+    },
+    assignExperiment() {
+      return Promise.resolve(null);
+    },
+  });
+
+// Provider component that accepts MMS experiment utils as props
+export const CompassExperimentationProvider: React.FC<{
+  children: React.ReactNode;
+  useAssignment: UseAssignmentHookFn;
+  assignExperiment: AssignExperimentFn;
+}> = ({ children, useAssignment, assignExperiment }) => {
+  const contextValue = useMemo(
+    () => ({ useAssignment, assignExperiment }),
+    [useAssignment, assignExperiment]
+  );
+
+  return (
+    <ExperimentationContext.Provider value={contextValue}>
+      {children}
+    </ExperimentationContext.Provider>
+  );
+};
+
+// Hook for components to access experiment assignment
+export const useAssignment = (...args: Parameters<UseAssignmentHookFn>) => {
+  return useContext(ExperimentationContext).useAssignment(...args);
+};

packages/compass-telemetry/src/index.ts

@@ -5,3 +5,5 @@ export type {
   IdentifyTraits,
   ExtraConnectionData,
 } from './types';
+
+export { CompassExperimentationProvider } from './experimentation-provider';

packages/compass-web/src/index.tsx

@@ -4,3 +4,5 @@ export type {
   OpenWorkspaceOptions,
   WorkspaceTab,
 } from '@mongodb-js/compass-workspaces';
+
+export { CompassExperimentationProvider } from '@mongodb-js/compass-telemetry';