Added the Self Serve Data Model (#367)

* added recursion and inition decorators

* working version

* added todo comment and removed console.log

* Added Recursive add

* removed type requirement

* proper resolution of promises

* added custom element and base class

* Made selfServe standalone page

* Added custom renderer as async type

* Added overall defaults

* added inital open from data explorer

* removed landingpage

* added feature for self serve type

* renamed sqlx->example and added invalid type

* Added comments for Example

* removed unnecessary changes

* Resolved PR comments

Added tests
Moved onSubmt and initialize inside base class
Moved testExplorer to separate folder
made fields of SelfServe Class non static

* fixed lint errors

* fixed compilation errors

* Removed reactbinding changes

* renamed dropdown -> choice

* Added SelfServeComponent

* Addressed PR comments

* merged master

* added selfservetype.none for emulator and hosted experience

* fixed formatting errors

* Removed "any" type

* undid package.json changes

test/testExplorer/TestExplorer.ts

@@ -0,0 +1,140 @@
+import { MessageTypes } from "../../src/Contracts/ExplorerContracts";
+import "../../less/hostedexplorer.less";
+import { TestExplorerParams } from "./TestExplorerParams";
+import { ClientSecretCredential } from "@azure/identity";
+import { DatabaseAccountsGetResponse } from "@azure/arm-cosmosdb/esm/models";
+import { CosmosDBManagementClient } from "@azure/arm-cosmosdb";
+import * as msRest from "@azure/ms-rest-js";
+import * as ViewModels from "../../src/Contracts/ViewModels";
+
+class CustomSigner implements msRest.ServiceClientCredentials {
+  private token: string;
+  constructor(token: string) {
+    this.token = token;
+  }
+
+  async signRequest(webResource: msRest.WebResourceLike): Promise<msRest.WebResourceLike> {
+    webResource.headers.set("authorization", `bearer ${this.token}`);
+    return webResource;
+  }
+}
+
+const handleMessage = (event: MessageEvent): void => {
+  if (event.data.type === MessageTypes.InitTestExplorer) {
+    sendMessageToExplorerFrame(event.data);
+  }
+};
+
+const AADLogin = async (
+  notebooksTestRunnerApplicationId: string,
+  notebooksTestRunnerClientId: string,
+  notebooksTestRunnerClientSecret: string
+): Promise<string> => {
+  const credentials = new ClientSecretCredential(
+    notebooksTestRunnerApplicationId,
+    notebooksTestRunnerClientId,
+    notebooksTestRunnerClientSecret
+  );
+  const token = await credentials.getToken("https://management.core.windows.net/.default");
+  return token.token;
+};
+
+const getDatabaseAccount = async (
+  token: string,
+  notebooksAccountSubscriptonId: string,
+  notebooksAccountResourceGroup: string,
+  notebooksAccountName: string
+): Promise<DatabaseAccountsGetResponse> => {
+  const client = new CosmosDBManagementClient(new CustomSigner(token), notebooksAccountSubscriptonId);
+  return client.databaseAccounts.get(notebooksAccountResourceGroup, notebooksAccountName);
+};
+
+const sendMessageToExplorerFrame = (data: unknown): void => {
+  const explorerFrame = document.getElementById("explorerMenu") as HTMLIFrameElement;
+
+  explorerFrame &&
+    explorerFrame.contentDocument &&
+    explorerFrame.contentDocument.referrer &&
+    explorerFrame.contentWindow.postMessage(
+      {
+        signature: "pcIframe",
+        data: data
+      },
+      explorerFrame.contentDocument.referrer || window.location.href
+    );
+};
+
+const initTestExplorer = async (): Promise<void> => {
+  window.addEventListener("message", handleMessage, false);
+
+  const urlSearchParams = new URLSearchParams(window.location.search);
+  const notebooksTestRunnerTenantId = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.notebooksTestRunnerTenantId)
+  );
+  const notebooksTestRunnerClientId = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.notebooksTestRunnerClientId)
+  );
+  const notebooksTestRunnerClientSecret = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.notebooksTestRunnerClientSecret)
+  );
+  const portalRunnerDatabaseAccount = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.portalRunnerDatabaseAccount)
+  );
+  const portalRunnerDatabaseAccountKey = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.portalRunnerDatabaseAccountKey)
+  );
+  const portalRunnerSubscripton = decodeURIComponent(urlSearchParams.get(TestExplorerParams.portalRunnerSubscripton));
+  const portalRunnerResourceGroup = decodeURIComponent(
+    urlSearchParams.get(TestExplorerParams.portalRunnerResourceGroup)
+  );
+  const selfServeType = urlSearchParams.get(TestExplorerParams.selfServeType);
+
+  const token = await AADLogin(
+    notebooksTestRunnerTenantId,
+    notebooksTestRunnerClientId,
+    notebooksTestRunnerClientSecret
+  );
+  const databaseAccount = await getDatabaseAccount(
+    token,
+    portalRunnerSubscripton,
+    portalRunnerResourceGroup,
+    portalRunnerDatabaseAccount
+  );
+
+  const initTestExplorerContent = {
+    type: MessageTypes.InitTestExplorer,
+    inputs: {
+      databaseAccount: databaseAccount,
+      subscriptionId: portalRunnerSubscripton,
+      resourceGroup: portalRunnerResourceGroup,
+      authorizationToken: `Bearer ${token}`,
+      features: {},
+      hasWriteAccess: true,
+      csmEndpoint: "https://management.azure.com",
+      dnsSuffix: "documents.azure.com",
+      serverId: "prod1",
+      extensionEndpoint: "/proxy",
+      subscriptionType: 3,
+      quotaId: "Internal_2014-09-01",
+      addCollectionDefaultFlight: "2",
+      isTryCosmosDBSubscription: false,
+      masterKey: portalRunnerDatabaseAccountKey,
+      loadDatabaseAccountTimestamp: 1604663109836,
+      dataExplorerVersion: "1.0.1",
+      sharedThroughputMinimum: 400,
+      sharedThroughputMaximum: 1000000,
+      sharedThroughputDefault: 400,
+      defaultCollectionThroughput: {
+        storage: "100",
+        throughput: { fixed: 400, unlimited: 400, unlimitedmax: 100000, unlimitedmin: 400, shared: 400 }
+      },
+      // add UI test only when feature is not dependent on flights anymore
+      flights: [],
+      selfServeType: selfServeType
+    } as ViewModels.DataExplorerInputsFrame
+  };
+
+  window.postMessage(initTestExplorerContent, window.location.href);
+};
+
+window.addEventListener("load", initTestExplorer);

