Show unique keys in Settings for SQL api (#2136)

* master pull

* Added unique keys in Settings for SQL api

* Revert settings.json

* Reverting other PR changes that haven't merged

* Adding space back in

* Added unit tests

src/Explorer/Controls/Settings/SettingsSubComponents/SubSettingsComponent.test.tsx

@@ -143,4 +143,39 @@ describe("SubSettingsComponent", () => {
     expect(subSettingsComponentInstance.getTtlValue(TtlType.On)).toEqual(TtlOn);
     expect(subSettingsComponentInstance.getTtlValue(TtlType.Off)).toEqual(TtlOff);
   });
+
+  it("uniqueKey is visible", () => {
+    updateUserContext({
+      databaseAccount: {
+        properties: {
+          capabilities: [{ name: "EnableSQL" }],
+        },
+      } as DatabaseAccount,
+    });
+    const subSettingsComponent = new SubSettingsComponent(baseProps);
+    expect(subSettingsComponent.getUniqueKeyVisible()).toEqual(true);
+  });
+
+  it("uniqueKey not visible due to no keys", () => {
+    const props = {
+      ...baseProps,
+      ...(baseProps.collection.rawDataModel.uniqueKeyPolicy.uniqueKeys = []),
+    };
+    const subSettingsComponent = new SubSettingsComponent(props);
+    expect(subSettingsComponent.getUniqueKeyVisible()).toEqual(false);
+  });
+
+  it("uniqueKey not visible for API", () => {
+    const newContainer = new Explorer();
+    updateUserContext({
+      databaseAccount: {
+        properties: {
+          capabilities: [{ name: "EnableMongo" }],
+        },
+      } as DatabaseAccount,
+    });
+    const props = { ...baseProps, container: newContainer };
+    const subSettingsComponent = new SubSettingsComponent(props);
+    expect(subSettingsComponent.getUniqueKeyVisible()).toEqual(false);
+  });
 });

src/Explorer/Controls/Settings/SettingsSubComponents/SubSettingsComponent.tsx

@@ -63,12 +63,16 @@ export class SubSettingsComponent extends React.Component<SubSettingsComponentPr
   private geospatialVisible: boolean;
   private partitionKeyValue: string;
   private partitionKeyName: string;
+  private uniqueKeyName: string;
+  private uniqueKeyValue: string;
 
   constructor(props: SubSettingsComponentProps) {
     super(props);
     this.geospatialVisible = userContext.apiType === "SQL";
     this.partitionKeyName = userContext.apiType === "Mongo" ? "Shard key" : "Partition key";
     this.partitionKeyValue = this.getPartitionKeyValue();
+    this.uniqueKeyName = "Unique keys";
+    this.uniqueKeyValue = this.getUniqueKeyValue();
   }
 
   componentDidMount(): void {
@@ -351,6 +355,28 @@ export class SubSettingsComponent extends React.Component<SubSettingsComponentPr
   public isLargePartitionKeyEnabled = (): boolean => this.props.collection.partitionKey?.version >= 2;
   public isHierarchicalPartitionedContainer = (): boolean => this.props.collection.partitionKey?.kind === "MultiHash";
 
+  public getUniqueKeyVisible = (): boolean => {
+    return this.props.collection.rawDataModel.uniqueKeyPolicy?.uniqueKeys.length > 0 && userContext.apiType === "SQL";
+  };
+
+  private getUniqueKeyValue = (): string => {
+    const paths = this.props.collection.rawDataModel.uniqueKeyPolicy?.uniqueKeys?.[0]?.paths;
+    return paths?.join(", ") || "";
+  };
+
+  private getUniqueKeyComponent = (): JSX.Element => (
+    <Stack {...titleAndInputStackProps}>
+      {this.getUniqueKeyVisible() && (
+        <TextField
+          label={this.uniqueKeyName}
+          disabled
+          styles={getTextFieldStyles(undefined, undefined)}
+          defaultValue={this.uniqueKeyValue}
+        />
+      )}
+    </Stack>
+  );
+
   public render(): JSX.Element {
     return (
       <Stack {...subComponentStackProps}>
@@ -363,6 +389,8 @@ export class SubSettingsComponent extends React.Component<SubSettingsComponentPr
         {this.props.changeFeedPolicyVisible && this.getChangeFeedComponent()}
 
         {this.getPartitionKeyComponent()}
+
+        {this.getUniqueKeyComponent()}
       </Stack>
     );
   }

src/Explorer/Controls/Settings/SettingsSubComponents/__snapshots__/SubSettingsComponent.test.tsx.snap

@@ -231,6 +231,34 @@ exports[`SubSettingsComponent analyticalTimeToLive hidden 1`] = `
       Non-hierarchically partitioned container.
     </Text>
   </Stack>
+  <Stack
+    tokens={
+      {
+        "childrenGap": 5,
+      }
+    }
+  >
+    <StyledTextFieldBase
+      defaultValue="/id"
+      disabled={true}
+      label="Unique keys"
+      styles={
+        {
+          "fieldGroup": {
+            "borderColor": "",
+            "height": 25,
+            "selectors": {
+              ":disabled": {
+                "backgroundColor": undefined,
+                "borderColor": undefined,
+              },
+            },
+            "width": 300,
+          },
+        }
+      }
+    />
+  </Stack>
 </Stack>
 `;
 
@@ -520,6 +548,34 @@ exports[`SubSettingsComponent analyticalTimeToLiveSeconds hidden 1`] = `
       Non-hierarchically partitioned container.
     </Text>
   </Stack>
+  <Stack
+    tokens={
+      {
+        "childrenGap": 5,
+      }
+    }
+  >
+    <StyledTextFieldBase
+      defaultValue="/id"
+      disabled={true}
+      label="Unique keys"
+      styles={
+        {
+          "fieldGroup": {
+            "borderColor": "",
+            "height": 25,
+            "selectors": {
+              ":disabled": {
+                "backgroundColor": undefined,
+                "borderColor": undefined,
+              },
+            },
+            "width": 300,
+          },
+        }
+      }
+    />
+  </Stack>
 </Stack>
 `;
 
@@ -769,6 +825,34 @@ exports[`SubSettingsComponent changeFeedPolicy hidden 1`] = `
       Non-hierarchically partitioned container.
     </Text>
   </Stack>
+  <Stack
+    tokens={
+      {
+        "childrenGap": 5,
+      }
+    }
+  >
+    <StyledTextFieldBase
+      defaultValue="/id"
+      disabled={true}
+      label="Unique keys"
+      styles={
+        {
+          "fieldGroup": {
+            "borderColor": "",
+            "height": 25,
+            "selectors": {
+              ":disabled": {
+                "backgroundColor": undefined,
+                "borderColor": undefined,
+              },
+            },
+            "width": 300,
+          },
+        }
+      }
+    />
+  </Stack>
 </Stack>
 `;
 
@@ -1083,6 +1167,34 @@ exports[`SubSettingsComponent renders 1`] = `
       Non-hierarchically partitioned container.
     </Text>
   </Stack>
+  <Stack
+    tokens={
+      {
+        "childrenGap": 5,
+      }
+    }
+  >
+    <StyledTextFieldBase
+      defaultValue="/id"
+      disabled={true}
+      label="Unique keys"
+      styles={
+        {
+          "fieldGroup": {
+            "borderColor": "",
+            "height": 25,
+            "selectors": {
+              ":disabled": {
+                "backgroundColor": undefined,
+                "borderColor": undefined,
+              },
+            },
+            "width": 300,
+          },
+        }
+      }
+    />
+  </Stack>
 </Stack>
 `;
 
@@ -1371,5 +1483,33 @@ exports[`SubSettingsComponent timeToLiveSeconds hidden 1`] = `
       Non-hierarchically partitioned container.
     </Text>
   </Stack>
+  <Stack
+    tokens={
+      {
+        "childrenGap": 5,
+      }
+    }
+  >
+    <StyledTextFieldBase
+      defaultValue="/id"
+      disabled={true}
+      label="Unique keys"
+      styles={
+        {
+          "fieldGroup": {
+            "borderColor": "",
+            "height": 25,
+            "selectors": {
+              ":disabled": {
+                "backgroundColor": undefined,
+                "borderColor": undefined,
+              },
+            },
+            "width": 300,
+          },
+        }
+      }
+    />
+  </Stack>
 </Stack>
 `;

src/Explorer/Controls/Settings/TestUtils.tsx

@@ -17,7 +17,15 @@ export const collection = {
     includedPaths: [],
     excludedPaths: [],
   }),
