Skip to content

New Messaging for Tool Form Modal Errors #19562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hujambo-dunia wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

New Messaging for Tool Form Modal Errors #19562

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
700919a
New Messaging for Tool Form Modal Errors
hujambo-dunia Feb 6, 2025
7276e60
Moved modal error-transcript into collapse/expand box
hujambo-dunia Feb 10, 2025
0dfb5bf
Fix for linting around new component
hujambo-dunia Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions client/src/components/Common/ErrorPluginTracker.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<script setup lang="ts">
import { getGalaxyInstance } from "@/app";
import { computed } from "vue";

const errorReportingAvailable = computed(() =>{
const Galaxy = getGalaxyInstance();
if (!!Galaxy.Sentry.isInitialized) {
Copy link
Copy Markdown
Member

@mvdbeek mvdbeek Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This just means we have a sentry client that is able to submit client errors, but that doesn't mean entirely expected things like this error are captured in sentry.

return "Your error has been logged in Sentry to improve your experience.";
Copy link
Copy Markdown
Contributor

@davelopez davelopez Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't explicitly mention Sentry, users may not know what it is. Maybe something like:

Suggested change
return "Your error has been logged in Sentry to improve your experience.";
return "The error has been logged in our issue tracker system, and our team is investigating to fix it as soon as possible.";

Or something similar :)

}
});
</script>
<template>
<span v-localize>
{{ errorReportingAvailable }}
</span>
</template>
3 changes: 3 additions & 0 deletions client/src/components/Tool/ToolForm.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<b-modal v-model="showError" size="sm" :title="errorTitle | l" scrollable ok-only>
<b-alert v-if="errorMessage" show variant="danger">
{{ errorMessage }}
<ErrorPluginTracker />
</b-alert>
<b-alert v-if="submissionRequestFailed" show variant="warning">
The server could not complete this request. Please verify your parameter settings, retry submission and
Expand Down Expand Up @@ -133,6 +134,7 @@ import ToolCard from "./ToolCard";
import { allowCachedJobs } from "./utilities";

import FormSelect from "@/components/Form/Elements/FormSelect.vue";
import ErrorPluginTracker from "../Common/ErrorPluginTracker.vue";

export default {
components: {
Expand All @@ -145,6 +147,7 @@ export default {
ToolEntryPoints,
ToolRecommendation,
Heading,
ErrorPluginTracker,
},
props: {
id: {
Expand Down