Skip to content

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.

Simplify assets uploading (#1372)

Bogdan Chadkin85473f8e5751
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 9273263b36..bd17e0db6c 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -45,7 +45,6 @@ import {
import { type Settings, useClientSettings } from "./shared/client-settings";
import { getBuildUrl } from "~/shared/router-utils";
import { useCopyPaste } from "~/shared/copy-paste";
-import { AssetsProvider } from "./shared/assets";
import type { Asset } from "@webstudio-is/asset-uploader";
import { useSearchParams } from "@remix-run/react";
import { useSyncInitializeOnce } from "~/shared/hook-utils";
@@ -316,40 +315,38 @@ export const Builder = ({
});
return (
- <AssetsProvider projectId={project.id} authToken={authToken}>
- <ChromeWrapper isPreviewMode={isPreviewMode}>
- <Topbar gridArea="header" project={project} publish={publish} />
- <Main>
- <Workspace onTransitionEnd={onTransitionEnd} publish={publish}>
- <CanvasIframe
- ref={iframeRefCallback}
- src={canvasUrl}
- pointerEvents={isCanvasPointerEventsEnabled ? "auto" : "none"}
- title={project.title}
- css={{
- height: "100%",
- width: "100%",
- }}
- />
- </Workspace>
- </Main>
- <SidePanel gridArea="sidebar" isPreviewMode={isPreviewMode}>
- <SidebarLeft publish={publish} />
- </SidePanel>
- <NavigatorPanel
- isPreviewMode={isPreviewMode}
- navigatorLayout={navigatorLayout}
- />
- <SidePanel
- gridArea="inspector"
- isPreviewMode={isPreviewMode}
- css={{ overflow: "hidden" }}
- >
- <Inspector publish={publish} navigatorLayout={navigatorLayout} />
- </SidePanel>
- {isPreviewMode === false && <Footer />}
- <BlockingAlerts />
- </ChromeWrapper>
- </AssetsProvider>
+ <ChromeWrapper isPreviewMode={isPreviewMode}>
+ <Topbar gridArea="header" project={project} publish={publish} />
+ <Main>
+ <Workspace onTransitionEnd={onTransitionEnd} publish={publish}>
+ <CanvasIframe
+ ref={iframeRefCallback}
+ src={canvasUrl}
+ pointerEvents={isCanvasPointerEventsEnabled ? "auto" : "none"}
+ title={project.title}
+ css={{
+ height: "100%",
+ width: "100%",
+ }}
+ />
+ </Workspace>
+ </Main>
+ <SidePanel gridArea="sidebar" isPreviewMode={isPreviewMode}>
+ <SidebarLeft publish={publish} />
+ </SidePanel>
+ <NavigatorPanel
+ isPreviewMode={isPreviewMode}
+ navigatorLayout={navigatorLayout}
+ />
+ <SidePanel
+ gridArea="inspector"
+ isPreviewMode={isPreviewMode}
+ css={{ overflow: "hidden" }}
+ >
+ <Inspector publish={publish} navigatorLayout={navigatorLayout} />
+ </SidePanel>
+ {isPreviewMode === false && <Footer />}
+ <BlockingAlerts />
+ </ChromeWrapper>
);
};
diff --git a/apps/builder/app/builder/shared/assets/asset-upload.tsx b/apps/builder/app/builder/shared/assets/asset-upload.tsx
index ef884b0ca8..402a37c9ee 100644
--- a/apps/builder/app/builder/shared/assets/asset-upload.tsx
+++ b/apps/builder/app/builder/shared/assets/asset-upload.tsx
@@ -1,13 +1,33 @@
import { type ChangeEvent, useRef } from "react";
-import { Button, Flex, Tooltip } from "@webstudio-is/design-system";
+import { Button, Flex, Tooltip, toast } from "@webstudio-is/design-system";
import { UploadIcon } from "@webstudio-is/icons";
-import type { AssetType } from "@webstudio-is/asset-uploader";
+import {
+ type AssetType,
+ MAX_UPLOAD_SIZE,
+ toBytes,
+} from "@webstudio-is/asset-uploader";
import { FONT_MIME_TYPES } from "@webstudio-is/fonts";
-import { useAssets } from "./use-assets";
+import { useUploadAsset } from "./use-assets";
import { useAuthPermit } from "~/shared/nano-states";
+const maxSize = toBytes(MAX_UPLOAD_SIZE);
+
+const getFilesFromInput = (_type: AssetType, input: HTMLInputElement) => {
+ const files = Array.from(input?.files ?? []);
+
+ const exceedSizeFiles = files.filter((file) => file.size > maxSize);
+
+ for (const file of exceedSizeFiles) {
+ toast.error(
+ `Asset "${file.name}" cannot be bigger than ${MAX_UPLOAD_SIZE}MB`
+ );
+ }
+
+ return files.filter((file) => file.size <= maxSize);
+};
+
const useUpload = (type: AssetType) => {
- const { handleSubmit } = useAssets(type);
+ const uploadAsset = useUploadAsset();
const inputRef = useRef<HTMLInputElement | null>(null);
const onChange = (event: ChangeEvent<HTMLFormElement>) => {
@@ -16,7 +36,8 @@ const useUpload = (type: AssetType) => {
if (input === null) {
return;
}
- handleSubmit(input);
+ const files = getFilesFromInput(type, input);
+ uploadAsset(type, files);
form.reset();
};
diff --git a/apps/builder/app/builder/shared/assets/use-assets.tsx b/apps/builder/app/builder/shared/assets/use-assets.tsx
index 09dd430422..1c6b08a352 100644
--- a/apps/builder/app/builder/shared/assets/use-assets.tsx
+++ b/apps/builder/app/builder/shared/assets/use-assets.tsx
@@ -1,33 +1,22 @@
-import {
- useMemo,
- createContext,
- useContext,
- type ReactNode,
- useState,
-} from "react";
+import { useMemo } from "react";
import { useStore } from "@nanostores/react";
import warnOnce from "warn-once";
import store from "immerhin";
-import type { Project } from "@webstudio-is/project";
import {
type AssetType,
+ type Asset,
idsFormDataFieldName,
- MAX_UPLOAD_SIZE,
- toBytes,
- Asset,
} from "@webstudio-is/asset-uploader";
import { toast } from "@webstudio-is/design-system";
import { sanitizeS3Key } from "@webstudio-is/asset-uploader";
import { restAssetsPath } from "~/shared/router-utils";
-import type {
- AssetContainer,
- PreviewAsset,
- UploadingAssetContainer,
-} from "./types";
+import type { AssetContainer } from "./types";
import { usePersistentFetcher } from "~/shared/fetcher";
import type { ActionData } from "~/builder/shared/assets";
import { normalizeErrors, toastUnknownFieldErrors } from "~/shared/form-utils";
-import { assetsStore } from "~/shared/nano-states";
+import { assetsStore, authTokenStore } from "~/shared/nano-states";
+import { atom, computed } from "nanostores";
+import { projectContainer } from "../nano-states";
export const deleteAssets = (assetIds: Asset["id"][]) => {
store.createTransaction([assetsStore], (assets) => {
@@ -54,100 +43,81 @@ const setAsset = (asset: Asset) => {
});
};
-export type UploadData = ActionData;
+type FileData = {
+ id: string;
+ type: AssetType;
+ file: File;
+ objectURL: string;
+};
-const toUploadingAssetsAndFormData = (
- type: AssetType,
- files: File[]
-): Promise<[UploadingAssetContainer, FormData][]> => {
- const assets: Array<Promise<[UploadingAssetContainer, FormData]>> = [];
+const getFilesData = (type: AssetType, files: File[]): FileData[] => {
+ return files.map((file) => {
+ return {
+ id: crypto.randomUUID(),
+ type,
+ file,
+ objectURL: URL.createObjectURL(file),
+ };
+ });
+};
- for (const file of files) {
- const promise = new Promise<[UploadingAssetContainer, FormData]>(
- (resolve, reject) => {
- const reader = new FileReader();
- reader.addEventListener("load", (event) => {
- const dataUri = event?.target?.result;
- if (dataUri === undefined) {
- return reject(new Error(`Could not read file "${file.name}"`));
- }
+const uploadingFilesDataStore = atom<FileData[]>([]);
- const id = crypto.randomUUID();
+const addUploadingFilesData = (filesData: FileData[]) => {
+ const uploadingFilesData = uploadingFilesDataStore.get();
+ uploadingFilesDataStore.set([...uploadingFilesData, ...filesData]);
+};
- // sanitizeS3Key here is just because of https://github.com/remix-run/remix/issues/4443
- // should be removed after fix
- const formData = new FormData();
- formData.append(type, file, sanitizeS3Key(file.name));
- formData.append(idsFormDataFieldName, id);
+const deleteUploadingFileData = (id: FileData["id"]) => {
+ const uploadingFilesData = uploadingFilesDataStore.get();
+ uploadingFilesDataStore.set(
+ uploadingFilesData.filter((fileData) => fileData.id !== id)
+ );
+};
- resolve([
- {
- status: "uploading",
- asset: {
- type,
- format: file.type.split("/")[1],
- path: String(dataUri),
- name: file.name,
- description: file.name,
- id,
- },
- },
- formData,
- ]);
+const assetContainersStore = computed(
+ [assetsStore, uploadingFilesDataStore],
+ (assets, uploadingFilesData) => {
+ const uploadingAssets = new Map();
+ for (const { id, type, file, objectURL } of uploadingFilesData) {
+ uploadingAssets.set(id, {
+ id,
+ type,
+ format: file.type.split("/")[1],
+ path: objectURL,
+ name: file.name,
+ description: file.name,
+ });
+ }
+ const assetContainers: Array<AssetContainer> = [];
+ for (const [assetId, asset] of assets) {
+ const uploadingAsset = uploadingAssets.get(assetId);
+ if (uploadingAsset) {
+ assetContainers.push({
+ status: "uploading",
+ asset: uploadingAsset,
});
-
- reader.readAsDataURL(file);
+ continue;
}
- );
-
- assets.push(promise);
- }
-
- return Promise.all(assets);
-};
-
-const maxSize = toBytes(MAX_UPLOAD_SIZE);
-
-const getFilesFromInput = (_type: AssetType, input: HTMLInputElement) => {
- const files = Array.from(input?.files ?? []);
-
- const exceedSizeFiles = files.filter((file) => file.size > maxSize);
-
- for (const file of exceedSizeFiles) {
- toast.error(
- `Asset "${file.name}" cannot be bigger than ${MAX_UPLOAD_SIZE}MB`
- );
+ if (asset) {
+ assetContainers.push({
+ status: "uploaded",
+ asset,
+ });
+ }
+ }
+ return assetContainers;
}
+);
- return files.filter((file) => file.size <= maxSize);
-};
-
-type AssetsContext = {
- handleSubmit: (type: AssetType, files: File[]) => Promise<void>;
- assetContainers: AssetContainer[];
-};
-
-const Context = createContext<AssetsContext | undefined>(undefined);
+export type UploadData = ActionData;
-export const AssetsProvider = ({
- projectId,
- authToken,
- children,
-}: {
- projectId: Project["id"];
- authToken: string | undefined;
- children: ReactNode;
-}) => {
- const [uploadingAssets, setUploadingAssets] = useState<
- Array<Asset | PreviewAsset>
- >([]);
+export const useUploadAsset = () => {
const submit = usePersistentFetcher();
- const action = restAssetsPath({ projectId: projectId, authToken });
-
const handleAfterSubmit = (assetId: string, data: UploadData) => {
// remove uploaded or failed asset
- setUploadingAssets((prev) => prev.filter((asset) => asset.id !== assetId));
+ deleteUploadingFileData(assetId);
if (data.errors !== undefined) {
deleteAssets([assetId]);
@@ -175,32 +145,37 @@ export const AssetsProvider = ({
setAsset(uploadedAsset);
};
- const handleSubmit = async (type: AssetType, files: File[]) => {
- try {
- const uploadingAssetsAndFormData = await toUploadingAssetsAndFormData(
- type,
- files
- );
- const uploadingAssets = uploadingAssetsAndFormData.map(
- ([previewAsset]) => previewAsset.asset
- );
-
- setUploadingAssets((prev) => [...uploadingAssets, ...prev]);
-
- stubAssets(uploadingAssets.map((asset) => asset.id));
+ const uploadAsset = (type: AssetType, files: File[]) => {
+ const projectId = projectContainer.get()?.id;
+ const authToken = authTokenStore.get();
+ if (projectId === undefined) {
+ return;
+ }
- for (const [
- uploadingAssetContainer,
- formData,
- ] of uploadingAssetsAndFormData) {
+ try {
+ const filesData = getFilesData(type, files);
+
+ addUploadingFilesData(filesData);
+ stubAssets(filesData.map((fileData) => fileData.id));
+
+ for (const fileData of filesData) {
+ const { id, type, file } = fileData;
+ // sanitizeS3Key here is just because of https://github.com/remix-run/remix/issues/4443
+ // should be removed after fix
+ const formData = new FormData();
+ formData.append(type, file, sanitizeS3Key(file.name));
+ formData.append(idsFormDataFieldName, id);
submit<UploadData>(
formData,
{
method: "post",
- action,
+ action: restAssetsPath({ projectId, authToken }),
encType: "multipart/form-data",
},
- (data) => handleAfterSubmit(uploadingAssetContainer.asset.id, data)
+ (data) => {
+ URL.revokeObjectURL(fileData.objectURL);
+ handleAfterSubmit(fileData.id, data);
+ }
);
}
} catch (error) {
@@ -210,34 +185,7 @@ export const AssetsProvider = ({
}
};
- const uploadingAssetsMap = new Map();
- for (const asset of uploadingAssets) {
- uploadingAssetsMap.set(asset.id, asset);
- }
- const assetContainers: Array<AssetContainer> = [];
- const assets = useStore(assetsStore);
- for (const [assetId, asset] of assets) {
- const uploadingAsset = uploadingAssetsMap.get(assetId);
- if (uploadingAsset) {
- assetContainers.push({
- status: "uploading",
- asset: uploadingAsset,
- });
- continue;
- }
- if (asset) {
- assetContainers.push({
- status: "uploaded",
- asset,
- });
- }
- }
-
- return (
- <Context.Provider value={{ assetContainers, handleSubmit }}>
- {children}
- </Context.Provider>
- );
+ return uploadAsset;
};
const filterByType = (assetContainers: AssetContainer[], type: AssetType) => {
@@ -247,26 +195,16 @@ const filterByType = (assetContainers: AssetContainer[], type: AssetType) => {
};
export const useAssets = (type: AssetType) => {
- const assetContainersContext = useContext(Context);
- if (!assetContainersContext) {
- throw new Error("useAssets is used without AssetsProvider");
- }
+ const assetContainers = useStore(assetContainersStore);
const assetsByType = useMemo(() => {
- const assetContainers = assetContainersContext.assetContainers;
return filterByType(assetContainers, type);
- }, [assetContainersContext.assetContainers, type]);
-
- const handleSubmit = (input: HTMLInputElement) => {
- const formsData = getFilesFromInput(type, input);
- assetContainersContext.handleSubmit(type, formsData);
- };
+ }, [assetContainers, type]);
return {
/**
* Already loaded assets or assets that are being uploaded
*/
assetContainers: assetsByType,
- handleSubmit,
};
};
diff --git a/packages/asset-uploader/src/patch.ts b/packages/asset-uploader/src/patch.ts
index 7295692624..26f3476834 100644
--- a/packages/asset-uploader/src/patch.ts
+++ b/packages/asset-uploader/src/patch.ts
@@ -35,5 +35,7 @@ export const patchAssets = async (
deletedAssetIds.push(assetId);
}
}
- deleteAssets({ projectId, ids: deletedAssetIds }, context);
+ if (deletedAssetIds.length !== 0) {
+ deleteAssets({ projectId, ids: deletedAssetIds }, context);
+ }
};