Move queryDocuments out of DataAccessUtility (#334)

2025-12-19 08:51:24 +00:00 · 2020-12-16 15:27:17 -08:00
parent ea39c1d092
commit f54e8eb692
40 changed files with 1163 additions and 1442 deletions
--- a/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.test.tsx
+++ b/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.test.tsx
@@ -1,4 +1,5 @@
-jest.mock("../../../Common/DocumentClientUtilityBase");
+jest.mock("../../../Common/dataAccess/queryDocuments");
+jest.mock("../../../Common/dataAccess/queryDocumentsPage");
 import React from "react";
 import * as sinon from "sinon";
 import { mount, ReactWrapper } from "enzyme";
@@ -12,7 +13,8 @@ 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";
+import { queryDocuments } from "../../../Common/dataAccess/queryDocuments";
+import { queryDocumentsPage } from "../../../Common/dataAccess/queryDocumentsPage";

 describe("Check whether query result is vertex array", () => {
  it("should reject null as vertex array", () => {
@@ -299,12 +301,12 @@ describe("GraphExplorer", () => {
      ignoreD3Update: boolean
    ): GraphExplorer => {
      (queryDocuments as jest.Mock).mockImplementation((container: any, query: string, options: any) => {
-        return Q.resolve({
+        return {
          _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) => {
--- a/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.tsx
+++ b/src/Explorer/Graph/GraphExplorerComponent/GraphExplorer.tsx
@@ -28,8 +28,10 @@ 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 { queryDocuments, queryDocumentsPage } from "../../../Common/DocumentClientUtilityBase";
+import { queryDocuments } from "../../../Common/dataAccess/queryDocuments";
+import { queryDocumentsPage } from "../../../Common/dataAccess/queryDocumentsPage";
 import { getErrorMessage } from "../../../Common/ErrorHandlingUtils";
+import { FeedOptions } from "@azure/cosmos";

 export interface GraphAccessor {
  applyFilter: () => void;
@@ -725,26 +727,32 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
  /**
   * Execute DocDB query and get all results
   */
-  public executeNonPagedDocDbQuery(query: string): Q.Promise<DataModels.DocumentId[]> {
-    // TODO maxItemCount: this reduces throttling, but won't cap the # of results
-    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;
-      }
-    );
+  public async executeNonPagedDocDbQuery(query: string): Promise<DataModels.DocumentId[]> {
+    try {
+      // TODO maxItemCount: this reduces throttling, but won't cap the # of results
+      const iterator: QueryIterator<ItemDefinition & Resource> = queryDocuments(
+        this.props.databaseId,
+        this.props.collectionId,
+        query,
+        {
+          maxItemCount: GraphExplorer.PAGE_ALL,
+          enableCrossPartitionQuery:
+            StorageUtility.LocalStorageUtility.getEntryString(
+              StorageUtility.StorageKey.IsCrossPartitionQueryEnabled
+            ) === "true"
+        } as FeedOptions
+      );
+      const response = await iterator.fetchNext();
+
+      return response?.resources;
+    } catch (error) {
+      GraphExplorer.reportToConsole(
+        ConsoleDataType.Error,
+        `Failed to execute non-paged query ${query}. Reason:${error}`,
+        error
+      );
+      return null;
+    }
  }

  /**
@@ -864,7 +872,7 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
  /**
   * User executes query
   */
-  public submitQuery(query: string): void {
+  public async submitQuery(query: string): Promise<void> {
    // Clear any progress indicator
    this.executeCounter = 0;
    this.setState({
@@ -882,24 +890,22 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
    // Remember query
    this.pushToLatestQueryFragments(query);

-    let backendPromise;
-
-    if (query.toLocaleLowerCase() === "g.V()".toLocaleLowerCase()) {
-      backendPromise = this.executeDocDbGVQuery();
-    } else {
-      backendPromise = this.executeGremlinQuery(query);
-    }
-
-    backendPromise.then(
-      (result: UserQueryResult) => (this.queryTotalRequestCharge = result.requestCharge),
-      (error: any) => {
-        const errorMsg = `Failure in submitting query: ${query}: ${getErrorMessage(error)}`;
-        GraphExplorer.reportToConsole(ConsoleDataType.Error, errorMsg);
-        this.setState({
-          filterQueryError: errorMsg
-        });
+    try {
+      let result: UserQueryResult;
+      if (query.toLocaleLowerCase() === "g.V()".toLocaleLowerCase()) {
+        result = await this.executeDocDbGVQuery();
+      } else {
+        result = await this.executeGremlinQuery(query);
      }
-    );
+
+      this.queryTotalRequestCharge = result.requestCharge;
+    } catch (error) {
+      const errorMsg = `Failure in submitting query: ${query}: ${getErrorMessage(error)}`;
+      GraphExplorer.reportToConsole(ConsoleDataType.Error, errorMsg);
+      this.setState({
+        filterQueryError: errorMsg
+      });
+    }
  }

  /**
@@ -1390,7 +1396,7 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
  /**
   * Update possible vertices to display in UI
   */
-  private updatePossibleVertices(): Q.Promise<PossibleVertex[]> {
+  private updatePossibleVertices(): Promise<PossibleVertex[]> {
    const highlightedNodeId = this.state.highlightedNode ? this.state.highlightedNode.id : null;

    const q = `SELECT c.id, c["${this.props.graphConfigUiData.nodeCaptionChoice() ||
@@ -1721,85 +1727,81 @@ export class GraphExplorer extends React.Component<GraphExplorerProps, GraphExpl
    );
  }

-  private executeDocDbGVQuery(): Q.Promise<UserQueryResult> {
+  private async executeDocDbGVQuery(): Promise<UserQueryResult> {
    let query = "select root.id from root where IS_DEFINED(root._isEdge) = false order by root._ts desc";
    if (this.props.collectionPartitionKeyProperty) {
      query = `select root.id, root.${this.props.collectionPartitionKeyProperty} from root where IS_DEFINED(root._isEdge) = false order by root._ts asc`;
    }

-    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 = {
-            iterator: iterator,
-            index: 0,
-            query: query
-          };
-        },
-        (reason: any) => {
-          GraphExplorer.reportToConsole(
-            ConsoleDataType.Error,
-            `Failed to execute CosmosDB query: ${query} reason:${reason}`
-          );
-        }
-      )
-      .then(() => this.loadMoreRootNodes());
+    try {
+      const iterator: QueryIterator<ItemDefinition & Resource> = queryDocuments(
+        this.props.databaseId,
+        this.props.collectionId,
+        query,
+        {
+          maxItemCount: GraphExplorer.ROOT_LIST_PAGE_SIZE,
+          enableCrossPartitionQuery:
+            LocalStorageUtility.getEntryString(StorageKey.IsCrossPartitionQueryEnabled) === "true"
+        } as FeedOptions
+      );
+      this.currentDocDBQueryInfo = {
+        iterator: iterator,
+        index: 0,
+        query: query
+      };
+      return await this.loadMoreRootNodes();
+    } catch (error) {
+      GraphExplorer.reportToConsole(
+        ConsoleDataType.Error,
+        `Failed to execute CosmosDB query: ${query} reason:${error}`
+      );
+      throw error;
+    }
  }

-  private loadMoreRootNodes(): Q.Promise<UserQueryResult> {
+  private async loadMoreRootNodes(): Promise<UserQueryResult> {
    if (!this.currentDocDBQueryInfo) {
-      return Q.resolve(null);
+      return undefined;
    }
-    let RU: string = GraphExplorer.REQUEST_CHARGE_UNKNOWN_MSG;

+    let RU: string = GraphExplorer.REQUEST_CHARGE_UNKNOWN_MSG;
    const queryInfoStr = `${this.currentDocDBQueryInfo.query} (${this.currentDocDBQueryInfo.index + 1}-${this
      .currentDocDBQueryInfo.index + GraphExplorer.ROOT_LIST_PAGE_SIZE})`;
    const id = GraphExplorer.reportToConsole(ConsoleDataType.InProgress, `Executing: ${queryInfoStr}`);

-    return queryDocumentsPage(
-      this.props.collectionId,
-      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;
-        this.setState({ hasMoreRoots: results.hasMoreResults });
-        RU = results.requestCharge.toString();
-        GraphExplorer.reportToConsole(
-          ConsoleDataType.Info,
-          `Executed: ${queryInfoStr} ${GremlinClient.GremlinClient.getRequestChargeString(RU)}`
-        );
-        const documents = results.documents || [];
-        return documents.map(
-          (item: DataModels.DocumentId) => {
-            return GraphExplorer.getPkIdFromDocumentId(item, this.props.collectionPartitionKeyProperty);
-          },
-          (reason: any) => {
-            // Failure
-            GraphExplorer.clearConsoleProgress(id);
-            const errorMsg = `Failed to query: ${this.currentDocDBQueryInfo.query}. Reason:${reason}`;
-            GraphExplorer.reportToConsole(ConsoleDataType.Error, errorMsg);
-            this.setState({
-              filterQueryError: errorMsg
-            });
-            this.setFilterQueryStatus(FilterQueryStatus.ErrorResult);
-            throw reason;
-          }
-        );
-      })
-      .then((pkIds: string[]) => {
-        const arg = pkIds.join(",");
-        return this.executeGremlinQuery(`g.V(${arg})`);
-      })
-      .then(() => ({ requestCharge: RU }));
+    try {
+      const results: ViewModels.QueryResults = await queryDocumentsPage(
+        this.props.collectionId,
+        this.currentDocDBQueryInfo.iterator,
+        this.currentDocDBQueryInfo.index
+      );
+
+      GraphExplorer.clearConsoleProgress(id);
+      this.currentDocDBQueryInfo.index = results.lastItemIndex + 1;
+      this.setState({ hasMoreRoots: results.hasMoreResults });
+      RU = results.requestCharge.toString();
+      GraphExplorer.reportToConsole(
+        ConsoleDataType.Info,
+        `Executed: ${queryInfoStr} ${GremlinClient.GremlinClient.getRequestChargeString(RU)}`
+      );
+      const pkIds: string[] = (results.documents || []).map((item: DataModels.DocumentId) =>
+        GraphExplorer.getPkIdFromDocumentId(item, this.props.collectionPartitionKeyProperty)
+      );
+
+      const arg = pkIds.join(",");
+      await this.executeGremlinQuery(`g.V(${arg})`);
+
+      return { requestCharge: RU };
+    } catch (error) {
+      GraphExplorer.clearConsoleProgress(id);
+      const errorMsg = `Failed to query: ${this.currentDocDBQueryInfo.query}. Reason:${getErrorMessage(error)}`;
+      GraphExplorer.reportToConsole(ConsoleDataType.Error, errorMsg);
+      this.setState({
+        filterQueryError: errorMsg
+      });
+      this.setFilterQueryStatus(FilterQueryStatus.ErrorResult);
+      throw error;
+    }
  }

  private executeGremlinQuery(query: string): Q.Promise<UserQueryResult> {