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.

fix: Disabling image optimize breaks image path (#3931)

Ivan Starkovdf5a8e8c2785
diff --git a/fixtures/ssg/app/constants.mjs b/fixtures/ssg/app/constants.mjs
index 8c020c0df1..7de2d9d42c 100644
--- a/fixtures/ssg/app/constants.mjs
+++ b/fixtures/ssg/app/constants.mjs
@@ -2,6 +2,8 @@
* We use mjs extension as constants in this file is shared with the build script
* and we use `node --eval` to extract the constants.
*/
+import { UrlCanParse } from "@webstudio-is/image";
+
export const assetBaseUrl = "/assets/";
export const imageBaseUrl = "/assets/";
@@ -9,7 +11,7 @@ export const imageBaseUrl = "/assets/";
* @type {import("@webstudio-is/image").ImageLoader}
*/
export const imageLoader = ({ src }) => {
- if (URL.canParse(src)) {
+ if (UrlCanParse(src)) {
return src;
}
diff --git a/packages/cli/templates/ssg-netlify/app/constants.mjs b/packages/cli/templates/ssg-netlify/app/constants.mjs
index a3e96aa259..e3a9ce885b 100644
--- a/packages/cli/templates/ssg-netlify/app/constants.mjs
+++ b/packages/cli/templates/ssg-netlify/app/constants.mjs
@@ -2,6 +2,8 @@
* We use mjs extension as constants in this file is shared with the build script
* and we use `node --eval` to extract the constants.
*/
+import { UrlCanParse } from "@webstudio-is/image";
+
export const assetBaseUrl = "/assets/";
export const imageBaseUrl = "/assets/";
@@ -9,7 +11,7 @@ export const imageBaseUrl = "/assets/";
* @type {import("@webstudio-is/image").ImageLoader}
*/
export const imageLoader = (props) => {
- if (URL.canParse(props.src)) {
+ if (UrlCanParse(props.src)) {
return props.src;
}
diff --git a/packages/cli/templates/ssg-vercel/app/constants.mjs b/packages/cli/templates/ssg-vercel/app/constants.mjs
index 567eb673e1..6008913310 100644
--- a/packages/cli/templates/ssg-vercel/app/constants.mjs
+++ b/packages/cli/templates/ssg-vercel/app/constants.mjs
@@ -2,6 +2,8 @@
* We use mjs extension as constants in this file is shared with the build script
* and we use `node --eval` to extract the constants.
*/
+import { UrlCanParse } from "@webstudio-is/image";
+
export const assetBaseUrl = "/assets/";
export const imageBaseUrl = "/assets/";
@@ -9,7 +11,7 @@ export const imageBaseUrl = "/assets/";
* @type {import("@webstudio-is/image").ImageLoader}
*/
export const imageLoader = (props) => {
- if (URL.canParse(props.src)) {
+ if (UrlCanParse(props.src)) {
return props.src;
}
diff --git a/packages/cli/templates/ssg/app/constants.mjs b/packages/cli/templates/ssg/app/constants.mjs
index 8c020c0df1..7de2d9d42c 100644
--- a/packages/cli/templates/ssg/app/constants.mjs
+++ b/packages/cli/templates/ssg/app/constants.mjs
@@ -2,6 +2,8 @@
* We use mjs extension as constants in this file is shared with the build script
* and we use `node --eval` to extract the constants.
*/
+import { UrlCanParse } from "@webstudio-is/image";
+
export const assetBaseUrl = "/assets/";
export const imageBaseUrl = "/assets/";
@@ -9,7 +11,7 @@ export const imageBaseUrl = "/assets/";
* @type {import("@webstudio-is/image").ImageLoader}
*/
export const imageLoader = ({ src }) => {
- if (URL.canParse(src)) {
+ if (UrlCanParse(src)) {
return src;
}
diff --git a/packages/image/src/image-loaders.ts b/packages/image/src/image-loaders.ts
index ac38990618..8887f00fe9 100644
--- a/packages/image/src/image-loaders.ts
+++ b/packages/image/src/image-loaders.ts
@@ -44,19 +44,19 @@ export const createImageLoader =
return src;
}
- // const searchParams = new URLSearchParams();
+ if (format !== "raw") {
+ resultUrl.searchParams.set("width", width.toString());
+ resultUrl.searchParams.set("quality", quality.toString());
- 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) {
- resultUrl.searchParams.set("height", props.height.toString());
- }
+ if (props.height != null) {
+ resultUrl.searchParams.set("height", props.height.toString());
+ }
- if (props.format !== "raw" && props.fit != null) {
- resultUrl.searchParams.set("fit", props.fit);
+ if (props.fit != null) {
+ resultUrl.searchParams.set("fit", props.fit);
+ }
}
+ resultUrl.searchParams.set("format", format ?? "auto");
resultUrl.pathname = joinPath(resultUrl.pathname, encodePathFragment(src));
diff --git a/packages/image/src/image-optimize.test.ts b/packages/image/src/image-optimize.test.ts
index f5e12edc61..842fc2d824 100644
--- a/packages/image/src/image-optimize.test.ts
+++ b/packages/image/src/image-optimize.test.ts
@@ -23,6 +23,26 @@ describe("Image optimizations applied", () => {
`);
});
+ test("width is number, url is absolute, create pixel density descriptor 'x'", () => {
+ const imgAttr = getImageAttributes({
+ optimize: true,
+ width: 100,
+ src: "https://webstudio.is/logo.webp",
+ srcSet: undefined,
+ sizes: undefined,
+ quality: 100,
+ loader: createImageLoader({ imageBaseUrl: "/asset/image/" }),
+ });
+
+ expect(imgAttr).toMatchInlineSnapshot(`
+ {
+ "sizes": "100vw",
+ "src": "/asset/image/https%3A//webstudio.is/logo.webp?width=256&quality=100&format=auto",
+ "srcSet": "/asset/image/https%3A//webstudio.is/logo.webp?width=16&quality=100&format=auto 16w, /asset/image/https%3A//webstudio.is/logo.webp?width=32&quality=100&format=auto 32w, /asset/image/https%3A//webstudio.is/logo.webp?width=48&quality=100&format=auto 48w, /asset/image/https%3A//webstudio.is/logo.webp?width=64&quality=100&format=auto 64w, /asset/image/https%3A//webstudio.is/logo.webp?width=96&quality=100&format=auto 96w, /asset/image/https%3A//webstudio.is/logo.webp?width=128&quality=100&format=auto 128w, /asset/image/https%3A//webstudio.is/logo.webp?width=256&quality=100&format=auto 256w",
+ }
+ `);
+ });
+
test("width is undefined, create 'w' descriptor and sizes prop", () => {
const imgAttr = getImageAttributes({
optimize: true,
@@ -111,6 +131,24 @@ describe("Image optimizations applied", () => {
describe("Image optimizations not applied", () => {
test("optimize is false", () => {
+ const imgAttr = getImageAttributes({
+ optimize: false,
+ width: 100,
+ src: "logo.webp",
+ srcSet: undefined,
+ sizes: undefined,
+ quality: 100,
+ loader: createImageLoader({ imageBaseUrl: "/asset/image/" }),
+ });
+
+ expect(imgAttr).toMatchInlineSnapshot(`
+ {
+ "src": "/asset/image/logo.webp?format=raw",
+ }
+ `);
+ });
+
+ test("optimize is false and url absolute", () => {
const imgAttr = getImageAttributes({
optimize: false,
width: 100,
diff --git a/packages/image/src/image-optimize.ts b/packages/image/src/image-optimize.ts
index f8f31f4407..6803f72490 100644
--- a/packages/image/src/image-optimize.ts
+++ b/packages/image/src/image-optimize.ts
@@ -232,6 +232,18 @@ const DEFAULT_SIZES = "(min-width: 1280px) 50vw, 100vw";
const DEFAULT_QUALITY = 80;
+/**
+ * URL.canParse(props.src)
+ */
+export const UrlCanParse = (url: string) => {
+ try {
+ new URL(url);
+ return true;
+ } catch {
+ return false;
+ }
+};
+
export const getImageAttributes = (props: {
src: string | undefined;
srcSet: string | undefined;
@@ -272,7 +284,11 @@ export const getImageAttributes = (props: {
src: string;
srcSet?: string;
sizes?: string;
- } = { src: props.src };
+ } = {
+ src: UrlCanParse(props.src)
+ ? props.src
+ : props.loader({ src: props.src, format: "raw" }),
+ };
if (props.srcSet != null) {
resAttrs.srcSet = props.srcSet;