MongoClient Feature Flag (#1073)

Adding a feature flag for Mongo Client that allows a user to specify a mongo endpoint and an API so that users can test specific APIs locally.

Example:

https://localhost:1234/hostedExplorer.html?feature.mongoproxyendpoint=https://localhost:12901&feature.mongoProxyAPIs=createDocument|readDocument

The above link says to test APIs createDocument and readDocument on https://localhost:12901

Co-authored-by: artrejo <ato9000@users.noreply.github.com>
Co-authored-by: Asier Isayas <aisayas@microsoft.com>

src/Platform/Hosted/extractFeatures.test.ts

@@ -1,4 +1,4 @@
-import { extractFeatures } from "./extractFeatures";
+import { extractFeatures, hasFlag } from "./extractFeatures";
 
 describe("extractFeatures", () => {
   it("correctly detects feature flags in a case insensitive manner", () => {
@@ -14,9 +14,24 @@ describe("extractFeatures", () => {
     });
 
     const features = extractFeatures(params);
-
     expect(features.notebookServerUrl).toBe(url);
     expect(features.notebookServerToken).toBe(token);
     expect(features.enableNotebooks).toBe(notebooksEnabled);
   });
 });
+
+describe("hasFlag", () => {
+  it("correctly determines if value has flag", () => {
+    const desiredFlag = "readDocument";
+
+    const singleFlagValue = "readDocument";
+    const multipleFlagValues = "readDocument|createDocument";
+    const differentFlagValue = "createDocument";
+
+    expect(hasFlag(singleFlagValue, desiredFlag)).toBe(true);
+    expect(hasFlag(multipleFlagValues, desiredFlag)).toBe(true);
+    expect(hasFlag(differentFlagValue, desiredFlag)).toBe(false);
+    expect(hasFlag(multipleFlagValues, undefined)).toBe(false);
+    expect(hasFlag(undefined, desiredFlag)).toBe(false);
+  });
+});

src/Platform/Hosted/extractFeatures.ts

@@ -29,6 +29,8 @@ export type Features = {
   readonly pr?: string;
   readonly showMinRUSurvey: boolean;
   readonly ttl90Days: boolean;
+  readonly mongoProxyEndpoint: string;
+  readonly mongoProxyAPIs: string;
   readonly notebooksTemporarilyDown: boolean;
 };
 
@@ -63,6 +65,8 @@ export function extractFeatures(given = new URLSearchParams(window.location.sear
     enableKoResourceTree: "true" === get("enablekoresourcetree"),
     executeSproc: "true" === get("dataexplorerexecutesproc"),
     hostedDataExplorer: "true" === get("hosteddataexplorerenabled"),
+    mongoProxyEndpoint: get("mongoproxyendpoint"),
+    mongoProxyAPIs: get("mongoproxyapis"),
     junoEndpoint: get("junoendpoint"),
     livyEndpoint: get("livyendpoint"),
     notebookBasePath: get("notebookbasepath"),
@@ -80,3 +84,12 @@ export function extractFeatures(given = new URLSearchParams(window.location.sear
     phoenix: "true" === get("phoenix"),
   };
 }
+
+export function hasFlag(flags: string, desiredFlag: string): boolean {
+  if (!flags || !desiredFlag) {
+    return false;
+  }
+
+  const features = flags.split("|");
+  return features.find((feature) => feature === desiredFlag) ? true : false;
+}