Add create time filters to invocation grid

Fixes galaxyproject#15863

Author: ahmedhamidawan

client/src/components/Grid/GridInvocation.vue

@@ -110,6 +110,7 @@ function refreshTable() {
             :grid-message="props.headerMessage"
             :no-data-message="effectiveNoInvocationsMessage"
             :extra-props="extraProps"
+            standalone
             :embedded="forStoredWorkflow || forHistory || forBatch">
             <template v-slot:expanded="{ rowData }">
                 <span class="mb-2" :data-invocation-id="rowData.id">

client/src/components/Grid/GridList.vue

@@ -47,6 +47,8 @@ interface Props {
     usernameSearch?: string;
     // any extra props to be passed to `getData`
     extraProps?: Record<string, unknown>;
+    /** Whether the filter menu should be standalone or not */
+    standalone?: boolean;
 }
 
 const props = withDefaults(defineProps<Props>(), {
@@ -168,14 +170,19 @@ async function getGridData() {
             return;
         }
         try {
+            // TODO: Feels a little hacky, better to type `getData` to accept `filterQueryParams` as an argument
+            const extraProps = {
+                ...props.extraProps,
+                filterQueryParams: validatedFilterQueryParamDict(),
+            };
             const offset = props.limit * (currentPage.value ? currentPage.value - 1 : 0);
             const [responseData, responseTotal] = await props.gridConfig.getData(
                 offset,
                 props.limit,
                 validatedFilterText(),
                 sortBy.value,
                 sortDesc.value,
-                props.extraProps
+                extraProps
             );
             gridData.value = responseData;
             totalRows.value = responseTotal;
@@ -250,6 +257,14 @@ function onFilter(filter?: string) {
     }
 }
 
+function onSearch(filters: Record<string, string | boolean>, text?: string) {
+    if (props.standalone) {
+        filterText.value = text || "";
+    }
+
+    // TODO: We can handle other on-search variables here if needed
+}
+
 // Select multiple rows
 function onSelect(rowData: RowData) {
     if (selected.value.has(rowData)) {
@@ -295,6 +310,21 @@ function validatedFilterText() {
     return filterClass?.getFilterText(validFilters.value || {}, false) || "";
 }
 
+/**
+ * Returns an object with filter keys ("q") and values ("qv") for backend queries.
+ * Example: { q: ["name", "create_time"], qv: ["test", "2023-01-01"] }
+ */
+function validatedFilterQueryParamDict() {
+    const initDict = filterClass?.getQueryDict(filterText.value) || {};
+    if (Object.keys(initDict).length === 0) {
+        return {};
+    }
+    return {
+        q: Object.keys(initDict),
+        qv: Object.values(initDict),
+    };
+}
+
 /**
  * Initialize grid data
  */
@@ -355,9 +385,11 @@ watch(operationMessage, () => {
                 :placeholder="`search ${gridConfig.plural.toLowerCase()}`"
                 :filter-class="filterClass"
                 :filter-text.sync="filterText"
+                :menu-type="props.standalone ? 'standalone' : undefined"
                 :loading="initDataLoading || resultsLoading"
                 :show-advanced.sync="showAdvanced"
-                view="compact" />
+                view="compact"
+                @on-search="onSearch" />
         </div>
         <LoadingSpan v-if="initDataLoading" />
         <span v-else-if="!isAvailable || hasInvalidFilters">

client/src/components/Grid/configs/invocations.ts

@@ -6,6 +6,7 @@ import type { WorkflowInvocation } from "@/api/invocations";
 import type { StoredWorkflowDetailed } from "@/api/workflows";
 import { useHistoryStore } from "@/stores/historyStore";
 import { useWorkflowStore } from "@/stores/workflowStore";
+import Filtering, { compare, toDate, type ValidFilter } from "@/utils/filtering";
 import _l from "@/utils/localization";
 import { rethrowSimple } from "@/utils/simple-error";
 
@@ -29,6 +30,7 @@ export async function getData(
     sort_desc: boolean,
     extraProps?: Record<string, unknown>
 ) {
+    const filterQueryParams = extraProps?.filterQueryParams || {};
     const params = {
         limit,
         offset,
@@ -37,6 +39,10 @@ export async function getData(
         include_nested_invocations: false,
     } as Record<string, unknown>;
 
+    if (Object.keys(filterQueryParams).length > 0) {
+        Object.assign(params, filterQueryParams);
+    }
+
     if (extraProps && "include_terminal" in extraProps) {
         params["include_terminal"] = extraProps["include_terminal"];
     }
@@ -150,13 +156,27 @@ const fields: FieldArray = [
     },
 ];
 
+/**
+ * Declare filter options
+ */
+const validFilters: Record<string, ValidFilter<number>> = {
+    create_time: {
+        placeholder: "creation time",
+        type: Date,
+        handler: compare("create_time", "le", toDate),
+        isRangeInput: true,
+        menuItem: true,
+    },
+};
+
 /**
  * Grid configuration
  */
 const gridConfig: GridConfig = {
     id: "invocations-grid",
     actions: actions,
     fields: fields,
+    filtering: new Filtering(validFilters, undefined, true, false),
     getData: getData,
     plural: "Workflow Invocations",
     sortBy: "create_time",

lib/galaxy/managers/workflows.py

@@ -55,6 +55,7 @@
 )
 from galaxy.job_execution.actions.post import ActionBox
 from galaxy.managers import (
+    base,
     deletable,
     sharable,
 )
@@ -517,6 +518,7 @@ def build_invocations_query(
         sort_desc=None,
         include_nested_invocations=True,
         check_ownership=True,
+        filters=[],
     ) -> Tuple[List, int]:
         """Get invocations owned by the current user."""
 
@@ -545,6 +547,11 @@ def build_invocations_query(
             )
             stmt = stmt.where(~subquery)
 
+        # Apply any filters from the filters array
+        for filter_item in filters:
+            if hasattr(filter_item, "filter_type") and filter_item.filter_type == "orm":
+                stmt = stmt.where(filter_item.filter)
+
         total_matches = get_count(trans.sa_session, stmt)
 
         if sort_by:
@@ -2142,6 +2149,19 @@ def get_workflow_by_trs_id_and_version(
         return sa_session.execute(stmnt.order_by(model.StoredWorkflow.id.desc()).limit(1)).scalar()
 
 
+class InvocationFilters(base.ModelFilterParser):
+    model_class = model.WorkflowInvocation
+    model_manager_class = WorkflowsManager
+
+    def _add_parsers(self):
+        super()._add_parsers()
+        self.orm_filter_parsers.update(
+            {
+                "create_time": {"op": ("le", "ge", "gt", "lt"), "val": self.parse_date},
+            }
+        )
+
+
 class RefactorRequest(RefactorActions):
     style: str = "export"
 

lib/galaxy/webapps/galaxy/api/workflows.py

@@ -16,6 +16,7 @@
 
 from fastapi import (
     Body,
+    Depends,
     Path,
     Query,
     Response,
@@ -51,6 +52,7 @@
     WorkflowUpdateOptions,
 )
 from galaxy.model.item_attrs import UsesAnnotations
+from galaxy.schema import FilterQueryParams
 from galaxy.schema.fields import DecodedDatabaseIdField
 from galaxy.schema.invocation import (
     CreateInvocationFromStore,
@@ -112,7 +114,10 @@
     Router,
     search_query_param,
 )
-from galaxy.webapps.galaxy.api.common import SerializationViewQueryParam
+from galaxy.webapps.galaxy.api.common import (
+    get_filter_query_params,
+    SerializationViewQueryParam,
+)
 from galaxy.webapps.galaxy.services.base import (
     ConsumesModelStores,
     ServesExportStores,
@@ -1335,6 +1340,7 @@ def index_invocations(
         user_id: UserIdQueryParam = None,
         sort_by: InvocationsSortByQueryParam = None,
         sort_desc: InvocationsSortDescQueryParam = False,
+        filter_query_params: FilterQueryParams = Depends(get_filter_query_params),
         include_terminal: InvocationsIncludeTerminalQueryParam = True,
         limit: InvocationsLimitQueryParam = 20,
         offset: InvocationsOffsetQueryParam = None,
@@ -1365,7 +1371,12 @@ def index_invocations(
             view=view,
             step_details=step_details,
         )
-        invocations, total_matches = self.invocations_service.index(trans, invocation_payload, serialization_params)
+        invocations, total_matches = self.invocations_service.index(
+            trans,
+            invocation_payload,
+            serialization_params,
+            filter_query_params=filter_query_params,
+        )
         response.headers["total_matches"] = str(total_matches)
         return invocations
 

lib/galaxy/webapps/galaxy/services/invocations.py

@@ -29,14 +29,18 @@
     invocation_job_source_iter,
     summarize_metrics,
 )
-from galaxy.managers.workflows import WorkflowsManager
+from galaxy.managers.workflows import (
+    InvocationFilters,
+    WorkflowsManager,
+)
 from galaxy.model import (
     HistoryDatasetAssociation,
     HistoryDatasetCollectionAssociation,
     WorkflowInvocation,
     WorkflowInvocationStep,
     WorkflowRequestInputParameter,
 )
+from galaxy.schema import FilterQueryParams
 from galaxy.schema.fields import DecodedDatabaseIdField
 from galaxy.schema.invocation import (
     CreateInvocationFromStore,
@@ -89,15 +93,21 @@ def __init__(
         security: IdEncodingHelper,
         histories_manager: HistoryManager,
         workflows_manager: WorkflowsManager,
+        filters: InvocationFilters,
         short_term_storage_allocator: ShortTermStorageAllocator,
     ):
         super().__init__(security=security)
         self._histories_manager = histories_manager
         self._workflows_manager = workflows_manager
+        self.filters = filters
         self.short_term_storage_allocator = short_term_storage_allocator
 
     def index(
-        self, trans, invocation_payload: InvocationIndexPayload, serialization_params: InvocationSerializationParams
+        self,
+        trans,
+        invocation_payload: InvocationIndexPayload,
+        serialization_params: InvocationSerializationParams,
+        filter_query_params: FilterQueryParams,
     ) -> Tuple[List[WorkflowInvocationResponse], int]:
         workflow_id = invocation_payload.workflow_id
         if invocation_payload.instance:
@@ -121,6 +131,10 @@ def index(
             # Get all invocations if user is admin (and user_id is None).
             # xref https://github.com/galaxyproject/galaxy/pull/13862#discussion_r865732297
             user_id = invocation_payload.user_id
+
+        filter_params = self.filters.build_filter_params(filter_query_params)
+        filters = self.filters.parse_filters(filter_params)
+
         invocations, total_matches = self._workflows_manager.build_invocations_query(
             trans,
             stored_workflow_id=invocation_payload.workflow_id,
@@ -134,6 +148,7 @@ def index(
             sort_desc=invocation_payload.sort_desc,
             include_nested_invocations=invocation_payload.include_nested_invocations,
             check_ownership=False,
+            filters=filters,
         )
         invocation_dict = self.serialize_workflow_invocations(invocations, serialization_params)
         return invocation_dict, total_matches