change to use limit as pref

Author: nbbeeken

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-options/pipeline-collation.tsx

@@ -14,7 +14,7 @@ import {
 import type { RootState } from '../../../modules';
 import { collationStringChanged } from '../../../modules/collation-string';
 import { maxTimeMSChanged } from '../../../modules/max-time-ms';
-import { DEFAULT_MAX_TIME_MS, WEB_MAX_TIME_MS_LIMIT } from '../../../constants';
+import { DEFAULT_MAX_TIME_MS } from '../../../constants';
 import { usePreference } from 'compass-preferences-model/provider';
 
 const pipelineOptionsContainerStyles = css({
@@ -59,46 +59,46 @@ const PipelineCollation: React.FunctionComponent<PipelineCollationProps> = ({
   maxTimeMSValue,
   maxTimeMSChanged,
 }) => {
-  const showMaxTimeMSWarning = Boolean(usePreference('showMaxTimeMSWarning'));
+  const maxTimeMSEnvLimit = usePreference('maxTimeMSEnvLimit');
 
   const onMaxTimeMSChanged = useCallback(
     (evt: React.ChangeEvent<HTMLInputElement>) => {
       if (maxTimeMSChanged) {
         const parsed = Number(evt.currentTarget.value);
         const newValue = Number.isNaN(parsed) ? 0 : parsed;
 
-        // When warning is enabled, enforce the hard limit
-        if (showMaxTimeMSWarning && newValue > WEB_MAX_TIME_MS_LIMIT) {
-          maxTimeMSChanged(WEB_MAX_TIME_MS_LIMIT);
+        // When environment limit is set (> 0), enforce it
+        if (maxTimeMSEnvLimit && newValue > maxTimeMSEnvLimit) {
+          maxTimeMSChanged(maxTimeMSEnvLimit);
         } else {
           maxTimeMSChanged(newValue);
         }
       }
     },
-    [maxTimeMSChanged, showMaxTimeMSWarning]
+    [maxTimeMSChanged, maxTimeMSEnvLimit]
   );
 
   const maxTimeMSLimit = usePreference('maxTimeMS');
 
-  // Determine the effective max limit when warning is enabled
+  // Determine the effective max limit when environment limit is set (> 0)
   const effectiveMaxLimit = useMemo(() => {
-    if (showMaxTimeMSWarning) {
+    if (maxTimeMSEnvLimit) {
       return maxTimeMSLimit
-        ? Math.min(maxTimeMSLimit, WEB_MAX_TIME_MS_LIMIT)
-        : WEB_MAX_TIME_MS_LIMIT;
+        ? Math.min(maxTimeMSLimit, maxTimeMSEnvLimit)
+        : maxTimeMSEnvLimit;
     }
     return maxTimeMSLimit;
-  }, [showMaxTimeMSWarning, maxTimeMSLimit]);
+  }, [maxTimeMSEnvLimit, maxTimeMSLimit]);
 
-  // Check if value exceeds the limit when warning is enabled
+  // Check if value exceeds the environment limit (when limit > 0)
   const exceedsLimit = Boolean(
     useMemo(() => {
       return (
-        showMaxTimeMSWarning &&
+        maxTimeMSEnvLimit &&
         maxTimeMSValue &&
-        maxTimeMSValue >= WEB_MAX_TIME_MS_LIMIT
+        maxTimeMSValue >= maxTimeMSEnvLimit
       );
-    }, [showMaxTimeMSWarning, maxTimeMSValue])
+    }, [maxTimeMSEnvLimit, maxTimeMSValue])
   );
 
   return (

packages/compass-aggregations/src/constants.ts

@@ -1,10 +1,3 @@
-/**
- * Data Explorer limits (5 minutes = 300,000ms)
- * This limit is artificial but necessary for the backend that powers DE.
- * https://github.com/10gen/mms/blob/dea184f4a40db0a64ed0d6665d36265f62ae4f65/server/src/main/com/xgen/cloud/services/clusterconnection/runtime/ws/ClusterConnectionServerProvider.java#L50-L51
- */
-export const WEB_MAX_TIME_MS_LIMIT = 300_000;
-
 /**
  * Default for maxTimeMS option.
  */

packages/compass-preferences-model/src/preferences-schema.tsx

@@ -106,7 +106,7 @@ export type UserConfigurablePreferences = PermanentFeatureFlags &
     proxy: string;
     inferNamespacesFromPrivileges?: boolean;
     // Features that are enabled by default in Date Explorer, but are disabled in Compass
-    showMaxTimeMSWarning?: boolean;
+    maxTimeMSEnvLimit?: number;
   };
 
 /**
@@ -1064,15 +1064,16 @@ export const storedUserPreferencesProps: Required<{
     validator: z.boolean().default(true),
     type: 'boolean',
   },
-  showMaxTimeMSWarning: {
+  maxTimeMSEnvLimit: {
     ui: true,
     cli: true,
     global: true,
     description: {
-      short: 'Show Max Time MS over 5min Warning for Data Explorer',
+      short:
+        'Maximum time limit for operations in environment (milliseconds). Set to 0 for no limit.',
     },
-    validator: z.boolean().default(false),
-    type: 'boolean',
+    validator: z.number().min(0).default(0),
+    type: 'number',
   },
 
   ...allFeatureFlagsProps,

packages/compass-query-bar/src/components/query-option.tsx

@@ -11,10 +11,7 @@ import {
 } from '@mongodb-js/compass-components';
 import { connect } from '../stores/context';
 import OptionEditor from './option-editor';
-import {
-  OPTION_DEFINITION,
-  WEB_MAX_TIME_MS_LIMIT,
-} from '../constants/query-option-definition';
+import { OPTION_DEFINITION } from '../constants/query-option-definition';
 import type {
   QueryOptionOfTypeDocument,
   QueryOption as QueryOptionType,
@@ -159,7 +156,7 @@ const QueryOption: React.FunctionComponent<QueryOptionProps> = ({
   }, [track, name, connectionInfoRef]);
 
   // MaxTimeMS warning tooltip logic
-  const showMaxTimeMSWarning = Boolean(usePreference('showMaxTimeMSWarning'));
+  const maxTimeMSEnvLimit = usePreference('maxTimeMSEnvLimit');
   const numericValue = useMemo(() => {
     if (!value) return 0;
     const parsed = Number(value);
@@ -169,10 +166,10 @@ const QueryOption: React.FunctionComponent<QueryOptionProps> = ({
   const exceedsMaxTimeMSLimit = useMemo(() => {
     return (
       name === 'maxTimeMS' &&
-      showMaxTimeMSWarning &&
-      numericValue >= WEB_MAX_TIME_MS_LIMIT
+      maxTimeMSEnvLimit && // 0 is falsy, so no limit when 0
+      numericValue >= maxTimeMSEnvLimit
     );
-  }, [name, showMaxTimeMSWarning, numericValue]);
+  }, [name, maxTimeMSEnvLimit, numericValue]);
 
   return (
     <div

packages/compass-query-bar/src/constants/query-option-definition.ts

@@ -9,13 +9,6 @@ export type QueryOptionOfTypeDocument = Exclude<
   'maxTimeMS' | 'limit' | 'skip'
 >;
 
-/**
- * Data Explorer limits (5 minutes = 300,000ms)
- * This limit is artificial but necessary for the backend that powers DE.
- * https://github.com/10gen/mms/blob/dea184f4a40db0a64ed0d6665d36265f62ae4f65/server/src/main/com/xgen/cloud/services/clusterconnection/runtime/ws/ClusterConnectionServerProvider.java#L50-L51
- */
-export const WEB_MAX_TIME_MS_LIMIT = 300_000;
-
 export const OPTION_DEFINITION: {
   [optionName in QueryOption]: {
     name: optionName;
@@ -77,14 +70,13 @@ export const OPTION_DEFINITION: {
     link: 'https://docs.mongodb.com/manual/reference/method/cursor.maxTimeMS/',
     extraTextInputProps() {
       const preferenceMaxTimeMS = usePreference('maxTimeMS');
-      const showMaxTimeMSWarning =
-        usePreference('showMaxTimeMSWarning') ?? false;
+      const maxTimeMSEnvLimit = usePreference('maxTimeMSEnvLimit');
 
-      // Determine the effective max limit when warning is enabled
-      const effectiveMaxLimit = showMaxTimeMSWarning
+      // Determine the effective max limit when environment limit is set (> 0)
+      const effectiveMaxLimit = maxTimeMSEnvLimit
         ? preferenceMaxTimeMS
-          ? Math.min(preferenceMaxTimeMS, WEB_MAX_TIME_MS_LIMIT)
-          : WEB_MAX_TIME_MS_LIMIT
+          ? Math.min(preferenceMaxTimeMS, maxTimeMSEnvLimit)
+          : maxTimeMSEnvLimit
         : preferenceMaxTimeMS;
 
       const props: {
@@ -94,8 +86,8 @@ export const OPTION_DEFINITION: {
         max: effectiveMaxLimit,
       };
 
-      if (effectiveMaxLimit !== undefined && effectiveMaxLimit < 60000) {
-        props.placeholder = String(effectiveMaxLimit);
+      if (effectiveMaxLimit && effectiveMaxLimit < 60000) {
+        props.placeholder = `${+effectiveMaxLimit}`;
       }
 
       return props;

packages/compass-query-bar/src/stores/query-bar-reducer.ts

@@ -52,7 +52,7 @@ type QueryBarState = {
 
 export const INITIAL_STATE: QueryBarState = {
   isReadonlyConnection: false,
-  fields: mapQueryToFormFields({}, DEFAULT_FIELD_VALUES),
+  fields: mapQueryToFormFields({ maxTimeMSEnvLimit: 0 }, DEFAULT_FIELD_VALUES),
   expanded: false,
   serverVersion: '3.6.0',
   lastAppliedQuery: { source: null, query: {} },
@@ -103,9 +103,7 @@ export const changeField = (
   return (dispatch, getState, { preferences }) => {
     const parsedValue = validateField(name, stringValue, {
       maxTimeMS: preferences.getPreferences().maxTimeMS ?? undefined,
-      showMaxTimeMSWarning: Boolean(
-        preferences.getPreferences().showMaxTimeMSWarning
-      ),
+      maxTimeMSEnvLimit: preferences.getPreferences().maxTimeMSEnvLimit,
     });
     const isValid = parsedValue !== false;
     dispatch({
@@ -165,11 +163,7 @@ export const resetQuery = (
       return false;
     }
     const fields = mapQueryToFormFields(
-      {
-        maxTimeMS: preferences.getPreferences().maxTimeMS,
-        showMaxTimeMSWarning:
-          preferences.getPreferences().showMaxTimeMSWarning ?? false,
-      },
+      preferences.getPreferences(),
       DEFAULT_FIELD_VALUES
     );
     dispatch({ type: QueryBarActions.ResetQuery, fields, source });
@@ -186,10 +180,7 @@ export const setQuery = (
   query: BaseQuery
 ): QueryBarThunkAction<void, SetQueryAction> => {
   return (dispatch, getState, { preferences }) => {
-    const fields = mapQueryToFormFields(
-      { maxTimeMS: preferences.getPreferences().maxTimeMS },
-      query
-    );
+    const fields = mapQueryToFormFields(preferences.getPreferences(), query);
     dispatch({ type: QueryBarActions.SetQuery, fields });
   };
 };
@@ -245,14 +236,11 @@ export const applyFromHistory = (
       }
       return acc;
     }, {});
-    const fields = mapQueryToFormFields(
-      { maxTimeMS: preferences.getPreferences().maxTimeMS },
-      {
-        ...DEFAULT_FIELD_VALUES,
-        ...query,
-        ...currentQuery,
-      }
-    );
+    const fields = mapQueryToFormFields(preferences.getPreferences(), {
+      ...DEFAULT_FIELD_VALUES,
+      ...query,
+      ...currentQuery,
+    });
     dispatch({
       type: QueryBarActions.ApplyFromHistory,
       fields,

packages/compass-query-bar/src/utils/query.ts

@@ -14,7 +14,6 @@ import type {
   QueryProperty,
 } from '../constants/query-properties';
 import { QUERY_PROPERTIES } from '../constants/query-properties';
-import { WEB_MAX_TIME_MS_LIMIT } from '../constants/query-option-definition';
 
 export function mapFormFieldsToQuery(fields: QueryFormFields): BaseQuery {
   // We always want filter field to be in the query, even if the field
@@ -57,7 +56,7 @@ export function doesQueryHaveExtraOptionsSet(fields?: QueryFormFields) {
 
 export function parseQueryAttributesToFormFields(
   query: Record<string, unknown>,
-  preferences: Pick<UserPreferences, 'maxTimeMS' | 'showMaxTimeMSWarning'>
+  preferences: Pick<UserPreferences, 'maxTimeMS' | 'maxTimeMSEnvLimit'>
 ): QueryFormFields {
   return Object.fromEntries(
     Object.entries(query)
@@ -82,7 +81,7 @@ export function parseQueryAttributesToFormFields(
  * Map query document to the query fields state only preserving valid values
  */
 export function mapQueryToFormFields(
-  preferences: Pick<UserPreferences, 'maxTimeMS' | 'showMaxTimeMSWarning'>,
+  preferences: Pick<UserPreferences, 'maxTimeMS' | 'maxTimeMSEnvLimit'>,
   query?: BaseQuery,
   onlyValid = true
 ): QueryFormFields {
@@ -128,8 +127,8 @@ export function validateField(
   value: string,
   {
     maxTimeMS: preferencesMaxTimeMS,
-    showMaxTimeMSWarning,
-  }: Pick<UserPreferences, 'maxTimeMS' | 'showMaxTimeMSWarning'>
+    maxTimeMSEnvLimit,
+  }: Pick<UserPreferences, 'maxTimeMS' | 'maxTimeMSEnvLimit'>
 ) {
   const validated = validate(field, value);
   if (field === 'filter' && validated === '') {
@@ -141,15 +140,15 @@ export function validateField(
   }
 
   // Additional validation for maxTimeMS to make sure that we are not over the
-  // upper bound set in preferences or Data Explorer limits
+  // upper bound set in preferences or environment limits
   if (field === 'maxTimeMS') {
     const maxTimeMS = Number(value);
 
-    // When warning is enabled, enforce hard limit
+    // When environment limit is set (> 0), enforce it
     if (
-      showMaxTimeMSWarning &&
+      maxTimeMSEnvLimit &&
       !Number.isNaN(maxTimeMS) &&
-      maxTimeMS > WEB_MAX_TIME_MS_LIMIT
+      maxTimeMS > maxTimeMSEnvLimit
     ) {
       return false;
     }
@@ -175,7 +174,7 @@ export function validateField(
 
 export function isQueryFieldsValid(
   fields: QueryFormFields,
-  preferences: Pick<UserPreferences, 'maxTimeMS' | 'showMaxTimeMSWarning'>
+  preferences: Pick<UserPreferences, 'maxTimeMS' | 'maxTimeMSEnvLimit'>
 ) {
   return Object.entries(fields).every(
     ([key, value]) => validateField(key, value.string, preferences) !== false

packages/compass-web/src/entrypoint.tsx

@@ -384,7 +384,7 @@ const CompassWeb = ({
   });
   const preferencesAccess = useCompassWebPreferences({
     ...initialPreferences,
-    showMaxTimeMSWarning: true,
+    maxTimeMSEnvLimit: 300_000, // 5 minutes limit for Data Explorer
   });
   // TODO (COMPASS-9565): My Queries feature flag will be used to conditionally provide storage providers
   const initialWorkspaceRef = useRef(initialWorkspace);