Legacy Mongo Shell Mongo Proxy support (#1802)

* LMS Mongo Proxy support

* change stirng to url for get mongo shell url

* fix tests

* enable feature flag

* fixed unit test

---------

Co-authored-by: Asier Isayas <aisayas@microsoft.com>

src/Explorer/Tabs/MongoShellTab/MongoShellTabComponent.tsx

@@ -9,7 +9,6 @@ import { isInvalidParentFrameOrigin, isReadyMessage } from "../../../Utils/Messa
 import { logConsoleError, logConsoleInfo, logConsoleProgress } from "../../../Utils/NotificationConsoleUtils";
 import Explorer from "../../Explorer";
 import TabsBase from "../TabsBase";
-import { getMongoShellOrigin } from "./getMongoShellOrigin";
 import { getMongoShellUrl } from "./getMongoShellUrl";
 
 //eslint-disable-next-line
@@ -35,7 +34,7 @@ export interface IMongoShellTabAccessor {
 }
 
 export interface IMongoShellTabComponentStates {
-  url: string;
+  url: URL;
 }
 
 export interface IMongoShellTabComponentProps {
@@ -50,13 +49,16 @@ export default class MongoShellTabComponent extends Component<
   IMongoShellTabComponentStates
 > {
   private _logTraces: Map<string, number>;
+  private _useMongoProxyEndpoint: boolean;
 
   constructor(props: IMongoShellTabComponentProps) {
     super(props);
     this._logTraces = new Map();
+    this._useMongoProxyEndpoint = userContext.features.enableLegacyMongoShell;
+    // this._useMongoProxyEndpoint = useMongoProxyEndpoint("legacyMongoShell");
 
     this.state = {
-      url: getMongoShellUrl(),
+      url: getMongoShellUrl(this._useMongoProxyEndpoint),
     };
 
     props.onMongoShellTabAccessor({
@@ -119,9 +121,10 @@ export default class MongoShellTabComponent extends Component<
       ) + Constants.MongoDBAccounts.defaultPort.toString();
     const databaseId = this.props.collection.databaseId;
     const collectionId = this.props.collection.id();
-    const apiEndpoint = configContext.BACKEND_ENDPOINT;
+    const apiEndpoint = this._useMongoProxyEndpoint
+      ? configContext.MONGO_PROXY_ENDPOINT
+      : configContext.BACKEND_ENDPOINT;
     const encryptedAuthToken: string = userContext.accessToken;
-    const targetOrigin = getMongoShellOrigin();
 
     shellIframe.contentWindow.postMessage(
       {
@@ -137,7 +140,7 @@ export default class MongoShellTabComponent extends Component<
           apiEndpoint: apiEndpoint,
         },
       },
-      targetOrigin,
+      window.origin,
     );
   }
 
@@ -218,7 +221,7 @@ export default class MongoShellTabComponent extends Component<
         name="explorer"
         className="iframe"
         style={{ width: "100%", height: "100%", border: 0, padding: 0, margin: 0, overflow: "hidden" }}
-        src={this.state.url}
+        src={this.state.url.toString()}
         id={this.props.tabsBaseInstance.tabId}
         onLoad={(event) => this.setContentFocus(event)}
         title="Mongo Shell"

src/Explorer/Tabs/MongoShellTab/getMongoShellOrigin.test.ts

@@ -1,86 +0,0 @@
-import { extractFeatures } from "Platform/Hosted/extractFeatures";
-import { configContext } from "../../../ConfigContext";
-import { updateUserContext } from "../../../UserContext";
-import { getMongoShellOrigin } from "./getMongoShellOrigin";
-
-describe("getMongoShellOrigin", () => {
-  (window as { origin: string }).origin = "window_origin";
-
-  beforeEach(() => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1": "false",
-          "feature.enableLegacyMongoShellV2": "false",
-          "feature.enableLegacyMongoShellV1Debug": "false",
-          "feature.enableLegacyMongoShellV2Debug": "false",
-          "feature.loadLegacyMongoShellFromBE": "false",
-        }),
-      ),
-    });
-  });
-
-  it("should return  by default", () => {
-    expect(getMongoShellOrigin()).toBe(window.origin);
-  });
-
-  it("should return window.origin when enableLegacyMongoShellV1", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellOrigin()).toBe(window.origin);
-  });
-
-  it("should return window.origin when enableLegacyMongoShellV2===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV2": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellOrigin()).toBe(window.origin);
-  });
-
-  it("should return window.origin when enableLegacyMongoShellV1Debug===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1Debug": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellOrigin()).toBe(window.origin);
-  });
-
-  it("should return window.origin when enableLegacyMongoShellV2Debug===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV2Debug": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellOrigin()).toBe(window.origin);
-  });
-
-  it("should return BACKEND_ENDPOINT when loadLegacyMongoShellFromBE===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.loadLegacyMongoShellFromBE": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellOrigin()).toBe(configContext.BACKEND_ENDPOINT);
-  });
-});