test/testExplorer/TestExplorerParams.ts

@@ -0,0 +1,10 @@
+export enum TestExplorerParams {
+  notebooksTestRunnerTenantId = "notebooksTestRunnerTenantId",
+  notebooksTestRunnerClientId = "notebooksTestRunnerClientId",
+  notebooksTestRunnerClientSecret = "notebooksTestRunnerClientSecret",
+  portalRunnerDatabaseAccount = "portalRunnerDatabaseAccount",
+  portalRunnerDatabaseAccountKey = "portalRunnerDatabaseAccountKey",
+  portalRunnerSubscripton = "portalRunnerSubscripton",
+  portalRunnerResourceGroup = "portalRunnerResourceGroup",
+  selfServeType = "selfServeType"
+}

test/testExplorer/TestExplorerUtils.ts

@@ -0,0 +1,54 @@
+import { Frame } from "puppeteer";
+import { TestExplorerParams } from "./TestExplorerParams";
+
+let testExplorerFrame: Frame;
+export const getTestExplorerFrame = async (params?: Map<string, string>): Promise<Frame> => {
+  if (testExplorerFrame) {
+    return testExplorerFrame;
+  }
+
+  const notebooksTestRunnerTenantId = process.env.NOTEBOOKS_TEST_RUNNER_TENANT_ID;
+  const notebooksTestRunnerClientId = process.env.NOTEBOOKS_TEST_RUNNER_CLIENT_ID;
+  const notebooksTestRunnerClientSecret = process.env.NOTEBOOKS_TEST_RUNNER_CLIENT_SECRET;
+  const portalRunnerDatabaseAccount = process.env.PORTAL_RUNNER_DATABASE_ACCOUNT;
+  const portalRunnerDatabaseAccountKey = process.env.PORTAL_RUNNER_DATABASE_ACCOUNT_KEY;
+  const portalRunnerSubscripton = process.env.PORTAL_RUNNER_SUBSCRIPTION;
+  const portalRunnerResourceGroup = process.env.PORTAL_RUNNER_RESOURCE_GROUP;
+
+  const testExplorerUrl = new URL("testExplorer.html", "https://localhost:1234");
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.notebooksTestRunnerTenantId,
+    encodeURI(notebooksTestRunnerTenantId)
+  );
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.notebooksTestRunnerClientId,
+    encodeURI(notebooksTestRunnerClientId)
+  );
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.notebooksTestRunnerClientSecret,
+    encodeURI(notebooksTestRunnerClientSecret)
+  );
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.portalRunnerDatabaseAccount,
+    encodeURI(portalRunnerDatabaseAccount)
+  );
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.portalRunnerDatabaseAccountKey,
+    encodeURI(portalRunnerDatabaseAccountKey)
+  );
+  testExplorerUrl.searchParams.append(TestExplorerParams.portalRunnerSubscripton, encodeURI(portalRunnerSubscripton));
+  testExplorerUrl.searchParams.append(
+    TestExplorerParams.portalRunnerResourceGroup,
+    encodeURI(portalRunnerResourceGroup)
+  );
+
+  if (params) {
+    for (const key of params.keys()) {
+      testExplorerUrl.searchParams.append(key, encodeURI(params.get(key)));
+    }
+  }
+
+  await page.goto(testExplorerUrl.toString());
+  const handle = await page.waitForSelector("iframe");
+  return await handle.contentFrame();
+};

test/testExplorer/testExplorer.html

@@ -0,0 +1,18 @@
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0" />
+    <title>Azure Cosmos DB</title>
+    <link rel="shortcut icon" href="images/CosmosDB_rgb_ui_lighttheme.ico" type="image/x-icon" />
+  </head>
+
+  <body>
+    <iframe
+      id="explorerMenu"
+      name="explorer"
+      class="iframe"
+      title="explorer"
+      src="explorer.html?v=1.0.1&platform=Portal"
+    ></iframe>
+  </body>
+</html>