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
fix: tolerate invalid asset metadata on load (#6419)
Oleg Isonencf606ca4c3ac
diff --git a/fixtures/react-router-cloudflare/.webstudio/data.json b/fixtures/react-router-cloudflare/.webstudio/data.jsonindex a4fcbb4324..9e06cf4de6 100644--- a/fixtures/react-router-cloudflare/.webstudio/data.json+++ b/fixtures/react-router-cloudflare/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "f565d527-32e7-4731-bc71-aca9e9574587","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/react-router-docker/.webstudio/data.json b/fixtures/react-router-docker/.webstudio/data.jsonindex a4fcbb4324..9e06cf4de6 100644--- a/fixtures/react-router-docker/.webstudio/data.json+++ b/fixtures/react-router-docker/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "f565d527-32e7-4731-bc71-aca9e9574587","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/react-router-netlify/.webstudio/data.json b/fixtures/react-router-netlify/.webstudio/data.jsonindex a4fcbb4324..9e06cf4de6 100644--- a/fixtures/react-router-netlify/.webstudio/data.json+++ b/fixtures/react-router-netlify/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "f565d527-32e7-4731-bc71-aca9e9574587","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/react-router-vercel/.webstudio/data.json b/fixtures/react-router-vercel/.webstudio/data.jsonindex a4fcbb4324..9e06cf4de6 100644--- a/fixtures/react-router-vercel/.webstudio/data.json+++ b/fixtures/react-router-vercel/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "f565d527-32e7-4731-bc71-aca9e9574587","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/ssg-cloudflare-pages/.webstudio/data.json b/fixtures/ssg-cloudflare-pages/.webstudio/data.jsonindex 8dee425a36..51fb65f95c 100644--- a/fixtures/ssg-cloudflare-pages/.webstudio/data.json+++ b/fixtures/ssg-cloudflare-pages/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "a2e8de30-03d5-4514-a3a6-406b3266a3af","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/ssg-netlify-by-project-id/.webstudio/data.json b/fixtures/ssg-netlify-by-project-id/.webstudio/data.jsonindex 4805319a68..c7091ab809 100644--- a/fixtures/ssg-netlify-by-project-id/.webstudio/data.json+++ b/fixtures/ssg-netlify-by-project-id/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "823cc69d-b2ed-418b-823c-2efc717319cd","projectId": "8a7358b1-7de3-459d-b7b1-56dddfb6ce1e",diff --git a/fixtures/webstudio-cloudflare-template/.webstudio/data.json b/fixtures/webstudio-cloudflare-template/.webstudio/data.jsonindex 8dee425a36..51fb65f95c 100644--- a/fixtures/webstudio-cloudflare-template/.webstudio/data.json+++ b/fixtures/webstudio-cloudflare-template/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "a2e8de30-03d5-4514-a3a6-406b3266a3af","projectId": "d845c167-ea07-4875-b08d-83e97c09dcce",diff --git a/fixtures/webstudio-features/.webstudio/data.json b/fixtures/webstudio-features/.webstudio/data.jsonindex 7d8a2d0f94..1c54514585 100644--- a/fixtures/webstudio-features/.webstudio/data.json+++ b/fixtures/webstudio-features/.webstudio/data.json@@ -1,5 +1,5 @@{- "bundleVersion": "bundle-1x6rafk",+ "bundleVersion": "bundle-zql42m","build": {"id": "1b66ee06-8ea5-4420-9a0e-e0d3a67aca32","projectId": "cddc1d44-af37-4cb6-a430-d300cf6f932d",diff --git a/packages/asset-uploader/src/asset-patch-core.ts b/packages/asset-uploader/src/asset-patch-core.tsindex 172249129b..b8d5d3f876 100644--- a/packages/asset-uploader/src/asset-patch-core.ts+++ b/packages/asset-uploader/src/asset-patch-core.ts@@ -2,7 +2,7 @@ import { asset as assetSchema, type Asset, assets } from "@webstudio-is/sdk";import { assetResourceLimits } from "@webstudio-is/sdk/asset-resource-limits";import type { Client, Database } from "@webstudio-is/postgrest/index.server";import { mapBounded } from "@webstudio-is/content-engine/compiler";-import { formatAsset } from "./utils/format-asset";+import { formatAsset, formatAssetForRead } from "./utils/format-asset";import {applyValidatedMapPatches,assertPostgrestSuccess,@@ -346,6 +346,11 @@ export const loadAssetsByProjectWithClient = async (assertPostgrestSuccess(response);const result: Asset[] = [];+ const invalidFontMetadata: Array<{+ assetId: string;+ format: string;+ issues: Array<{ code: string; path: string[] }>;+ }> = [];for (const {assetId,projectId,@@ -355,18 +360,33 @@ export const loadAssetsByProjectWithClient = async (file,} of response.data ?? []) {if (file) {- result.push(- formatAsset({+ const formatted = formatAssetForRead({+ assetId,+ projectId,+ filename,+ description,+ folderId,+ file,+ });+ result.push(formatted.asset);+ if (formatted.fontMetaIssues !== undefined) {+ invalidFontMetadata.push({assetId,- projectId,- filename,- description,- folderId,- file,- })- );+ format: file.format,+ issues: formatted.fontMetaIssues,+ });+ }}}+ if (invalidFontMetadata.length > 0) {+ console.error(+ "Invalid stored font metadata; loading affected assets as files",+ {+ projectId,+ assets: invalidFontMetadata,+ }+ );+ }return result;};diff --git a/packages/asset-uploader/src/db/load.test.ts b/packages/asset-uploader/src/db/load.test.tsindex 2be97d1946..336b96aafc 100644--- a/packages/asset-uploader/src/db/load.test.ts+++ b/packages/asset-uploader/src/db/load.test.ts@@ -1,4 +1,4 @@-import { describe, test, expect } from "vitest";+import { describe, test, expect, vi } from "vitest";import {createTestServer,db,@@ -7,6 +7,7 @@ import {} from "@webstudio-is/postgrest/testing";import type { AppContext } from "@webstudio-is/trpc-interface/index.server";import { AuthorizationError } from "@webstudio-is/trpc-interface/index.server";+import { asset } from "@webstudio-is/sdk";import { loadAssetsByProject } from "./load";const server = createTestServer();@@ -82,6 +83,57 @@ describe("loadAssetsByProject (msw)", () => {expect(result).toEqual([]);});+ test("loads malformed font metadata as a generic file and reports it", async () => {+ const malformedFontRow = {+ ...assetRow,+ assetId: "font-1",+ filename: "Inter",+ file: {+ ...assetRow.file,+ name: "Inter.woff2",+ format: "woff2",+ meta: JSON.stringify({}),+ },+ };+ const report = vi.spyOn(console, "error").mockImplementation(() => {});+ server.use(+ projectOwnershipHandler,+ db.get("Asset", () => json([malformedFontRow])),+ db.get("AssetFolder", () => json([]))+ );++ try {+ const result = await loadAssetsByProject("proj-1", createContext());++ expect(result).toMatchObject([+ {+ id: "font-1",+ type: "file",+ format: "unknown",+ meta: {},+ },+ ]);+ expect(asset.safeParse(result[0]).success).toBe(true);+ expect(report).toHaveBeenCalledWith(+ expect.stringContaining("Invalid stored font metadata"),+ expect.objectContaining({+ projectId: "proj-1",+ assets: [+ expect.objectContaining({+ assetId: "font-1",+ format: "woff2",+ issues: expect.arrayContaining([+ expect.objectContaining({ path: ["variationAxes"] }),+ ]),+ }),+ ],+ })+ );+ } finally {+ report.mockRestore();+ }+ });+test("places assets with a missing folder in the root", async () => {server.use(projectOwnershipHandler,diff --git a/packages/asset-uploader/src/patch.test.ts b/packages/asset-uploader/src/patch.test.tsindex d067cb8b59..7519c80aff 100644--- a/packages/asset-uploader/src/patch.test.ts+++ b/packages/asset-uploader/src/patch.test.ts@@ -809,6 +809,46 @@ describe("asset patch persistence", () => {expect(validatedMeta).toEqual(nextMeta);});+ test("rejects invalid font metadata before persisting a raw asset patch", async () => {+ const projectId = uid();+ const fontRow = {+ ...assetRow,+ projectId,+ file: {+ ...assetRow.file,+ name: "font.woff2",+ format: "woff2",+ meta: JSON.stringify({+ family: "Inter",+ style: "normal",+ weight: 400,+ }),+ },+ };+ let persisted = false;+ server.use(+ db.get("Asset", () => json([fontRow])),+ db.patch("File", () => {+ persisted = true;+ return json({ meta: "{}" });+ })+ );++ await expect(+ patchAssetsWithClient(+ { projectId, client: testContext.postgrest.client },+ [+ {+ op: "replace",+ path: ["asset-1", "meta"],+ value: { family: "Inter", style: "normal" },+ },+ ]+ )+ ).rejects.toThrow();+ expect(persisted).toBe(false);+ });+test("updates only supplied metadata and reloads only that asset", async () => {const projectId = uid();let update: unknown;diff --git a/packages/asset-uploader/src/utils/format-asset.test.ts b/packages/asset-uploader/src/utils/format-asset.test.tsindex 7de079a269..efbb55227c 100644--- a/packages/asset-uploader/src/utils/format-asset.test.ts+++ b/packages/asset-uploader/src/utils/format-asset.test.ts@@ -1,4 +1,5 @@import { describe, test, expect } from "vitest";+import { asset } from "@webstudio-is/sdk";import { formatAsset } from "./format-asset";describe("formatAsset", () => {@@ -44,6 +45,28 @@ describe("formatAsset", () => {});});+ test("keeps assets with invalid JSON metadata from breaking project loads", () => {+ const result = formatAsset({+ ...baseParams,+ file: {+ name: "Inter-Regular.woff2",+ format: "woff2",+ description: null,+ size: 50000,+ createdAt: "2024-01-01T00:00:00Z",+ updatedAt: "2024-01-02T00:00:00Z",+ meta: "{invalid json",+ },+ });++ expect(result).toMatchObject({+ type: "file",+ format: "unknown",+ meta: {},+ });+ expect(asset.safeParse(result).success).toBe(true);+ });+test("formats image asset with width and height correctly", () => {const result = formatAsset({...baseParams,diff --git a/packages/asset-uploader/src/utils/format-asset.ts b/packages/asset-uploader/src/utils/format-asset.tsindex 97420db816..472b476065 100644--- a/packages/asset-uploader/src/utils/format-asset.ts+++ b/packages/asset-uploader/src/utils/format-asset.ts@@ -5,15 +5,9 @@ import {videoMeta,detectAssetType,} from "@webstudio-is/sdk";+import { z } from "zod";-export const formatAsset = ({- assetId,- projectId,- filename,- description,- folderId,- file,-}: {+type FormatAssetInput = {assetId: string;projectId: string;filename: string | null;@@ -28,69 +22,115 @@ export const formatAsset = ({updatedAt: string;meta: string;};-}): Asset => {+};++const getBaseAsset = ({+ assetId,+ projectId,+ filename,+ description,+ folderId,+ file,+}: FormatAssetInput) => ({+ id: assetId,+ name: file.name,+ projectId,+ filename: filename ?? undefined,+ description: description ?? undefined,+ folderId: folderId ?? undefined,+ size: file.size,+ createdAt: file.createdAt,+ updatedAt: file.updatedAt,+});++type FontMetaIssueSummary = { code: string; path: string[] };++const summarizeFontMetaIssues = (+ issues: z.ZodIssue[]+): FontMetaIssueSummary[] =>+ issues.flatMap((issue) =>+ issue.code === "invalid_union"+ ? summarizeFontMetaIssues(issue.errors.flat())+ : [{ code: issue.code, path: issue.path.map(String) }]+ );++const formatAssetWithDiagnostics = (+ input: FormatAssetInput+): { asset: Asset; fontMetaIssues?: FontMetaIssueSummary[] } => {+ const { file } = input;const isFont = FONT_FORMATS.has(file.format as FontFormat);- const parsedMeta = JSON.parse(file.meta);- const base = {- id: assetId,- name: file.name,- projectId,- filename: filename ?? undefined,- description: description ?? undefined,- folderId: folderId ?? undefined,- size: file.size,- createdAt: file.createdAt,- updatedAt: file.updatedAt,- };+ const base = getBaseAsset(input);+ let parsedMeta: unknown;+ let fontMetaIssues: FontMetaIssueSummary[] | undefined;+ try {+ parsedMeta = JSON.parse(file.meta);+ } catch {+ // Treat invalid persisted metadata as untyped instead of breaking the load.+ if (isFont) {+ fontMetaIssues = [{ code: "invalid_json", path: [] }];+ }+ }- if (isFont) {- return {- ...base,- type: "font",- format: file.format as FontFormat,- meta: fontMeta.parse(parsedMeta),- };+ if (isFont && fontMetaIssues === undefined) {+ const result = fontMeta.safeParse(parsedMeta);+ if (result.success) {+ return {+ asset: {+ ...base,+ type: "font",+ format: file.format as FontFormat,+ meta: result.data,+ },+ };+ }+ fontMetaIssues = summarizeFontMetaIssues(result.error.issues);}// Detect actual asset type based on file extensionconst detectedType = detectAssetType(file.name);- // Check if it's an image by verifying both metadata AND file extension- // Videos also have width/height but should not be treated as images- const isImage =- detectedType === "image" &&- parsedMeta &&- typeof parsedMeta.width === "number" &&- typeof parsedMeta.height === "number";- const isVideo =- detectedType === "video" &&- parsedMeta &&- typeof parsedMeta.width === "number" &&- typeof parsedMeta.height === "number";-- if (isImage) {- return {- ...base,- type: "image",- format: file.format,- meta: imageMeta.parse(parsedMeta),- };+ if (detectedType === "image") {+ const result = imageMeta.safeParse(parsedMeta);+ if (result.success) {+ return {+ asset: {+ ...base,+ type: "image",+ format: file.format,+ meta: result.data,+ },+ };+ }}- if (isVideo) {- return {- ...base,- type: "video",- format: file.format,- meta: videoMeta.parse(parsedMeta),- };+ if (detectedType === "video") {+ const result = videoMeta.safeParse(parsedMeta);+ if (result.success) {+ return {+ asset: {+ ...base,+ type: "video",+ format: file.format,+ meta: result.data,+ },+ };+ }}- // Default to file type for everything else+ // Font formats require font metadata, so use an unknown format when falling+ // back to a generic file to keep the asset valid against the SDK schema.return {- ...base,- type: "file",- format: file.format,- meta: {},+ asset: {+ ...base,+ type: "file",+ format: isFont ? "unknown" : file.format,+ meta: {},+ },+ ...(fontMetaIssues === undefined ? {} : { fontMetaIssues }),};};++export const formatAsset = (input: FormatAssetInput): Asset =>+ formatAssetWithDiagnostics(input).asset;++export const formatAssetForRead = formatAssetWithDiagnostics;diff --git a/packages/asset-uploader/src/utils/get-asset-data.test.ts b/packages/asset-uploader/src/utils/get-asset-data.test.tsindex f930f8b1a9..60400f2398 100644--- a/packages/asset-uploader/src/utils/get-asset-data.test.ts+++ b/packages/asset-uploader/src/utils/get-asset-data.test.ts@@ -1,7 +1,35 @@import { describe, expect, test } from "vitest";-import { applyAssetDataOverride } from "./get-asset-data";+import { readFileSync } from "node:fs";+import { createRequire } from "node:module";+import { applyAssetDataOverride, getAssetData } from "./get-asset-data";++const require = createRequire(import.meta.url);describe("asset data overrides", () => {+ 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")+ );++ const detected = await getAssetData({+ type: "file",+ name: "inter-latin-wght-normal.woff2",+ size: data.byteLength,+ data,+ });++ expect(applyAssetDataOverride(detected)).toMatchObject({+ format: "woff2",+ meta: {+ family: "Inter",+ style: "normal",+ variationAxes: {+ wght: { min: 100, default: 400, max: 900 },+ },+ },+ });+ });+test("merges partial font metadata over detected metadata", () => {expect(applyAssetDataOverride(@@ -96,4 +124,13 @@ describe("asset data overrides", () => {)).toThrow("metadata override is invalid");});++ test("rejects overriding a generic file format to a font format", () => {+ expect(() =>+ applyAssetDataOverride(+ { size: 100, format: "txt", meta: {} },+ { format: "woff2" }+ )+ ).toThrow("Font format requires valid font metadata");+ });});diff --git a/packages/asset-uploader/src/utils/get-asset-data.ts b/packages/asset-uploader/src/utils/get-asset-data.tsindex 7682abbe26..44cc48538b 100644--- a/packages/asset-uploader/src/utils/get-asset-data.ts+++ b/packages/asset-uploader/src/utils/get-asset-data.ts@@ -1,6 +1,11 @@import { z } from "zod";import { imageMeta as parseImageMeta } from "image-meta";-import { type FontMeta, fontMeta } from "@webstudio-is/fonts";+import {+ FONT_FORMATS,+ type FontFormat,+ type FontMeta,+ fontMeta,+} from "@webstudio-is/fonts";import {type AssetType,type ImageMeta,@@ -42,13 +47,15 @@ export const applyAssetDataOverride = (if (meta === undefined) {throw new Error("Asset metadata override is invalid");}+ const format =+ type === "font" ? detected.format : (override?.format ?? detected.format);+ if (type !== "font" && FONT_FORMATS.has(format as FontFormat)) {+ throw new Error("Font format requires valid font metadata");+ }return {...detected,- format:- "family" in detected.meta- ? detected.format- : (override?.format ?? detected.format),+ format,meta,};};@@ -107,8 +114,19 @@ export const getAssetData = async (};}- // Validate file name and get extension+ // The persisted asset type is derived from its detected format. Parse font+ // extensions as fonts even when a caller labels the upload as a generic file,+ // otherwise the upload could persist `{}` metadata that cannot be loaded as a+ // font later.const { extension } = validateFileName(options.name);+ if (FONT_FORMATS.has(extension as FontFormat)) {+ const { format, ...meta } = getFontData(options.data, options.name);+ return {+ size: options.size,+ format,+ meta,+ };+ }return {size: options.size,diff --git a/packages/sdk/src/assets.test.ts b/packages/sdk/src/assets.test.tsindex df0fc14ca5..0f3bcc5bdb 100644--- a/packages/sdk/src/assets.test.ts+++ b/packages/sdk/src/assets.test.ts@@ -1,6 +1,6 @@import { describe, test, expect } from "vitest";import { fontMeta } from "@webstudio-is/fonts";-import { assetType } from "./schema/assets";+import { asset, assetType } from "./schema/assets";import {ALLOWED_FILE_TYPES,getMimeTypeByExtension,@@ -40,6 +40,22 @@ test("hashes asset content with SHA-256", async () => {);});+test("rejects a font format stored as a generic file", () => {+ expect(+ asset.safeParse({+ id: "font-1",+ projectId: "project-1",+ size: 100,+ name: "font.woff2",+ description: null,+ createdAt: "2026-01-01T00:00:00.000Z",+ format: "woff2",+ meta: {},+ type: "file",+ }).success+ ).toBe(false);+});+describe("getFileExtension", () => {test.each([["file.md", "md"],diff --git a/packages/sdk/src/schema/assets.ts b/packages/sdk/src/schema/assets.tsindex 62e04038af..f6045285d1 100644--- a/packages/sdk/src/schema/assets.ts+++ b/packages/sdk/src/schema/assets.ts@@ -1,6 +1,8 @@import { z } from "zod";import { assetFolderId } from "./asset-folders";import {+ FONT_FORMATS,+ type FontFormat,fontFormat,fontMeta,fontMetaUpdate,@@ -68,7 +70,12 @@ export type VideoAsset = z.infer<typeof videoAsset>;export const fileAsset = z.object({...baseAsset,- format: z.string(),+ format: z+ .string()+ .refine(+ (format) => FONT_FORMATS.has(format as FontFormat) === false,+ "Font formats must use font asset type"+ ),meta: z.object({}),type: z.literal(assetType.enum.file),});