Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
Upload assets with native fetch (#1583)
Bogdan Chadkinf018ff945108
diff --git a/apps/builder/app/builder/shared/assets/use-assets.tsx b/apps/builder/app/builder/shared/assets/use-assets.tsxindex 3ee7876af3..b215392306 100644--- a/apps/builder/app/builder/shared/assets/use-assets.tsx+++ b/apps/builder/app/builder/shared/assets/use-assets.tsx@@ -7,9 +7,7 @@ import { toast } from "@webstudio-is/design-system";import { sanitizeS3Key } from "@webstudio-is/asset-uploader";import { restAssetsUploadPath, restAssetsPath } from "~/shared/router-utils";import type { AssetContainer, PreviewAsset } from "./types";-import { usePersistentFetcher } from "~/shared/fetcher";import type { ActionData } from "~/builder/shared/assets";-import { normalizeErrors, toastUnknownFieldErrors } from "~/shared/form-utils";import { assetsStore, authTokenStore } from "~/shared/nano-states";import { atom, computed } from "nanostores";import { projectContainer } from "../nano-states";@@ -108,22 +106,63 @@ const assetContainersStore = computed(export type UploadData = ActionData;-export const useUploadAsset = () => {- const submitAsset = usePersistentFetcher();- const submitUpload = usePersistentFetcher();-- const handleAfterSubmit = (assetId: string, data: UploadData) => {- // remove uploaded or failed asset- deleteUploadingFileData(assetId);+const uploadAsset = async ({+ authToken,+ projectId,+ assetId,+ type,+ file,+ onCompleted,+ onError,+}: {+ authToken: undefined | string;+ projectId: string;+ assetId: string;+ type: string;+ file: File;+ onCompleted: (data: UploadData) => void;+ onError: (error: string) => void;+}) => {+ try {+ const metaFormData = new FormData();+ metaFormData.append("projectId", projectId);+ metaFormData.append("assetId", assetId);+ // sanitizeS3Key here is just because of https://github.com/remix-run/remix/issues/4443+ // should be removed after fix+ metaFormData.append("filename", sanitizeS3Key(file.name));+ const metaResponse = await fetch(restAssetsPath({ authToken }), {+ method: "POST",+ body: metaFormData,+ });+ const metaData: { name: string } | { errors: string } =+ await metaResponse.json();+ if ("errors" in metaData) {+ throw Error(metaData.errors);+ }- if (data.errors !== undefined) {- deleteAssets([assetId]);- return toastUnknownFieldErrors(- normalizeErrors(data.errors ?? "Could not upload an asset"),- []- );+ const uploadFormData = new FormData();+ uploadFormData.append(type, file, metaData.name);+ const uploadResponse = await fetch(+ restAssetsUploadPath({ name: metaData.name }),+ {+ method: "POST",+ body: uploadFormData,+ }+ );+ const uploadData: UploadData = await uploadResponse.json();+ if ("errors" in uploadData) {+ throw Error(uploadData.errors);+ }+ onCompleted(uploadData);+ } catch (error) {+ if (error instanceof Error) {+ onError(error.message);}+ }+};+export const useUploadAsset = () => {+ const handleAfterSubmit = (assetId: string, data: UploadData) => {warnOnce(data.uploadedAssets?.length !== 1,"Expected exactly 1 uploaded asset"@@ -142,61 +181,41 @@ export const useUploadAsset = () => {setAsset(uploadedAsset);};- const uploadAsset = (type: AssetType, files: File[]) => {+ const uploadAssets = (type: AssetType, files: File[]) => {const projectId = projectContainer.get()?.id;const authToken = authTokenStore.get();if (projectId === undefined) {return;}- try {- const filesData = getFilesData(type, files);-- addUploadingFilesData(filesData);- stubAssets(filesData.map((fileData) => fileData.id));-- for (const fileData of filesData) {- const { id, type, file } = fileData;- // should be removed after fix- const formData = new FormData();- formData.append("projectId", projectId);- formData.append("assetId", id);- // sanitizeS3Key here is just because of https://github.com/remix-run/remix/issues/4443- // should be removed after fix- formData.append("filename", sanitizeS3Key(file.name));- submitAsset<{ name: string }>(- formData,- {- method: "post",- action: restAssetsPath({ authToken }),- encType: "multipart/form-data",- },- (data) => {- const formData = new FormData();- formData.append(type, file, data.name);- submitUpload<UploadData>(- formData,- {- method: "post",- action: restAssetsUploadPath({ name: data.name }),- encType: "multipart/form-data",- },- (data) => {- URL.revokeObjectURL(fileData.objectURL);- handleAfterSubmit(fileData.id, data);- }- );- }- );- }- } catch (error) {- if (error instanceof Error) {- toast.error(error.message);- }+ const filesData = getFilesData(type, files);++ addUploadingFilesData(filesData);+ stubAssets(filesData.map((fileData) => fileData.id));++ for (const fileData of filesData) {+ const assetId = fileData.id;+ uploadAsset({+ authToken,+ projectId,+ assetId,+ file: fileData.file,+ type,+ onCompleted: (data) => {+ URL.revokeObjectURL(fileData.objectURL);+ deleteUploadingFileData(assetId);+ handleAfterSubmit(assetId, data);+ },+ onError: (error) => {+ deleteAssets([assetId]);+ deleteUploadingFileData(assetId);+ toast.error(error);+ },+ });}};- return uploadAsset;+ return uploadAssets;};const filterByType = (assetContainers: AssetContainer[], type: AssetType) => {diff --git a/apps/builder/app/root.tsx b/apps/builder/app/root.tsxindex a8713b9f38..30a223ff62 100644--- a/apps/builder/app/root.tsx+++ b/apps/builder/app/root.tsx@@ -5,7 +5,6 @@ import { setEnv } from "@webstudio-is/feature-flags";import { withSentry } from "@sentry/remix";import { ErrorBoundary } from "@sentry/remix";import env from "./shared/env";-import { PersistentFetcherProvider } from "./shared/fetcher";import type { ComponentProps } from "react";setEnv(env.FEATURES as string);@@ -15,9 +14,7 @@ type OutletProps = ComponentProps<typeof Outlet>;const RootWithErrorBoundary = (props: OutletProps) => (<ErrorBoundary><TooltipProvider>- <PersistentFetcherProvider>- <Outlet {...props} />- </PersistentFetcherProvider>+ <Outlet {...props} /></TooltipProvider></ErrorBoundary>);diff --git a/apps/builder/app/routes/rest.assets.tsx b/apps/builder/app/routes/rest.assets.tsxindex 022725b437..2e38ebb484 100644--- a/apps/builder/app/routes/rest.assets.tsx+++ b/apps/builder/app/routes/rest.assets.tsx@@ -49,7 +49,9 @@ export const action = async (props: ActionArgs) => {} catch (error) {if (error instanceof Error) {sentryException({ error });- throw error;+ return {+ errors: error.message,+ };}}};diff --git a/apps/builder/app/shared/fetcher/index.ts b/apps/builder/app/shared/fetcher/index.tsdeleted file mode 100644index 2e118759f7..0000000000--- a/apps/builder/app/shared/fetcher/index.ts+++ /dev/null@@ -1,2 +0,0 @@-export * from "./on-fetch-end";-export * from "./persistent-fetcher";diff --git a/apps/builder/app/shared/fetcher/on-fetch-end.ts b/apps/builder/app/shared/fetcher/on-fetch-end.tsdeleted file mode 100644index 410ead8c20..0000000000--- a/apps/builder/app/shared/fetcher/on-fetch-end.ts+++ /dev/null@@ -1,22 +0,0 @@-import type { Fetcher } from "@remix-run/react";-import { useEffect, useRef } from "react";--export const useOnFetchEnd = <Data>(- fetcher: Fetcher<Data>,- handler: (data: Data) => void-) => {- const latestHandler = useRef(handler);- latestHandler.current = handler;-- const prevFetcher = useRef(fetcher);- useEffect(() => {- if (- prevFetcher.current.state !== fetcher.state &&- fetcher.state === "idle" &&- fetcher.data !== undefined- ) {- latestHandler.current(fetcher.data);- }- prevFetcher.current = fetcher;- }, [fetcher]);-};diff --git a/apps/builder/app/shared/fetcher/persistent-fetcher.tsx b/apps/builder/app/shared/fetcher/persistent-fetcher.tsxdeleted file mode 100644index 7f94b429cf..0000000000--- a/apps/builder/app/shared/fetcher/persistent-fetcher.tsx+++ /dev/null@@ -1,97 +0,0 @@-import { type FetcherWithComponents, useFetcher } from "@remix-run/react";-import {- createContext,- useCallback,- useContext,- useRef,- type ReactNode,-} from "react";-import { useOnFetchEnd } from "./on-fetch-end";--/* This utility is designed for the case when you want to send a request using Remix's fetcher,- * but you don't want the request to be cancelled when the component where useFetcher() is called unmounts.- */--type Task<Data> = {- target: Parameters<FetcherWithComponents<Data>["submit"]>[0];- options: Parameters<FetcherWithComponents<Data>["submit"]>[1];- callback?: (data: Data) => void;-};--type AddTaskFn = <Data>(- target: Task<Data>["target"],- options: Task<Data>["options"],- callback?: Task<Data>["callback"]-) => void;--const Context = createContext<AddTaskFn | undefined>(undefined);--export const PersistentFetcherProvider = ({- children,-}: {- children: ReactNode;-}) => {- const fetcher = useFetcher();- const queue = useRef<Task<unknown>[]>([]);- const currentRequestCallback = useRef<- ((data: unknown) => void) | undefined- >();-- // we can't use fetcher.state === "idle"- // because it's not updated immediately when you call fetcher.submit()- const isIdle = useRef(true);-- const submitTask = useCallback(- (task: Task<unknown>) => {- isIdle.current = false;- currentRequestCallback.current = task.callback;- fetcher.submit(task.target, task.options);- },- [fetcher]- );-- useOnFetchEnd(fetcher, (data) => {- isIdle.current = true;-- if (currentRequestCallback.current) {- const callback = currentRequestCallback.current;- // reset before calling to enable sequential submits- currentRequestCallback.current = undefined;- callback(data);- }-- const nextTask = queue.current.shift();-- if (nextTask) {- submitTask(nextTask);- }- });-- const addTask = useCallback(- (- target: Task<unknown>["target"],- options: Task<unknown>["options"],- callback: Task<unknown>["callback"]- ) => {- const task: Task<unknown> = { target, options, callback };- if (isIdle.current && queue.current.length === 0) {- submitTask(task);- } else {- queue.current.push(task);- }- },- [submitTask]- ) as AddTaskFn;-- return <Context.Provider value={addTask}>{children}</Context.Provider>;-};--export const usePersistentFetcher = () => {- const addTask = useContext(Context);- if (!addTask) {- throw new Error(- "usePersistentFetcher is used without PersistentFetcherProvider"- );- }- return addTask;-};diff --git a/apps/builder/app/shared/form-utils/index.ts b/apps/builder/app/shared/form-utils/index.tsindex 68761926d3..1851921d4f 100644--- a/apps/builder/app/shared/form-utils/index.ts+++ b/apps/builder/app/shared/form-utils/index.ts@@ -1,2 +1 @@-export * from "./validation";export * from "./use-ids";diff --git a/apps/builder/app/shared/form-utils/validation.ts b/apps/builder/app/shared/form-utils/validation.tsdeleted file mode 100644index ca9dc69a68..0000000000--- a/apps/builder/app/shared/form-utils/validation.ts+++ /dev/null@@ -1,30 +0,0 @@-import { toast } from "@webstudio-is/design-system";-import type { ZodError } from "zod";--export const normalizeErrors = (- errors: string | ZodError["formErrors"]-): ZodError["formErrors"] =>- typeof errors === "string"- ? { formErrors: [errors], fieldErrors: {} }- : errors;--// Show a toast for each of formErrors-// as well as fieldErrors which we cannot display near a corresponding field-export const toastUnknownFieldErrors = (- errors: ZodError["formErrors"],- knownFields?: readonly string[]-) => {- for (const message of errors.formErrors) {- toast.error(message);- }-- if (knownFields !== undefined) {- for (const fieldName in errors.fieldErrors) {- if (knownFields.includes(fieldName) === false) {- for (const message of errors.fieldErrors[fieldName] ?? []) {- toast.error(`${fieldName}: ${message}`);- }- }- }- }-};