@knime/hub-features 1.10.3 → 1.10.5

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @knime/hub-features
 
+## 1.10.5
+
+### Patch Changes
+
+- 805588d: update async download flow in useDownloadArtifact to reflect api changes
+
+## 1.10.4
+
+### Patch Changes
+
+- cd0f5f0: Fix baseURL handling on ofetch client used by the upload, download and versions features.
+  Supplying a custom baseURL with trailing slashes now doesn't break these features
+
 ## 1.10.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.10.3",
+  "version": "1.10.5",
   "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/common/ofetchClient.ts

@@ -1,6 +1,8 @@
 import { merge } from "lodash-es";
 import { type FetchOptions, ofetch } from "ofetch";
 
+import { DEFAULT_API_BASE_URL } from "./constants";
+
 export const defaultConfig: FetchOptions = {
   headers: {
     "Content-Type": "application/json",
@@ -10,5 +12,11 @@ export const defaultConfig: FetchOptions = {
   },
 } as const;
 
-export const getFetchClient = (customOptions?: FetchOptions) =>
-  ofetch.create(merge(customOptions, defaultConfig));
+export const getFetchClient = (customOptions?: FetchOptions) => {
+  const { baseURL = DEFAULT_API_BASE_URL, ...otherCustomOptions } =
+    customOptions ?? {};
+
+  return ofetch.create(
+    merge({ baseURL, ...otherCustomOptions }, defaultConfig),
+  );
+};

package/src/components/versions/useVersionsApi.ts

@@ -12,7 +12,6 @@ import type {
   WithLabels,
 } from "@knime/hub-features/versions";
 
-import { DEFAULT_API_BASE_URL } from "../../common/constants";
 import { getFetchClient } from "../../common/ofetchClient";
 
 type UseVersionsApiOptions = {
@@ -22,10 +21,7 @@ type UseVersionsApiOptions = {
 export const useVersionsApi = ({
   customFetchClientOptions,
 }: UseVersionsApiOptions) => {
-  const { baseURL = DEFAULT_API_BASE_URL, ...otherCustomOptions } =
-    customFetchClientOptions ?? {};
-
-  const $ofetch = getFetchClient({ baseURL, ...otherCustomOptions });
+  const $ofetch = getFetchClient(customFetchClientOptions);
 
   const doHubRequest = (path: string, fetchOptions?: FetchOptions) => {
     const defaults: FetchOptions = {

package/src/useDownloadArtifact/useDownloadArtifact.ts

@@ -4,7 +4,6 @@ import { FetchError, type FetchOptions } from "ofetch";
 import type { DownloadItem as DownloadItemExternal } from "@knime/components";
 import { sleep } from "@knime/utils";
 
-import { DEFAULT_API_BASE_URL } from "../common/constants";
 import { getFetchClient } from "../common/ofetchClient";
 import { rfcErrors } from "../rfcErrors";
 
@@ -19,8 +18,20 @@ type ArtifactStatusResponse = {
   downloadUrl?: string;
 };
 
-type RequestDownloadResponse = {
-  downloadId: string;
+// Initial request can have either download url (if it can be downloaded immediately) or download id (to poll for the status)
+type RequestDownloadResponse =
+  | {
+      downloadId: string;
+    }
+  | {
+      downloadUrl: string;
+    };
+
+// type guard
+const hasDownloadUrl = (
+  response: RequestDownloadResponse,
+): response is { downloadUrl: string } => {
+  return "downloadUrl" in response;
 };
 
 /**
@@ -80,13 +91,11 @@ const isAbortError = (error: unknown) =>
 export const useDownloadArtifact = (
   options: UseDownloadArtifactOptions = {},
 ) => {
+  const $ofetch = getFetchClient(options.customFetchClientOptions);
+
   const downloadItems = ref<Record<string, DownloadItem>>({});
   const abortControllers: Record<string, AbortController> = {};
 
-  const $ofetch = getFetchClient(options.customFetchClientOptions);
-  const baseUrl =
-    options.customFetchClientOptions?.baseURL ?? DEFAULT_API_BASE_URL;
-
   // Use fallback values if none are provided
   const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES;
   const pollingInterval = options.pollingInterval ?? DEFAULT_POLLING_INTERVAL;
@@ -111,13 +120,10 @@ export const useDownloadArtifact = (
     downloadId: string;
     signal?: AbortSignal;
   }) => {
-    return $ofetch<ArtifactStatusResponse>(
-      `${baseUrl}/downloads/${downloadId}/status`,
-      {
-        method: "GET",
-        signal,
-      },
-    );
+    return $ofetch<ArtifactStatusResponse>(`/downloads/${downloadId}/status`, {
+      method: "GET",
+      signal,
+    });
   };
 
   const openDownload = (downloadUrl: string) => {
@@ -255,30 +261,26 @@ export const useDownloadArtifact = (
   }) => {
     try {
       const response = await $ofetch<RequestDownloadResponse>(
-        `${baseUrl}/repository/${itemId}/artifact`,
+        `/repository/${itemId}/artifact`,
         {
           method: "GET",
           query: { version },
         },
       );
-      const downloadId = response.downloadId;
-
-      const downloadStatusResponse = await fetchDownloadStatus({ downloadId });
-
-      if (
-        // download is ready immediately, no polling needed
-        downloadStatusResponse?.status === "READY" &&
-        downloadStatusResponse?.downloadUrl
-      ) {
-        openDownload(downloadStatusResponse.downloadUrl);
-      } else {
-        await pollDownloadItem({
-          itemId,
-          version,
-          downloadId,
-          name,
-        });
+
+      // if download is ready, open url immediately
+      if (hasDownloadUrl(response)) {
+        openDownload(response.downloadUrl);
+        return;
       }
+
+      // otherwise start polling download status
+      await pollDownloadItem({
+        itemId,
+        version,
+        downloadId: response.downloadId,
+        name,
+      });
     } catch (error: unknown) {
       // here only errors thrown by the initial requests are caught;
       // errors occurring while polling will be handled in pollDownloadItem

package/src/useFileUpload/useFileUpload.ts

@@ -4,7 +4,6 @@ import { FetchError, type FetchOptions } from "ofetch";
 import { useUploadManager } from "@knime/components";
 import { getFileMimeType, knimeFileFormats, promise } from "@knime/utils";
 
-import { DEFAULT_API_BASE_URL } from "../common/constants";
 import { getFetchClient } from "../common/ofetchClient";
 import { rfcErrors } from "../rfcErrors";
 
@@ -108,8 +107,6 @@ type UseFileUploadOptions = {
  * ```
  */
 export const useFileUpload = (options: UseFileUploadOptions = {}) => {
-  const baseUrl =
-    options.customFetchClientOptions?.baseURL ?? DEFAULT_API_BASE_URL;
   const $ofetch = getFetchClient(options.customFetchClientOptions);
 
   const prepareUpload = (
@@ -141,10 +138,10 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
       items: Record<string, { uploadId: string }>;
     };
 
-    return $ofetch<PrepareUploadResponse>(
-      `${baseUrl}/repository/${parentId}/manifest`,
-      { method: "POST", body: { items } },
-    ).then(({ items }) => {
+    return $ofetch<PrepareUploadResponse>(`/repository/${parentId}/manifest`, {
+      method: "POST",
+      body: { items },
+    }).then(({ items }) => {
       return Object.keys(items).map((name) => {
         const { uploadId } = items[name];
         const file = fileDictionary[name];
@@ -161,7 +158,7 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
     };
 
     return $ofetch<UploadURLResponse>(
-      `${baseUrl}/uploads/${uploadId}/parts/?partNumber=${partNumber}`,
+      `/uploads/${uploadId}/parts/?partNumber=${partNumber}`,
       { method: "POST" },
     );
   };
@@ -170,14 +167,14 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
     uploadId: string,
     partIds: Record<number, string>,
   ) => {
-    return $ofetch(`${baseUrl}/uploads/${uploadId}`, {
+    return $ofetch(`/uploads/${uploadId}`, {
       method: "POST",
       body: partIds,
     });
   };
 
   const cancelUpload = (uploadId: string) => {
-    return $ofetch(`${baseUrl}/uploads/${uploadId}`, {
+    return $ofetch(`/uploads/${uploadId}`, {
       method: "DELETE",
     });
   };