src/Explorer/Tabs/MongoShellTab/getMongoShellOrigin.ts

@@ -1,10 +0,0 @@
-import { configContext } from "../../../ConfigContext";
-import { userContext } from "../../../UserContext";
-
-export function getMongoShellOrigin(): string {
-  if (userContext.features.loadLegacyMongoShellFromBE === true) {
-    return configContext.BACKEND_ENDPOINT;
-  }
-
-  return window.origin;
-}

src/Explorer/Tabs/MongoShellTab/getMongoShellUrl.test.ts

@@ -1,9 +1,9 @@
-import { extractFeatures } from "Platform/Hosted/extractFeatures";
-import { Platform, configContext, resetConfigContext, updateConfigContext } from "../../../ConfigContext";
+import { Platform, resetConfigContext, updateConfigContext } from "../../../ConfigContext";
 import { updateUserContext, userContext } from "../../../UserContext";
-import { getExtensionEndpoint, getMongoShellUrl } from "./getMongoShellUrl";
+import { getMongoShellUrl } from "./getMongoShellUrl";
 
 const mongoBackendEndpoint = "https://localhost:1234";
+const hostedExplorerURL = "https://cosmos.azure.com/";
 
 describe("getMongoShellUrl", () => {
   let queryString = "";
@@ -13,6 +13,7 @@ describe("getMongoShellUrl", () => {
 
     updateConfigContext({
       BACKEND_ENDPOINT: mongoBackendEndpoint,
+      hostedExplorerURL: hostedExplorerURL,
       platform: Platform.Hosted,
     });
 
@@ -32,175 +33,18 @@ describe("getMongoShellUrl", () => {
           cassandraEndpoint: "fakeCassandraEndpoint",
         },
       },
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1": "false",
-          "feature.enableLegacyMongoShellV2": "false",
-          "feature.enableLegacyMongoShellV1Debug": "false",
-          "feature.enableLegacyMongoShellV2Debug": "false",
-          "feature.loadLegacyMongoShellFromBE": "false",
-        }),
-      ),
       portalEnv: "prod",
     });
 
     queryString = `resourceId=${userContext.databaseAccount.id}&accountName=${userContext.databaseAccount.name}&mongoEndpoint=${userContext.databaseAccount.properties.documentEndpoint}`;
   });
 
