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: Allow ECMAScript module asset uploads (#6613)

Oleg Isonenc9f6435abae9
diff --git a/apps/builder/app/builder/shared/asset-manager/asset-filters.tsx b/apps/builder/app/builder/shared/asset-manager/asset-filters.tsx
index a763b921a5..fd21e565aa 100644
--- a/apps/builder/app/builder/shared/asset-manager/asset-filters.tsx
+++ b/apps/builder/app/builder/shared/asset-manager/asset-filters.tsx
@@ -51,6 +51,7 @@ const EXTENSION_TO_DISPLAY_CATEGORY: Record<
md: "Code",
mdx: "Code",
js: "Code",
+ mjs: "Code",
css: "Code",
json: "Code",
html: "Code",
diff --git a/apps/builder/app/services/asset-rest.server.test.ts b/apps/builder/app/services/asset-rest.server.test.ts
index 5e80ad7c50..f4726ee976 100644
--- a/apps/builder/app/services/asset-rest.server.test.ts
+++ b/apps/builder/app/services/asset-rest.server.test.ts
@@ -5,7 +5,7 @@ import {
AssetRepositoryNotFoundError,
AssetUploadCountLimitError,
} from "@webstudio-is/asset-uploader/server";
-import { assetFolders } from "@webstudio-is/sdk";
+import { assetFolders, validateFileName } from "@webstudio-is/sdk";
import { assetResourceLimits } from "@webstudio-is/sdk/asset-resource-limits";
import { assetResourceApiOperations } from "@webstudio-is/protocol/asset-resource-api";
import { AuthorizationError } from "@webstudio-is/trpc-interface/index.server";
@@ -48,6 +48,15 @@ describe("Assets REST responses", () => {
expect(await response.json()).toEqual({ errors: error.message });
});
+ test("does not report an unsupported file extension as a server failure", () => {
+ expect.assertions(1);
+ try {
+ validateFileName("library.exe");
+ } catch (error) {
+ expect(assetRestErrorResponse(error).status).toBe(400);
+ }
+ });
+
test("maps duplicate sibling folders to conflict", () => {
const error = assetFolders.safeParse(
new Map([
diff --git a/apps/builder/app/services/asset-rest.server.ts b/apps/builder/app/services/asset-rest.server.ts
index d11c77fde2..128e2c9b5b 100644
--- a/apps/builder/app/services/asset-rest.server.ts
+++ b/apps/builder/app/services/asset-rest.server.ts
@@ -19,6 +19,7 @@ import {
} from "@webstudio-is/asset-uploader/server";
import type { ProjectPermit } from "@webstudio-is/trpc-interface/index.server";
import { assetResourceLimits } from "@webstudio-is/sdk/asset-resource-limits";
+import { InvalidAssetFileNameError } from "@webstudio-is/sdk";
import { parseBuilderUrl } from "@webstudio-is/protocol";
import { assetDescriptionEncoding } from "@webstudio-is/protocol/asset-resource-api";
import { ZodError } from "zod";
@@ -245,7 +246,11 @@ const getAssetRestErrorStatus = (error: unknown) => {
) {
return 413;
}
- if (error instanceof AssetRestRequestError || error instanceof ZodError) {
+ if (
+ error instanceof AssetRestRequestError ||
+ error instanceof InvalidAssetFileNameError ||
+ error instanceof ZodError
+ ) {
return 400;
}
return 500;
diff --git a/docs/university/foundations/assets.md b/docs/university/foundations/assets.md
index 1e5047b764..f891275ba1 100644
--- a/docs/university/foundations/assets.md
+++ b/docs/university/foundations/assets.md
@@ -21,7 +21,7 @@ The Assets panel is located on the left side of the builder. It stores all stati
| **Video** | MP4, MOV, AVI, WebM |
| **Audio** | MP3, WAV, OGG, M4A |
| **Documents** | PDF, DOC, DOCX, XLS, XLSX, CSV, PPT, PPTX |
-| **Code & text** | TXT, MD, MDX, JS, CSS, JSON, HTML, XML |
+| **Code & text** | TXT, MD, MDX, JS, MJS, CSS, JSON, HTML, XML |
| **Archives** | ZIP, RAR |
{% hint style="info" %}
@@ -49,7 +49,7 @@ Webstudio creates the file in the current folder and opens it in the code
editor. New JSON files start with an empty object so the Content Engine can
index them immediately.
-You can open uploaded `txt`, `csv`, `md`, `mdx`, `js`, `css`, `json`, `html`, `xml`,
+You can open uploaded `txt`, `csv`, `md`, `mdx`, `js`, `mjs`, `css`, `json`, `html`, `xml`,
and `svg` assets in the same editor. Syntax highlighting follows the file type;
unsupported text types use plain text. Markdown and MDX files also provide
formatting controls and a preview.
diff --git a/packages/asset-uploader/src/utils/get-asset-data.test.ts b/packages/asset-uploader/src/utils/get-asset-data.test.ts
index 60400f2398..354115ff51 100644
--- a/packages/asset-uploader/src/utils/get-asset-data.test.ts
+++ b/packages/asset-uploader/src/utils/get-asset-data.test.ts
@@ -6,6 +6,18 @@ import { applyAssetDataOverride, getAssetData } from "./get-asset-data";
const require = createRequire(import.meta.url);
describe("asset data overrides", () => {
+ test("accepts an ECMAScript module as a file asset", async () => {
+ const data = new TextEncoder().encode("export default 1;");
+ await expect(
+ getAssetData({
+ type: "file",
+ name: "library.mjs",
+ size: data.byteLength,
+ data,
+ })
+ ).resolves.toEqual({ size: data.byteLength, format: "mjs", meta: {} });
+ });
+
test("parses font extensions as fonts even when declared as generic files", async () => {
const data = readFileSync(
require.resolve("@fontsource-variable/inter/files/inter-latin-wght-normal.woff2")
diff --git a/packages/http-client/src/index.test.ts b/packages/http-client/src/index.test.ts
index 1971d07c98..32d6c672cb 100644
--- a/packages/http-client/src/index.test.ts
+++ b/packages/http-client/src/index.test.ts
@@ -1528,6 +1528,23 @@ test("preserves a single asset upload permission error", async () => {
});
});
+test("does not retry an unsupported asset upload", async () => {
+ const fetch = vi.fn(async () =>
+ Response.json({ errors: "Unsupported file type" }, { status: 400 })
+ );
+ vi.stubGlobal("fetch", fetch);
+
+ await expect(
+ uploadProjectAsset({
+ ...apiParams,
+ asset: { name: "library.exe", type: "file", format: "exe", meta: {} },
+ readAssetData: async () => new Blob(["content"]),
+ })
+ ).rejects.toMatchObject({ cause: expect.objectContaining({ status: 400 }) });
+
+ expect(fetch).toHaveBeenCalledOnce();
+});
+
test("keeps uploaded assets in input order", async () => {
const first = createImageAssetFixture({ id: "first", name: "first.png" });
const second = createImageAssetFixture({ id: "second", name: "second.png" });
diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts
index 1b92d7133a..79f02d87bb 100644
--- a/packages/http-client/src/index.ts
+++ b/packages/http-client/src/index.ts
@@ -452,10 +452,17 @@ export const getErrorStatus = (error: unknown) => {
}
};
-const retryOnce = async <Result>(task: () => Promise<Result>, delayMs = 0) => {
+const retryOnce = async <Result>(
+ task: () => Promise<Result>,
+ delayMs = 0,
+ shouldRetry?: (error: unknown) => boolean
+) => {
try {
return await task();
- } catch {
+ } catch (error) {
+ if (shouldRetry?.(error) === false) {
+ throw error;
+ }
if (delayMs > 0) {
await new Promise((resolve) => setTimeout(resolve, delayMs));
}
@@ -627,7 +634,9 @@ const uploadAssetsSettled = async (
});
};
const uploadedAssets =
- force === true ? await upload() : await retryOnce(upload, 100);
+ force === true
+ ? await upload()
+ : await retryOnce(upload, 100, isRetryableAssetUploadError);
results[index] = { status: "fulfilled", uploadedAssets };
} catch (cause) {
const error =
diff --git a/packages/sdk/src/assets.test.ts b/packages/sdk/src/assets.test.ts
index 0f3bcc5bdb..8adca5ee52 100644
--- a/packages/sdk/src/assets.test.ts
+++ b/packages/sdk/src/assets.test.ts
@@ -3,6 +3,7 @@ import { fontMeta } from "@webstudio-is/fonts";
import { asset, assetType } from "./schema/assets";
import {
ALLOWED_FILE_TYPES,
+ InvalidAssetFileNameError,
getMimeTypeByExtension,
getMimeTypeByFilename,
isAllowedExtension,
@@ -157,6 +158,7 @@ describe("allowed-file-types", () => {
["md", "markdown"],
["mdx", "markdown"],
["js", "javascript"],
+ ["mjs", "javascript"],
["css", "css"],
["json", "json"],
["html", "html"],
@@ -201,6 +203,7 @@ describe("allowed-file-types", () => {
expect(getMimeTypeByFilename("image.jpg")).toBe("image/jpeg");
expect(getMimeTypeByFilename("document.pdf")).toBe("application/pdf");
expect(getMimeTypeByFilename("video.mp4")).toBe("video/mp4");
+ expect(getMimeTypeByFilename("module.mjs")).toBe("text/javascript");
});
test("handles files with multiple dots", () => {
@@ -284,6 +287,10 @@ describe("allowed-file-types", () => {
extension: "pdf",
mimeType: "application/pdf",
});
+ expect(validateFileName("module.mjs")).toEqual({
+ extension: "mjs",
+ mimeType: "text/javascript",
+ });
});
test("is case-insensitive", () => {
@@ -311,6 +318,9 @@ describe("allowed-file-types", () => {
});
test("throws error for disallowed extensions", () => {
+ expect(() => validateFileName("malware.exe")).toThrow(
+ InvalidAssetFileNameError
+ );
expect(() => validateFileName("malware.exe")).toThrow(
'File type "exe" is not allowed'
);
diff --git a/packages/sdk/src/assets.ts b/packages/sdk/src/assets.ts
index bcbbe04d7f..a8f11286c5 100644
--- a/packages/sdk/src/assets.ts
+++ b/packages/sdk/src/assets.ts
@@ -161,6 +161,7 @@ const assetFileTypes = {
md: textFile("text/markdown", "markdown"),
mdx: textFile("text/mdx", "markdown"),
js: textFile("text/javascript", "javascript"),
+ mjs: textFile("text/javascript", "javascript"),
css: textFile("text/css", "css"),
json: textFile("application/json", "json"),
html: textFile("text/html", "html"),
@@ -485,9 +486,11 @@ export const doesAssetMatchMimePatterns = (
return false;
};
+export class InvalidAssetFileNameError extends Error {}
+
/**
* Validate a filename and return its extension and MIME type
- * @throws Error if file extension is not allowed
+ * @throws InvalidAssetFileNameError if file extension is not allowed
*/
export const validateFileName = (
fileName: string
@@ -495,11 +498,11 @@ export const validateFileName = (
const extension = getFileExtension(fileName)?.toLowerCase();
if (!extension) {
- throw new Error("File must have an extension");
+ throw new InvalidAssetFileNameError("File must have an extension");
}
if (!isAllowedExtension(extension)) {
- throw new Error(
+ throw new InvalidAssetFileNameError(
`File type "${extension}" is not allowed. Allowed types: ${Array.from(
ALLOWED_FILE_EXTENSIONS
).join(", ")}`
@@ -508,7 +511,7 @@ export const validateFileName = (
const mimeType = getMimeTypeByExtension(extension);
if (!mimeType) {
- throw new Error(
+ throw new InvalidAssetFileNameError(
`Could not determine MIME type for extension: ${extension}`
);
}