Global Secondary Index (#2071)

* add Materialized Views feature flag

* fetch MV properties from RP API and capture them in our data models

* AddMaterializedViewPanel

* undefined check

* subpartition keys

* Partition Key, Throughput, Unique Keys

* All views associated with a container (#2063) and Materialized View Target Container (#2065)

Identified Source container and Target container
Created tabs in Scale and Settings respectively
Changed the Icon of target container

* Add MV Panel

* format

* format

* styling

* add tests

* tests

* test files (#2074)

Co-authored-by: nishthaAhujaa

* fix type error

* fix tests

* merge conflict

* Panel Integration (#2075)

* integrated panel

* edited header text

---------

Co-authored-by: nishthaAhujaa <nishtha17354@iiittd.ac.in>
Co-authored-by: Asier Isayas <aisayas@microsoft.com>

* updated tests (#2077)

Co-authored-by: nishthaAhujaa

* fix tests

* update treeNodeUtil test snap

* update settings component test snap

* fixed source container in global "New Materialized View"

* source container check (#2079)

Co-authored-by: nishthaAhujaa

* renamed Materialized Views to Global Secondary Index

* more renaming

* fix import

* fix typo

* disable materialized views for Fabric

* updated input validation

---------

Co-authored-by: Asier Isayas <aisayas@microsoft.com>
Co-authored-by: Nishtha Ahuja <45535788+nishthaAhujaa@users.noreply.github.com>
Co-authored-by: nishthaAhujaa <nishtha17354@iiittd.ac.in>

src/Explorer/Controls/Settings/SettingsComponent.tsx

@@ -44,6 +44,10 @@ import {
   ConflictResolutionComponent,
   ConflictResolutionComponentProps,
 } from "./SettingsSubComponents/ConflictResolutionComponent";
+import {
+  GlobalSecondaryIndexComponent,
+  GlobalSecondaryIndexComponentProps,
+} from "./SettingsSubComponents/GlobalSecondaryIndexComponent";
 import { IndexingPolicyComponent, IndexingPolicyComponentProps } from "./SettingsSubComponents/IndexingPolicyComponent";
 import {
   MongoIndexingPolicyComponent,
@@ -162,6 +166,7 @@ export class SettingsComponent extends React.Component<SettingsComponentProps, S
   private shouldShowComputedPropertiesEditor: boolean;
   private shouldShowIndexingPolicyEditor: boolean;
   private shouldShowPartitionKeyEditor: boolean;
+  private isGlobalSecondaryIndex: boolean;
   private isVectorSearchEnabled: boolean;
   private isFullTextSearchEnabled: boolean;
   private totalThroughputUsed: number;
@@ -179,6 +184,8 @@ export class SettingsComponent extends React.Component<SettingsComponentProps, S
       this.shouldShowComputedPropertiesEditor = userContext.apiType === "SQL";
       this.shouldShowIndexingPolicyEditor = userContext.apiType !== "Cassandra" && userContext.apiType !== "Mongo";
       this.shouldShowPartitionKeyEditor = userContext.apiType === "SQL" && isRunningOnPublicCloud();
+      this.isGlobalSecondaryIndex =
+        !!this.collection?.materializedViewDefinition() || !!this.collection?.materializedViews();
       this.isVectorSearchEnabled = isVectorSearchEnabled() && !hasDatabaseSharedThroughput(this.collection);
       this.isFullTextSearchEnabled = isFullTextSearchEnabled() && !hasDatabaseSharedThroughput(this.collection);
 
@@ -1272,6 +1279,11 @@ export class SettingsComponent extends React.Component<SettingsComponentProps, S
       explorer: this.props.settingsTab.getContainer(),
     };
 
+    const globalSecondaryIndexComponentProps: GlobalSecondaryIndexComponentProps = {
+      collection: this.collection,
+      explorer: this.props.settingsTab.getContainer(),
+    };
+
     const tabs: SettingsV2TabInfo[] = [];
     if (!hasDatabaseSharedThroughput(this.collection) && this.offer) {
       tabs.push({
@@ -1335,6 +1347,13 @@ export class SettingsComponent extends React.Component<SettingsComponentProps, S
       });
     }
 
+    if (this.isGlobalSecondaryIndex) {
+      tabs.push({
+        tab: SettingsV2TabTypes.GlobalSecondaryIndexTab,
+        content: <GlobalSecondaryIndexComponent {...globalSecondaryIndexComponentProps} />,
+      });
+    }
+
     const pivotProps: IPivotProps = {
       onLinkClick: this.onPivotChange,
       selectedKey: SettingsV2TabTypes[this.state.selectedTab],

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

@@ -0,0 +1,46 @@
+import { shallow } from "enzyme";
+import React from "react";
+import { collection, container } from "../TestUtils";
+import { GlobalSecondaryIndexComponent } from "./GlobalSecondaryIndexComponent";
+import { GlobalSecondaryIndexSourceComponent } from "./GlobalSecondaryIndexSourceComponent";
+import { GlobalSecondaryIndexTargetComponent } from "./GlobalSecondaryIndexTargetComponent";
+
+describe("GlobalSecondaryIndexComponent", () => {
+  let testCollection: typeof collection;
+  let testExplorer: typeof container;
+
+  beforeEach(() => {
+    testCollection = { ...collection };
+  });
+
+  it("renders only the source component when materializedViewDefinition is missing", () => {
+    testCollection.materializedViews([
+      { id: "view1", _rid: "rid1" },
+      { id: "view2", _rid: "rid2" },
+    ]);
+    testCollection.materializedViewDefinition(null);
+    const wrapper = shallow(<GlobalSecondaryIndexComponent collection={testCollection} explorer={testExplorer} />);
+    expect(wrapper.find(GlobalSecondaryIndexSourceComponent).exists()).toBe(true);
+    expect(wrapper.find(GlobalSecondaryIndexTargetComponent).exists()).toBe(false);
+  });
+
+  it("renders only the target component when materializedViews is missing", () => {
+    testCollection.materializedViews(null);
+    testCollection.materializedViewDefinition({
+      definition: "SELECT * FROM c WHERE c.id = 1",
+      sourceCollectionId: "source1",
+      sourceCollectionRid: "rid123",
+    });
+    const wrapper = shallow(<GlobalSecondaryIndexComponent collection={testCollection} explorer={testExplorer} />);
+    expect(wrapper.find(GlobalSecondaryIndexSourceComponent).exists()).toBe(false);
+    expect(wrapper.find(GlobalSecondaryIndexTargetComponent).exists()).toBe(true);
+  });
+
+  it("renders neither component when both are missing", () => {
+    testCollection.materializedViews(null);
+    testCollection.materializedViewDefinition(null);
+    const wrapper = shallow(<GlobalSecondaryIndexComponent collection={testCollection} explorer={testExplorer} />);
+    expect(wrapper.find(GlobalSecondaryIndexSourceComponent).exists()).toBe(false);
+    expect(wrapper.find(GlobalSecondaryIndexTargetComponent).exists()).toBe(false);
+  });
+});

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

@@ -0,0 +1,41 @@
+import { FontIcon, Link, Stack, Text } from "@fluentui/react";
+import Explorer from "Explorer/Explorer";
+import React from "react";
+import * as ViewModels from "../../../../Contracts/ViewModels";
+import { GlobalSecondaryIndexSourceComponent } from "./GlobalSecondaryIndexSourceComponent";
+import { GlobalSecondaryIndexTargetComponent } from "./GlobalSecondaryIndexTargetComponent";
+
+export interface GlobalSecondaryIndexComponentProps {
+  collection: ViewModels.Collection;
+  explorer: Explorer;
+}
+
+export const GlobalSecondaryIndexComponent: React.FC<GlobalSecondaryIndexComponentProps> = ({
+  collection,
+  explorer,
+}) => {
+  const isTargetContainer = !!collection?.materializedViewDefinition();
+  const isSourceContainer = !!collection?.materializedViews();
+
+  return (
+    <Stack tokens={{ childrenGap: 8 }} styles={{ root: { maxWidth: 600 } }}>
+      <Stack horizontal verticalAlign="center" wrap tokens={{ childrenGap: 8 }}>
+        {isSourceContainer && (
+          <Text styles={{ root: { fontWeight: 600 } }}>This container has the following indexes defined for it.</Text>
+        )}
+        <Text>
+          <Link
+            target="_blank"
+            href="https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/materialized-views#defining-materialized-views"
+          >
+            Learn more
+            <FontIcon iconName="NavigateExternalInline" style={{ marginLeft: "4px" }} />
+          </Link>{" "}
+          about how to define global secondary indexes and how to use them.
+        </Text>
+      </Stack>
+      {isSourceContainer && <GlobalSecondaryIndexSourceComponent collection={collection} explorer={explorer} />}
+      {isTargetContainer && <GlobalSecondaryIndexTargetComponent collection={collection} />}
+    </Stack>
+  );
+};

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

@@ -0,0 +1,42 @@
+import { PrimaryButton } from "@fluentui/react";
+import { shallow } from "enzyme";
+import React from "react";
+import { collection, container } from "../TestUtils";
+import { GlobalSecondaryIndexSourceComponent } from "./GlobalSecondaryIndexSourceComponent";
+
+describe("GlobalSecondaryIndexSourceComponent", () => {
+  let testCollection: typeof collection;
+  let testExplorer: typeof container;
+
+  beforeEach(() => {
+    testCollection = { ...collection };
+  });
+
+  it("renders without crashing", () => {
+    const wrapper = shallow(
+      <GlobalSecondaryIndexSourceComponent collection={testCollection} explorer={testExplorer} />,
+    );
+    expect(wrapper.exists()).toBe(true);
+  });
+
+  it("renders the PrimaryButton", () => {
+    const wrapper = shallow(
+      <GlobalSecondaryIndexSourceComponent collection={testCollection} explorer={testExplorer} />,
+    );
+    expect(wrapper.find(PrimaryButton).exists()).toBe(true);
+  });
+
+  it("updates when new global secondary indexes are provided", () => {
+    const wrapper = shallow(
+      <GlobalSecondaryIndexSourceComponent collection={testCollection} explorer={testExplorer} />,
+    );
+
+    // Simulating an update by modifying the observable directly
+    testCollection.materializedViews([{ id: "view3", _rid: "rid3" }]);
+
+    wrapper.setProps({ collection: testCollection });
+    wrapper.update();
+
+    expect(wrapper.find(PrimaryButton).exists()).toBe(true);
+  });
+});

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

@@ -0,0 +1,114 @@
+import { PrimaryButton } from "@fluentui/react";
+import { GlobalSecondaryIndexLabels } from "Common/Constants";
+import { MaterializedView } from "Contracts/DataModels";
+import Explorer from "Explorer/Explorer";
+import { loadMonaco } from "Explorer/LazyMonaco";
+import { AddGlobalSecondaryIndexPanel } from "Explorer/Panes/AddGlobalSecondaryIndexPanel/AddGlobalSecondaryIndexPanel";
+import { useDatabases } from "Explorer/useDatabases";
+import { useSidePanel } from "hooks/useSidePanel";
+import * as monaco from "monaco-editor";
+import React, { useEffect, useRef } from "react";
+import * as ViewModels from "../../../../Contracts/ViewModels";
+
+export interface GlobalSecondaryIndexSourceComponentProps {
+  collection: ViewModels.Collection;
+  explorer: Explorer;
+}
+
+export const GlobalSecondaryIndexSourceComponent: React.FC<GlobalSecondaryIndexSourceComponentProps> = ({
+  collection,
+  explorer,
+}) => {
+  const editorContainerRef = useRef<HTMLDivElement>(null);
+  const editorRef = useRef<monaco.editor.IStandaloneCodeEditor>(null);
+
+  const globalSecondaryIndexes: MaterializedView[] = collection?.materializedViews() ?? [];
+
+  // Helper function to fetch the definition and partition key of targetContainer by traversing through all collections and matching id from MaterializedView[] with collection id.
+  const getViewDetails = (viewId: string): { definition: string; partitionKey: string[] } => {
+    let definition = "";
+    let partitionKey: string[] = [];
+
+    useDatabases.getState().databases.find((database) => {
+      const collection = database.collections().find((collection) => collection.id() === viewId);
+      if (collection) {
+        const globalSecondaryIndexDefinition = collection.materializedViewDefinition();
+        globalSecondaryIndexDefinition && (definition = globalSecondaryIndexDefinition.definition);
+        collection.partitionKey?.paths && (partitionKey = collection.partitionKey.paths);
+      }
+    });
+
+    return { definition, partitionKey };
+  };
+
+  //JSON value for the editor using the fetched id and definitions.
+  const jsonValue = JSON.stringify(
+    globalSecondaryIndexes.map((view) => {
+      const { definition, partitionKey } = getViewDetails(view.id);
+      return {
+        name: view.id,
+        partitionKey: partitionKey.join(", "),
+        definition,
+      };
+    }),
+    null,
+    2,
+  );
+
+  // Initialize Monaco editor with the computed JSON value.
+  useEffect(() => {
+    let disposed = false;
+    const initMonaco = async () => {
+      const monacoInstance = await loadMonaco();
+      if (disposed || !editorContainerRef.current) {
+        return;
+      }
+
+      editorRef.current = monacoInstance.editor.create(editorContainerRef.current, {
+        value: jsonValue,
+        language: "json",
+        ariaLabel: "Global Secondary Index JSON",
+        readOnly: true,
+      });
+    };
+
+    initMonaco();
+    return () => {
+      disposed = true;
+      editorRef.current?.dispose();
+    };
+  }, [jsonValue]);
+
+  // Update the editor when the jsonValue changes.
+  useEffect(() => {
+    if (editorRef.current) {
+      editorRef.current.setValue(jsonValue);
+    }
+  }, [jsonValue]);
+
+  return (
+    <div>
+      <div
+        ref={editorContainerRef}
+        style={{
+          height: 250,
+          border: "1px solid #ccc",
+          borderRadius: 4,
+          overflow: "hidden",
+        }}
+      />
+      <PrimaryButton
+        text="Add index"
+        styles={{ root: { width: "fit-content", marginTop: 12 } }}
+        onClick={() =>
+          useSidePanel
+            .getState()
+            .openSidePanel(
+              GlobalSecondaryIndexLabels.NewGlobalSecondaryIndex,
+              <AddGlobalSecondaryIndexPanel explorer={explorer} sourceContainer={collection} />,
+            )
+        }
+      />
+    </div>
+  );
+};

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

@@ -0,0 +1,32 @@
+import { Text } from "@fluentui/react";
+import { Collection } from "Contracts/ViewModels";
+import { shallow } from "enzyme";
+import React from "react";
+import { collection } from "../TestUtils";
+import { GlobalSecondaryIndexTargetComponent } from "./GlobalSecondaryIndexTargetComponent";
+
+describe("GlobalSecondaryIndexTargetComponent", () => {
+  let testCollection: Collection;
+
+  beforeEach(() => {
+    testCollection = {
+      ...collection,
+      materializedViewDefinition: collection.materializedViewDefinition,
+    };
+  });
+
+  it("renders without crashing", () => {
+    const wrapper = shallow(<GlobalSecondaryIndexTargetComponent collection={testCollection} />);
+    expect(wrapper.exists()).toBe(true);
+  });
+
+  it("displays the source container ID", () => {
+    const wrapper = shallow(<GlobalSecondaryIndexTargetComponent collection={testCollection} />);
+    expect(wrapper.find(Text).at(2).dive().text()).toBe("source1");
+  });
+
+  it("displays the global secondary index definition", () => {
+    const wrapper = shallow(<GlobalSecondaryIndexTargetComponent collection={testCollection} />);
+    expect(wrapper.find(Text).at(4).dive().text()).toBe("SELECT * FROM c WHERE c.id = 1");
+  });
+});

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

@@ -0,0 +1,45 @@
+import { Stack, Text } from "@fluentui/react";
+import * as React from "react";
+import * as ViewModels from "../../../../Contracts/ViewModels";
+
+export interface GlobalSecondaryIndexTargetComponentProps {
+  collection: ViewModels.Collection;
+}
+
+export const GlobalSecondaryIndexTargetComponent: React.FC<GlobalSecondaryIndexTargetComponentProps> = ({
+  collection,
+}) => {
+  const globalSecondaryIndexDefinition = collection?.materializedViewDefinition();
+
+  const textHeadingStyle = {
+    root: { fontWeight: "600", fontSize: 16 },
+  };
+
+  const valueBoxStyle = {
+    root: {
+      backgroundColor: "#f3f3f3",
+      padding: "5px 10px",
+      borderRadius: "4px",
+    },
+  };
+
+  return (
+    <Stack tokens={{ childrenGap: 15 }} styles={{ root: { maxWidth: 600 } }}>
+      <Text styles={textHeadingStyle}>Global Secondary Index Settings</Text>
+
+      <Stack tokens={{ childrenGap: 5 }}>
+        <Text styles={{ root: { fontWeight: "600" } }}>Source container</Text>
+        <Stack styles={valueBoxStyle}>
+          <Text>{globalSecondaryIndexDefinition?.sourceCollectionId}</Text>
+        </Stack>
+      </Stack>
+
+      <Stack tokens={{ childrenGap: 5 }}>
+        <Text styles={{ root: { fontWeight: "600" } }}>Global secondary index definition</Text>
+        <Stack styles={valueBoxStyle}>
+          <Text>{globalSecondaryIndexDefinition?.definition}</Text>
+        </Stack>
+      </Stack>
+    </Stack>
+  );
+};

src/Explorer/Controls/Settings/SettingsUtils.tsx

@@ -57,6 +57,7 @@ export enum SettingsV2TabTypes {
   ComputedPropertiesTab,
   ContainerVectorPolicyTab,
   ThroughputBucketsTab,
+  GlobalSecondaryIndexTab,
 }
 
 export enum ContainerPolicyTabTypes {
@@ -171,6 +172,8 @@ export const getTabTitle = (tab: SettingsV2TabTypes): string => {
       return "Container Policies";
     case SettingsV2TabTypes.ThroughputBucketsTab:
       return "Throughput Buckets";
+    case SettingsV2TabTypes.GlobalSecondaryIndexTab:
+      return "Global Secondary Index (Preview)";
     default:
       throw new Error(`Unknown tab ${tab}`);
   }

src/Explorer/Controls/Settings/TestUtils.tsx

@@ -48,6 +48,15 @@ export const collection = {
   ]),
   vectorEmbeddingPolicy: ko.observable<DataModels.VectorEmbeddingPolicy>({} as DataModels.VectorEmbeddingPolicy),
   fullTextPolicy: ko.observable<DataModels.FullTextPolicy>({} as DataModels.FullTextPolicy),
+  materializedViews: ko.observable<DataModels.MaterializedView[]>([
+    { id: "view1", _rid: "rid1" },
+    { id: "view2", _rid: "rid2" },
+  ]),
+  materializedViewDefinition: ko.observable<DataModels.MaterializedViewDefinition>({
+    definition: "SELECT * FROM c WHERE c.id = 1",
+    sourceCollectionId: "source1",
+    sourceCollectionRid: "rid123",
+  }),
   readSettings: () => {
     return;
   },

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

@@ -60,6 +60,8 @@ exports[`SettingsComponent renders 1`] = `
               "getDatabase": [Function],
               "id": [Function],
               "indexingPolicy": [Function],
+              "materializedViewDefinition": [Function],
+              "materializedViews": [Function],
               "offer": [Function],
               "partitionKey": {
                 "kind": "hash",
@@ -139,6 +141,8 @@ exports[`SettingsComponent renders 1`] = `
               "getDatabase": [Function],
               "id": [Function],
               "indexingPolicy": [Function],
+              "materializedViewDefinition": [Function],
+              "materializedViews": [Function],
               "offer": [Function],
               "partitionKey": {
                 "kind": "hash",
@@ -258,6 +262,8 @@ exports[`SettingsComponent renders 1`] = `
               "getDatabase": [Function],
               "id": [Function],
               "indexingPolicy": [Function],
+              "materializedViewDefinition": [Function],
+              "materializedViews": [Function],
               "offer": [Function],
               "partitionKey": {
                 "kind": "hash",
@@ -336,6 +342,101 @@ exports[`SettingsComponent renders 1`] = `
           shouldDiscardComputedProperties={false}
         />
       </PivotItem>
+      <PivotItem
+        headerText="Global Secondary Index (Preview)"
+        itemKey="GlobalSecondaryIndexTab"
+        key="GlobalSecondaryIndexTab"
+        style={
+          {
+            "marginTop": 20,
+          }
+        }
+      >
+        <GlobalSecondaryIndexComponent
+          collection={
+            {
+              "analyticalStorageTtl": [Function],
+              "changeFeedPolicy": [Function],
+              "computedProperties": [Function],
+              "conflictResolutionPolicy": [Function],
+              "container": Explorer {
+                "_isInitializingNotebooks": false,
+                "isFixedCollectionWithSharedThroughputSupported": [Function],
+                "isTabsContentExpanded": [Function],
+                "onRefreshDatabasesKeyPress": [Function],
+                "onRefreshResourcesClick": [Function],
+                "phoenixClient": PhoenixClient {
+                  "armResourceId": undefined,
+                  "retryOptions": {
+                    "maxTimeout": 5000,
+                    "minTimeout": 5000,
+                    "retries": 3,
+                  },
+                },
+                "provideFeedbackEmail": [Function],
+                "queriesClient": QueriesClient {
+                  "container": [Circular],
+                },
+                "refreshNotebookList": [Function],
+                "resourceTree": ResourceTreeAdapter {
+                  "container": [Circular],
+                  "copyNotebook": [Function],
+                  "parameters": [Function],
+                },
+              },
+              "databaseId": "test",
+              "defaultTtl": [Function],
+              "fullTextPolicy": [Function],
+              "geospatialConfig": [Function],
+              "getDatabase": [Function],
+              "id": [Function],
+              "indexingPolicy": [Function],
+              "materializedViewDefinition": [Function],
+              "materializedViews": [Function],
+              "offer": [Function],
+              "partitionKey": {
+                "kind": "hash",
+                "paths": [],
+                "version": 2,
+              },
+              "partitionKeyProperties": [
+                "partitionKey",
+              ],
+              "readSettings": [Function],
+              "uniqueKeyPolicy": {},
+              "usageSizeInKB": [Function],
+              "vectorEmbeddingPolicy": [Function],
+            }
+          }
+          explorer={
+            Explorer {
+              "_isInitializingNotebooks": false,
+              "isFixedCollectionWithSharedThroughputSupported": [Function],
+              "isTabsContentExpanded": [Function],
+              "onRefreshDatabasesKeyPress": [Function],
+              "onRefreshResourcesClick": [Function],
+              "phoenixClient": PhoenixClient {
+                "armResourceId": undefined,
+                "retryOptions": {
+                  "maxTimeout": 5000,
+                  "minTimeout": 5000,
+                  "retries": 3,
+                },
+              },
+              "provideFeedbackEmail": [Function],
+              "queriesClient": QueriesClient {
+                "container": [Circular],
+              },
+              "refreshNotebookList": [Function],
+              "resourceTree": ResourceTreeAdapter {
+                "container": [Circular],
+                "copyNotebook": [Function],
+                "parameters": [Function],
+              },
+            }
+          }
+        />
+      </PivotItem>
     </StyledPivot>
   </div>
 </div>