Merge pull request #19210 from jmchilton/tool_search_jest_issues

Cleanup test output console for tool panel tests.
galaxyproject · Nov 29, 2024 · 2b5ecfb · 2b5ecfb
2 parents a648915 + 9575984
commit 2b5ecfb
Show file tree

Hide file tree

Showing 5 changed files with 112 additions and 14 deletions.
diff --git a/client/src/components/Panels/Common/ToolSearch.test.js b/client/src/components/Panels/Common/ToolSearch.test.js
@@ -21,6 +21,7 @@ describe("ToolSearch", () => {
                 showAdvanced: false,
                 toolsList: [],
                 currentPanel: {},
+                useWorker: false,
             },
             localVue,
             router,

diff --git a/client/src/components/Panels/Common/ToolSearch.vue b/client/src/components/Panels/Common/ToolSearch.vue
@@ -1,9 +1,11 @@
 <script setup lang="ts">
 import { BAlert } from "bootstrap-vue";
 import { storeToRefs } from "pinia";
+import { nextTick } from "vue";
 import { computed, type ComputedRef, onMounted, onUnmounted, type PropType, watch } from "vue";
 import { useRouter } from "vue-router/composables";
 
+import { searchToolsByKeys } from "@/components/Panels/utilities";
 import { type Tool, type ToolSection, useToolStore } from "@/stores/toolStore";
 import { useUserStore } from "@/stores/userStore";
 import Filtering, { contains, type ValidFilter } from "@/utils/filtering";
@@ -56,6 +58,10 @@ const props = defineProps({
         type: Object as PropType<Record<string, Tool | ToolSection>>,
         required: true,
     },
+    useWorker: {
+        type: Boolean,
+        default: false,
+    },
 });
 
 const emit = defineEmits<{
@@ -119,21 +125,101 @@ const ontologyList = computed(() =>
     toolStore.sectionDatalist("ontology:edam_topics").concat(toolStore.sectionDatalist("ontology:edam_operations"))
 );
 
-onMounted(() => {
-    // initialize worker
-    if (!searchWorker.value) {
-        searchWorker.value = new Worker(new URL("components/Panels/toolSearch.worker.js", import.meta.url));
+interface RequestPaylod {
+    tools: Tool[];
+    keys: ToolSearchKeys;
+    query: string;
+    panelView: string;
+    currentPanel: Record<string, Tool | ToolSection>;
+}
+
+interface SearchEventQuery {
+    type: "searchToolsByKeys";
+    payload: RequestPaylod;
+}
+
+interface SearchEventClear {
+    type: "clearFilter";
+}
+
+interface SearchEventFavorite {
+    type: "favoriteTools";
+}
+
+type SearchEventData = SearchEventQuery | SearchEventClear | SearchEventFavorite;
+
+interface SearchEvent {
+    data: SearchEventData;
+}
+
+interface ResponsePayloadResults {
+    type: "searchToolsByKeysResult";
+    payload: string[];
+    query: string;
+    closestTerm: string | null;
+    sectioned: Record<string, Tool | ToolSection> | null;
+}
+
+interface ResponseClearFilter {
+    type: "clearFilterResult";
+}
+
+interface ResponseFavoriteTools {
+    type: "favoriteToolsResult";
+}
+
+type ResponsePayloadData = ResponsePayloadResults | ResponseClearFilter | ResponseFavoriteTools;
+
+interface ResponsePayload {
+    type: "message";
+    data: ResponsePayloadData;
+}
+
+function handlePost(event: SearchEvent) {
+    const { type } = event.data;
+    if (type === "searchToolsByKeys") {
+        const { tools, keys, query, panelView, currentPanel } = event.data.payload;
+        const { results, resultPanel, closestTerm } = searchToolsByKeys(tools, keys, query, panelView, currentPanel);
+        // send the result back to the main thread
+        onMessage({
+            data: {
+                type: "searchToolsByKeysResult",
+                payload: results.slice(),
+                sectioned: resultPanel,
+                query: query,
+                closestTerm: closestTerm,
+            },
+        } as unknown as MessageEvent);
+    } else if (type === "clearFilter") {
+        onMessage({ data: { type: "clearFilterResult" } } as unknown as MessageEvent);
+    } else if (type === "favoriteTools") {
+        onMessage({ data: { type: "favoriteToolsResult" } } as unknown as MessageEvent);
     }
-    searchWorker.value.onmessage = ({ data }) => {
-        const { type, payload, sectioned, query, closestTerm } = data;
-        if (type === "searchToolsByKeysResult" && query === props.query) {
+}
+
+function onMessage(event: MessageEvent) {
+    const type = (event as unknown as ResponsePayload).data.type;
+    if (type === "searchToolsByKeysResult") {
+        const data = event.data as ResponsePayloadResults;
+        const { payload, sectioned, query, closestTerm } = data;
+        if (query === props.query) {
             emit("onResults", payload, sectioned, closestTerm);
-        } else if (type === "clearFilterResult") {
-            emit("onResults", null, null, null);
-        } else if (type === "favoriteToolsResult") {
-            emit("onResults", currentFavorites.value.tools, null, null);
         }
-    };
+    } else if (type === "clearFilterResult") {
+        emit("onResults", null, null, null);
+    } else if (type === "favoriteToolsResult") {
+        emit("onResults", currentFavorites.value.tools, null, null);
+    }
+}
+
+onMounted(() => {
+    if (props.useWorker) {
+        // initialize worker
+        if (!searchWorker.value) {
+            searchWorker.value = new Worker(new URL("components/Panels/toolSearch.worker.js", import.meta.url));
+        }
+        searchWorker.value.onmessage = onMessage;
+    }
 });
 
 onUnmounted(() => {
@@ -175,7 +261,13 @@ function checkQuery(q: string) {
 }
 
 function post(message: object) {
-    searchWorker.value?.postMessage(message);
+    if (props.useWorker) {
+        searchWorker.value?.postMessage(message);
+    } else {
+        nextTick(() => {
+            handlePost({ data: message as SearchEventData });
+        });
+    }
 }
 
 function onAdvancedSearch(filters: any) {
@@ -184,7 +276,7 @@ function onAdvancedSearch(filters: any) {
 </script>
 
 <template>
-    <div v-if="searchWorker">
+    <div v-if="searchWorker || !props.userWorker">
         <FilterMenu
             v-if="props.enableAdvanced"
             :class="!propShowAdvanced && 'mb-3'"

diff --git a/client/src/components/Panels/ToolBox.vue b/client/src/components/Panels/ToolBox.vue
@@ -36,6 +36,7 @@ const props = defineProps({
     editorWorkflows: { type: Array, default: null },
     dataManagers: { type: Array, default: null },
     moduleSections: { type: Array as PropType<Record<string, any>>, default: null },
+    useSearchWorker: { type: Boolean, default: true },
 });
 
 library.add(faEye, faEyeSlash);
@@ -200,6 +201,7 @@ function onToggle() {
                 :current-panel="localSectionsById"
                 :query="query"
                 :query-pending="queryPending"
+                :use-worker="useSearchWorker"
                 @onQuery="(q) => (query = q)"
                 @onResults="onResults" />
             <section v-if="!propShowAdvanced">

diff --git a/client/src/components/Panels/ToolPanel.test.ts b/client/src/components/Panels/ToolPanel.test.ts
@@ -44,6 +44,7 @@ describe("ToolPanel", () => {
                 editorWorkflows: null,
                 dataManagers: null,
                 moduleSections: null,
+                useSearchWorker: false,
             },
             localVue,
             stubs: {

diff --git a/client/src/components/Panels/ToolPanel.vue b/client/src/components/Panels/ToolPanel.vue
@@ -20,6 +20,7 @@ const props = defineProps({
     editorWorkflows: { type: Array, default: null },
     dataManagers: { type: Array, default: null },
     moduleSections: { type: Array, default: null },
+    useSearchWorker: { type: Boolean, default: true },
 });
 
 const emit = defineEmits<{
@@ -201,6 +202,7 @@ watch(
             :editor-workflows="editorWorkflows"
             :data-managers="dataManagers"
             :module-sections="moduleSections"
+            :use-search-worker="useSearchWorker"
             @updatePanelView="updatePanelView"
             @onInsertTool="onInsertTool"
             @onInsertModule="onInsertModule"