GSI: Remove Unique Key Policy and Manual Throughput (#2114)

* Remove Unique Key Policy and Manual Throughput * fix tests * remove manual throughput option from scale & settings * fix test * cleanup --------- Co-authored-by: Asier Isayas <aisayas@microsoft.com>
2025-05-11 02:44:21 +01:00 · 2025-04-18 14:39:31 -04:00 · 2025-04-18 14:39:31 -04:00 · af4e1d10b4
commit af4e1d10b4
parent 6dbc412fa6
11 changed files with 74 additions and 172 deletions
--- a/src/Explorer/Controls/Settings/SettingsComponent.tsx
+++ b/src/Explorer/Controls/Settings/SettingsComponent.tsx
@ -1149,6 +1149,7 @@ export class SettingsComponent extends React.Component<SettingsComponentProps, S
      collection: this.collection,
      database: this.database,
      isFixedContainer: this.isFixedContainer,
+      isGlobalSecondaryIndex: this.isGlobalSecondaryIndex,
      onThroughputChange: this.onThroughputChange,
      throughput: this.state.throughput,
      throughputBaseline: this.state.throughputBaseline,
--- a/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.test.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.test.tsx
@ -9,6 +9,7 @@ describe("ScaleComponent", () => {
    collection: collection,
    database: undefined,
    isFixedContainer: false,
+    isGlobalSecondaryIndex: false,
    onThroughputChange: () => {
      return;
    },
--- a/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.tsx
@ -22,6 +22,7 @@ export interface ScaleComponentProps {
  collection: ViewModels.Collection;
  database: ViewModels.Database;
  isFixedContainer: boolean;
+  isGlobalSecondaryIndex: boolean;
  onThroughputChange: (newThroughput: number) => void;
  throughput: number;
  throughputBaseline: number;
@ -143,6 +144,7 @@ export class ScaleComponent extends React.Component<ScaleComponentProps> {
      throughputError={this.props.throughputError}
      instantMaximumThroughput={this.offer?.instantMaximumThroughput}
      softAllowedMaximumThroughput={this.offer?.softAllowedMaximumThroughput}
+      isGlobalSecondaryIndex={this.props.isGlobalSecondaryIndex}
    />
  );

--- a/src/Explorer/Controls/Settings/SettingsSubComponents/ThroughputInputComponents/ThroughputInputAutoPilotV3Component.test.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/ThroughputInputComponents/ThroughputInputAutoPilotV3Component.test.tsx
@ -44,6 +44,7 @@ describe("ThroughputInputAutoPilotV3Component", () => {
    },
    instantMaximumThroughput: 5000,
    softAllowedMaximumThroughput: 1000000,
+    isGlobalSecondaryIndex: false,
  };

  it("throughput input visible", () => {
--- a/src/Explorer/Controls/Settings/SettingsSubComponents/ThroughputInputComponents/ThroughputInputAutoPilotV3Component.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/ThroughputInputComponents/ThroughputInputAutoPilotV3Component.tsx
@ -80,6 +80,7 @@ export interface ThroughputInputAutoPilotV3Props {
  throughputError?: string;
  instantMaximumThroughput: number;
  softAllowedMaximumThroughput: number;
+  isGlobalSecondaryIndex: boolean;
 }

 interface ThroughputInputAutoPilotV3State {
@ -375,22 +376,26 @@ export class ThroughputInputAutoPilotV3Component extends React.Component<
            toolTipElement={getToolTipContainer(this.props.infoBubbleText)}
          />
        </Label>
-        {this.overrideWithProvisionedThroughputSettings() && (
-          <MessageBar
-            messageBarIconProps={{ iconName: "InfoSolid", className: "messageBarInfoIcon" }}
-            styles={messageBarStyles}
-          >
-            {manualToAutoscaleDisclaimerElement}
-          </MessageBar>
+        {!this.props.isGlobalSecondaryIndex && (
+          <>
+            {this.overrideWithProvisionedThroughputSettings() && (
+              <MessageBar
+                messageBarIconProps={{ iconName: "InfoSolid", className: "messageBarInfoIcon" }}
+                styles={messageBarStyles}
+              >
+                {manualToAutoscaleDisclaimerElement}
+              </MessageBar>
+            )}
+            <ChoiceGroup
+              selectedKey={this.props.isAutoPilotSelected.toString()}
+              options={this.options}
+              onChange={this.onChoiceGroupChange}
+              required={this.props.showAsMandatory}
+              ariaLabelledBy={labelId}
+              styles={getChoiceGroupStyles(this.props.wasAutopilotOriginallySet, this.props.isAutoPilotSelected, true)}
+            />
+          </>
        )}
-        <ChoiceGroup
-          selectedKey={this.props.isAutoPilotSelected.toString()}
-          options={this.options}
-          onChange={this.onChoiceGroupChange}
-          required={this.props.showAsMandatory}
-          ariaLabelledBy={labelId}
-          styles={getChoiceGroupStyles(this.props.wasAutopilotOriginallySet, this.props.isAutoPilotSelected, true)}
-        />
      </Stack>
    );
  };
--- a/src/Explorer/Controls/Settings/snapshots/SettingsComponent.test.tsx.snap
+++ b/src/Explorer/Controls/Settings/snapshots/SettingsComponent.test.tsx.snap
@ -79,6 +79,7 @@ exports[`SettingsComponent renders 1`] = `
          }
          isAutoPilotSelected={false}
          isFixedContainer={false}
+          isGlobalSecondaryIndex={true}
          onAutoPilotSelected={[Function]}
          onMaxAutoPilotThroughputChange={[Function]}
          onScaleDiscardableChange={[Function]}
--- a/src/Explorer/Controls/ThroughputInput/ThroughputInput.tsx
+++ b/src/Explorer/Controls/ThroughputInput/ThroughputInput.tsx
@ -18,6 +18,7 @@ export interface ThroughputInputProps {
  isFreeTier: boolean;
  showFreeTierExceedThroughputTooltip: boolean;
  isQuickstart?: boolean;
+  isGlobalSecondaryIndex?: boolean;
  setThroughputValue: (throughput: number) => void;
  setIsAutoscale: (isAutoscale: boolean) => void;
  setIsThroughputCapExceeded: (isThroughputCapExceeded: boolean) => void;
@ -30,6 +31,7 @@ export const ThroughputInput: FunctionComponent<ThroughputInputProps> = ({
  isFreeTier,
  showFreeTierExceedThroughputTooltip,
  isQuickstart,
+  isGlobalSecondaryIndex,
  setThroughputValue,
  setIsAutoscale,
  setIsThroughputCapExceeded,
@ -193,41 +195,41 @@ export const ThroughputInput: FunctionComponent<ThroughputInputProps> = ({
        </Text>
        <InfoTooltip>{PricingUtils.getRuToolTipText()}</InfoTooltip>
      </Stack>
+      {!isGlobalSecondaryIndex && (
+        <Stack horizontal verticalAlign="center">
+          <div role="radiogroup">
+            <input
+              id="Autoscale-input"
+              className="throughputInputRadioBtn"
+              aria-label={`${getThroughputLabelText()} Autoscale`}
+              aria-required={true}
+              checked={isAutoscaleSelected}
+              type="radio"
+              role="radio"
+              tabIndex={0}
+              onChange={(e) => handleOnChangeMode(e, "Autoscale")}
+            />
+            <label htmlFor="Autoscale-input" className="throughputInputRadioBtnLabel">
+              Autoscale
+            </label>

-      <Stack horizontal verticalAlign="center">
-        <div role="radiogroup">
-          <input
-            id="Autoscale-input"
-            className="throughputInputRadioBtn"
-            aria-label={`${getThroughputLabelText()} Autoscale`}
-            aria-required={true}
-            checked={isAutoscaleSelected}
-            type="radio"
-            role="radio"
-            tabIndex={0}
-            onChange={(e) => handleOnChangeMode(e, "Autoscale")}
-          />
-          <label htmlFor="Autoscale-input" className="throughputInputRadioBtnLabel">
-            Autoscale
-          </label>
-
-          <input
-            id="Manual-input"
-            className="throughputInputRadioBtn"
-            aria-label={`${getThroughputLabelText()} Manual`}
-            checked={!isAutoscaleSelected}
-            type="radio"
-            aria-required={true}
-            role="radio"
-            tabIndex={0}
-            onChange={(e) => handleOnChangeMode(e, "Manual")}
-          />
-          <label className="throughputInputRadioBtnLabel" htmlFor="Manual-input">
-            Manual
-          </label>
-        </div>
-      </Stack>
-
+            <input
+              id="Manual-input"
+              className="throughputInputRadioBtn"
+              aria-label={`${getThroughputLabelText()} Manual`}
+              checked={!isAutoscaleSelected}
+              type="radio"
+              aria-required={true}
+              role="radio"
+              tabIndex={0}
+              onChange={(e) => handleOnChangeMode(e, "Manual")}
+            />
+            <label className="throughputInputRadioBtnLabel" htmlFor="Manual-input">
+              Manual
+            </label>
+          </div>
+        </Stack>
+      )}
      {isAutoscaleSelected && (
        <Stack className="throughputInputSpacing">
          <Text variant="small" aria-label="capacity calculator of azure cosmos db">
--- a/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/AddGlobalSecondaryIndexPanel.tsx
+++ b/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/AddGlobalSecondaryIndexPanel.tsx
@ -22,7 +22,6 @@ import {
  FullTextPolicyDefault,
  getPartitionKey,
  isSynapseLinkEnabled,
-  parseUniqueKeys,
  scrollToSection,
  shouldShowAnalyticalStoreOptions,
 } from "Explorer/Panes/AddCollectionPanel/AddCollectionPanelUtility";
@ -35,7 +34,6 @@ import { AnalyticalStoreComponent } from "Explorer/Panes/AddGlobalSecondaryIndex
 import { FullTextSearchComponent } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/FullTextSearchComponent";
 import { PartitionKeyComponent } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/PartitionKeyComponent";
 import { ThroughputComponent } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/ThroughputComponent";
-import { UniqueKeysComponent } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/UniqueKeysComponent";
 import { VectorSearchComponent } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/VectorSearchComponent";
 import { PanelFooterComponent } from "Explorer/Panes/PanelFooterComponent";
 import { PanelInfoErrorComponent } from "Explorer/Panes/PanelInfoErrorComponent";
@ -66,14 +64,13 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
  const [useHashV1, setUseHashV1] = useState<boolean>();
  const [enableDedicatedThroughput, setEnabledDedicatedThroughput] = useState<boolean>();
  const [isThroughputCapExceeded, setIsThroughputCapExceeded] = useState<boolean>();
-  const [uniqueKeys, setUniqueKeys] = useState<string[]>([]);
  const [enableAnalyticalStore, setEnableAnalyticalStore] = useState<boolean>();
-  const [vectorEmbeddingPolicy, setVectorEmbeddingPolicy] = useState<VectorEmbedding[]>();
-  const [vectorIndexingPolicy, setVectorIndexingPolicy] = useState<VectorIndex[]>();
-  const [vectorPolicyValidated, setVectorPolicyValidated] = useState<boolean>();
+  const [vectorEmbeddingPolicy, setVectorEmbeddingPolicy] = useState<VectorEmbedding[]>([]);
+  const [vectorIndexingPolicy, setVectorIndexingPolicy] = useState<VectorIndex[]>([]);
+  const [vectorPolicyValidated, setVectorPolicyValidated] = useState<boolean>(true);
  const [fullTextPolicy, setFullTextPolicy] = useState<FullTextPolicy>(FullTextPolicyDefault);
-  const [fullTextIndexes, setFullTextIndexes] = useState<FullTextIndex[]>();
-  const [fullTextPolicyValidated, setFullTextPolicyValidated] = useState<boolean>();
+  const [fullTextIndexes, setFullTextIndexes] = useState<FullTextIndex[]>([]);
+  const [fullTextPolicyValidated, setFullTextPolicyValidated] = useState<boolean>(true);
  const [errorMessage, setErrorMessage] = useState<string>();
  const [showErrorDetails, setShowErrorDetails] = useState<boolean>();
  const [isExecuting, setIsExecuting] = useState<boolean>();
@ -109,17 +106,12 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
  }, [errorMessage]);

  let globalSecondaryIndexThroughput: number;
-  let isGlobalSecondaryIndexAutoscale: boolean;
  let isCostAcknowledged: boolean;

  const globalSecondaryIndexThroughputOnChange = (globalSecondaryIndexThroughputValue: number): void => {
    globalSecondaryIndexThroughput = globalSecondaryIndexThroughputValue;
  };

-  const isGlobalSecondaryIndexAutoscaleOnChange = (isGlobalSecondaryIndexAutoscaleValue: boolean): void => {
-    isGlobalSecondaryIndexAutoscale = isGlobalSecondaryIndexAutoscaleValue;
-  };
-
  const isCostAknowledgedOnChange = (isCostAcknowledgedValue: boolean): void => {
    isCostAcknowledged = isCostAcknowledgedValue;
  };
@ -178,9 +170,7 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
    }

    if (globalSecondaryIndexThroughput > CollectionCreation.DefaultCollectionRUs100K && !isCostAcknowledged) {
-      const errorMessage = isGlobalSecondaryIndexAutoscale
-        ? "Please acknowledge the estimated monthly spend."
-        : "Please acknowledge the estimated daily spend.";
+      const errorMessage: string = "Please acknowledge the estimated monthly spend.";
      setErrorMessage(errorMessage);
      return false;
    }
@ -221,7 +211,6 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel

    const partitionKeyTrimmed: string = partitionKey.trim();

-    const uniqueKeyPolicy: DataModels.UniqueKeyPolicy = parseUniqueKeys(uniqueKeys);
    const partitionKeyVersion = useHashV1 ? undefined : 2;
    const partitionKeyPaths: DataModels.PartitionKey = partitionKeyTrimmed
      ? {
@ -256,9 +245,8 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
      collection: {
        id: globalSecondaryIdTrimmed,
        throughput: globalSecondaryIndexThroughput,
-        isAutoscale: isGlobalSecondaryIndexAutoscale,
+        isAutoscale: true,
        partitionKeyPaths,
-        uniqueKeyPolicy,
        collectionWithDedicatedThroughput: enableDedicatedThroughput,
      },
      subscriptionQuotaId: userContext.quotaId,
@ -268,28 +256,17 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
    const startKey: number = TelemetryProcessor.traceStart(Action.CreateCollection, telemetryData);
    const databaseLevelThroughput: boolean = isSelectedSourceContainerSharedThroughput() && !enableDedicatedThroughput;

-    let offerThroughput: number;
-    let autoPilotMaxThroughput: number;
-
-    if (!databaseLevelThroughput) {
-      if (isGlobalSecondaryIndexAutoscale) {
-        autoPilotMaxThroughput = globalSecondaryIndexThroughput;
-      } else {
-        offerThroughput = globalSecondaryIndexThroughput;
-      }
-    }
-
    const createGlobalSecondaryIndexParams: DataModels.CreateMaterializedViewsParams = {
      materializedViewId: globalSecondaryIdTrimmed,
      materializedViewDefinition: globalSecondaryIndexDefinition,
      databaseId: selectedSourceContainer.databaseId,
      databaseLevelThroughput: databaseLevelThroughput,
-      offerThroughput: offerThroughput,
-      autoPilotMaxThroughput: autoPilotMaxThroughput,
+      ...(!databaseLevelThroughput && {
+        autoPilotMaxThroughput: globalSecondaryIndexThroughput,
+      }),
      analyticalStorageTtl: getAnalyticalStorageTtl(),
      indexingPolicy: indexingPolicy,
      partitionKey: partitionKeyPaths,
-      uniqueKeyPolicy: uniqueKeyPolicy,
      vectorEmbeddingPolicy: vectorEmbeddingPolicyFinal,
      fullTextPolicy: fullTextPolicy,
    };
@ -395,12 +372,10 @@ export const AddGlobalSecondaryIndexPanel = (props: AddGlobalSecondaryIndexPanel
              isSelectedSourceContainerSharedThroughput,
              showCollectionThroughputInput,
              globalSecondaryIndexThroughputOnChange,
-              isGlobalSecondaryIndexAutoscaleOnChange,
              setIsThroughputCapExceeded,
              isCostAknowledgedOnChange,
            }}
          />
-          <UniqueKeysComponent {...{ uniqueKeys, setUniqueKeys }} />
          {shouldShowAnalyticalStoreOptions() && (
            <AnalyticalStoreComponent {...{ explorer, enableAnalyticalStore, setEnableAnalyticalStore }} />
          )}
--- a/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/ThroughputComponent.tsx
+++ b/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/ThroughputComponent.tsx
@ -12,7 +12,6 @@ export interface ThroughputComponentProps {
  isSelectedSourceContainerSharedThroughput: () => boolean;
  showCollectionThroughputInput: () => boolean;
  globalSecondaryIndexThroughputOnChange: (globalSecondaryIndexThroughputValue: number) => void;
-  isGlobalSecondaryIndexAutoscaleOnChange: (isGlobalSecondaryIndexAutoscaleValue: boolean) => void;
  setIsThroughputCapExceeded: React.Dispatch<React.SetStateAction<boolean>>;
  isCostAknowledgedOnChange: (isCostAknowledgedValue: boolean) => void;
 }
@ -24,7 +23,6 @@ export const ThroughputComponent = (props: ThroughputComponentProps): JSX.Elemen
    isSelectedSourceContainerSharedThroughput,
    showCollectionThroughputInput,
    globalSecondaryIndexThroughputOnChange,
-    isGlobalSecondaryIndexAutoscaleOnChange,
    setIsThroughputCapExceeded,
    isCostAknowledgedOnChange,
  } = props;
@ -52,12 +50,11 @@ export const ThroughputComponent = (props: ThroughputComponentProps): JSX.Elemen
          isSharded={false}
          isFreeTier={isFreeTierAccount()}
          isQuickstart={false}
+          isGlobalSecondaryIndex={true}
          setThroughputValue={(throughput: number) => {
            globalSecondaryIndexThroughputOnChange(throughput);
          }}
-          setIsAutoscale={(isAutoscale: boolean) => {
-            isGlobalSecondaryIndexAutoscaleOnChange(isAutoscale);
-          }}
+          setIsAutoscale={() => {}}
          setIsThroughputCapExceeded={(isThroughputCapExceeded: boolean) => {
            setIsThroughputCapExceeded(isThroughputCapExceeded);
          }}
--- a/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/UniqueKeysComponent.tsx
+++ b/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/Components/UniqueKeysComponent.tsx
@ -1,78 +0,0 @@
-import { ActionButton, IconButton, Stack } from "@fluentui/react";
-import { UniqueKeysHeader } from "Explorer/Panes/AddCollectionPanel/AddCollectionPanelUtility";
-import React from "react";
-import { userContext } from "UserContext";
-
-export interface UniqueKeysComponentProps {
-  uniqueKeys: string[];
-  setUniqueKeys: React.Dispatch<React.SetStateAction<string[]>>;
-}
-
-export const UniqueKeysComponent = (props: UniqueKeysComponentProps): JSX.Element => {
-  const { uniqueKeys, setUniqueKeys } = props;
-
-  const updateUniqueKeysOnChange = (value: string, uniqueKeyToReplaceIndex: number): void => {
-    const updatedUniqueKeys = uniqueKeys.map((uniqueKey: string, uniqueKeyIndex: number) => {
-      if (uniqueKeyToReplaceIndex === uniqueKeyIndex) {
-        return value;
-      }
-      return uniqueKey;
-    });
-    setUniqueKeys(updatedUniqueKeys);
-  };
-
-  const deleteUniqueKeyOnClick = (uniqueKeyToDeleteIndex: number): void => {
-    const updatedUniqueKeys = uniqueKeys.filter((_, uniqueKeyIndex) => uniqueKeyToDeleteIndex !== uniqueKeyIndex);
-    setUniqueKeys(updatedUniqueKeys);
-  };
-
-  const addUniqueKeyOnClick = (): void => {
-    setUniqueKeys([...uniqueKeys, ""]);
-  };
-
-  return (
-    <Stack>
-      {UniqueKeysHeader()}
-
-      {uniqueKeys.map((uniqueKey: string, uniqueKeyIndex: number): JSX.Element => {
-        return (
-          <Stack style={{ marginBottom: 8 }} key={`uniqueKey-${uniqueKeyIndex}`} horizontal>
-            <input
-              type="text"
-              autoComplete="off"
-              placeholder={
-                userContext.apiType === "Mongo"
-                  ? "Comma separated paths e.g. firstName,address.zipCode"
-                  : "Comma separated paths e.g. /firstName,/address/zipCode"
-              }
-              className="panelTextField"
-              autoFocus
-              value={uniqueKey}
-              onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
-                updateUniqueKeysOnChange(event.target.value, uniqueKeyIndex);
-              }}
-            />
-
-            <IconButton
-              iconProps={{ iconName: "Delete" }}
-              style={{ height: 27 }}
-              onClick={() => {
-                deleteUniqueKeyOnClick(uniqueKeyIndex);
-              }}
-            />
-          </Stack>
-        );
-      })}
-
-      <ActionButton
-        iconProps={{ iconName: "Add" }}
-        styles={{ root: { padding: 0 }, label: { fontSize: 12 } }}
-        onClick={() => {
-          addUniqueKeyOnClick();
-        }}
-      >
-        Add unique key
-      </ActionButton>
-    </Stack>
-  );
-};
--- a/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/snapshots/AddGlobalSecondaryIndexPanel.test.tsx.snap
+++ b/src/Explorer/Panes/AddGlobalSecondaryIndexPanel/snapshots/AddGlobalSecondaryIndexPanel.test.tsx.snap
@ -137,16 +137,11 @@ exports[`AddGlobalSecondaryIndexPanel render default panel 1`] = `
      <ThroughputComponent
        globalSecondaryIndexThroughputOnChange={[Function]}
        isCostAknowledgedOnChange={[Function]}
-        isGlobalSecondaryIndexAutoscaleOnChange={[Function]}
        isSelectedSourceContainerSharedThroughput={[Function]}
        setEnabledDedicatedThroughput={[Function]}
        setIsThroughputCapExceeded={[Function]}
        showCollectionThroughputInput={[Function]}
      />
-      <UniqueKeysComponent
-        setUniqueKeys={[Function]}
-        uniqueKeys={[]}
-      />
      <AnalyticalStoreComponent
        explorer={
          Explorer {