chore: pass sortModel to backend

Signed-off-by: Scott Dover <[email protected]>

Author: Scott Dover

client/src/components/LibraryNavigator/LibraryModel.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 import { ProgressLocation, l10n, window } from "vscode";
 
+import { SortModelItem } from "ag-grid-community";
 import { Writable } from "stream";
 
 import PaginatedResultSet from "./PaginatedResultSet";
@@ -27,12 +28,17 @@ class LibraryModel {
     item: LibraryItem,
   ): PaginatedResultSet<{ data: TableData; error?: Error }> {
     return new PaginatedResultSet<{ data: TableData; error?: Error }>(
-      async (start: number, end: number) => {
+      async (start: number, end: number, sortModel: SortModelItem[]) => {
         await this.libraryAdapter.setup();
         const limit = end - start + 1;
         try {
           return {
-            data: await this.libraryAdapter.getRows(item, start, limit),
+            data: await this.libraryAdapter.getRows(
+              item,
+              start,
+              limit,
+              sortModel,
+            ),
           };
         } catch (e) {
           return { error: e, data: { rows: [], count: 0 } };

client/src/components/LibraryNavigator/PaginatedResultSet.ts

@@ -1,15 +1,18 @@
 // Copyright © 2023, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { SortModelItem } from "ag-grid-community";
 
 class PaginatedResultSet<T> {
-  private queryForData: (start: number, end: number) => Promise<T>;
+  constructor(
+    protected readonly queryForData: PaginatedResultSet<T>["getData"],
+  ) {}
 
-  constructor(queryForData: (start: number, end: number) => Promise<T>) {
-    this.queryForData = queryForData;
-  }
-
-  public async getData(start: number, end: number): Promise<T> {
-    return await this.queryForData(start, end);
+  public async getData(
+    start: number,
+    end: number,
+    sortModel: SortModelItem[],
+  ): Promise<T> {
+    return await this.queryForData(start, end, sortModel);
   }
 }
 

client/src/components/LibraryNavigator/types.ts

@@ -1,5 +1,7 @@
 // Copyright © 2023, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { SortModelItem } from "ag-grid-community";
+
 import { ColumnCollection } from "../../connection/rest/api/compute";
 
 export const LibraryType = "library";
@@ -39,7 +41,12 @@ export interface LibraryAdapter {
     items: LibraryItem[];
     count: number;
   }>;
-  getRows(item: LibraryItem, start: number, limit: number): Promise<TableData>;
+  getRows(
+    item: LibraryItem,
+    start: number,
+    limit: number,
+    sortModel: SortModelItem[],
+  ): Promise<TableData>;
   getRowsAsCSV(
     item: LibraryItem,
     start: number,

client/src/connection/itc/ItcLibraryAdapter.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 import { l10n } from "vscode";
 
+import { SortModelItem } from "ag-grid-community";
 import { ChildProcessWithoutNullStreams } from "child_process";
 
 import { onRunError } from "../../commands/run";
@@ -91,6 +92,7 @@ class ItcLibraryAdapter implements LibraryAdapter {
     item: LibraryItem,
     start: number,
     limit: number,
+    sortModel: SortModelItem[],
   ): Promise<TableData> {
     const { rows: rawRowValues, count } = await this.getDatasetInformation(
       item,

client/src/connection/rest/RestLibraryAdapter.ts

@@ -1,5 +1,6 @@
 // Copyright © 2024, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { SortModelItem } from "ag-grid-community";
 import { AxiosResponse } from "axios";
 
 import { getSession } from "..";
@@ -44,6 +45,7 @@ class RestLibraryAdapter implements LibraryAdapter {
     item: LibraryItem,
     start: number,
     limit: number,
+    sortModel: SortModelItem[],
   ): Promise<TableData> {
     const { data } = await this.retryOnFail<RowCollection>(
       async () =>

client/src/panels/DataViewer.ts

@@ -2,6 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 import { Uri, window } from "vscode";
 
+import { SortModelItem } from "ag-grid-community";
+
 import PaginatedResultSet from "../components/LibraryNavigator/PaginatedResultSet";
 import { TableData } from "../components/LibraryNavigator/types";
 import { Column } from "../connection/rest/api/compute";
@@ -66,14 +68,15 @@ class DataViewer extends WebView {
     event: Event & {
       key: string;
       command: string;
-      data?: { start?: number; end?: number };
+      data?: { start?: number; end?: number; sortModel?: SortModelItem[] };
     },
   ): Promise<void> {
     switch (event.command) {
       case "request:loadData": {
         const { data, error } = await this._paginator.getData(
           event.data!.start!,
           event.data!.end!,
+          event.data!.sortModel!,
         );
         if (error) {
           await window.showErrorMessage(error.message);

client/src/webview/useDataViewer.ts

@@ -8,6 +8,7 @@ import {
   GridReadyEvent,
   IGetRowsParams,
   ModuleRegistry,
+  SortModelItem,
 } from "ag-grid-community";
 import { v4 } from "uuid";
 
@@ -34,12 +35,16 @@ const clearQueryTimeout = (): void => {
   clearTimeout(queryTableDataTimeoutId);
   queryTableDataTimeoutId = null;
 };
-const queryTableData = (start: number, end: number): Promise<TableData> => {
+const queryTableData = (
+  start: number,
+  end: number,
+  sortModel: SortModelItem[],
+): Promise<TableData> => {
   const requestKey = v4();
   vscode.postMessage({
     command: "request:loadData",
     key: requestKey,
-    data: { start, end },
+    data: { start, end, sortModel },
   });
 
   return new Promise((resolve, reject) => {
@@ -103,23 +108,25 @@ const useDataViewer = () => {
       const dataSource = {
         rowCount: undefined,
         getRows: async (params: IGetRowsParams) => {
-          await queryTableData(params.startRow, params.endRow).then(
-            ({ rows, count }: TableData) => {
-              const rowData = rows.map(({ cells }) => {
-                const row = cells.reduce(
-                  (carry, cell, index) => ({
-                    ...carry,
-                    [columns[index].field]: cell,
-                  }),
-                  {},
-                );
-
-                return row;
-              });
-
-              params.successCallback(rowData, count);
-            },
-          );
+          await queryTableData(
+            params.startRow,
+            params.endRow,
+            params.sortModel,
+          ).then(({ rows, count }: TableData) => {
+            const rowData = rows.map(({ cells }) => {
+              const row = cells.reduce(
+                (carry, cell, index) => ({
+                  ...carry,
+                  [columns[index].field]: cell,
+                }),
+                {},
+              );
+
+              return row;
+            });
+
+            params.successCallback(rowData, count);
+          });
         },
       };
 

client/test/components/LibraryNavigator/PaginatedResultSet.test.ts

@@ -27,7 +27,7 @@ describe("PaginatedResultSet", async function () {
       async () => mockAxiosResponse,
     );
 
-    expect(await paginatedResultSet.getData(0, 100)).to.deep.equal(
+    expect(await paginatedResultSet.getData(0, 100, [])).to.deep.equal(
       mockAxiosResponse,
     );
   });