Support data plane RBAC

src/Common/Constants.ts

@@ -185,6 +185,9 @@ export class CassandraProxyAPIs {
 export class Queries {
   public static CustomPageOption: string = "custom";
   public static UnlimitedPageOption: string = "unlimited";
+  public static setAutomaticRBACOption: string = "Automatic";
+  public static setTrueRBACOption: string = "True";
+  public static setFalseRBACOption: string = "False";
   public static itemsPerPage: number = 100;
   public static unlimitedItemsPerPage: number = 100; // TODO: Figure out appropriate value so it works for accounts with a large number of partitions
   public static containersPerPage: number = 50;

src/Explorer/Panes/SettingsPane/SettingsPane.tsx

@@ -44,6 +44,13 @@ export const SettingsPane: FunctionComponent<{ explorer: Explorer }> = ({
       ? Constants.Queries.UnlimitedPageOption
       : Constants.Queries.CustomPageOption,
   );
+  const [enableDataPlaneRBACOption, setEnableDataPlaneRBACOption] = useState<string>(
+    LocalStorageUtility.getEntryString(StorageKey.DataPlaneRbacEnabled) === Constants.Queries.setAutomaticRBACOption
+      ? Constants.Queries.setAutomaticRBACOption
+      : LocalStorageUtility.getEntryString(StorageKey.DataPlaneRbacEnabled) === Constants.Queries.setTrueRBACOption
+        ? Constants.Queries.setTrueRBACOption
+        : Constants.Queries.setFalseRBACOption
+  );
   const [ruThresholdEnabled, setRUThresholdEnabled] = useState<boolean>(isRUThresholdEnabled());
   const [ruThreshold, setRUThreshold] = useState<number>(getRUThreshold());
   const [queryTimeoutEnabled, setQueryTimeoutEnabled] = useState<boolean>(
@@ -119,7 +126,14 @@ export const SettingsPane: FunctionComponent<{ explorer: Explorer }> = ({
       StorageKey.ActualItemPerPage,
       isCustomPageOptionSelected() ? customItemPerPage : Constants.Queries.unlimitedItemsPerPage,
     );
+
     LocalStorageUtility.setEntryNumber(StorageKey.CustomItemPerPage, customItemPerPage);
+
+    LocalStorageUtility.setEntryString(
+      StorageKey.DataPlaneRbacEnabled,
+      enableDataPlaneRBACOption
+    );
+
     LocalStorageUtility.setEntryBoolean(StorageKey.RUThresholdEnabled, ruThresholdEnabled);
     LocalStorageUtility.setEntryBoolean(StorageKey.QueryTimeoutEnabled, queryTimeoutEnabled);
     LocalStorageUtility.setEntryNumber(StorageKey.RetryAttempts, retryAttempts);
@@ -207,9 +221,10 @@ export const SettingsPane: FunctionComponent<{ explorer: Explorer }> = ({
     { key: Constants.PriorityLevel.High, text: "High" },
   ];
 
-  const defaultQueryResultsViewOptionList: IChoiceGroupOption[] = [
+  const dataPlaneRBACOptionsList: IChoiceGroupOption[] = [
-    { key: SplitterDirection.Vertical, text: "Vertical" },
+    { key: Constants.Queries.setAutomaticRBACOption, text: "Automatic" },
-    { key: SplitterDirection.Horizontal, text: "Horizontal" },
+    { key: Constants.Queries.setTrueRBACOption, text: "True" },
+    { key: Constants.Queries.setFalseRBACOption, text: "False"}
   ];
 
   const handleOnPriorityLevelOptionChange = (
@@ -223,6 +238,10 @@ export const SettingsPane: FunctionComponent<{ explorer: Explorer }> = ({
     setPageOption(option.key);
   };
 
+  const handleOnDataPlaneRBACOptionChange = (ev: React.FormEvent<HTMLInputElement>, option: IChoiceGroupOption): void => {
+    setEnableDataPlaneRBACOption(option.key);
+  };
+
   const handleOnRUThresholdToggleChange = (ev: React.MouseEvent<HTMLElement>, checked?: boolean): void => {
     setRUThresholdEnabled(checked);
   };
@@ -383,6 +402,27 @@ export const SettingsPane: FunctionComponent<{ explorer: Explorer }> = ({
             </div>
           </div>
         )}
+        {(
+          <div className="settingsSection">
+            <div className="settingsSectionPart">
+              <fieldset>
+                <legend id="enableDataPlaneRBACOptions" className="settingsSectionLabel legendLabel">
+                  Enable DataPlane RBAC
+                </legend>
+                <InfoTooltip>
+                  Choose Automatic to enable DataPlane RBAC automatically. True/False to voluntarily enable/disable DataPlane RBAC
+                </InfoTooltip>
+                <ChoiceGroup
+                  ariaLabelledBy="enableDataPlaneRBACOptions"
+                  selectedKey={enableDataPlaneRBACOption}
+                  options={dataPlaneRBACOptionsList}
+                  styles={choiceButtonStyles}
+                  onChange={handleOnDataPlaneRBACOptionChange}
+                />
+              </fieldset>
+            </div>
+          </div>
+        )}
         {userContext.apiType === "SQL" && (
           <>
             <div className="settingsSection">

src/Platform/Hosted/extractFeatures.ts

@@ -14,6 +14,7 @@ export type Features = {
   readonly enableTtl: boolean;
   readonly executeSproc: boolean;
   readonly enableAadDataPlane: boolean;
+  readonly enableDataPlaneRbac: boolean;
   readonly enableResourceGraph: boolean;
   readonly enableKoResourceTree: boolean;
   readonly hostedDataExplorer: boolean;
@@ -69,6 +70,7 @@ export function extractFeatures(given = new URLSearchParams(window.location.sear
     canExceedMaximumValue: "true" === get("canexceedmaximumvalue"),
     cosmosdb: "true" === get("cosmosdb"),
     enableAadDataPlane: "true" === get("enableaaddataplane"),
+    enableDataPlaneRbac: "true" === get("enabledataplanerbac"),
     enableResourceGraph: "true" === get("enableresourcegraph"),
     enableChangeFeedPolicy: "true" === get("enablechangefeedpolicy"),
     enableFixedCollectionWithSharedThroughput: "true" === get("enablefixedcollectionwithsharedthroughput"),

src/Shared/StorageUtility.ts

@@ -6,6 +6,9 @@ import * as StringUtility from "./StringUtility";
 export { LocalStorageUtility, SessionStorageUtility };
 export enum StorageKey {
   ActualItemPerPage,
+  DataPlaneRbacEnabled,
+  DataPlaneRbacDisabled,
+  isDataPlaneRbacAutomatic,
   RUThresholdEnabled,
   RUThreshold,
   QueryTimeoutEnabled,

src/UserContext.ts

@@ -101,6 +101,7 @@ export interface UserContext {
   sampleDataConnectionInfo?: ParsedResourceTokenConnectionString;
   readonly vcoreMongoConnectionParams?: VCoreMongoConnectionParams;
   readonly feedbackPolicies?: AdminFeedbackPolicySettings;
+  readonly dataPlaneRbacEnabled?: boolean;
 }
 
 export type ApiType = "SQL" | "Mongo" | "Gremlin" | "Tables" | "Cassandra" | "Postgres" | "VCoreMongo";

src/hooks/useKnockoutExplorer.ts

@@ -5,6 +5,7 @@ import { FABRIC_RPC_VERSION, FabricMessageV2 } from "Contracts/FabricMessagesCon
 import Explorer from "Explorer/Explorer";
 import { useSelectedNode } from "Explorer/useSelectedNode";
 import { scheduleRefreshDatabaseResourceToken } from "Platform/Fabric/FabricUtil";
+import { LocalStorageUtility, StorageKey } from "Shared/StorageUtility";
 import { getNetworkSettingsWarningMessage } from "Utils/NetworkUtility";
 import { logConsoleError } from "Utils/NotificationConsoleUtils";
 import { useQueryCopilot } from "hooks/useQueryCopilot";
@@ -271,9 +272,31 @@ async function configureHostedWithAAD(config: AAD): Promise<Explorer> {
     }
   }
   try {
+    if(LocalStorageUtility.hasItem(StorageKey.DataPlaneRbacEnabled)) {
+      var isDataPlaneRbacSetting = LocalStorageUtility.getEntryString(StorageKey.DataPlaneRbacEnabled);
+        if (isDataPlaneRbacSetting == "Automatic")
+        {
           if (!account.properties.disableLocalAuth) {
             keys = await listKeys(subscriptionId, resourceGroup, account.name);
           }
+          else {
+            updateUserContext({
+              dataPlaneRbacEnabled: true
+            });
+          }
+        }
+        else if(isDataPlaneRbacSetting == "True") {
+          updateUserContext({
+            dataPlaneRbacEnabled: true
+          });
+        }
+        else {
+          keys = await listKeys(subscriptionId, resourceGroup, account.name);
+          updateUserContext({
+            dataPlaneRbacEnabled: false
+          });
+        }
+    }
   } catch (e) {
     if (userContext.features.enableAadDataPlane) {
       console.warn(e);
@@ -394,8 +417,9 @@ async function configurePortal(): Promise<Explorer> {
   updateUserContext({
     authType: AuthType.AAD,
   });
+  
   let explorer: Explorer;
-  return new Promise((resolve) => {
+  return new Promise(async (resolve) => {
     // In development mode, try to load the iframe message from session storage.
     // This allows webpack hot reload to function properly in the portal
     if (process.env.NODE_ENV === "development" && !window.location.search.includes("disablePortalInitCache")) {
@@ -408,6 +432,7 @@ async function configurePortal(): Promise<Explorer> {
         console.dir(message);
         updateContextsFromPortalMessage(message);
         explorer = new Explorer();
+
         // In development mode, save the iframe message from the portal in session storage.
         // This allows webpack hot reload to funciton properly
         if (process.env.NODE_ENV === "development") {
@@ -420,7 +445,7 @@ async function configurePortal(): Promise<Explorer> {
     // In the Portal, configuration of Explorer happens via iframe message
     window.addEventListener(
       "message",
-      (event) => {
+      async (event) => {
         if (isInvalidParentFrameOrigin(event)) {
           return;
         }
@@ -450,6 +475,37 @@ async function configurePortal(): Promise<Explorer> {
             setTimeout(() => explorer.openNPSSurveyDialog(), 3000);
           }
 
+          let dbAccount = userContext.databaseAccount;
+          let keys: DatabaseAccountListKeysResult = {};
+          const account = userContext.databaseAccount;
+          const subscriptionId = userContext.subscriptionId;
+          const resourceGroup = userContext.resourceGroup;
+          if(LocalStorageUtility.hasItem(StorageKey.DataPlaneRbacEnabled)) {
+            var isDataPlaneRbacSetting = LocalStorageUtility.getEntryString(StorageKey.DataPlaneRbacEnabled);
+              if (isDataPlaneRbacSetting == "Automatic")
+              {
+                if (!account.properties.disableLocalAuth) {
+                  keys = await listKeys(subscriptionId, resourceGroup, account.name);
+                }
+                else {
+                  updateUserContext({
+                    dataPlaneRbacEnabled: true
+                  });
+                }
+              }
+              else if(isDataPlaneRbacSetting == "True") {
+                updateUserContext({
+                  dataPlaneRbacEnabled: true
+                });
+              }
+              else {
+                keys = await listKeys(subscriptionId, resourceGroup, account.name);
+                updateUserContext({
+                  dataPlaneRbacEnabled: false
+                });
+              }
+          }
+            
           if (openAction) {
             handleOpenAction(openAction, useDatabases.getState().databases, explorer);
           }
@@ -472,7 +528,9 @@ async function configurePortal(): Promise<Explorer> {
     );
     
     sendReadyMessage();
+
   });
+
 }
 
 function shouldForwardMessage(message: PortalMessage, messageOrigin: string) {