-  it("should return /mongoshell/indexv2.html by default", () => {
-    expect(getMongoShellUrl()).toBe(`/mongoshell/indexv2.html?${queryString}`);
+  it("should return /indexv2.html by default", () => {
+    expect(getMongoShellUrl().toString()).toContain(`/indexv2.html?${queryString}`);
   });
 
-  it("should return /mongoshell/indexv2.html when portalEnv==localhost", () => {
-    updateUserContext({
-      portalEnv: "localhost",
-    });
-
-    expect(getMongoShellUrl()).toBe(`/mongoshell/indexv2.html?${queryString}`);
-  });
-
-  it("should return /mongoshell/index.html when enableLegacyMongoShellV1===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellUrl()).toBe(`/mongoshell/index.html?${queryString}`);
-  });
-
-  it("should return /mongoshell/index.html when enableLegacyMongoShellV2===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV2": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellUrl()).toBe(`/mongoshell/indexv2.html?${queryString}`);
-  });
-
-  it("should return /mongoshell/index.html when enableLegacyMongoShellV1Debug===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV1Debug": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellUrl()).toBe(`/mongoshell/debug/index.html?${queryString}`);
-  });
-
-  it("should return /mongoshell/index.html when enableLegacyMongoShellV2Debug===true", () => {
-    updateUserContext({
-      features: extractFeatures(
-        new URLSearchParams({
-          "feature.enableLegacyMongoShellV2Debug": "true",
-        }),
-      ),
-    });
-
-    expect(getMongoShellUrl()).toBe(`/mongoshell/debug/indexv2.html?${queryString}`);
-  });
-
-  describe("loadLegacyMongoShellFromBE===true", () => {
-    beforeEach(() => {
-      resetConfigContext();
-      updateConfigContext({
-        BACKEND_ENDPOINT: mongoBackendEndpoint,
-        platform: Platform.Hosted,
-      });
-
-      updateUserContext({
-        features: extractFeatures(
-          new URLSearchParams({
-            "feature.loadLegacyMongoShellFromBE": "true",
-          }),
-        ),
-      });
-    });
-
-    it("should return /mongoshell/index.html", () => {
-      const endpoint = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-      expect(getMongoShellUrl()).toBe(`${endpoint}/content/mongoshell/debug/index.html?${queryString}`);
-    });
-
-    it("configContext.platform !== Platform.Hosted, should return /mongoshell/indexv2.html", () => {
-      updateConfigContext({
-        platform: Platform.Portal,
-      });
-
-      const endpoint = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-      expect(getMongoShellUrl()).toBe(`${endpoint}/content/mongoshell/debug/index.html?${queryString}`);
-    });
-
-    it("configContext.BACKEND_ENDPOINT !== '' and configContext.platform !== Platform.Hosted, should return /mongoshell/indexv2.html", () => {
-      resetConfigContext();
-      updateConfigContext({
-        platform: Platform.Portal,
-        BACKEND_ENDPOINT: mongoBackendEndpoint,
-      });
-
-      const endpoint = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-      expect(getMongoShellUrl()).toBe(`${endpoint}/content/mongoshell/debug/index.html?${queryString}`);
-    });
-
-    it("configContext.BACKEND_ENDPOINT === '' and configContext.platform === Platform.Hosted, should return /mongoshell/indexv2.html", () => {
-      resetConfigContext();
-      updateConfigContext({
-        platform: Platform.Hosted,
-      });
-
-      const endpoint = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-      expect(getMongoShellUrl()).toBe(`${endpoint}/content/mongoshell/debug/index.html?${queryString}`);
-    });
-
-    it("configContext.BACKEND_ENDPOINT === '' and configContext.platform !== Platform.Hosted, should return /mongoshell/indexv2.html", () => {
-      resetConfigContext();
-      updateConfigContext({
-        platform: Platform.Portal,
-      });
-
-      const endpoint = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-      expect(getMongoShellUrl()).toBe(`${endpoint}/content/mongoshell/debug/index.html?${queryString}`);
-    });
-  });
-});
-
-describe("getExtensionEndpoint", () => {
-  it("when platform === Platform.Hosted, backendEndpoint is undefined", () => {
-    expect(getExtensionEndpoint(Platform.Hosted, undefined)).toBe("");
-  });
-
-  it("when platform === Platform.Hosted, backendEndpoint === ''", () => {
-    expect(getExtensionEndpoint(Platform.Hosted, "")).toBe("");
-  });
-
-  it("when platform === Platform.Hosted, backendEndpoint === null", () => {
-    expect(getExtensionEndpoint(Platform.Hosted, null)).toBe("");
-  });
-
-  it("when platform === Platform.Hosted, backendEndpoint != ''", () => {
-    expect(getExtensionEndpoint(Platform.Hosted, "foo")).toBe("foo");
-  });
-
-  it("when platform === Platform.Portal, backendEndpoint is udefined", () => {
-    expect(getExtensionEndpoint(Platform.Portal, undefined)).toBe("");
-  });
-
-  it("when platform === Platform.Portal, backendEndpoint === ''", () => {
-    expect(getExtensionEndpoint(Platform.Portal, "")).toBe("");
-  });
-
-  it("when platform === Platform.Portal, backendEndpoint === null", () => {
-    expect(getExtensionEndpoint(Platform.Portal, null)).toBe("");
-  });
-
-  it("when platform !== Platform.Portal, backendEndpoint != ''", () => {
-    expect(getExtensionEndpoint(Platform.Portal, "foo")).toBe("foo");
+  it("should return /index.html when useMongoProxyEndpoint is true", () => {
+    const useMongoProxyEndpoint: boolean = true;
+    expect(getMongoShellUrl(useMongoProxyEndpoint).toString()).toContain(`/index.html?${queryString}`);
   });
 });

src/Explorer/Tabs/MongoShellTab/getMongoShellUrl.ts

@@ -1,45 +1,13 @@
-import { configContext, Platform } from "../../../ConfigContext";
+import { configContext } from "ConfigContext";
 import { userContext } from "../../../UserContext";
 
-export function getMongoShellUrl(): string {
+export function getMongoShellUrl(useMongoProxyEndpoint?: boolean): URL {
   const { databaseAccount: account } = userContext;
   const resourceId = account?.id;
   const accountName = account?.name;
   const mongoEndpoint = account?.properties?.mongoEndpoint || account?.properties?.documentEndpoint;
   const queryString = `resourceId=${resourceId}&accountName=${accountName}&mongoEndpoint=${mongoEndpoint}`;
+  const path: string = useMongoProxyEndpoint ? `/index.html?${queryString}` : `/indexv2.html?${queryString}`;
 
-  if (userContext.features.enableLegacyMongoShellV1 === true) {
-    return `/mongoshell/index.html?${queryString}`;
-  }
-
-  if (userContext.features.enableLegacyMongoShellV1Debug === true) {
-    return `/mongoshell/debug/index.html?${queryString}`;
-  }
-
-  if (userContext.features.enableLegacyMongoShellV2 === true) {
-    return `/mongoshell/indexv2.html?${queryString}`;
-  }
-
-  if (userContext.features.enableLegacyMongoShellV2Debug === true) {
-    return `/mongoshell/debug/indexv2.html?${queryString}`;
-  }
-
-  if (userContext.portalEnv === "localhost") {
-    return `/mongoshell/indexv2.html?${queryString}`;
-  }
-
-  if (userContext.features.loadLegacyMongoShellFromBE === true) {
-    const extensionEndpoint: string = getExtensionEndpoint(configContext.platform, configContext.BACKEND_ENDPOINT);
-    return `${extensionEndpoint}/content/mongoshell/debug/index.html?${queryString}`;
-  }
-
-  return `/mongoshell/indexv2.html?${queryString}`;
-}
-
-export function getExtensionEndpoint(platform: string, backendEndpoint: string): string {
-  const runtimeEndpoint = platform === Platform.Hosted ? backendEndpoint : "";
-
-  const extensionEndpoint: string = backendEndpoint || runtimeEndpoint || "";
-
-  return extensionEndpoint;
+  return new URL(path, configContext.hostedExplorerURL);
 }

src/Explorer/Tabs/Tabs.tsx

@@ -329,7 +329,7 @@ const getReactTabContent = (activeReactTab: ReactTabKind, explorer: Explorer): J
 const showMongoAndCassandraProxiesNetworkSettingsWarning = (): boolean => {
   const ipRules: IpRule[] = userContext.databaseAccount?.properties?.ipRules;
   if (
-    ((userContext.apiType === "Mongo" && configContext.MONGO_PROXY_ENDPOINT !== MongoProxyEndpoints.Development) ||
+    ((userContext.apiType === "Mongo" && configContext.MONGO_PROXY_ENDPOINT !== MongoProxyEndpoints.Local) ||
       (userContext.apiType === "Cassandra" &&
         configContext.CASSANDRA_PROXY_ENDPOINT !== CassandraProxyEndpoints.Development)) &&
     ipRules?.length