Use GridConfig and gridConfig to avoid confusion

galaxyproject · Dec 1, 2023 · 9b40f78 · 9b40f78
1 parent 06c729a
commit 9b40f78
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 34 deletions.
diff --git a/client/src/components/Grid/GridList.test.js b/client/src/components/Grid/GridList.test.js
@@ -110,7 +110,7 @@ function createTarget(propsData) {
 describe("GridList", () => {
     it("basic rendering", async () => {
         const wrapper = createTarget({
-            config: testGrid,
+            gridConfig: testGrid,
         });
         const findInput = wrapper.find("[data-description='filter text input']");
         expect(findInput.attributes().placeholder).toBe("search tests");
@@ -142,7 +142,7 @@ describe("GridList", () => {
 
     it("header rendering", async () => {
         const wrapper = createTarget({
-            config: testGrid,
+            gridConfig: testGrid,
         });
         await wrapper.vm.$nextTick();
         for (const [fieldIndex, field] of Object.entries(testGrid.fields)) {
@@ -152,7 +152,7 @@ describe("GridList", () => {
 
     it("operation handling", async () => {
         const wrapper = createTarget({
-            config: testGrid,
+            gridConfig: testGrid,
         });
         await wrapper.vm.$nextTick();
         const dropdown = wrapper.find("[data-description='grid cell 0-2']");
@@ -174,7 +174,7 @@ describe("GridList", () => {
 
     it("filter handling", async () => {
         const wrapper = createTarget({
-            config: testGrid,
+            gridConfig: testGrid,
         });
         await wrapper.vm.$nextTick();
         const filterInput = wrapper.find("[data-description='filter text input']");
@@ -187,7 +187,7 @@ describe("GridList", () => {
 
     it("pagination", async () => {
         const wrapper = createTarget({
-            config: testGrid,
+            gridConfig: testGrid,
             limit: 2,
         });
         await wrapper.vm.$nextTick();

diff --git a/client/src/components/Grid/GridList.vue b/client/src/components/Grid/GridList.vue
@@ -7,7 +7,7 @@ import { BAlert, BButton, BLink, BPagination } from "bootstrap-vue";
 import { computed, onMounted, onUnmounted, ref, watch } from "vue";
 import { useRouter } from "vue-router/composables";
 
-import { Config, FieldHandler, Operation, RowData } from "./configs/types";
+import { FieldHandler, GridConfig, Operation, RowData } from "./configs/types";
 
 import GridBoolean from "./GridElements/GridBoolean.vue";
 import GridLink from "./GridElements/GridLink.vue";
@@ -26,7 +26,7 @@ library.add(faCaretDown, faCaretUp, faShieldAlt);
 
 interface Props {
     // provide a grid configuration
-    config: Config;
+    gridConfig: GridConfig;
     // debounce delay
     delay?: number;
     // rows per page to be shown
@@ -57,8 +57,8 @@ const loading = ref(true);
 const isAvailable = computed(() => !loading.value && totalRows.value > 0);
 
 // sort references
-const sortBy = ref(props.config ? props.config.sortBy : "");
-const sortDesc = ref(props.config ? props.config.sortDesc : false);
+const sortBy = ref(props.gridConfig ? props.gridConfig.sortBy : "");
+const sortDesc = ref(props.gridConfig ? props.gridConfig.sortDesc : false);
 
 // filtering refs and handlers
 const filterText = ref("");
@@ -74,7 +74,7 @@ const hideMessage = useDebounceFn(() => {
  * Manually set filter value, used for tags and `SharingIndicators`
  */
 function applyFilter(filter: string, value: string | boolean, quoted = false) {
-    const filtering = props.config?.filtering;
+    const filtering = props.gridConfig?.filtering;
     const quotedValue = quoted ? `'${value}'` : value;
     if (filtering) {
         filterText.value = filtering.setFilterValue(filterText.value, filter, quotedValue.toString()) || "";
@@ -85,10 +85,10 @@ function applyFilter(filter: string, value: string | boolean, quoted = false) {
  * Request grid data
  */
 async function getGridData() {
-    if (props.config) {
+    if (props.gridConfig) {
         try {
             const offset = props.limit * (currentPage.value - 1);
-            const [responseData, responseTotal] = await props.config.getData(
+            const [responseData, responseTotal] = await props.gridConfig.getData(
                 offset,
                 props.limit,
                 searchTerm.value,
@@ -184,19 +184,19 @@ watch(operationMessage, () => {
 </script>
 
 <template>
-    <div :id="config.id" class="d-flex flex-column overflow-auto">
+    <div :id="gridConfig.id" class="d-flex flex-column overflow-auto">
         <BAlert v-if="!!errorMessage" variant="danger" show>{{ errorMessage }}</BAlert>
         <BAlert v-if="!!operationMessage" :variant="operationStatus" fade show>{{ operationMessage }}</BAlert>
         <div class="grid-header d-flex justify-content-between pb-2">
             <div>
                 <h1 class="m-0" data-description="grid title">
-                    {{ config.title }}
+                    {{ gridConfig.title }}
                 </h1>
                 <FilterMenu
                     class="py-2"
-                    :name="config.plural"
-                    :placeholder="`search ${config.plural.toLowerCase()}`"
-                    :filter-class="config.filtering"
+                    :name="gridConfig.plural"
+                    :placeholder="`search ${gridConfig.plural.toLowerCase()}`"
+                    :filter-class="gridConfig.filtering"
                     :filter-text.sync="filterText"
                     :loading="loading"
                     :show-advanced.sync="showAdvanced"
@@ -205,7 +205,7 @@ watch(operationMessage, () => {
             </div>
             <div v-if="!showAdvanced" class="py-3">
                 <BButton
-                    v-for="(action, actionIndex) in config.actions"
+                    v-for="(action, actionIndex) in gridConfig.actions"
                     :key="actionIndex"
                     class="m-1"
                     size="sm"
@@ -228,11 +228,11 @@ watch(operationMessage, () => {
         <table v-else class="grid-table">
             <thead>
                 <th
-                    v-for="(fieldEntry, fieldIndex) in config.fields"
+                    v-for="(fieldEntry, fieldIndex) in gridConfig.fields"
                     :key="fieldIndex"
                     class="text-nowrap px-2"
                     :data-description="`grid header ${fieldIndex}`">
-                    <span v-if="config.sortKeys.includes(fieldEntry.key)">
+                    <span v-if="gridConfig.sortKeys.includes(fieldEntry.key)">
                         <BLink @click="onSort(fieldEntry.key)">
                             <span>{{ fieldEntry.title || fieldEntry.key }}</span>
                             <span v-if="sortBy === fieldEntry.key">
@@ -246,7 +246,7 @@ watch(operationMessage, () => {
             </thead>
             <tr v-for="(rowData, rowIndex) in gridData" :key="rowIndex" :class="{ 'grid-dark-row': rowIndex % 2 }">
                 <td
-                    v-for="(fieldEntry, fieldIndex) in config.fields"
+                    v-for="(fieldEntry, fieldIndex) in gridConfig.fields"
                     :key="fieldIndex"
                     class="px-2 py-3"
                     :style="{ width: `${fieldEntry.width}%` }">

diff --git a/client/src/components/Grid/configs/adminUsers.ts b/client/src/components/Grid/configs/adminUsers.ts
@@ -20,7 +20,7 @@ import Filtering, { contains, equals, toBool, type ValidFilter } from "@/utils/f
 import { withPrefix } from "@/utils/redirect";
 import { errorMessageAsString } from "@/utils/simple-error";
 
-import type { ActionArray, Config, FieldArray } from "./types";
+import type { ActionArray, FieldArray, GridConfig } from "./types";
 
 const { emit } = useEventBus<string>("grid-router-push");
 
@@ -323,7 +323,7 @@ const validFilters: Record<string, ValidFilter<string | boolean | undefined>> =
 /**
  * Grid configuration
  */
-const config: Config = {
+const gridConfig: GridConfig = {
     id: "users-grid",
     actions: actions,
     fields: fields,
@@ -336,4 +336,4 @@ const config: Config = {
     title: "Users",
 };
 
-export default config;
+export default gridConfig;
diff --git a/client/src/components/Grid/configs/types.ts b/client/src/components/Grid/configs/types.ts
@@ -11,7 +11,7 @@ export interface Action {
 
 export type ActionArray = Array<Action>;
 
-export interface Config {
+export interface GridConfig {
     id: string;
     actions?: ActionArray;
     fields: FieldArray;

diff --git a/client/src/components/Grid/configs/visualizations.ts b/client/src/components/Grid/configs/visualizations.ts
@@ -8,7 +8,7 @@ import Filtering, { contains, equals, expandNameTag, toBool, type ValidFilter }
 import { withPrefix } from "@/utils/redirect";
 import { errorMessageAsString, rethrowSimple } from "@/utils/simple-error";
 
-import type { ActionArray, Config, FieldArray } from "./types";
+import type { ActionArray, FieldArray, GridConfig } from "./types";
 
 const { emit } = useEventBus<string>("grid-router-push");
 
@@ -237,7 +237,7 @@ const validFilters: Record<string, ValidFilter<string | boolean | undefined>> =
 /**
  * Grid configuration
  */
-const config: Config = {
+const gridConfig: GridConfig = {
     id: "visualizations-grid",
     actions: actions,
     fields: fields,
@@ -249,4 +249,5 @@ const config: Config = {
     sortKeys: ["create_time", "title", "update_time"],
     title: "Saved Visualizations",
 };
-export default config;
+
+export default gridConfig;
diff --git a/client/src/components/Grid/configs/visualizationsPublished.ts b/client/src/components/Grid/configs/visualizationsPublished.ts
@@ -2,7 +2,7 @@ import { fetcher } from "@/api/schema";
 import Filtering, { contains, expandNameTag, type ValidFilter } from "@/utils/filtering";
 import { withPrefix } from "@/utils/redirect";
 
-import type { Config, FieldArray } from "./types";
+import type { FieldArray, GridConfig } from "./types";
 
 /**
  * Api endpoint handlers
@@ -86,7 +86,7 @@ const validFilters: Record<string, ValidFilter<string | boolean | undefined>> =
 /**
  * Grid configuration
  */
-const config: Config = {
+const gridConfig: GridConfig = {
     id: "visualizations-published-grid",
     fields: fields,
     filtering: new Filtering(validFilters, undefined, false, false),
@@ -98,4 +98,4 @@ const config: Config = {
     title: "Published Visualizations",
 };
 
-export default config;
+export default gridConfig;
diff --git a/client/src/entry/analysis/router.js b/client/src/entry/analysis/router.js
@@ -466,14 +466,14 @@ export function getRouter(Galaxy) {
                         path: "visualizations/list",
                         component: GridList,
                         props: {
-                            config: visualizationsGrid,
+                            gridConfig: visualizationsGrid,
                         },
                     },
                     {
                         path: "visualizations/list_published",
                         component: GridList,
                         props: {
-                            config: visualizationsPublishedGrid,
+                            gridConfig: visualizationsPublishedGrid,
                         },
                     },
                     {

diff --git a/client/src/entry/analysis/routes/admin-routes.js b/client/src/entry/analysis/routes/admin-routes.js
@@ -157,7 +157,7 @@ export default [
                 path: "users",
                 component: GridList,
                 props: {
-                    config: adminUsersGrid,
+                    gridConfig: adminUsersGrid,
                 },
             },
             {