@knime/utils 1.1.1 → 1.1.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/utils
 
+## 1.1.3
+
+### Patch Changes
+
+- 9fa8163: bugfix/improvements in uploads: retry only on server error, reset placeholder skeleton on prepare upload error
+
+## 1.1.2
+
+### Patch Changes
+
+- 15a4479: add utilities for file extensions
+
 ## 1.1.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/utils",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Internal utility functions and constants shared across @knime packages.",
   "homepage": "https://knime.github.io/webapps-common/",
   "license": "GPL 3 and Additional Permissions according to Sec. 7 (SEE the file LICENSE)",

package/src/fileExtensions.ts

@@ -0,0 +1,68 @@
+export const getFileExtension = (nameOrPath: string) => {
+  const basename = nameOrPath.split(/[\\/]/).pop();
+  const position = basename?.lastIndexOf(".") as number;
+
+  if (basename === "" || position < 1) {
+    return "";
+  }
+
+  return basename?.slice(position + 1);
+};
+
+/**
+ * Metadata for .knar files, which corresponds to exported KNIME Workflow Groups
+ * or Components
+ */
+const KNAR = Object.freeze({
+  extension: "knar",
+  mimeType: "application/vnd.knime.workflow-group+zip",
+  matches(file: File) {
+    const extension = getFileExtension(file.name);
+    return extension === this.extension;
+  },
+});
+
+/**
+ * Metadata for .knwf files, which corresponds to exported KNIME Workflows
+ */
+const KNWF = Object.freeze({
+  extension: "knwf",
+  mimeType: "application/vnd.knime.workflow+zip",
+  matches(file: File) {
+    const extension = getFileExtension(file.name);
+    return extension === this.extension;
+  },
+});
+
+export const knimeFileFormats = { KNAR, KNWF };
+
+/**
+ * Gets the mime type from a given file. Defaults to `application/octet-stream`
+ * if mimeType cannot be detected
+ * @param file File
+ * @returns mimeType
+ */
+export const getFileMimeType = (file: File): string => {
+  const DEFAULT_MIMETYPE = "application/octet-stream";
+
+  const extension = getFileExtension(file.name);
+
+  if (!extension) {
+    return DEFAULT_MIMETYPE;
+  }
+
+  if (KNWF.matches(file)) {
+    return KNWF.mimeType;
+  }
+
+  if (KNAR.matches(file)) {
+    return KNAR.mimeType;
+  }
+
+  // file has extension but unrecognizable mime type
+  if (!file.type) {
+    return DEFAULT_MIMETYPE;
+  }
+
+  return file.type;
+};

package/src/index.ts

@@ -45,6 +45,8 @@ export namespace UploadManagerNS {
   export type UploadStateName = _UploadStateName;
 }
 
+export * from "./fileExtensions";
+
 export {
   uploadManager,
   promise,

package/src/promise/retryPromise.ts

@@ -1,8 +1,8 @@
 /* eslint-disable func-style */
 import sleep from "../sleep";
 
-const DEFAULT_RETRY_DELAY_MS = 0;
-const DEFAULT_RETRY_COUNT = 5;
+export const DEFAULT_RETRY_DELAY_MS = 0;
+export const DEFAULT_RETRY_COUNT = 5;
 
 /**
  * Helper to add retry capability to an async function
@@ -11,12 +11,17 @@ const DEFAULT_RETRY_COUNT = 5;
  * @param retryDelayMS delay in-between retries in millisecs. defaults to 0
  * @param excludeError predicate fn to exclude specific errors from causing a retry
  */
-export async function retryPromise<T>(
-  fn: () => Promise<T>,
+export async function retryPromise<T>({
+  fn,
   retryCount = DEFAULT_RETRY_COUNT,
   retryDelayMS = DEFAULT_RETRY_DELAY_MS,
-  excludeError?: (error: Error) => boolean,
-) {
+  excludeError,
+}: {
+  fn: () => Promise<T>;
+  retryCount?: number;
+  retryDelayMS?: number;
+  excludeError?: (error: Error) => boolean;
+}) {
   try {
     return await fn();
   } catch (error) {
@@ -28,7 +33,12 @@ export async function retryPromise<T>(
       await sleep(retryDelayMS);
 
       // eslint-disable-next-line no-return-await
-      return await retryPromise(fn, retryCount - 1, retryDelayMS);
+      return await retryPromise({
+        fn,
+        retryCount: retryCount - 1,
+        retryDelayMS,
+        excludeError,
+      });
     }
 
     throw error;

package/src/uploadManager/index.ts

@@ -56,12 +56,22 @@ const uploadChunkWithProgress = (params: {
         // https://datatracker.ietf.org/doc/html/rfc7232#section-2.3
         resolve({ partId: etag.replace(/^(?:W\/)?"|"$/g, "") });
       } else {
-        reject(new Error(`Failed to upload chunk ${chunkIndex}`));
+        consola.error("Failed or unexpected XHR response", {
+          xhrStatus: xhr.status,
+          xhrResponse: xhr.response,
+          chunkIndex,
+        });
+        reject(new Error("Failed to upload file"));
       }
     };
 
-    xhr.onerror = () =>
-      reject(new Error(`Failed to upload chunk ${chunkIndex}`));
+    xhr.onerror = (event) => {
+      consola.error("Failed to upload chunk", {
+        xhrErrorEvent: event,
+        chunkIndex,
+      });
+      reject(new Error("Failed to upload file"));
+    };
 
     xhr.send(chunk);
   });
@@ -251,11 +261,11 @@ export const createUploadManager = (config: UploaderManagerConfig) => {
       const chunk = file.slice(start, end);
 
       try {
-        const { method, url } = await retryPromise(
-          () => getUploadFilePartUrl(uploadId, chunkIndex + 1),
-          DEFAULT_RETRY_COUNT,
-          DEFAULT_RETRY_DELAY_MS,
-        );
+        const { method, url } = await retryPromise({
+          fn: () => getUploadFilePartUrl(uploadId, chunkIndex + 1),
+          retryCount: DEFAULT_RETRY_COUNT,
+          retryDelayMS: DEFAULT_RETRY_DELAY_MS,
+        });
 
         consola.trace("File part upload url resolved", { method, url });
 
@@ -269,8 +279,8 @@ export const createUploadManager = (config: UploaderManagerConfig) => {
         };
 
         const filePartResponse = await runAbortablePromise(() =>
-          retryPromise(
-            () =>
+          retryPromise({
+            fn: () =>
               uploadChunkWithProgress({
                 method,
                 url,
@@ -279,9 +289,9 @@ export const createUploadManager = (config: UploaderManagerConfig) => {
                 onProgress: onChunkUploadProgress,
                 abortSignal: abortController.signal,
               }),
-            DEFAULT_RETRY_COUNT,
-            DEFAULT_RETRY_DELAY_MS,
-          ),
+            retryCount: DEFAULT_RETRY_COUNT,
+            retryDelayMS: DEFAULT_RETRY_DELAY_MS,
+          }),
         );
 
         consola.trace(