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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
feat: Support image transform for 3rd party images (#3585)
Ivan Starkov2dc2a21f4c5b
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsxindex 3518ff4572..f38bf1b85d 100644--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx@@ -70,7 +70,12 @@ const renderProperty = (},onChange: (propValue) => {logic.handleChange({ prop, propName }, propValue);- if (component === "Image" && propName === "src") {++ if (+ component === "Image" &&+ propName === "src" &&+ propValue.type === "asset"+ ) {logic.handleChangeByPropName("width", propValue);logic.handleChangeByPropName("height", propValue);}diff --git a/apps/builder/app/routes/cgi.image.$name.ts b/apps/builder/app/routes/cgi.image.$.tssimilarity index 71%rename from apps/builder/app/routes/cgi.image.$name.tsrename to apps/builder/app/routes/cgi.image.$.tsindex 5e195fb44f..6406753acb 100644--- a/apps/builder/app/routes/cgi.image.$name.ts+++ b/apps/builder/app/routes/cgi.image.$.ts@@ -5,21 +5,15 @@ import type { LoaderFunctionArgs } from "@remix-run/server-runtime";import env from "~/env/env.server";import { getImageNameAndType } from "~/builder/shared/assets/asset-utils";import { z } from "zod";+import { createImageLoader } from "@webstudio-is/image";const ImageParams = z.object({width: z.string().transform((value) => Math.round(parseFloat(value))),height: z.optional(z.string().transform((value) => Math.round(parseFloat(value)))),- fit: z.optional(- z.union([- z.literal("scale-down"),- z.literal("contain"),- z.literal("cover"),- z.literal("crop"),- z.literal("pad"),- ])- ),+ fit: z.optional(z.literal("pad")),+ background: z.optional(z.string()),quality: z.string().transform((value) => Math.round(parseFloat(value))),@@ -32,23 +26,20 @@ const ImageParams = z.object({z.literal("png"),z.literal("raw"),]),-- // For testing purposes- sleep: z- .optional(z.string())- .transform((value) => (value ? Math.round(parseFloat(value)) : undefined)),});+const decodePathFragment = (fragment: string) => {+ return decodeURIComponent(fragment);+};+// this route used as proxy for images to cloudflare endpoint// https://developers.cloudflare.com/fundamentals/get-started/reference/cdn-cgi-endpoint/-export const loader = async ({ params, request }: LoaderFunctionArgs) => {- const { name } = params;- if (name === undefined) {- throw Error("Name is undefined");- }+export const loader = async ({ request }: LoaderFunctionArgs) => {+ const basePath = `/cgi/image/`;const url = new URL(request.url);+ const name = decodePathFragment(url.pathname.slice(basePath.length));// The code should be +- same as here https://github.com/webstudio-is/webstudio-saas/blob/6c9a3bfb67cf5a221c20666de34bd20dc14bd558/packages/assets-proxy/src/image-transform.ts#L68const rawParameters: Record<string, string> = {@@ -69,19 +60,8 @@ export const loader = async ({ params, request }: LoaderFunctionArgs) => {rawParameters.fit = fit;}- const sleep = url.searchParams.get("sleep");-- if (sleep != null) {- rawParameters.sleep = sleep;- }-const imageParameters = ImageParams.parse(rawParameters);- // For testing purposes- if (imageParameters.sleep !== undefined) {- await new Promise((resolve) => setTimeout(resolve, imageParameters.sleep));- }-// Allow direct image access, and from the same originconst refererRawUrl = request.headers.get("referer");const refererUrl = refererRawUrl === null ? url : new URL(refererRawUrl);@@ -92,19 +72,37 @@ export const loader = async ({ params, request }: LoaderFunctionArgs) => {}if (env.RESIZE_ORIGIN !== undefined) {- const assetUrl = `${name}`;- // @todo add secret ti avoid exploiting our server- const imageUrl = `${env.RESIZE_ORIGIN}/cgi/image/${assetUrl}?${url.searchParams}`;+ const imageLoader = createImageLoader({+ imageBaseUrl: `${env.RESIZE_ORIGIN}/cgi/image/`,+ });++ const imgHref = imageLoader({+ src: name,+ ...imageParameters,+ format: "auto",+ });++ const imgUrl = new URL(imgHref);+ imgUrl.search = url.search;- const response = await fetch(imageUrl, {+ const response = await fetch(imgUrl.href, {headers: {accept: request.headers.get("accept") ?? "","accept-encoding": request.headers.get("accept-encoding") ?? "",},});- response.headers.set("Access-Control-Allow-Origin", url.origin);- return response;+ const responseWHeaders = new Response(response.body, response);++ if (false === responseWHeaders.ok) {+ console.error(+ `Request to Image url ${imgUrl.href} responded with status = ${responseWHeaders.status}`+ );+ }++ responseWHeaders.headers.set("Access-Control-Allow-Origin", url.origin);++ return responseWHeaders;}if (env.FILE_UPLOAD_PATH === undefined) {diff --git a/packages/image/src/image-loader.test.ts b/packages/image/src/image-loader.test.tsnew file mode 100644index 0000000000..01322b2b38--- /dev/null+++ b/packages/image/src/image-loader.test.ts@@ -0,0 +1,100 @@+import { describe, test, expect } from "@jest/globals";+import { createImageLoader } from "./image-loaders";++const decodePathFragment = (fragment: string) => {+ return decodeURIComponent(fragment);+};++const encodePathFragment = (fragment: string) => {+ return encodeURIComponent(fragment).replace(/%2F/g, "/");+};++describe("Asset image transforms", () => {+ test("width is number", () => {+ const imageBaseUrl = "/asset/image/";+ const loader = createImageLoader({ imageBaseUrl });++ const assetName = "Привет_Мир__2F__BQNEuP8O9N79eVwPfbBJg.webp";+ const result = loader({+ width: 128,+ src: assetName,+ quality: 100,+ });++ const resultUrl = new URL(result, "https://any-domain.any");++ expect(result).toMatchInlineSnapshot(+ `"/asset/image/%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82_%D0%9C%D0%B8%D1%80__2F__BQNEuP8O9N79eVwPfbBJg.webp?width=128&quality=100&format=auto"`+ );++ expect(+ decodePathFragment(resultUrl.pathname.slice(imageBaseUrl.length))+ ).toBe(assetName);+ });++ test("imageBaseUrl is remote", () => {+ const loader = createImageLoader({+ imageBaseUrl: "https://remote-transform-server.xx/asset/image/",+ });++ const result = loader({+ width: 128,+ src: "logo.webp",+ quality: 100,+ });++ expect(result).toMatchInlineSnapshot(+ `"https://remote-transform-server.xx/asset/image/logo.webp?width=128&quality=100&format=auto"`+ );+ });+});++describe("Remote src image transforms", () => {+ test("width is number", () => {+ const imageBaseUrl = "/asset/image/";+ const loader = createImageLoader({ imageBaseUrl });++ const remoteSrc = "https://example.com/lo%3Fgo.webp?a=1";++ const result = loader({+ width: 128,+ src: remoteSrc,+ quality: 100,+ });++ const resultUrl = new URL(result, "https://any-domain.any");++ expect(+ decodePathFragment(resultUrl.pathname.slice(imageBaseUrl.length))+ ).toBe(remoteSrc);++ expect(resultUrl.searchParams.get("width")).toBe("128");++ expect(result).toMatchInlineSnapshot(+ `"/asset/image/https%3A//example.com/lo%253Fgo.webp%3Fa%3D1?width=128&quality=100&format=auto"`+ );+ });++ test("Double encoded fragment", () => {+ const imageBaseUrl = "/asset/image/";+ const loader = createImageLoader({ imageBaseUrl });++ const remoteSrc = encodePathFragment(+ "https://ex%2Fample.com/lo%3Fgo.webp?a=1"+ );++ const result = loader({+ width: 128,+ src: remoteSrc,+ quality: 100,+ });++ const resultUrl = new URL(result, "https://any-domain.any");++ expect(+ decodePathFragment(resultUrl.pathname.slice(imageBaseUrl.length))+ ).toBe(remoteSrc);++ expect(resultUrl.searchParams.get("width")).toBe("128");+ });+});diff --git a/packages/image/src/image-loaders.ts b/packages/image/src/image-loaders.tsindex 78b94c4cdb..ac38990618 100644--- a/packages/image/src/image-loaders.ts+++ b/packages/image/src/image-loaders.ts@@ -5,6 +5,19 @@ export type ImageLoaderOptions = {imageBaseUrl: string;};+const NON_EXISTING_DOMAIN = "https://a3cbcbec-cdb1-4ea4-ad60-43c795308ddc.ddc";++const joinPath = (...segments: string[]) => {+ return segments+ .filter((segment) => segment !== "") // Remove empty segments+ .map((segment) => segment.replace(/(^\/+|\/+$)/g, "")) // Remove leading and trailing slashes from each segment+ .join("/");+};++const encodePathFragment = (fragment: string) => {+ return encodeURIComponent(fragment).replace(/%2F/g, "/");+};+/*** Default image loader in case of no loader provided* https://developers.cloudflare.com/images/image-resizing/url-format/@@ -16,14 +29,6 @@ export const createImageLoader =const quality = props.format === "raw" ? 100 : props.quality;const { format, src } = props;- // load absolute images without changes- try {- new URL(src);- return src;- } catch {- // empty block- }-if (process.env.NODE_ENV !== "production") {warnOnce(allSizes.includes(width) === false,@@ -31,19 +36,34 @@ export const createImageLoader =);}const { imageBaseUrl } = loaderOptions;- const searchParams = new URLSearchParams();- searchParams.set("width", width.toString());- searchParams.set("quality", quality.toString());- searchParams.set("format", format ?? "auto");++ let resultUrl;+ try {+ resultUrl = new URL(imageBaseUrl, NON_EXISTING_DOMAIN);+ } catch {+ return src;+ }++ // const searchParams = new URLSearchParams();++ resultUrl.searchParams.set("width", width.toString());+ resultUrl.searchParams.set("quality", quality.toString());+ resultUrl.searchParams.set("format", format ?? "auto");if (props.format !== "raw" && props.height != null) {- searchParams.set("height", props.height.toString());+ resultUrl.searchParams.set("height", props.height.toString());}if (props.format !== "raw" && props.fit != null) {- searchParams.set("fit", props.fit);+ resultUrl.searchParams.set("fit", props.fit);+ }++ resultUrl.pathname = joinPath(resultUrl.pathname, encodePathFragment(src));++ if (resultUrl.href.startsWith(NON_EXISTING_DOMAIN)) {+ return `${resultUrl.pathname}?${resultUrl.searchParams.toString()}`;}// Cloudflare docs say that we don't need to urlencode the path params- return `${imageBaseUrl}${src}?${searchParams.toString()}`;+ return resultUrl.href;};diff --git a/packages/image/src/image.tsx b/packages/image/src/image.tsxindex f12a904b44..26b942ef6c 100644--- a/packages/image/src/image.tsx+++ b/packages/image/src/image.tsx@@ -53,7 +53,7 @@ const imagePlaceholderSvg = `data:image/svg+xml;base64,${btoa(`<svgfill="none"xmlns="http://www.w3.org/2000/svg">- <rect width="600" height="600" />+ <rect width="600" height="600" fill="hsla(0, 0%, 80%, 0.2)" /><pathfill-rule="evenodd"clip-rule="evenodd"diff --git a/packages/sdk-components-react/src/image.tsx b/packages/sdk-components-react/src/image.tsxindex d4fc10a293..50ce5bbcf1 100644--- a/packages/sdk-components-react/src/image.tsx+++ b/packages/sdk-components-react/src/image.tsx@@ -9,30 +9,6 @@ import { ReactSdkContext } from "@webstudio-is/react-sdk";export const defaultTag = "img";-const imagePlaceholderSvg = `data:image/svg+xml;base64,${btoa(`<svg- width="140"- height="140"- viewBox="0 0 600 600"- fill="none"- xmlns="http://www.w3.org/2000/svg"- >- <rect width="600" height="600" fill="#CCCCCC" />- <path- fill-rule="evenodd"- clip-rule="evenodd"- d="M450 170H150C141.716 170 135 176.716 135 185V415C135 423.284 141.716 430 150 430H450C458.284 430 465 423.284 465 415V185C465 176.716 458.284 170 450 170ZM150 145C127.909 145 110 162.909 110 185V415C110 437.091 127.909 455 150 455H450C472.091 455 490 437.091 490 415V185C490 162.909 472.091 145 450 145H150Z"- fill="#A2A2A2"- />- <path- d="M237.135 235.012C237.135 255.723 220.345 272.512 199.635 272.512C178.924 272.512 162.135 255.723 162.135 235.012C162.135 214.301 178.924 197.512 199.635 197.512C220.345 197.512 237.135 214.301 237.135 235.012Z"- fill="#A2A2A2"- />- <path- d="M160 405V367.205L221.609 306.364L256.552 338.628L358.161 234L440 316.043V405H160Z"- fill="#A2A2A2"- />-</svg>`)}`;-type Props = Omit<ComponentPropsWithoutRef<typeof WebstudioImage>, "loader">;export const Image = forwardRef<@@ -88,21 +64,11 @@ export const Image = forwardRef<}}- if (src.startsWith(assetBaseUrl) === false) {- return (- <img- key={key}- loading={loading}- {...props}- src={src || imagePlaceholderSvg}- ref={ref}- />- );- }+ let assetName = src;- // webstudio pass resolved assetBaseUrl + asset.name- // trim assetBaseUrl and pass only asset.name to image loader- const assetName = src.slice(assetBaseUrl.length);+ if (src.startsWith(assetBaseUrl)) {+ assetName = src.slice(assetBaseUrl.length);+ }return (<WebstudioImage