Refactor DocumentClientUtilityBase to not be a class (#115)

2025-12-19 08:51:24 +00:00 · 2020-07-27 12:58:27 -05:00
parent 6d142f16f9
commit 2e49ed45c3
48 changed files with 1567 additions and 1754 deletions
--- a/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.test.tsx
+++ b/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.test.tsx
@@ -1,3 +1,4 @@
+jest.mock("../../../Common/DocumentClientUtilityBase");
 import React from "react";
 import * as sinon from "sinon";
 import { mount, ReactWrapper } from "enzyme";
@@ -7,11 +8,11 @@ import { GraphExplorer, GraphExplorerProps, GraphAccessor, GraphHighlightedNodeD
 import * as D3ForceGraph from "./D3ForceGraph";
 import { GraphData } from "./GraphData";
 import { TabComponent } from "../../Controls/Tabs/TabComponent";
-import * as ViewModels from "../../../Contracts/ViewModels";
 import * as DataModels from "../../../Contracts/DataModels";
 import * as StorageUtility from "../../../Shared/StorageUtility";
 import GraphTab from "../../Tabs/GraphTab";
 import { ConsoleDataType } from "../../Menus/NotificationConsole/NotificationConsoleComponent";
+import { queryDocuments, queryDocumentsPage } from "../../../Common/DocumentClientUtilityBase";

 describe("Check whether query result is vertex array", () => {
  it("should reject null as vertex array", () => {
@@ -134,7 +135,7 @@ describe("GraphExplorer", () => {
  const COLLECTION_SELF_LINK = "collectionSelfLink";
  const gremlinRU = 789.12;

-  const createMockProps = (documentClientUtility?: any): GraphExplorerProps => {
+  const createMockProps = (): GraphExplorerProps => {
    const graphConfig = GraphTab.createGraphConfig();
    const graphConfigUi = GraphTab.createGraphConfigUiData(graphConfig);

@@ -149,7 +150,6 @@ describe("GraphExplorer", () => {
      onIsValidQueryChange: (isValidQuery: boolean): void => {},

      collectionPartitionKeyProperty: "collectionPartitionKeyProperty",
-      documentClientUtility: documentClientUtility,
      collectionRid: COLLECTION_RID,
      collectionSelfLink: COLLECTION_SELF_LINK,
      graphBackendEndpoint: "graphBackendEndpoint",
@@ -188,7 +188,6 @@ describe("GraphExplorer", () => {
    let wrapper: ReactWrapper;

    let connectStub: sinon.SinonSpy;
-    let queryDocStub: sinon.SinonSpy;
    let submitToBackendSpy: sinon.SinonSpy;
    let renderResultAsJsonStub: sinon.SinonSpy;
    let onMiddlePaneInitializedStub: sinon.SinonSpy;
@@ -215,46 +214,6 @@ describe("GraphExplorer", () => {
      [query: string]: AjaxResponse;
    }

-    const createDocumentClientUtilityMock = (docDBResponse: AjaxResponse) => {
-      const mock = {
-        queryDocuments: () => {},
-        queryDocumentsPage: (
-          rid: string,
-          iterator: any,
-          firstItemIndex: number,
-          options: any
-        ): Q.Promise<ViewModels.QueryResults> => {
-          const qresult = {
-            hasMoreResults: false,
-            firstItemIndex: firstItemIndex,
-            lastItemIndex: 0,
-            itemCount: 0,
-            documents: docDBResponse.response,
-            activityId: "",
-            headers: [] as any[],
-            requestCharge: gVRU
-          };
-
-          return Q.resolve(qresult);
-        }
-      };
-
-      const fakeIterator: any = {
-        nextItem: (callback: (error: any, document: DataModels.DocumentId) => void): void => {},
-        hasMoreResults: () => false,
-        executeNext: (callback: (error: any, documents: DataModels.DocumentId[], headers: any) => void): void => {}
-      };
-
-      queryDocStub = sinon.stub(mock, "queryDocuments").callsFake(
-        (container: ViewModels.DocumentRequestContainer, query: string, options: any): Q.Promise<any> => {
-          (fakeIterator as any)._query = query;
-          return Q.resolve(fakeIterator);
-        }
-      );
-
-      return mock;
-    };
-
    const setupMocks = (
      graphExplorer: GraphExplorer,
      backendResponses: BackendResponses,
@@ -333,7 +292,29 @@ describe("GraphExplorer", () => {
      done: any,
      ignoreD3Update: boolean
    ): GraphExplorer => {
-      const props: GraphExplorerProps = createMockProps(createDocumentClientUtilityMock(docDBResponse));
+      (queryDocuments as jest.Mock).mockImplementation((container: any, query: string, options: any) => {
+        return Q.resolve({
+          _query: query,
+          nextItem: (callback: (error: any, document: DataModels.DocumentId) => void): void => {},
+          hasMoreResults: () => false,
+          executeNext: (callback: (error: any, documents: DataModels.DocumentId[], headers: any) => void): void => {}
+        });
+      });
+      (queryDocumentsPage as jest.Mock).mockImplementation(
+        (rid: string, iterator: any, firstItemIndex: number, options: any) => {
+          return Q.resolve({
+            hasMoreResults: false,
+            firstItemIndex: firstItemIndex,
+            lastItemIndex: 0,
+            itemCount: 0,
+            documents: docDBResponse.response,
+            activityId: "",
+            headers: [] as any[],
+            requestCharge: gVRU
+          });
+        }
+      );
+      const props: GraphExplorerProps = createMockProps();
      wrapper = mount(<GraphExplorer {...props} />);
      graphExplorerInstance = wrapper.instance() as GraphExplorer;
      setupMocks(graphExplorerInstance, backendResponses, done, ignoreD3Update);
@@ -341,7 +322,7 @@ describe("GraphExplorer", () => {
    };

    const cleanUpStubsWrapper = () => {
-      queryDocStub.restore();
+      jest.resetAllMocks();
      connectStub.restore();
      submitToBackendSpy.restore();
      renderResultAsJsonStub.restore();
@@ -378,22 +359,11 @@ describe("GraphExplorer", () => {
        expect((graphExplorerInstance.submitToBackend as sinon.SinonSpy).calledWith("g.V()")).toBe(false);
      });

-      it("should submit g.V() as docdb query with proper query", () => {
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[2]
-        ).toBe(DOCDB_G_DOT_V_QUERY);
-      });
-
      it("should submit g.V() as docdb query with proper parameters", () => {
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[0]
-        ).toEqual("databaseId");
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[1]
-        ).toEqual("collectionId");
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[3]
-        ).toEqual({ maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE, enableCrossPartitionQuery: true });
+        expect(queryDocuments).toBeCalledWith("databaseId", "collectionId", DOCDB_G_DOT_V_QUERY, {
+          maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE,
+          enableCrossPartitionQuery: true
+        });
      });

      it("should call backend thrice (user query, fetch outE, then fetch inE)", () => {
@@ -426,22 +396,11 @@ describe("GraphExplorer", () => {
        expect((graphExplorerInstance.submitToBackend as sinon.SinonSpy).calledWith("g.V()")).toBe(false);
      });

-      it("should submit g.V() as docdb query with proper query", () => {
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[2]
-        ).toBe(DOCDB_G_DOT_V_QUERY);
-      });
-
      it("should submit g.V() as docdb query with proper parameters", () => {
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[0]
-        ).toEqual("databaseId");
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[1]
-        ).toEqual("collectionId");
-        expect(
-          (graphExplorerInstance.props.documentClientUtility.queryDocuments as sinon.SinonSpy).getCall(0).args[3]
-        ).toEqual({ maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE, enableCrossPartitionQuery: true });
+        expect(queryDocuments).toBeCalledWith("databaseId", "collectionId", DOCDB_G_DOT_V_QUERY, {
+          maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE,
+          enableCrossPartitionQuery: true
+        });
      });

      it("should call backend thrice (user query, fetch outE, then fetch inE)", () => {
--- a/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.tsx
+++ b/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.tsx
@@ -28,7 +28,7 @@ import * as Constants from "../../../Common/Constants";
 import { InputProperty } from "../../../Contracts/ViewModels";
 import { QueryIterator, ItemDefinition, Resource } from "@azure/cosmos";
 import LoadingIndicatorIcon from "../../../../images/LoadingIndicator_3Squares.gif";
-import DocumentClientUtilityBase from "../../../Common/DocumentClientUtilityBase";
+import { queryDocuments, queryDocumentsPage } from "../../../Common/DocumentClientUtilityBase";

 export interface GraphAccessor {
  applyFilter: () => void;
@@ -47,7 +47,6 @@ export interface GraphExplorerProps {
  onIsValidQueryChange: (isValidQuery: boolean) => void;

  collectionPartitionKeyProperty: string;
-  documentClientUtility: DocumentClientUtilityBase;
  collectionRid: string;
  collectionSelfLink: string;
  graphBackendEndpoint: string;
@@ -697,7 +696,6 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
   * @param cmd
   */
  public submitToBackend(cmd: string): Q.Promise<GremlinClient.GremlinRequestResult> {
-    console.log("submit:", cmd);
    const id = GraphExplorer.reportToConsole(ConsoleDataType.InProgress, `Executing: ${cmd}`);
    this.setExecuteCounter(this.executeCounter + 1);

@@ -730,26 +728,24 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
   */
  public executeNonPagedDocDbQuery(query: string): Q.Promise<DataModels.DocumentId[]> {
    // TODO maxItemCount: this reduces throttling, but won't cap the # of results
-    return this.props.documentClientUtility
-      .queryDocuments(this.props.databaseId, this.props.collectionId, query, {
-        maxItemCount: GraphExplorer.PAGE_ALL,
-        enableCrossPartitionQuery:
-          StorageUtility.LocalStorageUtility.getEntryString(StorageUtility.StorageKey.IsCrossPartitionQueryEnabled) ===
-          "true"
-      })
-      .then(
-        (iterator: QueryIterator<ItemDefinition & Resource>) => {
-          return iterator.fetchNext().then(response => response.resources);
-        },
-        (reason: any) => {
-          GraphExplorer.reportToConsole(
-            ConsoleDataType.Error,
-            `Failed to execute non-paged query ${query}. Reason:${reason}`,
-            reason
-          );
-          return null;
-        }
-      );
+    return queryDocuments(this.props.databaseId, this.props.collectionId, query, {
+      maxItemCount: GraphExplorer.PAGE_ALL,
+      enableCrossPartitionQuery:
+        StorageUtility.LocalStorageUtility.getEntryString(StorageUtility.StorageKey.IsCrossPartitionQueryEnabled) ===
+        "true"
+    }).then(
+      (iterator: QueryIterator<ItemDefinition & Resource>) => {
+        return iterator.fetchNext().then(response => response.resources);
+      },
+      (reason: any) => {
+        GraphExplorer.reportToConsole(
+          ConsoleDataType.Error,
+          `Failed to execute non-paged query ${query}. Reason:${reason}`,
+          reason
+        );
+        return null;
+      }
+    );
  }

  /**
@@ -1732,12 +1728,10 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
      query = `select root.id, root.${this.props.collectionPartitionKeyProperty} from root where IS_DEFINED(root._isEdge) = false order by root._ts asc`;
    }

-    return this.props.documentClientUtility
-      .queryDocuments(this.props.databaseId, this.props.collectionId, query, {
-        maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE,
-        enableCrossPartitionQuery:
-          LocalStorageUtility.getEntryString(StorageKey.IsCrossPartitionQueryEnabled) === "true"
-      })
+    return queryDocuments(this.props.databaseId, this.props.collectionId, query, {
+      maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE,
+      enableCrossPartitionQuery: LocalStorageUtility.getEntryString(StorageKey.IsCrossPartitionQueryEnabled) === "true"
+    })
      .then(
        (iterator: QueryIterator<ItemDefinition & Resource>) => {
          this.currentDocDBQueryInfo = {
@@ -1766,16 +1760,15 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
      .currentDocDBQueryInfo.index + GraphExplorer.ROOT_LIST_PAGE_SIZE})`;
    const id = GraphExplorer.reportToConsole(ConsoleDataType.InProgress, `Executing: ${queryInfoStr}`);

-    return this.props.documentClientUtility
-      .queryDocumentsPage(
-        this.props.collectionRid,
-        this.currentDocDBQueryInfo.iterator,
-        this.currentDocDBQueryInfo.index,
-        {
-          enableCrossPartitionQuery:
-            LocalStorageUtility.getEntryString(StorageKey.IsCrossPartitionQueryEnabled) === "true"
-        }
-      )
+    return queryDocumentsPage(
+      this.props.collectionRid,
+      this.currentDocDBQueryInfo.iterator,
+      this.currentDocDBQueryInfo.index,
+      {
+        enableCrossPartitionQuery:
+          LocalStorageUtility.getEntryString(StorageKey.IsCrossPartitionQueryEnabled) === "true"
+      }
+    )
      .then((results: ViewModels.QueryResults) => {
        GraphExplorer.clearConsoleProgress(id);
        this.currentDocDBQueryInfo.index = results.lastItemIndex + 1;
--- a/src/Explorer/Graph/GraphExplorerComponent/GraphExplorerAdapter.tsx
+++ b/src/Explorer/Graph/GraphExplorerComponent/GraphExplorerAdapter.tsx
@@ -3,7 +3,6 @@ import { ReactAdapter } from "../../../Bindings/ReactBindingHandler";
 import { GraphConfig } from "../../Tabs/GraphTab";
 import * as ViewModels from "../../../Contracts/ViewModels";
 import { GraphExplorer, GraphAccessor } from "./GraphExplorer";
-import DocumentClientUtilityBase from "../../../Common/DocumentClientUtilityBase";

 interface Parameter {
  onIsNewVertexDisabledChange: (isEnabled: boolean) => void;
@@ -18,7 +17,6 @@ interface Parameter {
  graphConfig?: GraphConfig;

  collectionPartitionKeyProperty: string;
-  documentClientUtility: DocumentClientUtilityBase;
  collectionRid: string;
  collectionSelfLink: string;
  graphBackendEndpoint: string;
@@ -51,7 +49,6 @@ export class GraphExplorerAdapter implements ReactAdapter {
        onIsGraphDisplayed={this.params.onIsGraphDisplayed}
        onResetDefaultGraphConfigValues={this.params.onResetDefaultGraphConfigValues}
        collectionPartitionKeyProperty={this.params.collectionPartitionKeyProperty}
-        documentClientUtility={this.params.documentClientUtility}
        collectionRid={this.params.collectionRid}
        collectionSelfLink={this.params.collectionSelfLink}
        graphBackendEndpoint={this.params.graphBackendEndpoint}