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.

perf: generate asset prop for links and images (#2356)

Bogdan Chadkin45585c056542
diff --git a/fixtures/webstudio-custom-template/public/favicon.ico b/fixtures/webstudio-custom-template/public/favicon.ico
new file mode 100644
index 0000000000..9cb8c815dc
Binary files /dev/null and b/fixtures/webstudio-custom-template/public/favicon.ico differ
diff --git a/fixtures/webstudio-remix-vercel/.webstudio/data.json b/fixtures/webstudio-remix-vercel/.webstudio/data.json
index 7fb21ec844..af44bfaaf7 100644
--- a/fixtures/webstudio-remix-vercel/.webstudio/data.json
+++ b/fixtures/webstudio-remix-vercel/.webstudio/data.json
@@ -1,9 +1,9 @@
{
"build": {
- "id": "4cbe561d-2bae-468c-b9f2-be5cafb59ab5",
+ "id": "9d1c997b-3fcf-4ca6-b467-3814b38669df",
"projectId": "cddc1d44-af37-4cb6-a430-d300cf6f932d",
- "version": 132,
- "createdAt": "2023-09-17T13:00:27.518Z",
+ "version": 153,
+ "createdAt": "2023-09-22T08:56:41.573Z",
"pages": {
"homePage": {
"id": "7Db64ZXgYiRqKSQNR-qTQ",
@@ -1951,6 +1951,26 @@
"type": "string",
"value": "h3"
}
+ ],
+ [
+ "qk_m-CJJD4kY_F07wADHU",
+ {
+ "id": "qk_m-CJJD4kY_F07wADHU",
+ "instanceId": "D8wLZzLWQfxH9uaKsn-0L",
+ "name": "tag",
+ "type": "string",
+ "value": "span"
+ }
+ ],
+ [
+ "GmWaLJTu_cVzrs8-chvQ4",
+ {
+ "id": "GmWaLJTu_cVzrs8-chvQ4",
+ "instanceId": "8AXawjUE3fJoOH_1qOAoq",
+ "name": "href",
+ "type": "asset",
+ "value": "9a8bc926-7804-4d3f-af81-69196b1d2ed8"
+ }
]
],
"dataSources": [
@@ -2124,6 +2144,14 @@
"type": "id",
"value": "l9AI_pShC-BH4ibxK6kNT"
},
+ {
+ "type": "id",
+ "value": "D8wLZzLWQfxH9uaKsn-0L"
+ },
+ {
+ "type": "id",
+ "value": "8AXawjUE3fJoOH_1qOAoq"
+ },
{
"type": "id",
"value": "82HYqzxZeahPxSDFNWem5"
@@ -2933,6 +2961,34 @@
}
]
}
+ ],
+ [
+ "8AXawjUE3fJoOH_1qOAoq",
+ {
+ "type": "instance",
+ "id": "8AXawjUE3fJoOH_1qOAoq",
+ "component": "Link",
+ "children": [
+ {
+ "type": "text",
+ "value": "go download this little kitten"
+ }
+ ]
+ }
+ ],
+ [
+ "D8wLZzLWQfxH9uaKsn-0L",
+ {
+ "type": "instance",
+ "id": "D8wLZzLWQfxH9uaKsn-0L",
+ "component": "Text",
+ "children": [
+ {
+ "type": "text",
+ "value": " or "
+ }
+ ]
+ }
]
],
"deployment": {
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
index bce0b509c0..4fcba9c90f 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
@@ -17,10 +17,10 @@ export const pageData: PageData = {
"HNaXZUvlg14jFvxc29n9T",
{
id: "HNaXZUvlg14jFvxc29n9T",
- instanceId: "AdXSAYCx4QDo5QN6nLoGs",
name: "src",
- type: "asset",
- value: "9a8bc926-7804-4d3f-af81-69196b1d2ed8",
+ instanceId: "AdXSAYCx4QDo5QN6nLoGs",
+ type: "string",
+ value: "/assets/small-avif-kitty_FnabJsioMWpBtXZSGf4DR.webp",
},
],
],
@@ -100,7 +100,11 @@ export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";
const Page = (props: { scripts?: ReactNode }) => {
return (
<Body data-ws-id="EDEfpMPRqDejthtwkH7ws" data-ws-component="Body">
- <Image data-ws-id="AdXSAYCx4QDo5QN6nLoGs" data-ws-component="Image" />
+ <Image
+ data-ws-id="AdXSAYCx4QDo5QN6nLoGs"
+ data-ws-component="Image"
+ src={"/assets/small-avif-kitty_FnabJsioMWpBtXZSGf4DR.webp"}
+ />
{props.scripts}
</Body>
);
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
index eec853e6c4..3c170a2c4f 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
@@ -10,6 +10,7 @@ import {
Box as Box,
Paragraph as Paragraph,
Image as Image,
+ Text as Text,
} from "@webstudio-is/sdk-components-react";
import { Link as Link } from "@webstudio-is/sdk-components-react-remix";
@@ -21,10 +22,11 @@ export const pageData: PageData = {
"rTRZFZEd03RBH4gUWj9LW",
{
id: "rTRZFZEd03RBH4gUWj9LW",
- instanceId: "pX1ovPI7NdC0HRjkw6Kpw",
name: "src",
- type: "asset",
- value: "cd939c56-bcdd-4e64-bd9c-567a9bccd3da",
+ instanceId: "pX1ovPI7NdC0HRjkw6Kpw",
+ type: "string",
+ value:
+ "/assets/_937084ed-a798-49fe-8664-df93a2af605e_uiBk3o6UWdqolyakMvQJ9.jpeg",
},
],
[
@@ -47,6 +49,26 @@ export const pageData: PageData = {
value: "szYLvBduHPmbtqQKCDY0b",
},
],
+ [
+ "qk_m-CJJD4kY_F07wADHU",
+ {
+ id: "qk_m-CJJD4kY_F07wADHU",
+ instanceId: "D8wLZzLWQfxH9uaKsn-0L",
+ name: "tag",
+ type: "string",
+ value: "span",
+ },
+ ],
+ [
+ "GmWaLJTu_cVzrs8-chvQ4",
+ {
+ id: "GmWaLJTu_cVzrs8-chvQ4",
+ name: "href",
+ instanceId: "8AXawjUE3fJoOH_1qOAoq",
+ type: "string",
+ value: "/assets/small-avif-kitty_FnabJsioMWpBtXZSGf4DR.webp",
+ },
+ ],
],
},
pages: [
@@ -150,13 +172,33 @@ const Page = (props: { scripts?: ReactNode }) => {
>
{"Click here to adore more kittens"}
</Link>
+ <Text
+ data-ws-id="D8wLZzLWQfxH9uaKsn-0L"
+ data-ws-component="Text"
+ tag={"span"}
+ >
+ {" or "}
+ </Text>
+ <Link
+ data-ws-id="8AXawjUE3fJoOH_1qOAoq"
+ data-ws-component="Link"
+ href={"/assets/small-avif-kitty_FnabJsioMWpBtXZSGf4DR.webp"}
+ >
+ {"go download this little kitten"}
+ </Link>
<Box data-ws-id="82HYqzxZeahPxSDFNWem5" data-ws-component="Box" />
<Link data-ws-id="9I4GRU1sev48hREkQcKQ-" data-ws-component="Link">
{"Symbols in path"}
</Link>
</Box>
<Box data-ws-id="qPnkiFGDj8dITWb1kmpGl" data-ws-component="Box">
- <Image data-ws-id="pX1ovPI7NdC0HRjkw6Kpw" data-ws-component="Image" />
+ <Image
+ data-ws-id="pX1ovPI7NdC0HRjkw6Kpw"
+ data-ws-component="Image"
+ src={
+ "/assets/_937084ed-a798-49fe-8664-df93a2af605e_uiBk3o6UWdqolyakMvQJ9.jpeg"
+ }
+ />
</Box>
</Box>
{props.scripts}
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/index.css b/fixtures/webstudio-remix-vercel/app/__generated__/index.css
index 50220655b7..c59c01712c 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/index.css
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/index.css
@@ -176,6 +176,15 @@ html {
min-height: 1em;
display: inline-block;
}
+ div:where([data-ws-component="Text"]) {
+ box-sizing: border-box;
+ border-top-width: 1px;
+ border-right-width: 1px;
+ border-bottom-width: 1px;
+ border-left-width: 1px;
+ outline-width: 1px;
+ min-height: 1em;
+ }
div:where(
[data-ws-component="@webstudio-is/sdk-components-react-radix:Accordion"]
) {
@@ -239,15 +248,6 @@ html {
padding-top: 0px;
padding-bottom: 0px;
}
- div:where([data-ws-component="Text"]) {
- box-sizing: border-box;
- border-top-width: 1px;
- border-right-width: 1px;
- border-bottom-width: 1px;
- border-left-width: 1px;
- outline-width: 1px;
- min-height: 1em;
- }
div:where(
[data-ws-component="@webstudio-is/sdk-components-react-radix:AccordionContent"]
) {
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index fdc3f4302f..3c05ff60a7 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -25,6 +25,7 @@ import {
namespaceMeta,
type Params,
type WsComponentMeta,
+ normalizeProps,
} from "@webstudio-is/react-sdk";
import type {
Instance,
@@ -436,10 +437,17 @@ export const prebuild = async (options: {
}
const pageData = siteDataByPage[pathName];
+ const props = new Map(
+ normalizeProps({
+ props: pageData.build.props.map(([_id, prop]) => prop),
+ assetBaseUrl,
+ assets: new Map(pageData.assets.map((asset) => [asset.id, asset])),
+ }).map((prop) => [prop.id, prop])
+ );
// serialize data only used in runtime
const renderedPageData: PageData = {
build: {
- props: pageData.build.props,
+ props: Array.from(props.entries()),
},
pages: pageData.pages,
page: pageData.page,
@@ -448,10 +456,9 @@ export const prebuild = async (options: {
const rootInstanceId = pageData.page.rootInstanceId;
const instances = new Map(pageData.build.instances);
- const props = new Map(pageData.build.props);
const dataSources = new Map(pageData.build.dataSources);
const utilsExport = generateUtilsExport({
- props: new Map(pageData.build.props),
+ props,
});
const pageComponent = generatePageComponent({
scope,
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index c31d9cb43f..33da92be41 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -14,10 +14,10 @@ export {
} from "./components/component-meta";
export * from "./embed-template";
export {
+ normalizeProps,
useInstanceProps,
getPropsByInstanceId,
usePropUrl,
- usePropAsset,
getInstanceIdFromComponentProps,
getIndexWithinAncestorFromComponentProps,
} from "./props";
diff --git a/packages/react-sdk/src/props.test.ts b/packages/react-sdk/src/props.test.ts
index 0a3d7f067e..825cd81ad2 100644
--- a/packages/react-sdk/src/props.test.ts
+++ b/packages/react-sdk/src/props.test.ts
@@ -1,9 +1,55 @@
import { describe, test, expect } from "@jest/globals";
import type { Page, Prop, Asset, Assets } from "@webstudio-is/sdk";
-import { resolveUrlProp, type Pages, type PropsByInstanceId } from "./props";
+import {
+ resolveUrlProp,
+ type Pages,
+ type PropsByInstanceId,
+ normalizeProps,
+} from "./props";
const unique = () => Math.random().toString();
+test("normalize asset prop into string", () => {
+ expect(
+ normalizeProps({
+ props: [
+ {
+ id: "prop1",
+ instanceId: "instance1",
+ name: "src",
+ type: "asset",
+ value: "asset1",
+ },
+ ],
+ assetBaseUrl: "/assets/",
+ assets: new Map([
+ [
+ "asset1",
+ {
+ id: "asset1",
+ type: "image",
+ name: "my-asset.jpg",
+ format: "jpg",
+ meta: { width: 0, height: 0 },
+ projectId: "",
+ size: 0,
+ description: "",
+ createdAt: "",
+ },
+ ],
+ ]),
+ })
+ ).toEqual([
+ {
+ id: "prop1",
+ instanceId: "instance1",
+ name: "src",
+ type: "string",
+ value: "/assets/my-asset.jpg",
+ },
+ ]);
+});
+
describe("resolveUrlProp", () => {
const instanceId = unique();
const projectId = unique();
@@ -127,7 +173,12 @@ describe("resolveUrlProp", () => {
const assets: Assets = new Map([[asset1.id, asset1]]);
- const stores = { props, pages, assets };
+ const stores = {
+ assetBaseUrl: "/assets/",
+ props,
+ pages,
+ assets,
+ };
test("if instanceId is unknown returns undefined", () => {
expect(
@@ -141,8 +192,8 @@ describe("resolveUrlProp", () => {
test("asset by id", () => {
expect(resolveUrlProp(instanceId, assetProp.name, stores)).toEqual({
- type: "asset",
- asset: asset1,
+ type: "string",
+ url: `/assets/${asset1.name}`,
});
});
diff --git a/packages/react-sdk/src/props.ts b/packages/react-sdk/src/props.ts
index f71547a6f4..6662744658 100644
--- a/packages/react-sdk/src/props.ts
+++ b/packages/react-sdk/src/props.ts
@@ -1,14 +1,7 @@
import { useContext, useMemo } from "react";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
-import type {
- Instance,
- Page,
- Prop,
- Props,
- Asset,
- Assets,
-} from "@webstudio-is/sdk";
+import type { Instance, Page, Prop, Props, Assets } from "@webstudio-is/sdk";
import { ReactSdkContext } from "./context";
import { idAttribute, indexAttribute } from "./tree/webstudio-component";
@@ -16,6 +9,38 @@ export type PropsByInstanceId = Map<Instance["id"], Prop[]>;
export type Pages = Map<Page["id"], Page>;
+export const normalizeProps = ({
+ props,
+ assetBaseUrl,
+ assets,
+}: {
+ props: Prop[];
+ assetBaseUrl: string;
+ assets: Assets;
+}) => {
+ const newProps: Prop[] = [];
+ for (const prop of props) {
+ if (prop.type === "asset") {
+ const assetId = prop.value;
+ const asset = assets.get(assetId);
+ if (asset === undefined) {
+ continue;
+ }
+ newProps.push({
+ id: prop.id,
+ name: prop.name,
+ required: prop.required,
+ instanceId: prop.instanceId,
+ type: "string",
+ value: `${assetBaseUrl}${asset.name}`,
+ });
+ continue;
+ }
+ newProps.push(prop);
+ }
+ return newProps;
+};
+
export const getPropsByInstanceId = (props: Props) => {
const propsByInstanceId: PropsByInstanceId = new Map();
for (const prop of props.values()) {
@@ -35,13 +60,15 @@ export const useInstanceProps = (instanceId: Instance["id"]) => {
const {
propsByInstanceIdStore,
dataSourcesLogicStore,
+ assetBaseUrl,
+ assetsStore,
indexesWithinAncestors,
} = useContext(ReactSdkContext);
const index = indexesWithinAncestors.get(instanceId);
const instancePropsObjectStore = useMemo(() => {
return computed(
- [propsByInstanceIdStore, dataSourcesLogicStore],
- (propsByInstanceId, dataSourcesLogic) => {
+ [propsByInstanceIdStore, dataSourcesLogicStore, assetsStore],
+ (propsByInstanceId, dataSourcesLogic, assets) => {
const instancePropsObject: Record<Prop["name"], unknown> = {};
if (index !== undefined) {
instancePropsObject[indexAttribute] = index.toString();
@@ -50,7 +77,14 @@ export const useInstanceProps = (instanceId: Instance["id"]) => {
if (instanceProps === undefined) {
return instancePropsObject;
}
- for (const prop of instanceProps) {
+ const normalizedProps = normalizeProps({
+ props: instanceProps,
+ assetBaseUrl,
+ assets,
+ });
+ for (const prop of normalizedProps) {
+ // asset is normalized to string
+ // page is handled internally
if (prop.type === "asset" || prop.type === "page") {
continue;
}
@@ -74,44 +108,32 @@ export const useInstanceProps = (instanceId: Instance["id"]) => {
return instancePropsObject;
}
);
- }, [propsByInstanceIdStore, dataSourcesLogicStore, instanceId, index]);
+ }, [
+ propsByInstanceIdStore,
+ assetsStore,
+ dataSourcesLogicStore,
+ instanceId,
+ index,
+ assetBaseUrl,
+ ]);
const instancePropsObject = useStore(instancePropsObjectStore);
return instancePropsObject;
};
-// this utility is used for image component in both builder and preview
-// so need to optimize rerenders with computed
-export const usePropAsset = (instanceId: Instance["id"], name: string) => {
- const { propsByInstanceIdStore, assetsStore } = useContext(ReactSdkContext);
- const assetStore = useMemo(() => {
- return computed(
- [propsByInstanceIdStore, assetsStore],
- (propsByInstanceId, assets) => {
- const instanceProps = propsByInstanceId.get(instanceId);
- if (instanceProps === undefined) {
- return;
- }
- for (const prop of instanceProps) {
- if (prop.type === "asset" && prop.name === name) {
- const assetId = prop.value;
- return assets.get(assetId);
- }
- }
- }
- );
- }, [propsByInstanceIdStore, assetsStore, instanceId, name]);
- const asset = useStore(assetStore);
- return asset;
-};
-
export const resolveUrlProp = (
instanceId: Instance["id"],
name: string,
{
+ assetBaseUrl,
props,
pages,
assets,
- }: { props: PropsByInstanceId; pages: Pages; assets: Assets }
+ }: {
+ assetBaseUrl: string;
+ props: PropsByInstanceId;
+ pages: Pages;
+ assets: Assets;
+ }
):
| {
type: "page";
@@ -119,7 +141,6 @@ export const resolveUrlProp = (
instanceId?: Instance["id"];
hash?: string;
}
- | { type: "asset"; asset: Asset }
| { type: "string"; url: string }
| undefined => {
const instanceProps = props.get(instanceId);
@@ -129,13 +150,19 @@ export const resolveUrlProp = (
let prop = undefined;
+ const normalizedProps = normalizeProps({
+ props: instanceProps,
+ assetBaseUrl,
+ assets,
+ });
+
// We had a bug that some props were duplicated https://github.com/webstudio-is/webstudio/pull/2170
// Use the latest prop to ensure consistency with the builder settings panel.
- for (const intanceProp of instanceProps) {
- if (intanceProp.name !== name) {
+ for (const instanceProp of normalizedProps) {
+ if (instanceProp.name !== name) {
continue;
}
- prop = intanceProp;
+ prop = instanceProp;
}
if (prop === undefined) {
@@ -178,27 +205,34 @@ export const resolveUrlProp = (
return { type: "string", url: prop.value };
}
- if (prop.type === "asset") {
- const asset = assets.get(prop.value);
- return asset && { type: "asset", asset };
- }
-
return;
};
// this utility is used for link component in both builder and preview
// so need to optimize rerenders with computed
export const usePropUrl = (instanceId: Instance["id"], name: string) => {
- const { propsByInstanceIdStore, pagesStore, assetsStore } =
+ const { assetBaseUrl, propsByInstanceIdStore, pagesStore, assetsStore } =
useContext(ReactSdkContext);
const store = useMemo(
() =>
computed(
[propsByInstanceIdStore, pagesStore, assetsStore],
(props, pages, assets) =>
- resolveUrlProp(instanceId, name, { props, pages, assets })
+ resolveUrlProp(instanceId, name, {
+ assetBaseUrl,
+ props,
+ pages,
+ assets,
+ })
),
- [propsByInstanceIdStore, pagesStore, assetsStore, instanceId, name]
+ [
+ propsByInstanceIdStore,
+ pagesStore,
+ assetsStore,
+ instanceId,
+ name,
+ assetBaseUrl,
+ ]
);
return useStore(store);
};
diff --git a/packages/sdk-components-react/src/image.tsx b/packages/sdk-components-react/src/image.tsx
index 370613ad03..6f98b91a31 100644
--- a/packages/sdk-components-react/src/image.tsx
+++ b/packages/sdk-components-react/src/image.tsx
@@ -5,11 +5,7 @@ import {
useContext,
} from "react";
import { Image as WebstudioImage } from "@webstudio-is/image";
-import {
- usePropAsset,
- getInstanceIdFromComponentProps,
- ReactSdkContext,
-} from "@webstudio-is/react-sdk";
+import { ReactSdkContext } from "@webstudio-is/react-sdk";
export const defaultTag = "img";
@@ -41,23 +37,27 @@ type Props = Omit<ComponentPropsWithoutRef<typeof WebstudioImage>, "loader">;
export const Image = forwardRef<ElementRef<typeof defaultTag>, Props>(
({ loading = "lazy", ...props }, ref) => {
- const { imageLoader } = useContext(ReactSdkContext);
- const asset = usePropAsset(getInstanceIdFromComponentProps(props), "src");
-
- const src = asset?.name ?? props.src;
+ const { imageLoader, assetBaseUrl } = useContext(ReactSdkContext);
- if (asset == null) {
+ if (
+ props.src === undefined ||
+ props.src.startsWith(assetBaseUrl) === false
+ ) {
return (
<img
- key={src}
+ key={props.src}
loading={loading}
{...props}
- src={src || imagePlaceholderSvg}
+ src={props.src || imagePlaceholderSvg}
ref={ref}
/>
);
}
+ // webstudio pass resolved assetBaseUrl + asset.name
+ // trim assetBaseUrl and pass only asset.name to image loader
+ const src = props.src.slice(assetBaseUrl.length);
+
return (
<WebstudioImage
/**
diff --git a/packages/sdk-components-react/src/link.tsx b/packages/sdk-components-react/src/link.tsx
index fde4ac4f1a..f8209a9d16 100644
--- a/packages/sdk-components-react/src/link.tsx
+++ b/packages/sdk-components-react/src/link.tsx
@@ -1,8 +1,7 @@
-import { forwardRef, type ComponentProps, useContext } from "react";
+import { forwardRef, type ComponentProps } from "react";
import {
usePropUrl,
getInstanceIdFromComponentProps,
- ReactSdkContext,
} from "@webstudio-is/react-sdk";
export const defaultTag = "a";
@@ -13,7 +12,6 @@ type Props = Omit<ComponentProps<"a">, "target"> & {
};
export const Link = forwardRef<HTMLAnchorElement, Props>((props, ref) => {
- const { assetBaseUrl } = useContext(ReactSdkContext);
const href = usePropUrl(getInstanceIdFromComponentProps(props), "href");
let url = "#";
@@ -30,9 +28,6 @@ export const Link = forwardRef<HTMLAnchorElement, Props>((props, ref) => {
}
break;
}
- case "asset":
- url = `${assetBaseUrl}${href.asset.name}`;
- break;
case "string":
url = href.url;
}