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.

Add public path to local image loader (#1409)

Bogdan Chadkin34181a1a95f0
diff --git a/apps/builder/.env.example b/apps/builder/.env.example
index a4dafb0f2e..97fc22c462 100644
--- a/apps/builder/.env.example
+++ b/apps/builder/.env.example
@@ -10,6 +10,7 @@ MAX_ASSETS_PER_PROJECT=50
# relative to the public directory
FILE_UPLOAD_PATH="uploads"
+ASSET_PUBLIC_PATH=/s/uploads/
# Optional max upload size in Mb
# MAX_UPLOAD_SIZE=10
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-thumbnail.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-thumbnail.tsx
index 994224a6da..0a19a13b74 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-thumbnail.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-thumbnail.tsx
@@ -98,7 +98,9 @@ export const LayerThumbnail = (props: { layerStyle: StyleInfo }) => {
? loaders.cloudflareImageLoader({
resizeOrigin: env.RESIZE_ORIGIN,
})
- : loaders.localImageLoader();
+ : loaders.localImageLoader({
+ publicPath: env.ASSET_PUBLIC_PATH,
+ });
return (
<StyledWebstudioImage
diff --git a/apps/builder/app/builder/shared/image-manager/image.tsx b/apps/builder/app/builder/shared/image-manager/image.tsx
index aef594c84d..2ac7b5b6a4 100644
--- a/apps/builder/app/builder/shared/image-manager/image.tsx
+++ b/apps/builder/app/builder/shared/image-manager/image.tsx
@@ -55,7 +55,9 @@ export const Image = ({ assetContainer, alt, width }: ImageProps) => {
});
}
- return loaders.localImageLoader();
+ return loaders.localImageLoader({
+ publicPath: env.ASSET_PUBLIC_PATH,
+ });
}, [remoteLocation]);
return (
diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.ts
index 01e1494552..5b52a69a05 100644
--- a/apps/builder/app/canvas/shared/styles.ts
+++ b/apps/builder/app/canvas/shared/styles.ts
@@ -10,6 +10,7 @@ import {
idAttribute,
addGlobalRules,
createImageValueTransformer,
+ getParams,
} from "@webstudio-is/react-sdk";
import type { StyleDecl } from "@webstudio-is/project-build";
import {
@@ -198,7 +199,9 @@ const addRule = (id: string, cssRule: CssRule, assets: Assets) => {
...cssRule,
style: toVarStyleWithFallback(id, cssRule.style),
},
- createImageValueTransformer(assets)
+ createImageValueTransformer(assets, {
+ publicPath: getParams().publicPath,
+ })
);
wrappedRulesMap.set(key, rule);
return rule;
diff --git a/apps/builder/app/env/env.public.server.ts b/apps/builder/app/env/env.public.server.ts
index c421a0915e..29b7ed244b 100644
--- a/apps/builder/app/env/env.public.server.ts
+++ b/apps/builder/app/env/env.public.server.ts
@@ -18,6 +18,8 @@ const env = {
BUILD_REQUIRE_SUBDOMAIN: process.env.BUILD_REQUIRE_SUBDOMAIN === "true",
// Must be set for Vercel deployments
RESIZE_ORIGIN: process.env.RESIZE_ORIGIN,
+ // must be set for local setup
+ ASSET_PUBLIC_PATH: process.env.ASSET_PUBLIC_PATH,
} as const;
export default env;
diff --git a/apps/builder/app/routes/$.tsx b/apps/builder/app/routes/$.tsx
index 4af9ff93c7..def419d773 100644
--- a/apps/builder/app/routes/$.tsx
+++ b/apps/builder/app/routes/$.tsx
@@ -19,6 +19,9 @@ export const loader = async ({ request }: LoaderArgs) => {
if (env.RESIZE_ORIGIN != null) {
params.resizeOrigin = env.RESIZE_ORIGIN;
}
+ if (env.ASSET_PUBLIC_PATH != null) {
+ params.publicPath = env.ASSET_PUBLIC_PATH;
+ }
return { params };
};
diff --git a/apps/builder/app/routes/s.css.ts b/apps/builder/app/routes/s.css.ts
index 147fb911ee..ec724923f5 100644
--- a/apps/builder/app/routes/s.css.ts
+++ b/apps/builder/app/routes/s.css.ts
@@ -39,12 +39,17 @@ export const loader = async ({ request }: ActionArgs) => {
throw json("Page not found", { status: 404 });
}
- const cssText = generateCssText({
- assets: canvasData.assets,
- breakpoints: canvasData.build?.breakpoints,
- styles: canvasData.build?.styles,
- styleSourceSelections: canvasData.build?.styleSourceSelections,
- });
+ const cssText = generateCssText(
+ {
+ assets: canvasData.assets,
+ breakpoints: canvasData.build?.breakpoints,
+ styles: canvasData.build?.styles,
+ styleSourceSelections: canvasData.build?.styleSourceSelections,
+ },
+ {
+ publicPath: env.ASSET_PUBLIC_PATH,
+ }
+ );
const engine = createCssEngine({ name: "ssr" });
for (const style of helperStyles) {
diff --git a/packages/asset-uploader/src/utils/get-asset-path.test.ts b/packages/asset-uploader/src/utils/get-asset-path.test.ts
index bf1a8cef16..05fe6344e8 100644
--- a/packages/asset-uploader/src/utils/get-asset-path.test.ts
+++ b/packages/asset-uploader/src/utils/get-asset-path.test.ts
@@ -38,30 +38,6 @@ describe("getAssetPath", () => {
process.env = OLD_ENV;
});
- describe("local", () => {
- test("returns local path with no custom path", async () => {
- const { getAssetPath } = await import("./get-asset-path");
- expect(
- getAssetPath({
- ...commonAsset,
- name: "test.png",
- location: Location.FS,
- })
- ).toBe("/s/uploads/test.png");
- });
-
- test("return local path with custom path", async () => {
- process.env.FILE_UPLOAD_PATH = "assets";
- const { getAssetPath } = await import("./get-asset-path");
- expect(
- getAssetPath({
- ...commonAsset,
- name: "test.png",
- location: Location.FS,
- })
- ).toBe("/assets/test.png");
- });
- });
describe("s3", () => {
test("returns s3 url", async () => {
process.env.S3_ENDPOINT = "https://fr1.s3.com";
diff --git a/packages/asset-uploader/src/utils/get-asset-path.ts b/packages/asset-uploader/src/utils/get-asset-path.ts
index 846fba58c8..db01aae4be 100644
--- a/packages/asset-uploader/src/utils/get-asset-path.ts
+++ b/packages/asset-uploader/src/utils/get-asset-path.ts
@@ -1,20 +1,11 @@
import { type Asset as DbAsset, Location } from "@webstudio-is/prisma-client";
-import { FsEnv, S3Env } from "../schema";
-import path from "path";
+import { S3Env } from "../schema";
const s3Envs = S3Env.safeParse(process.env);
-const fsEnv = FsEnv.parse(process.env);
export const getAssetPath = (asset: DbAsset) => {
if (asset.location === Location.FS) {
- const splitPath = fsEnv.FILE_UPLOAD_PATH.split("public");
- const url = new URL(
- path.join("/", splitPath[splitPath.length - 1], asset.name),
- // Hostname here is not important
- "http://localhost"
- );
-
- return url.pathname;
+ return asset.name;
}
if (asset.location === Location.REMOTE && s3Envs.success) {
diff --git a/packages/image/src/image-dev.stories.tsx b/packages/image/src/image-dev.stories.tsx
index 056ca17994..f281d857a9 100644
--- a/packages/image/src/image-dev.stories.tsx
+++ b/packages/image/src/image-dev.stories.tsx
@@ -30,7 +30,7 @@ const imageSrc = USE_CLOUDFLARE_IMAGE_TRANSFORM
const imageLoader = USE_CLOUDFLARE_IMAGE_TRANSFORM
? loaders.cloudflareImageLoader({ resizeOrigin: "https://webstudio.is" })
- : loaders.localImageLoader();
+ : loaders.localImageLoader({ publicPath: "" });
const ImageBase: ComponentStory<
React.ForwardRefExoticComponent<
diff --git a/packages/image/src/image-loaders.ts b/packages/image/src/image-loaders.ts
index 145694d0bd..4d92221318 100644
--- a/packages/image/src/image-loaders.ts
+++ b/packages/image/src/image-loaders.ts
@@ -33,15 +33,20 @@ export const cloudflareImageLoader: (
}
};
+type LocalImageLoaderOptions = {
+ publicPath?: string;
+};
+
/**
* Fake pseudo loader for local testing purposes
**/
-export const localImageLoader: () => ImageLoader =
- () =>
+export const localImageLoader =
+ (options: LocalImageLoaderOptions): ImageLoader =>
({ width, src, quality }) => {
+ const { publicPath = "/" } = options;
// Just emulate like we really resize the image
const params = new URLSearchParams();
params.set("width", `${width}`);
params.set("quality", `${quality}`);
- return `${src}?${params.toString()}`;
+ return `${publicPath}${src}?${params.toString()}`;
};
diff --git a/packages/react-sdk/src/app/custom-components/image.tsx b/packages/react-sdk/src/app/custom-components/image.tsx
index 0ddd92d7d1..391d35b2b6 100644
--- a/packages/react-sdk/src/app/custom-components/image.tsx
+++ b/packages/react-sdk/src/app/custom-components/image.tsx
@@ -25,7 +25,7 @@ export const Image = forwardRef<ElementRef<typeof defaultTag>, Props>(
if (asset.location === "REMOTE") {
return loaders.cloudflareImageLoader(params);
}
- return loaders.localImageLoader();
+ return loaders.localImageLoader(params);
}, [asset, params]);
let src = props.src;
diff --git a/packages/react-sdk/src/app/params.ts b/packages/react-sdk/src/app/params.ts
index fd4b2dbdaf..3e1cb634b0 100644
--- a/packages/react-sdk/src/app/params.ts
+++ b/packages/react-sdk/src/app/params.ts
@@ -1,5 +1,6 @@
export type Params = {
resizeOrigin?: string;
+ publicPath?: string;
};
let params: Params | null = {};
diff --git a/packages/react-sdk/src/css/css.ts b/packages/react-sdk/src/css/css.ts
index b60f118dc9..b5f077cb85 100644
--- a/packages/react-sdk/src/css/css.ts
+++ b/packages/react-sdk/src/css/css.ts
@@ -14,26 +14,36 @@ type Data = {
styleSourceSelections?: Build["styleSourceSelections"];
};
+type CssOptions = {
+ publicPath?: string;
+};
+
export const createImageValueTransformer =
- (assets: Assets): TransformValue =>
+ (assets: Assets, options: CssOptions): TransformValue =>
(styleValue) => {
if (styleValue.type === "image" && styleValue.value.type === "asset") {
const asset = assets.get(styleValue.value.value);
if (asset === undefined) {
return { type: "keyword", value: "none" };
}
+
+ // @todo reuse image loaders and generate image-set
+ const { publicPath = "/" } = options;
+ const url =
+ asset.location === "REMOTE" ? asset.path : `${publicPath}${asset.name}`;
+
return {
type: "image",
value: {
type: "url",
- url: asset.path,
+ url,
},
hidden: styleValue.hidden,
};
}
};
-export const generateCssText = (data: Data) => {
+export const generateCssText = (data: Data, options: CssOptions) => {
const assets = new Map<Asset["id"], Asset>(
data.assets.map((asset) => [asset.id, asset])
);
@@ -72,7 +82,7 @@ export const generateCssText = (data: Data) => {
breakpoint: breakpointId,
style,
},
- createImageValueTransformer(assets)
+ createImageValueTransformer(assets, options)
);
}