chore: moved usage of compass-preferences-model to compass-preference…

…s-model/provider COMPASS-7559 (#5371)

* chore: moved usage of compass-preferences-model to compass-preferences-model/provider

* chore: remove capMaxTimeMSAtPreferenceLimit from main export

* chore: moved initial value derivation back to Preferences class, outside of Storage

* chore: fixes the tests with broken import

configs/eslint-config-compass/plugin.js

@@ -24,8 +24,7 @@ module.exports = {
       // restrictedProviderImport('@mongodb-js/my-queries-storage'),
       // TODO(COMPASS-7412): enable when possible
       // restrictedProviderImport('@mongodb-js/atlas-service'),
-      // TODO(COMPASS-7559): enable when possible
-      // restrictedProviderImport('compass-preferences-model'),
+      restrictedProviderImport('compass-preferences-model'),
       {
         paths: require('module').builtinModules,
         message: 'Using Node.js built-in modules in plugins is not allowed.',

packages/compass-aggregations/src/components/focus-mode/focus-mode-modal-header.tsx

@@ -24,7 +24,7 @@ import {
 import { changeStageDisabled } from '../../modules/pipeline-builder/stage-editor';
 import type { StoreStage } from '../../modules/pipeline-builder/stage-editor';
 import { getInsightForStage } from '../../utils/insights';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import { createSearchIndex } from '../../modules/search-indexes';
 import type { ServerEnvironment } from '../../modules/env';
 

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-as-text-workspace/pipeline-stages-preview.tsx

@@ -20,7 +20,7 @@ import {
   MERGE_STAGE_PREVIEW_TEXT,
   OUT_STAGE_PREVIEW_TEXT,
 } from '../../../constants';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const bannerStyles = css({
   alignItems: 'center',

packages/compass-aggregations/src/components/pipeline-toolbar/index.tsx

@@ -7,7 +7,7 @@ import {
   useDarkMode,
 } from '@mongodb-js/compass-components';
 import { connect } from 'react-redux';
-import { useIsAIFeatureEnabled } from 'compass-preferences-model';
+import { useIsAIFeatureEnabled } from 'compass-preferences-model/provider';
 
 import PipelineHeader from './pipeline-header';
 import PipelineOptions from './pipeline-options';

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-ai.tsx

@@ -2,7 +2,7 @@ import React, { useRef, useEffect, useCallback } from 'react';
 import { openToast } from '@mongodb-js/compass-components';
 import { GenerativeAIInput } from '@mongodb-js/compass-generative-ai';
 import { connect } from 'react-redux';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 import {
   changeAIPromptText,

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-header/index.tsx

@@ -14,7 +14,7 @@ import PipelineStages from './pipeline-stages';
 import PipelineActions from './pipeline-actions';
 import SavedPipelines from '../../saved-pipelines/saved-pipelines';
 import type { RootState } from '../../../modules';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const containerStyles = css({
   display: 'flex',

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-header/pipeline-actions.tsx

@@ -25,7 +25,7 @@ import { openCreateIndexModal } from '../../../modules/insights';
 import {
   usePreference,
   useIsAIFeatureEnabled,
-} from 'compass-preferences-model';
+} from 'compass-preferences-model/provider';
 import { showInput as showAIInput } from '../../../modules/pipeline-builder/pipeline-ai';
 
 const containerStyles = css({

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-header/pipeline-stages.tsx

@@ -11,7 +11,7 @@ import {
   Icon,
 } from '@mongodb-js/compass-components';
 import { AIExperienceEntry } from '@mongodb-js/compass-generative-ai';
-import { useIsAIFeatureEnabled } from 'compass-preferences-model';
+import { useIsAIFeatureEnabled } from 'compass-preferences-model/provider';
 
 import type { RootState } from '../../../modules';
 import { editPipeline } from '../../../modules/workspace';

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

@@ -14,7 +14,7 @@ import type { RootState } from '../../../modules';
 import { collationStringChanged } from '../../../modules/collation-string';
 import { maxTimeMSChanged } from '../../../modules/max-time-ms';
 import { DEFAULT_MAX_TIME_MS } from '../../../constants';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const pipelineOptionsContainerStyles = css({
   paddingTop: spacing[1],

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-settings/index.tsx

@@ -8,7 +8,7 @@ import PipelineExtraSettings from './pipeline-extra-settings';
 import type { RootState } from '../../../modules';
 import { getIsPipelineInvalidFromBuilderState } from '../../../modules/pipeline-builder/builder-helpers';
 import { confirmNewPipeline } from '../../../modules/is-new-pipeline-confirm';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import { hiddenOnNarrowPipelineToolbarStyles } from '../pipeline-toolbar-container';
 import ModifySourceBanner from '../../modify-source-banner';
 

packages/compass-aggregations/src/components/settings/settings.tsx

@@ -14,7 +14,7 @@ import {
 } from '@mongodb-js/compass-components';
 
 import { DEFAULT_SAMPLE_SIZE, DEFAULT_LARGE_LIMIT } from '../../constants';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const aggregationCommentModeId = 'aggregation-comment-mode';
 const aggregationCommentModeDescriptionId =

packages/compass-aggregations/src/components/stage-preview/output-stage-preview.tsx

@@ -20,7 +20,7 @@ import {
   MERGE_STAGE_PREVIEW_TEXT,
   OUT_STAGE_PREVIEW_TEXT,
 } from '../../constants';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const stagePreviewStyles = css({
   display: 'flex',

packages/compass-aggregations/src/components/stage-toolbar/index.tsx

@@ -20,7 +20,7 @@ import { enableFocusMode } from '../../modules/focus-mode';
 import OptionMenu from './option-menu';
 import type { StoreStage } from '../../modules/pipeline-builder/stage-editor';
 import { getInsightForStage } from '../../utils/insights';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import type { ServerEnvironment } from '../../modules/env';
 import { createSearchIndex } from '../../modules/search-indexes';
 

packages/compass-aggregations/src/components/stage-toolbar/stage-operator-select.tsx

@@ -1,5 +1,5 @@
 import React, { useCallback } from 'react';
-import { withPreferences } from 'compass-preferences-model';
+import { withPreferences } from 'compass-preferences-model/provider';
 import { connect } from 'react-redux';
 
 import {

packages/compass-aggregations/src/plugin.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import Aggregations from './components/aggregations';
 import { ConfirmationModalArea } from '@mongodb-js/compass-components';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import type { ConfigureStoreOptions } from './stores/store';
 
 export const AggregationsPlugin: React.FunctionComponent<

packages/compass-aggregations/test/configure-store.ts

@@ -6,7 +6,7 @@ import type {
 import { activateAggregationsPlugin } from '../src/stores/store';
 import { mockDataService } from './mocks/data-service';
 import type { DataService } from '../src/modules/data-service';
-import { defaultPreferencesInstance } from 'compass-preferences-model';
+import { ReadOnlyPreferenceAccess } from 'compass-preferences-model/provider';
 import { createNoopLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
 
 export default function configureStore(
@@ -30,7 +30,7 @@ export default function configureStore(
     {
       dataService,
       instance: {} as any,
-      preferences: defaultPreferencesInstance,
+      preferences: new ReadOnlyPreferenceAccess(),
       globalAppRegistry: new AppRegistry(),
       localAppRegistry: new AppRegistry(),
       workspaces: {} as any,

packages/compass-collection/src/components/collection-header/collection-header.tsx

@@ -12,7 +12,7 @@ import {
 import type { Signal } from '@mongodb-js/compass-components';
 import React from 'react';
 import toNS from 'mongodb-ns';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import CollectionHeaderActions from '../collection-header-actions';
 import CollectionStats from '../collection-stats';
 import type { CollectionState } from '../../modules/collection-tab';

packages/compass-connection-import-export/src/components/export-modal.tsx

@@ -17,7 +17,7 @@ import type {
   ConnectionInfo,
   ConnectionStorage,
 } from '@mongodb-js/connection-storage/renderer';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const TOAST_TIMEOUT_MS = 5000;
 const tableStyles = css({

packages/compass-connection-import-export/src/hooks/use-export.ts

@@ -12,7 +12,7 @@ import type {
   ConnectionShortInfo,
   CommonImportExportState,
 } from './common';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 type ExportConnectionsState = CommonImportExportState<ConnectionShortInfo> & {
   removeSecrets: boolean;

packages/compass-connections/src/components/connections.tsx

@@ -27,7 +27,7 @@ import { useConnections } from '../stores/connections-store';
 import { cloneDeep } from 'lodash';
 import ConnectionList from './connection-list/connection-list';
 import { LegacyConnectionsModal } from './legacy-connections-modal';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 type ConnectFn = typeof connect;
 

packages/compass-connections/src/stores/connections-store.ts

@@ -27,7 +27,7 @@ import { adjustConnectionOptionsBeforeConnect } from '@mongodb-js/connection-for
 import { useEffectOnChange, useToast } from '@mongodb-js/compass-components';
 import { createLoggerAndTelemetry } from '@mongodb-js/compass-logging';
 import type { UserPreferences } from 'compass-preferences-model';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const { debug, mongoLogId, log } = createLoggerAndTelemetry(
   'COMPASS-CONNECTIONS'

packages/compass-crud/src/components/add-data-menu.tsx

@@ -6,7 +6,7 @@ import {
   css,
 } from '@mongodb-js/compass-components';
 import type { MenuAction } from '@mongodb-js/compass-components';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const tooltipContainerStyles = css({
   display: 'flex',

packages/compass-crud/src/components/connected-document-list.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 import DocumentList from './document-list';
 

packages/compass-crud/src/components/crud-toolbar.tsx

@@ -15,7 +15,7 @@ import type { MenuAction, Signal } from '@mongodb-js/compass-components';
 import { ViewSwitcher } from './view-switcher';
 import type { DocumentView } from '../stores/crud-store';
 import { AddDataMenu } from './add-data-menu';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import UpdateMenu from './update-data-menu';
 import DeleteMenu from './delete-data-menu';
 import { QueryBar } from '@mongodb-js/compass-query-bar';

packages/compass-crud/src/components/delete-data-menu.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import { Icon, Button, Tooltip } from '@mongodb-js/compass-components';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 type DeleteMenuButtonProps = {
   isWritable: boolean;

packages/compass-crud/src/components/editable-document.tsx

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import type { Document } from 'hadron-document';
 import HadronDocument from 'hadron-document';
 import { DocumentList, css } from '@mongodb-js/compass-components';
-import { withPreferences } from 'compass-preferences-model';
+import { withPreferences } from 'compass-preferences-model/provider';
 
 import { documentStyles, documentContentStyles } from './readonly-document';
 import { getInsightsForDocument } from '../utils';

packages/compass-crud/src/components/readonly-document.tsx

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import { DocumentList, css, spacing } from '@mongodb-js/compass-components';
 import type Document from 'hadron-document';
 import type { TypeCastMap } from 'hadron-type-checker';
-import { withPreferences } from 'compass-preferences-model';
+import { withPreferences } from 'compass-preferences-model/provider';
 import { getInsightsForDocument } from '../utils';
 type BSONObject = TypeCastMap['Object'];
 

packages/compass-crud/src/components/update-data-menu.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import { Icon, Button, Tooltip } from '@mongodb-js/compass-components';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 type UpdateMenuButtonProps = {
   isWritable: boolean;

packages/compass-databases-navigation/src/collection-item.tsx

@@ -21,7 +21,7 @@ import type {
   NamespaceItemProps,
 } from './tree-item';
 import type { Actions } from './constants';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const CollectionIcon: React.FunctionComponent<{
   type: string;

packages/compass-explain-plan/src/components/explain-plan-side-summary.tsx

@@ -20,7 +20,7 @@ import {
   type SerializedExplainPlan,
 } from '../stores/explain-plan-modal-store';
 import { connect } from 'react-redux';
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const defaultFormatter = (_: unknown) => String(_);
 

packages/compass-indexes/src/components/indexes-toolbar/indexes-toolbar.tsx

@@ -1,6 +1,9 @@
 import React, { useCallback } from 'react';
 import { connect } from 'react-redux';
-import { withPreferences } from 'compass-preferences-model';
+import {
+  withPreferences,
+  usePreference,
+} from 'compass-preferences-model/provider';
 import {
   Button,
   ErrorSummary,
@@ -17,7 +20,6 @@ import {
   SegmentedControl,
   SegmentedControlOption,
 } from '@mongodb-js/compass-components';
-import { usePreference } from 'compass-preferences-model';
 
 import type { RootState } from '../../modules';
 import {

packages/compass-indexes/src/components/regular-indexes-table/regular-indexes-table.tsx

@@ -1,7 +1,7 @@
 import React, { useMemo } from 'react';
 import { connect } from 'react-redux';
 import { IndexKeysBadge } from '@mongodb-js/compass-components';
-import { withPreferences } from 'compass-preferences-model';
+import { withPreferences } from 'compass-preferences-model/provider';
 
 import type { RootState } from '../../modules';
 

packages/compass-indexes/src/components/search-indexes-table/search-indexes-table.tsx

@@ -2,7 +2,7 @@ import React, { useEffect, useMemo } from 'react';
 import { connect } from 'react-redux';
 import type { Document } from 'mongodb';
 import type { SearchIndex, SearchIndexStatus } from 'mongodb-data-service';
-import { withPreferences } from 'compass-preferences-model';
+import { withPreferences } from 'compass-preferences-model/provider';
 import { useOpenWorkspace } from '@mongodb-js/compass-workspaces/provider';
 import { BadgeVariant } from '@mongodb-js/compass-components';
 import {

packages/compass-maybe-protect-connection-string/src/index.ts

@@ -1,4 +1,4 @@
-import { usePreference } from 'compass-preferences-model';
+import { usePreference } from 'compass-preferences-model/provider';
 import { redactConnectionString } from 'mongodb-connection-string-url';
 
 export function maybeProtectConnectionString(

packages/compass-preferences-model/src/index.ts

@@ -1,6 +1,4 @@
 export type { THEMES } from './preferences-schema';
-export { getSettingDescription } from './preferences-schema';
-export { featureFlags } from './feature-flags';
 
 import type {
   UserPreferences,
@@ -25,12 +23,9 @@ export {
   getExampleConfigFile,
 } from './global-config';
 export type { ParsedGlobalPreferencesResult } from './global-config';
-export { usePreference, withPreferences } from './react';
-export { capMaxTimeMSAtPreferenceLimit } from './maxtimems';
 export {
   setupPreferencesAndUser,
   getActiveUser,
-  useIsAIFeatureEnabled,
   isAIFeatureEnabled,
 } from './utils';
 export type { User, UserStorage } from './storage';

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

@@ -868,47 +868,6 @@ function featureFlagToPreferenceDefinition(
   };
 }
 
-export function makeComputePreferencesValuesAndStates(
-  values: AllPreferences,
-  states: Partial<Record<string, PreferenceState>> = {}
-) {
-  return function _computePreferenceValuesAndStates() {
-    const originalValues = { ...values };
-    const originalStates = { ...states };
-
-    function deriveValue<K extends keyof AllPreferences>(
-      key: K
-    ): {
-      value: AllPreferences[K];
-      state: PreferenceState;
-    } {
-      const descriptor = allPreferencesProps[key];
-      if (!descriptor.deriveValue) {
-        return { value: originalValues[key], state: originalStates[key] };
-      }
-      return (descriptor.deriveValue as DeriveValueFunction<AllPreferences[K]>)(
-        // `as unknown` to work around TS bug(?) https://twitter.com/addaleax/status/1572191664252551169
-        (k) =>
-          (k as unknown) === key ? originalValues[k] : deriveValue(k).value,
-        (k) =>
-          (k as unknown) === key ? originalStates[k] : deriveValue(k).state
-      );
-    }
-
-    for (const key of Object.keys(allPreferencesProps)) {
-      // awkward IIFE to make typescript understand that `key` is the *same* key
-      // in each loop iteration
-      (<K extends keyof AllPreferences>(key: K) => {
-        const result = deriveValue(key);
-        values[key] = result.value;
-        if (result.state !== undefined) states[key] = result.state;
-      })(key as keyof AllPreferences);
-    }
-
-    return { values, states };
-  };
-}
-
 export function getPreferencesValidator() {
   const preferencesPropsValidator = Object.fromEntries(
     Object.entries(storedUserPreferencesProps).map(([key, { validator }]) => [
@@ -930,14 +889,6 @@ export function getDefaultsForStoredPreferences(): StoredPreferences {
   );
 }
 
-export function getInitialValuesForStoredPreferences() {
-  const computeValuesAndStates = makeComputePreferencesValuesAndStates(
-    getDefaultsForStoredPreferences()
-  );
-
-  return computeValuesAndStates().values;
-}
-
 export function getSettingDescription<
   Name extends Exclude<keyof AllPreferences, keyof InternalUserPreferences>
 >(