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.

Remove assets data reloading (#1355)

Bogdan Chadkine7e52a941e56
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index e1fd61cbc1..8fbfb5d6e2 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -316,7 +316,7 @@ export const Builder = ({
});
return (
- <AssetsProvider authToken={authToken}>
+ <AssetsProvider projectId={project.id} authToken={authToken}>
<ChromeWrapper isPreviewMode={isPreviewMode}>
<Topbar gridArea="header" project={project} publish={publish} />
<Main>
diff --git a/apps/builder/app/builder/shared/assets/update-asset-containers.test.ts b/apps/builder/app/builder/shared/assets/update-asset-containers.test.ts
deleted file mode 100644
index c7412fde16..0000000000
--- a/apps/builder/app/builder/shared/assets/update-asset-containers.test.ts
+++ /dev/null
@@ -1,158 +0,0 @@
-import { describe, test, expect } from "@jest/globals";
-import type { Asset } from "@webstudio-is/asset-uploader";
-import type {
- UploadedAssetContainer,
- UploadingAssetContainer,
- DeletingAssetContainer,
- AssetContainer,
-} from "./types";
-import { updateStateAssets } from "./update-asset-containers";
-
-const getAssetId = (
- assetContainer: AssetContainer | DeletingAssetContainer
-): string => assetContainer.asset.id;
-
-const createServerAsset = (id: string, name?: string): Asset => ({
- id,
- type: "image",
- name: name ?? "test",
- location: "FS",
- projectId: "id",
- size: 2135,
- format: "png",
- createdAt: "",
- description: "",
- meta: { width: 200, height: 200 },
- path: "",
-});
-
-const createAsset = (id: string, name?: string): UploadedAssetContainer => ({
- status: "uploaded",
- asset: createServerAsset(id, name),
-});
-
-const createPreviewAsset = (id: string): UploadingAssetContainer => {
- return {
- status: "uploading",
- asset: createAsset(id).asset,
- };
-};
-
-const createPreviewAndAsset = (
- id: string,
- name?: string
-): UploadedAssetContainer => {
- return {
- status: "uploaded",
- asset: createAsset(id, name).asset,
- };
-};
-
-const createDeletingAsset = (id: string): DeletingAssetContainer => {
- return {
- ...createAsset(id),
- status: "deleting",
- };
-};
-
-describe("updateStateAssets", () => {
- const stateAssets = [
- createPreviewAsset("1"),
- createAsset("2"),
- createDeletingAsset("3"),
- createAsset("4"),
- createDeletingAsset("5"),
- createDeletingAsset("6"),
- createPreviewAsset("7"),
- ];
-
- test("Deleting assets should not update", () => {
- const serverAssets = [
- createServerAsset("2"),
- createServerAsset("3"),
- createServerAsset("4"),
- createServerAsset("5"),
- createServerAsset("6"),
- ];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual(stateAssets);
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-
- test("Deleting asset should gone if not exists in server data", () => {
- const serverAssets = [
- createServerAsset("2"),
- createServerAsset("4"),
- createServerAsset("6"),
- ];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual(
- stateAssets.filter((a) => getAssetId(a) !== "3" && getAssetId(a) !== "5")
- );
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-
- test("Preview assets preserves in state", () => {
- const serverAssets: Asset[] = [];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual(
- stateAssets.filter((a) => a.status === "uploading")
- );
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-
- test("Preview assets updated on same id asset at server state", () => {
- const serverAssets = [createServerAsset("1")];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual([
- createPreviewAndAsset("1"),
- createPreviewAsset("7"),
- ]);
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-
- test("Updated asset updated", () => {
- const serverAssets = [createServerAsset("1", "new name")];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual([
- createPreviewAndAsset("1", "new name"),
- createPreviewAsset("7"),
- ]);
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-
- test("Add asset not existing in stateAssets", () => {
- const serverAssets = [createServerAsset("8")];
-
- const nextAssets = updateStateAssets(stateAssets, serverAssets);
-
- expect(nextAssets).toEqual([
- createPreviewAsset("1"),
- createPreviewAsset("7"),
- createAsset("8"),
- ]);
-
- // Check referential equality
- expect(updateStateAssets(nextAssets, serverAssets)).toBe(nextAssets);
- });
-});
diff --git a/apps/builder/app/builder/shared/assets/update-asset-containers.ts b/apps/builder/app/builder/shared/assets/update-asset-containers.ts
deleted file mode 100644
index 83b8dbc90c..0000000000
--- a/apps/builder/app/builder/shared/assets/update-asset-containers.ts
+++ /dev/null
@@ -1,63 +0,0 @@
-import deepEqual from "fast-deep-equal";
-import type { Asset } from "@webstudio-is/asset-uploader";
-import type { AssetContainer, DeletingAssetContainer } from "./types";
-
-/**
- * Update local assets (containing optimistic data) with data from the server
- * - We need to preserve the order of local assets.
- * - We need to not remove optimistic assets until we are 100% sure all is fine.
- * - We need to keep in mind that "serverAssets" can be outdated, or contain information we don't have in local (optimistic) assets
- * - updateAssets(assets, data) must be referentially equal to updateAssets(updateAssets(assets, data), data)
- */
-export const updateStateAssets = <T>(
- assetContainer: (AssetContainer | DeletingAssetContainer)[],
- serverAssets: Asset[]
-) => {
- let nextAssets: (AssetContainer | DeletingAssetContainer)[] = [
- ...assetContainer,
- ];
- // Merging data with existing assets, trying to preserve sorting
- for (const serverAsset of serverAssets) {
- // The same asset is already in the assets
- const sameIndex = nextAssets.findIndex(
- (nextAsset) => nextAsset.asset.id === serverAsset.id
- );
-
- if (sameIndex !== -1) {
- if (nextAssets[sameIndex].status !== "deleting") {
- nextAssets[sameIndex] = {
- status: "uploaded",
- asset: serverAsset,
- };
- }
- continue;
- }
-
- // Assets array were empty or somebody loaded in parallel
- nextAssets.push({
- status: "uploaded",
- asset: serverAsset,
- });
- }
-
- // Remove non-preview assets that are not in the data
- nextAssets = nextAssets.filter((nextAsset) => {
- if (nextAsset.status !== "uploading") {
- if (
- serverAssets.find(
- (serverAsset) => serverAsset.id === nextAsset.asset.id
- ) === undefined
- ) {
- return false;
- }
- }
-
- return true;
- });
-
- if (deepEqual(nextAssets, assetContainer)) {
- return assetContainer;
- }
-
- return nextAssets;
-};
diff --git a/apps/builder/app/builder/shared/assets/use-assets.tsx b/apps/builder/app/builder/shared/assets/use-assets.tsx
index 34f8bbff13..4d66bb8a1c 100644
--- a/apps/builder/app/builder/shared/assets/use-assets.tsx
+++ b/apps/builder/app/builder/shared/assets/use-assets.tsx
@@ -1,26 +1,17 @@
-import {
- useEffect,
- useMemo,
- createContext,
- useContext,
- type ReactNode,
- useRef,
-} from "react";
+import { useMemo, createContext, useContext, type ReactNode } from "react";
import { useStore } from "@nanostores/react";
import warnOnce from "warn-once";
-import { useFetcher } from "@remix-run/react";
+import type { Project } from "@webstudio-is/project";
import {
type AssetType,
idsFormDataFieldName,
MAX_UPLOAD_SIZE,
toBytes,
- type Asset,
} from "@webstudio-is/asset-uploader";
import { toast } from "@webstudio-is/design-system";
import { sanitizeS3Key } from "@webstudio-is/asset-uploader";
import { assetContainersStore } from "~/shared/nano-states";
import { restAssetsPath } from "~/shared/router-utils";
-import { useProject } from "../nano-states";
import type {
AssetContainer,
DeletingAssetContainer,
@@ -30,7 +21,6 @@ import type {
import { usePersistentFetcher } from "~/shared/fetcher";
import type { ActionData } from "~/builder/shared/assets";
import { normalizeErrors, toastUnknownFieldErrors } from "~/shared/form-utils";
-import { updateStateAssets } from "./update-asset-containers";
export type UploadData = ActionData;
@@ -109,57 +99,23 @@ type AssetsContext = {
const Context = createContext<AssetsContext | undefined>(undefined);
export const AssetsProvider = ({
- children,
+ projectId,
authToken,
+ children,
}: {
- children: ReactNode;
+ projectId: Project["id"];
authToken: string | undefined;
+ children: ReactNode;
}) => {
- const [project] = useProject();
const assetContainers = useStore(assetContainersStore);
- const { submit: load, data: serverAssets } = useFetcher<Asset[]>();
const submit = usePersistentFetcher();
- const assetContainersRef = useRef(assetContainers);
-
- const action =
- project && restAssetsPath({ projectId: project.id, authToken });
- assetContainersRef.current = assetContainers;
-
- useEffect(() => {
- if (action && assetContainers.length === 0) {
- /**
- * To prevent the AssetsProvider from being redrawn every time an action is requested, we use PUT instead of GET
- * to load assets. The only reason PUT is chosen is that it is idempotent and has not been used before.
- */
- load({}, { action, method: "put" });
- }
- }, [action, assetContainers.length, load]);
- useEffect(() => {
- if (serverAssets !== undefined) {
- const nextAssetContainers = updateStateAssets(
- assetContainers,
- serverAssets
- );
-
- if (nextAssetContainers !== assetContainers) {
- assetContainersStore.set(nextAssetContainers);
- }
- }
- }, [serverAssets, assetContainers]);
+ const action = restAssetsPath({ projectId: projectId, authToken });
const handleDeleteAfterSubmit = (data: UploadData) => {
- // We need to remove assets only at updateStateAssets.
- // We can't remove it here optimistically because the previous load
- // can return it as "updated" because of the async operation nature
- if (action) {
- load({}, { action, method: "put" });
- }
-
- const { errors } = data;
+ const { errors, deletedAssets } = data;
+ const assetContainers = assetContainersStore.get();
if (errors !== undefined) {
- // We don't know what's wrong, remove the "deleting" status from assets and wait for the load to fix it
- const assetContainers = assetContainersRef.current;
const nextAssetContainers = assetContainers.map((assetContainer) => {
if (assetContainer.status === "deleting") {
const uploadedAssetContainer: UploadedAssetContainer = {
@@ -171,22 +127,24 @@ export const AssetsProvider = ({
return assetContainer;
});
-
assetContainersStore.set(nextAssetContainers);
-
return toastUnknownFieldErrors(normalizeErrors(errors), []);
}
- };
-
- const handleAfterSubmit = (assetId: string) => (data: UploadData) => {
- const assetContainers = assetContainersRef.current;
- if (action) {
- load({}, { action, method: "put" });
+ if (deletedAssets) {
+ const deletedIds = new Set(deletedAssets.map((asset) => asset.id));
+ assetContainersStore.set(
+ assetContainers.filter(
+ (assetContainer) => deletedIds.has(assetContainer.asset.id) === false
+ )
+ );
}
+ };
+
+ const handleAfterSubmit = (assetId: string, data: UploadData) => {
+ const assetContainers = assetContainersStore.get();
if (data.errors !== undefined) {
- // We don't know what's wrong, remove uploading asset and wait for the load to fix it
assetContainersStore.set(
assetContainers.filter(
(assetContainer) =>
@@ -230,7 +188,7 @@ export const AssetsProvider = ({
assetContainer.asset.id === assetId
) {
// We can start using the uploaded asset for image previews etc
- return { ...assetContainer, asset: uploadedAsset };
+ return { status: "uploaded", asset: uploadedAsset };
}
return assetContainer;
})
@@ -239,7 +197,7 @@ export const AssetsProvider = ({
const handleDelete = (ids: Array<string>) => {
const formData = new FormData();
- const assetContainer = assetContainersRef.current;
+ const assetContainer = assetContainersStore.get();
const nextAssetContainers = [...assetContainer];
@@ -283,10 +241,9 @@ export const AssetsProvider = ({
files
);
- const assets = assetContainersRef.current;
assetContainersStore.set([
...uploadingAssetsAndFormData.map(([previewAsset]) => previewAsset),
- ...assets,
+ ...assetContainersStore.get(),
]);
for (const [
@@ -300,7 +257,7 @@ export const AssetsProvider = ({
action,
encType: "multipart/form-data",
},
- handleAfterSubmit(uploadingAssetContainer.asset.id)
+ (data) => handleAfterSubmit(uploadingAssetContainer.asset.id, data)
);
}
} catch (error) {
@@ -311,9 +268,7 @@ export const AssetsProvider = ({
};
return (
- <Context.Provider
- value={{ handleSubmit, assetContainers: assetContainers, handleDelete }}
- >
+ <Context.Provider value={{ assetContainers, handleSubmit, handleDelete }}>
{children}
</Context.Provider>
);
diff --git a/apps/builder/app/routes/rest/assets.$projectId.tsx b/apps/builder/app/routes/rest/assets.$projectId.tsx
index 5a39877cf1..229b558adb 100644
--- a/apps/builder/app/routes/rest/assets.$projectId.tsx
+++ b/apps/builder/app/routes/rest/assets.$projectId.tsx
@@ -40,14 +40,6 @@ export const action = async (
const context = await createContext(request);
try {
- /**
- * To prevent the AssetsProvider from being redrawn every time an action is requested, we use PUT instead of GET
- * to load assets. The only reason PUT is chosen is that it is idempotent and has not been used before.
- */
- if (request.method === "PUT") {
- return await loader(props);
- }
-
if (request.method === "DELETE") {
const { assetId: ids } = DeleteAssets.parse(await request.formData());
const deletedAssets = await deleteAssets(
diff --git a/apps/builder/package.json b/apps/builder/package.json
index d513c15197..1c6f308928 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -60,7 +60,6 @@
"detect-font": "^0.1.5",
"djb2a": "^2.0.0",
"downshift": "^6.1.7",
- "fast-deep-equal": "3.1.3",
"hyphenate-style-name": "^1.0.4",
"immer": "^9.0.12",
"immerhin": "^0.4.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index dfa7768705..1da28147fa 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -177,9 +177,6 @@ importers:
downshift:
specifier: ^6.1.7
version: 6.1.7([email protected])
- fast-deep-equal:
- specifier: 3.1.3
- version: 3.1.3
hyphenate-style-name:
specifier: ^1.0.4
version: 1.0.4