@knime/hub-features 1.11.5 → 1.11.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 1.11.7
+
+### Patch Changes
+
+- 2e90c18: Add possibility to send and copy stacktrace in RFC errors
+
+## 1.11.6
+
+### Patch Changes
+
+- dc12ac4: Adjust payload for RFC error utils
+
 ## 1.11.5
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.11.5",
+  "version": "1.11.7",
   "description": "Vue components & composables for shared hub features",
   "homepage": "https://knime.github.io/webapps-common/",
   "license": "GPL 3 and Additional Permissions according to Sec. 7 (SEE the file LICENSE)",

package/src/rfcErrors/RFCErrorToastTemplate.vue

@@ -6,17 +6,21 @@ import { Button } from "@knime/components";
 import CheckIcon from "@knime/styles/img/icons/check.svg";
 import CopyIcon from "@knime/styles/img/icons/copy.svg";
 
-interface Props {
-  headline: string; // toast headline, will not be displayed here but needed when copying to clipboard
-  title: string;
-  details?: string[];
-  status: number;
-  date: Date;
-  requestId: string;
-  errorId?: string;
-}
+import type { RFCErrorData } from "./types";
 
-const props = defineProps<Props>();
+type Props = {
+  headline: string; // toast headline, will not be displayed here but needed when copying to clipboard
+  canCopyToClipboard?: boolean;
+} & RFCErrorData;
+
+const props = withDefaults(defineProps<Props>(), {
+  status: undefined,
+  date: undefined,
+  details: () => [],
+  requestId: undefined,
+  errorId: undefined,
+  canCopyToClipboard: true,
+});
 const emits = defineEmits(["showMore"]);
 
 const { copy, copied } = useClipboard({
@@ -57,16 +61,34 @@ const errorForClipboard = computed(() => {
   errorText += `${props.title}\n\n`;
   errorText += details ? `Details: ${details}\n\n` : "";
 
-  errorText += `Status: ${props.status}\n`;
-  errorText += `Date: ${formattedDate.value}\n`;
-  errorText += `Request Id: ${props.requestId}\n`;
-  errorText += props.errorId ? `Error Id: ${props.errorId}\n` : "";
+  if (props.status !== undefined) {
+    errorText += `Status: ${props.status}\n`;
+  }
+
+  if (props.date) {
+    errorText += `Date: ${formattedDate.value}\n`;
+  }
+
+  if (props.requestId) {
+    errorText += `Request Id: ${props.requestId}\n`;
+  }
+
+  if (props.errorId) {
+    errorText += `Error Id: ${props.errorId}\n`;
+  }
+
+  if (props.stacktrace) {
+    errorText += "------\n"; // separator
+    errorText += `Stacktrace:\n\n${props.stacktrace}\n`;
+  }
 
   return errorText;
 });
 
 const copyToClipboard = () => {
-  copy(errorForClipboard.value);
+  copy(errorForClipboard.value).catch((error) => {
+    consola.error("Failed to copy to clipboard", { error });
+  });
 };
 
 const onShowDetailsClicked = () => {
@@ -95,17 +117,23 @@ const onShowDetailsClicked = () => {
           </ul>
         </template>
       </div>
-      <div><strong>Status: </strong>{{ status }}</div>
-      <div><strong>Date: </strong>{{ formattedDate }}</div>
-      <div><strong>Request id: </strong>{{ requestId }}</div>
+
+      <div v-if="status !== undefined">
+        <strong>Status: </strong>{{ status }}
+      </div>
+      <div v-if="date"><strong>Date: </strong>{{ formattedDate }}</div>
+      <div v-if="requestId"><strong>Request id: </strong>{{ requestId }}</div>
       <div v-if="errorId"><strong>Error id: </strong>{{ errorId }}</div>
-      <div class="copy-button-wrapper">
+      <div v-if="stacktrace">
+        <strong>Stacktrace: </strong>Part of clipboard text
+      </div>
+      <div v-if="canCopyToClipboard" class="copy-button-wrapper">
         <Button @click="copyToClipboard">
-          <template v-if="copied"
-            ><CheckIcon class="copy-icon" />Error was copied</template
-          >
-          <template v-else
-            ><CopyIcon class="copy-icon" />Copy error to clipboard
+          <template v-if="copied">
+            <CheckIcon class="copy-icon" />Error was copied
+          </template>
+          <template v-else>
+            <CopyIcon class="copy-icon" />Copy error to clipboard
           </template>
         </Button>
       </div>

package/src/rfcErrors/index.ts

@@ -12,13 +12,19 @@ import { RFCError, type RFCErrorData } from "./types";
 const toToast = ({
   headline,
   rfcError,
+  canCopyToClipboard = true,
 }: {
   headline: string;
   rfcError: RFCError;
+  canCopyToClipboard?: boolean;
 }): Toast => {
   const { data } = rfcError;
 
-  const rfcErrorToastContent = h(RFCErrorToastTemplate, { headline, ...data });
+  const rfcErrorToastContent = h(RFCErrorToastTemplate, {
+    headline,
+    ...data,
+    canCopyToClipboard,
+  });
 
   return {
     type: "error",
@@ -39,14 +45,14 @@ const tryParse = (error: FetchError): RFCError | FetchError => {
 
   const responseDate = error.response.headers.get("date")
     ? new Date(error.response.headers.get("date")!)
-    : new Date();
+    : undefined;
 
   const rfcErrorData: RFCErrorData = {
     title: error.data.title as string,
     details: error.data.details as string[] | undefined,
     status: error.statusCode as number,
     date: responseDate,
-    requestId: error.response.headers.get("x-request-id") ?? "",
+    requestId: error.response.headers.get("x-request-id") ?? undefined,
     errorId: error.response.headers.get("x-error-id") ?? undefined,
   };
 

package/src/rfcErrors/types.ts

@@ -1,13 +1,24 @@
 /**
  * Type based on an RFC-9457 error standard (https://www.rfc-editor.org/rfc/rfc9457)
+ * Also see:
+ * https://knime-com.atlassian.net/wiki/spaces/SPECS/pages/4126769212/API+Errors+Problem+Details
  */
 export type RFCErrorData = {
   title: string;
+  status?: number;
+  date?: Date;
   details?: string[];
-  status: number;
-  date: Date;
-  requestId: string;
+  requestId?: string;
+  /**
+   * Id used to find an error in the Hub logs. Specially relevant
+   * when details of the error are not wanted to be exposed to the user.
+   */
   errorId?: string;
+  /**
+   * Relevant only for the Analytics Platform, since the Hub does not expose
+   * stack traces.
+   */
+  stacktrace?: string;
 };
 
 export class RFCError extends Error {