Implement tool installation request form and notification/email system

client/packages/api-client/src/schema/schema.ts

@@ -19777,6 +19777,7 @@ export interface components {
                 | components["schemas"]["MessageNotificationContent"]
                 | components["schemas"]["NewSharedItemNotificationContent"]
                 | components["schemas"]["StorageOperationNotificationContent"]
+                | components["schemas"]["ToolInstallationRequestCreateContent"]
                 | components["schemas"]["BroadcastNotificationContent"];
             /**
              * Expiration time
@@ -19866,6 +19867,7 @@ export interface components {
                 | components["schemas"]["MessageNotificationContent"]
                 | components["schemas"]["NewSharedItemNotificationContent"]
                 | components["schemas"]["StorageOperationNotificationContent"]
+                | components["schemas"]["ToolInstallationRequestNotificationContent"]
                 | components["schemas"]["BroadcastNotificationContent"];
             /**
              * Create time
@@ -21065,7 +21067,7 @@ export interface components {
          *     displayed in the notification preferences.
          * @enum {string}
          */
-        PersonalNotificationCategory: "message" | "new_shared_item" | "storage_operation";
+        PersonalNotificationCategory: "message" | "new_shared_item" | "storage_operation" | "tool_installation_request";
         /** PluginAspectStatus */
         PluginAspectStatus: {
             /** Message */
@@ -21719,6 +21721,48 @@ export interface components {
             | "track_config"
             | "genome_data"
             | "in_use_state";
+        /**
+         * RequestedTool
+         * @description A single requested tool in a tool installation request.
+         *
+         *     This is the per-item model: each entry describes one tool. An installation
+         *     request submits an array of these, wrapped by
+         *     :class:`ToolInstallationRequestNotificationContent` which carries the
+         *     request-level metadata. All fields are sanitized on validation: control
+         *     characters are collapsed and whitespace-only values become ``None``.
+         */
+        RequestedTool: {
+            /**
+             * Description
+             * @description Short description of the tool and its scientific use case.
+             */
+            description?: string | null;
+            /**
+             * Tool name
+             * @description The human-readable name of the tool, if known.
+             */
+            name?: string | null;
+            /**
+             * Requested version
+             * @description The version of the tool being requested, if any.
+             */
+            requested_version?: string | null;
+            /**
+             * Scientific domain
+             * @description The scientific domain for the requested tool.
+             */
+            scientific_domain?: string | null;
+            /**
+             * Tool shed ID
+             * @description The fully qualified tool shed repository ID (e.g. ``toolshed.g2.bx.psu.edu/repos/devteam/bwa``), if known.
+             */
+            tool_shed_id?: string | null;
+            /**
+             * Tool URL
+             * @description Homepage or repository URL for the requested tool. Must be an http(s) URL.
+             */
+            tool_url?: string | null;
+        };
         /**
          * Requirement
          * @description Available types of job sources (model classes) that produce dataset collections.
@@ -24683,6 +24727,81 @@ export interface components {
              */
             values: string;
         };
+        /**
+         * ToolInstallationRequestCreateContent
+         * @description The client-submittable (request) shape of a tool installation request.
+         *
+         *     Carries only the fields a user supplies: the requested ``tools`` and
+         *     request-level metadata (workflow context, remarks). The two server-stamped
+         *     fields -- ``requester_email`` and ``is_confirmation`` -- are deliberately
+         *     absent so they cannot be set by clients and do not appear in the POST
+         *     request schema. The service stamps them, promoting the content to a
+         *     :class:`ToolInstallationRequestNotificationContent` for persistence.
+         */
+        ToolInstallationRequestCreateContent: {
+            /**
+             * Additional remarks
+             * @description Any additional information or context for the request.
+             */
+            additional_remarks?: string | null;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            category: "tool_installation_request";
+            /**
+             * Requested tools
+             * @description The tools being requested. Each entry describes a single tool.
+             */
+            tools: components["schemas"]["RequestedTool"][];
+            /**
+             * Workflow ID
+             * @description Encoded ID of the workflow requiring these tools, if applicable.
+             */
+            workflow_id?: string | null;
+        };
+        /**
+         * ToolInstallationRequestNotificationContent
+         * @description The persisted/response shape of a tool installation request.
+         *
+         *     Extends the create model with the two server-stamped fields. ``requester_email``
+         *     is derived from the authenticated submitter; ``is_confirmation`` selects the
+         *     confirmation vs. admin-facing email template. Both are written by the service
+         *     and never trusted from the client.
+         */
+        ToolInstallationRequestNotificationContent: {
+            /**
+             * Additional remarks
+             * @description Any additional information or context for the request.
+             */
+            additional_remarks?: string | null;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            category: "tool_installation_request";
+            /**
+             * Is confirmation
+             * @description True on the copy sent to the user who made the request; False on the request sent to admins.
+             * @default false
+             */
+            is_confirmation: boolean;
+            /**
+             * Requester email
+             * @description Email address of the user who made the request.
+             */
+            requester_email?: string | null;
+            /**
+             * Requested tools
+             * @description The tools being requested. Each entry describes a single tool.
+             */
+            tools: components["schemas"]["RequestedTool"][];
+            /**
+             * Workflow ID
+             * @description Encoded ID of the workflow requiring these tools, if applicable.
+             */
+            workflow_id?: string | null;
+        };
         /** ToolLandingRequest */
         ToolLandingRequest: {
             /** Origin */
@@ -25665,6 +25784,13 @@ export interface components {
          *             "push": true
          *           },
          *           "enabled": true
+         *         },
+         *         "tool_installation_request": {
+         *           "channels": {
+         *             "email": true,
+         *             "push": true
+         *           },
+         *           "enabled": true
          *         }
          *       }
          *     }
