remove faker arg validation

Author: ncarbon

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

@@ -16,23 +16,8 @@ import type { CollectionState } from '../../modules/collection-tab';
 import { default as collectionTabReducer } from '../../modules/collection-tab';
 import type { ConnectionInfo } from '@mongodb-js/connection-info';
 import type { MockDataSchemaResponse } from '@mongodb-js/compass-generative-ai';
-import type { SinonSandbox } from 'sinon';
-import sinon from 'sinon';
-
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const { faker } = require('@faker-js/faker/locale/en');
 
 describe('MockDataGeneratorModal', () => {
-  let sandbox: SinonSandbox;
-
-  beforeEach(() => {
-    sandbox = sinon.createSandbox();
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
   async function renderModal({
     isOpen = true,
     currentStep = MockDataGeneratorStep.SCHEMA_CONFIRMATION,
@@ -323,7 +308,15 @@ describe('MockDataGeneratorModal', () => {
             {
               fieldPath: 'email',
               mongoType: 'string',
-              fakerMethod: 'internet.emailAddress',
+              fakerMethod: 'internet',
+              fakerArgs: [],
+              isArray: false,
+              probability: 1.0,
+            },
+            {
+              fieldPath: 'username',
+              mongoType: 'string',
+              fakerMethod: 'noSuchMethod',
               fakerArgs: [],
               isArray: false,
               probability: 1.0,
@@ -366,9 +359,6 @@ describe('MockDataGeneratorModal', () => {
     });
 
     it('shows correct values for the faker schema editor', async () => {
-      sandbox.stub(faker, 'person').returns('Jane');
-      sandbox.stub(faker, 'number').returns(30);
-      sandbox.stub(faker, 'internet').throws(new Error('Invalid faker method'));
       await renderModal({ mockServices: mockServicesWithMockDataResponse });
 
       // advance to the schema editor step
@@ -402,6 +392,14 @@ describe('MockDataGeneratorModal', () => {
           'Please select a function or we will default fill this field with the string "Unrecognized"'
         )
       ).to.exist;
+
+      // select the "username" field
+      userEvent.click(screen.getByText('username'));
+      expect(screen.getByText('username')).to.exist;
+      expect(screen.getByLabelText('JSON Type')).to.have.value('string');
+      expect(screen.getByLabelText('Faker Function')).to.have.value(
+        'Unrecognized'
+      );
     });
 
     it('disables the Next button when the faker schema mapping is not confirmed', async () => {

packages/compass-collection/src/modules/collection-tab.ts

@@ -43,8 +43,8 @@ import type {
   MockDataGeneratorState,
 } from '../components/mock-data-generator-modal/types';
 
-/* eslint-disable @typescript-eslint/no-require-imports */
-const { faker } = require('@faker-js/faker/locale/en');
+// @ts-expect-error TypeScript warns us about importing ESM module from CommonJS module, but we can ignore since this code will be consumed by webpack.
+import { faker } from '@faker-js/faker/locale/en';
 
 const DEFAULT_SAMPLE_SIZE = 100;
 
@@ -704,56 +704,23 @@ const validateFakerSchema = (
   logger: Logger
 ) => {
   return fakerSchema.content.fields.map((field) => {
-    const { fakerMethod, fakerArgs } = field;
+    const { fakerMethod } = field;
 
-    const [first, second] = fakerMethod.split('.');
-    try {
-      // Try with arguments first
-      const method = (faker as any)?.[first]?.[second];
-      if (typeof method !== 'function') {
-        throw new Error(`Faker method ${fakerMethod} is not a function`);
-      }
-      method(...fakerArgs);
-      return field;
-    } catch (error) {
-      // If that fails and there are arguments, try without arguments
-      if (fakerArgs.length > 0) {
-        try {
-          const method = (faker as any)?.[first]?.[second];
-          if (typeof method !== 'function') {
-            throw new Error(`Faker method ${fakerMethod} is not a function`);
-          }
-          method();
-          return field;
-        } catch (error) {
-          logger.debug(
-            mongoLogId(1_001_000_371),
-            'Collection',
-            'Failed to validate faker schema with arguments',
-            {
-              error: error instanceof Error ? error.message : String(error),
-              fakerMethod,
-              fakerArgs,
-            }
-          );
-        }
-      }
-      logger.debug(
-        mongoLogId(1_001_000_372),
+    const [firstLevel, secondLevel] = fakerMethod.split('.');
+    if (typeof (faker as any)[firstLevel]?.[secondLevel] !== 'function') {
+      logger.log.warn(
+        mongoLogId(1_001_000_365),
         'Collection',
-        'Failed to validate faker schema',
-        {
-          error: error instanceof Error ? error.message : String(error),
-          fakerMethod,
-          fakerArgs,
-        }
+        'Invalid faker method',
+        { fakerMethod }
       );
       return {
         ...field,
         fakerMethod: UNRECOGNIZED_FAKER_METHOD,
-        fakerArgs: [],
       };
     }
+
+    return field;
   });
 };