-  uniqueKeyPolicy: {} as DataModels.UniqueKeyPolicy,
+  rawDataModel: {
+    uniqueKeyPolicy: {
+      uniqueKeys: [
+        {
+          paths: ["/id"],
+        },
+      ],
+    },
+  },
   usageSizeInKB: ko.observable(100),
   offer: ko.observable<DataModels.Offer>({
     autoscaleMaxThroughput: undefined,

src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap

@@ -71,8 +71,18 @@ exports[`SettingsComponent renders 1`] = `
               "partitionKeyProperties": [
                 "partitionKey",
               ],
+              "rawDataModel": {
+                "uniqueKeyPolicy": {
+                  "uniqueKeys": [
+                    {
+                      "paths": [
+                        "/id",
+                      ],
+                    },
+                  ],
+                },
+              },
               "readSettings": [Function],
-              "uniqueKeyPolicy": {},
               "usageSizeInKB": [Function],
               "vectorEmbeddingPolicy": [Function],
             }
@@ -153,8 +163,18 @@ exports[`SettingsComponent renders 1`] = `
               "partitionKeyProperties": [
                 "partitionKey",
               ],
+              "rawDataModel": {
+                "uniqueKeyPolicy": {
+                  "uniqueKeys": [
+                    {
+                      "paths": [
+                        "/id",
+                      ],
+                    },
+                  ],
+                },
+              },
               "readSettings": [Function],
-              "uniqueKeyPolicy": {},
               "usageSizeInKB": [Function],
               "vectorEmbeddingPolicy": [Function],
             }
@@ -274,8 +294,18 @@ exports[`SettingsComponent renders 1`] = `
               "partitionKeyProperties": [
                 "partitionKey",
               ],
+              "rawDataModel": {
+                "uniqueKeyPolicy": {
+                  "uniqueKeys": [
+                    {
+                      "paths": [
+                        "/id",
+                      ],
+                    },
+                  ],
+                },
+              },
               "readSettings": [Function],
-              "uniqueKeyPolicy": {},
               "usageSizeInKB": [Function],
               "vectorEmbeddingPolicy": [Function],
             }
@@ -404,8 +434,18 @@ exports[`SettingsComponent renders 1`] = `
               "partitionKeyProperties": [
                 "partitionKey",
               ],
+              "rawDataModel": {
+                "uniqueKeyPolicy": {
+                  "uniqueKeys": [
+                    {
+                      "paths": [
+                        "/id",
+                      ],
+                    },
+                  ],
+                },
+              },
               "readSettings": [Function],
-              "uniqueKeyPolicy": {},
               "usageSizeInKB": [Function],
               "vectorEmbeddingPolicy": [Function],
             }