@@ -26081,6 +26207,13 @@ export interface components {
          *             "push": true
          *           },
          *           "enabled": true
+         *         },
+         *         "tool_installation_request": {
+         *           "channels": {
+         *             "email": true,
+         *             "push": true
+         *           },
+         *           "enabled": true
          *         }
          *       }
          *     }
@@ -26111,7 +26244,8 @@ export interface components {
             content:
                 | components["schemas"]["MessageNotificationContent"]
                 | components["schemas"]["NewSharedItemNotificationContent"]
-                | components["schemas"]["StorageOperationNotificationContent"];
+                | components["schemas"]["StorageOperationNotificationContent"]
+                | components["schemas"]["ToolInstallationRequestNotificationContent"];
             /**
              * Create time
              * Format: date-time

client/packages/ui/src/components/GModal.vue

@@ -6,7 +6,7 @@
 import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
 import { watchImmediate } from "@vueuse/core";
 import { faXmark } from "font-awesome-6";
-import { computed, onBeforeUnmount, onMounted, ref } from "vue";
+import { computed, nextTick, onBeforeUnmount, onMounted, ref } from "vue";
 
 import { useUid } from "../composables/uid";
 import { type ComponentColor, type ComponentSize, type ComponentSizeClassList, prefix } from "./componentVariants";
@@ -43,6 +43,8 @@ const props = withDefaults(
         okDisabled?: boolean;
         /** Title to show when the Ok button is disabled */
         okDisabledTitle?: string;
+        /** Disables all cancel/dismiss actions (Cancel button, backdrop click, Escape) */
+        cancelDisabled?: boolean;
         /** When false, keeps the modal open on "ok" */
         closeOnOk?: boolean;
         /** Allows content to overflow the modal body (e.g. for dropdowns/selectors inside the modal) */
@@ -62,6 +64,7 @@ const props = withDefaults(
         okColor: "blue",
         okDisabled: false,
         okDisabledTitle: undefined,
+        cancelDisabled: false,
         closeOnOk: true,
         overflowVisible: false,
     },
@@ -90,6 +93,7 @@ const dialog = ref<HTMLDialogElement | null>(null);
 onMounted(() => {
     if (dialog.value) {
         dialog.value.addEventListener("close", onClose);
+        dialog.value.addEventListener("cancel", onCancel);
     }
     if (props.show) {
         showModal();
@@ -99,11 +103,16 @@ onMounted(() => {
 onBeforeUnmount(() => {
     if (dialog.value) {
         dialog.value.removeEventListener("close", onClose);
+        dialog.value.removeEventListener("cancel", onCancel);
     }
 });
 
 function showModal() {
-    dialog.value?.showModal();
+    if (!dialog.value || dialog.value.open) {
+        return;
+    }
+
+    dialog.value.showModal();
     onOpen();
 }
 
@@ -114,22 +123,30 @@ function hideModal(ok = false) {
         emit("ok");
     } else {
         isOk = ok;
-        dialog.value?.close();
+        if (dialog.value?.open) {
+            dialog.value.close();
+        }
     }
 }
 
 watchImmediate(
     () => props.show,
-    () => {
-        if (props.show) {
+    async (show) => {
+        await nextTick();
+
+        if (show) {
             showModal();
         } else {
             hideModal();
         }
     },
+    { flush: "post" },
 );
 
 function onClickDialog(event: MouseEvent) {
+    if (props.cancelDisabled) {
+        return;
+    }
     if ((event.target as HTMLElement | null)?.tagName === "DIALOG") {
         const rect = dialog.value?.getBoundingClientRect();
         const insideDialogX = rect && event.clientX >= rect.left && event.clientX <= rect.right;
@@ -142,6 +159,14 @@ function onClickDialog(event: MouseEvent) {
     }
 }
 
+function onCancel(event: Event) {
+    // The native <dialog> fires "cancel" on Escape; prevent dismissal while
+    // cancel actions are disabled (e.g. during an in-flight submit).
+    if (props.cancelDisabled) {
+        event.preventDefault();
+    }
+}
+
 function onOpen() {
     emit("update:show", true);
     emit("open");
@@ -191,7 +216,13 @@ defineExpose({ showModal, hideModal });
 
                 <slot name="header"></slot>
 
-                <GButton icon-only class="g-modal-close-button" transparent size="large" @click="hideModal(false)">
+                <GButton
+                    icon-only
+                    class="g-modal-close-button"
+                    transparent
+                    size="large"
+                    :disabled="cancelDisabled"
+                    @click="hideModal(false)">
                     <FontAwesomeIcon fixed-width :icon="faXmark" />
                 </GButton>
             </header>
@@ -206,7 +237,9 @@ defineExpose({ showModal, hideModal });
                 </div>
 
                 <div v-if="props.confirm" class="g-modal-confirm-buttons">
-                    <GButton @click="hideModal(false)"> {{ props.cancelText ?? "Cancel" }} </GButton>
+                    <GButton :disabled="cancelDisabled" @click="hideModal(false)">
+                        {{ props.cancelText ?? "Cancel" }}
+                    </GButton>
                     <GButton
                         :disabled="okDisabled"
                         :disabled-title="okDisabledTitle"

client/src/api/notifications.ts

@@ -1,4 +1,6 @@
+import { GalaxyApi } from "@/api";
 import type { components } from "@/api/schema";
+import { rethrowSimple } from "@/utils/simple-error";
 
 export type BaseUserNotification = components["schemas"]["UserNotificationResponse"];
 export type UserNotificationPreferences = components["schemas"]["UserNotificationPreferences"]["preferences"];
@@ -33,7 +35,33 @@ export interface MessageNotificationCreateRequest extends NotificationCreateRequ
     notification: MessageNotificationCreateData;
 }
 
-export type UserNotification = MessageNotification | SharedItemNotification | StorageOperationNotification;
+export type ToolInstallationRequestNotificationContent =
+    components["schemas"]["ToolInstallationRequestNotificationContent"];
+
+export type ToolInstallationRequestCreateContent = components["schemas"]["ToolInstallationRequestCreateContent"];
+
+export type RequestedTool = components["schemas"]["RequestedTool"];
+
+export interface ToolInstallationRequestNotification extends BaseUserNotification {
+    category: "tool_installation_request";
+    content: ToolInstallationRequestNotificationContent;
+}
+
+/**
+ * Caller-supplied fields for a tool installation request.
+ *
+ * Derived from the create-only content model, which already omits the
+ * server-stamped `category`/`requester_email`/`is_confirmation` fields.
+ * `submitToolInstallationRequest` adds the `category` discriminator (required
+ * by the OpenAPI union) when building the request payload.
+ */
+export type ToolInstallationRequestInput = Omit<ToolInstallationRequestCreateContent, "category">;
+
+export type UserNotification =
+    | MessageNotification
+    | SharedItemNotification
+    | StorageOperationNotification
+    | ToolInstallationRequestNotification;
 
 export type NotificationChanges = components["schemas"]["UserNotificationUpdateRequest"];
 
@@ -43,3 +71,24 @@ export type NotificationVariants = components["schemas"]["NotificationVariant"];
 
 export type NewSharedItemNotificationContentItemType =
     components["schemas"]["NewSharedItemNotificationContent"]["item_type"];
+
+/** Submit a tool installation request as the authenticated user. */
+export async function submitToolInstallationRequest(content: ToolInstallationRequestInput) {
+    const { error } = await GalaxyApi().POST("/api/notifications", {
+        body: {
+            recipients: { user_ids: [], group_ids: [], role_ids: [] },
+            notification: {
+                source: "tool_installation_request_form",
+                category: "tool_installation_request",
+                variant: "info",
+                content: {
+                    ...content,
+                    category: "tool_installation_request",
+                },
+            },
+        },
+    });
+    if (error) {
+        rethrowSimple(error);
+    }
+}