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.

Pass cdn url to remote image loader (#1414)

Bogdan Chadkin18afa9d92b29
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 0a19a13b74..46c00b30cb 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
@@ -97,6 +97,7 @@ export const LayerThumbnail = (props: { layerStyle: StyleInfo }) => {
const loader = remoteLocation
? loaders.cloudflareImageLoader({
resizeOrigin: env.RESIZE_ORIGIN,
+ cdnUrl: env.ASSET_CDN_URL,
})
: loaders.localImageLoader({
publicPath: env.ASSET_PUBLIC_PATH,
diff --git a/apps/builder/app/builder/shared/image-manager/image.tsx b/apps/builder/app/builder/shared/image-manager/image.tsx
index 2ac7b5b6a4..d16b899b43 100644
--- a/apps/builder/app/builder/shared/image-manager/image.tsx
+++ b/apps/builder/app/builder/shared/image-manager/image.tsx
@@ -52,6 +52,7 @@ export const Image = ({ assetContainer, alt, width }: ImageProps) => {
if (remoteLocation) {
return loaders.cloudflareImageLoader({
resizeOrigin: env.RESIZE_ORIGIN,
+ cdnUrl: env.ASSET_CDN_URL,
});
}
diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.ts
index 5b52a69a05..42af654f6c 100644
--- a/apps/builder/app/canvas/shared/styles.ts
+++ b/apps/builder/app/canvas/shared/styles.ts
@@ -193,6 +193,7 @@ const wrappedRulesMap = new Map<string, StyleRule | PlaintextRule>();
const addRule = (id: string, cssRule: CssRule, assets: Assets) => {
const key = id + cssRule.breakpoint;
const selectorText = `[${idAttribute}="${id}"]`;
+ const params = getParams();
const rule = cssEngine.addStyleRule(
selectorText,
{
@@ -200,7 +201,8 @@ const addRule = (id: string, cssRule: CssRule, assets: Assets) => {
style: toVarStyleWithFallback(id, cssRule.style),
},
createImageValueTransformer(assets, {
- publicPath: getParams().publicPath,
+ publicPath: params.publicPath,
+ cdnUrl: params.cdnUrl,
})
);
wrappedRulesMap.set(key, rule);
diff --git a/apps/builder/app/env/env.public.server.ts b/apps/builder/app/env/env.public.server.ts
index 29b7ed244b..c4621408c6 100644
--- a/apps/builder/app/env/env.public.server.ts
+++ b/apps/builder/app/env/env.public.server.ts
@@ -3,6 +3,17 @@
**/
import serverEnv from "./env.server";
+const getCdnUrlFromS3 = () => {
+ const S3_ENDPOINT = process.env.S3_ENDPOINT;
+ const S3_BUCKET = process.env.S3_BUCKET;
+ if (S3_ENDPOINT === undefined || S3_BUCKET === undefined) {
+ return undefined;
+ }
+ const s3Url = new URL(S3_ENDPOINT);
+ s3Url.hostname = `${S3_BUCKET}.${s3Url.hostname}`;
+ return s3Url.toString();
+};
+
/**
* Environment variables we want to send to the UI inlined in the document.
* Never use a private key here, because it will become public.
@@ -18,6 +29,7 @@ const env = {
BUILD_REQUIRE_SUBDOMAIN: process.env.BUILD_REQUIRE_SUBDOMAIN === "true",
// Must be set for Vercel deployments
RESIZE_ORIGIN: process.env.RESIZE_ORIGIN,
+ ASSET_CDN_URL: process.env.ASSET_CDN_URL ?? getCdnUrlFromS3(),
// must be set for local setup
ASSET_PUBLIC_PATH: process.env.ASSET_PUBLIC_PATH,
} as const;
diff --git a/apps/builder/app/routes/$.tsx b/apps/builder/app/routes/$.tsx
index def419d773..aa741dc20c 100644
--- a/apps/builder/app/routes/$.tsx
+++ b/apps/builder/app/routes/$.tsx
@@ -22,6 +22,9 @@ export const loader = async ({ request }: LoaderArgs) => {
if (env.ASSET_PUBLIC_PATH != null) {
params.publicPath = env.ASSET_PUBLIC_PATH;
}
+ if (env.ASSET_CDN_URL != null) {
+ params.cdnUrl = env.ASSET_CDN_URL;
+ }
return { params };
};
diff --git a/apps/builder/app/routes/s.css.ts b/apps/builder/app/routes/s.css.ts
index ec724923f5..68ddc39609 100644
--- a/apps/builder/app/routes/s.css.ts
+++ b/apps/builder/app/routes/s.css.ts
@@ -48,6 +48,7 @@ export const loader = async ({ request }: ActionArgs) => {
},
{
publicPath: env.ASSET_PUBLIC_PATH,
+ cdnUrl: env.ASSET_CDN_URL,
}
);
diff --git a/packages/asset-uploader/src/utils/format-asset.ts b/packages/asset-uploader/src/utils/format-asset.ts
index 387ea26db7..72768d66c9 100644
--- a/packages/asset-uploader/src/utils/format-asset.ts
+++ b/packages/asset-uploader/src/utils/format-asset.ts
@@ -1,19 +1,16 @@
import type { Asset as DbAsset } from "@webstudio-is/prisma-client";
import { type FontFormat, FONT_FORMATS } from "@webstudio-is/fonts";
import { FontMeta } from "@webstudio-is/fonts";
-import { getAssetPath } from "./get-asset-path";
import { type Asset, ImageMeta } from "../schema";
export const formatAsset = (asset: DbAsset): Asset => {
- const path = getAssetPath(asset);
-
const isFont = FONT_FORMATS.has(asset.format as FontFormat);
if (isFont) {
return {
id: asset.id,
name: asset.name,
- path,
+ path: asset.name,
description: asset.description,
location: asset.location,
projectId: asset.projectId,
@@ -29,7 +26,7 @@ export const formatAsset = (asset: DbAsset): Asset => {
return {
id: asset.id,
name: asset.name,
- path,
+ path: asset.name,
description: asset.description,
location: asset.location,
projectId: asset.projectId,
diff --git a/packages/asset-uploader/src/utils/get-asset-path.test.ts b/packages/asset-uploader/src/utils/get-asset-path.test.ts
deleted file mode 100644
index 05fe6344e8..0000000000
--- a/packages/asset-uploader/src/utils/get-asset-path.test.ts
+++ /dev/null
@@ -1,85 +0,0 @@
-import {
- jest,
- describe,
- beforeEach,
- afterAll,
- test,
- expect,
-} from "@jest/globals";
-import { type Asset, Location } from "@webstudio-is/prisma-client";
-
-const commonAsset: Asset = {
- id: "sa-546",
- name: "test",
- location: Location.FS,
- projectId: "id",
- size: 2135,
- format: "png",
- createdAt: new Date(),
- description: "",
- status: "UPLOADED",
- meta: JSON.stringify({ width: 200, height: 200 }),
-};
-
-describe("getAssetPath", () => {
- const OLD_ENV = process.env;
-
- beforeEach(() => {
- jest.resetModules();
- process.env = {
- ...OLD_ENV,
- S3_ACCESS_KEY_ID: "testid",
- S3_SECRET_ACCESS_KEY: "testkey",
- ASSET_CDN_URL: "",
- };
- });
-
- afterAll(() => {
- process.env = OLD_ENV;
- });
-
- describe("s3", () => {
- test("returns s3 url", async () => {
- process.env.S3_ENDPOINT = "https://fr1.s3.com";
- process.env.S3_BUCKET = "bucket";
- process.env.S3_REGION = "fr1";
- const { getAssetPath } = await import("./get-asset-path");
- expect(
- getAssetPath({
- ...commonAsset,
- name: "test.png",
- location: Location.REMOTE,
- })
- ).toBe("https://bucket.fr1.s3.com/test.png");
- });
- test("returns s3 url and fixes extra slashes", async () => {
- process.env.S3_ENDPOINT = "https://fr1.s3.com//";
- process.env.S3_BUCKET = "bucket";
- process.env.S3_REGION = "fr1";
- const { getAssetPath } = await import("./get-asset-path");
- expect(
- getAssetPath({
- ...commonAsset,
- name: "test.png",
- location: Location.REMOTE,
- })
- ).toBe("https://bucket.fr1.s3.com/test.png");
- });
- });
- describe("R2", () => {
- test("returns r2 url", async () => {
- process.env.S3_ENDPOINT = "https://userid.r2.cloudflarestorage.com";
- process.env.S3_BUCKET = "bucket";
- process.env.S3_REGION = "auto";
- process.env.ASSET_CDN_URL = "https://worker-test.workers.dev";
- const { getAssetPath } = await import("./get-asset-path");
- expect(
- getAssetPath({
- ...commonAsset,
- name: "test.png",
- location: Location.REMOTE,
- })
- ).toBe("https://worker-test.workers.dev/test.png");
- });
- });
-});
diff --git a/packages/asset-uploader/src/utils/get-asset-path.ts b/packages/asset-uploader/src/utils/get-asset-path.ts
deleted file mode 100644
index db01aae4be..0000000000
--- a/packages/asset-uploader/src/utils/get-asset-path.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { type Asset as DbAsset, Location } from "@webstudio-is/prisma-client";
-import { S3Env } from "../schema";
-
-const s3Envs = S3Env.safeParse(process.env);
-
-export const getAssetPath = (asset: DbAsset) => {
- if (asset.location === Location.FS) {
- return asset.name;
- }
-
- if (asset.location === Location.REMOTE && s3Envs.success) {
- if (s3Envs.data.ASSET_CDN_URL) {
- const cndUrl = new URL(s3Envs.data.ASSET_CDN_URL);
- cndUrl.pathname = asset.name;
- return cndUrl.toString();
- }
- const s3Url = new URL(s3Envs.data.S3_ENDPOINT);
- s3Url.hostname = `${s3Envs.data.S3_BUCKET}.${s3Url.hostname}`;
- s3Url.pathname = asset.name;
- return s3Url.toString();
- }
-
- return "";
-};
diff --git a/packages/image/src/image-loaders.ts b/packages/image/src/image-loaders.ts
index 4d92221318..da649ecc19 100644
--- a/packages/image/src/image-loaders.ts
+++ b/packages/image/src/image-loaders.ts
@@ -2,17 +2,18 @@ import warnOnce from "warn-once";
import { allSizes, type ImageLoader } from "./image-optimize";
export type CloudflareImageLoaderOptions = {
+ // origin of transformation wrapper
resizeOrigin?: string | null;
+ // origin of cdn serving image
+ cdnUrl?: string;
};
/**
* Default image loader in case of no loader provided
* https://developers.cloudflare.com/images/image-resizing/url-format/
**/
-export const cloudflareImageLoader: (
- ops: CloudflareImageLoaderOptions | null
-) => ImageLoader =
- (loaderOptions) =>
+export const cloudflareImageLoader =
+ (loaderOptions: CloudflareImageLoaderOptions | null): ImageLoader =>
({ width, src, quality }) => {
if (process.env.NODE_ENV !== "production") {
warnOnce(
@@ -21,9 +22,12 @@ export const cloudflareImageLoader: (
);
}
+ const cdnUrl = loaderOptions?.cdnUrl ?? "/";
+ const imageUrl = `${cdnUrl}${src}`;
+
const options = `width=${width},quality=${quality},format=auto`;
// Cloudflare docs say that we don't need to urlencode the path params
- const pathname = `/cdn-cgi/image/${options}/${src}`;
+ const pathname = `/cdn-cgi/image/${options}/${imageUrl}`;
if (loaderOptions?.resizeOrigin != null) {
const url = new URL(pathname, loaderOptions.resizeOrigin);
diff --git a/packages/image/src/image-optimize.test.ts b/packages/image/src/image-optimize.test.ts
index 250a28c5bb..6cdaea4ad1 100644
--- a/packages/image/src/image-optimize.test.ts
+++ b/packages/image/src/image-optimize.test.ts
@@ -7,11 +7,14 @@ describe("Image optimizations applied", () => {
const imgAttr = getImageAttributes({
optimize: true,
width: 100,
- src: "https://webstudio.is/logo.webp",
+ src: "logo.webp",
srcSet: undefined,
sizes: undefined,
quality: 100,
- loader: cloudflareImageLoader({ resizeOrigin: null }),
+ loader: cloudflareImageLoader({
+ resizeOrigin: null,
+ cdnUrl: "https://webstudio.is/",
+ }),
});
expect(imgAttr).toMatchInlineSnapshot(`
@@ -27,11 +30,14 @@ describe("Image optimizations applied", () => {
const imgAttr = getImageAttributes({
optimize: true,
width: undefined,
- src: "https://webstudio.is/logo.webp",
+ src: "logo.webp",
srcSet: undefined,
sizes: undefined,
quality: 90,
- loader: cloudflareImageLoader({ resizeOrigin: null }),
+ loader: cloudflareImageLoader({
+ resizeOrigin: null,
+ cdnUrl: "https://webstudio.is/",
+ }),
});
expect(imgAttr).toMatchInlineSnapshot(`
@@ -47,11 +53,14 @@ describe("Image optimizations applied", () => {
const imgAttr = getImageAttributes({
optimize: true,
width: undefined,
- src: "https://webstudio.is/logo.webp",
+ src: "logo.webp",
srcSet: undefined,
sizes: "100vw",
quality: 70,
- loader: cloudflareImageLoader({ resizeOrigin: null }),
+ loader: cloudflareImageLoader({
+ resizeOrigin: null,
+ cdnUrl: "https://webstudio.is/",
+ }),
});
expect(imgAttr).toMatchInlineSnapshot(`
@@ -67,12 +76,13 @@ describe("Image optimizations applied", () => {
const imgAttr = getImageAttributes({
optimize: true,
width: undefined,
- src: "https://webstudio.is/logo.webp",
+ src: "logo.webp",
srcSet: undefined,
sizes: "100vw",
quality: 70,
loader: cloudflareImageLoader({
resizeOrigin: "https://resize-origin.is",
+ cdnUrl: "https://webstudio.is/",
}),
});
diff --git a/packages/react-sdk/src/app/params.ts b/packages/react-sdk/src/app/params.ts
index 3e1cb634b0..d88668e7ec 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;
+ cdnUrl?: string;
publicPath?: string;
};
diff --git a/packages/react-sdk/src/css/css.ts b/packages/react-sdk/src/css/css.ts
index b5f077cb85..dbf952ca25 100644
--- a/packages/react-sdk/src/css/css.ts
+++ b/packages/react-sdk/src/css/css.ts
@@ -16,6 +16,7 @@ type Data = {
type CssOptions = {
publicPath?: string;
+ cdnUrl?: string;
};
export const createImageValueTransformer =
@@ -28,9 +29,11 @@ export const createImageValueTransformer =
}
// @todo reuse image loaders and generate image-set
- const { publicPath = "/" } = options;
+ const { publicPath = "/", cdnUrl = "/" } = options;
const url =
- asset.location === "REMOTE" ? asset.path : `${publicPath}${asset.name}`;
+ asset.location === "REMOTE"
+ ? `${cdnUrl}${asset.name}`
+ : `${publicPath}${asset.name}`;
return {
type: "image",