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.

feat: drag image assets onto canvas (#5912)

Oleg Isonenef94d85ccf23
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index ce28b752b3..5e39fd6700 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -162,6 +162,68 @@ jobs:
process.exit(1)
}
+ builder-e2e-build:
+ name: builder-e2e build
+ # Run on push, regular PR (for repo branches), or labeled PR with safe-to-deploy (for forks)
+ if: |
+ github.event_name == 'push' ||
+ github.event_name == 'pull_request' ||
+ (github.event_name == 'pull_request_target' && github.event.label.name == 'safe-to-deploy')
+
+ timeout-minutes: 20
+
+ runs-on: ubuntu-24.04
+
+ environment:
+ name: development
+
+ outputs:
+ shards: ${{ steps.shards.outputs.value }}
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ ref: ${{ github.event.pull_request.head.sha || github.sha }}
+
+ - uses: ./.github/actions/submodules-checkout
+ with:
+ submodules-ssh-key: ${{ secrets.PRIVATE_GITHUB_DEPLOY_TOKEN }}
+
+ - uses: pnpm/action-setup@v4
+
+ - uses: actions/setup-node@v4
+ with:
+ node-version: 22
+ cache: pnpm
+
+ - name: Pnpm install
+ run: pnpm install
+
+ - name: Discover builder e2e shards
+ id: shards
+ run: echo "value=$(pnpm --dir apps/builder exec tsx ./e2e/print-shards.ts)" >> "$GITHUB_OUTPUT"
+
+ - name: Build builder and generated preview dependencies
+ run: |
+ pnpm --filter=@webstudio-is/builder build
+ pnpm --filter=@webstudio-is/sdk-components-react-router build
+
+ # Generate this from the current migrations for this workflow run only.
+ # Shards consume the snapshot as a fast, disposable schema cache.
+ - name: Generate builder e2e schema snapshot
+ run: pnpm e2e:builder:refresh-schema-cache
+
+ - name: Upload builder e2e prerequisites
+ uses: actions/upload-artifact@v4
+ with:
+ name: builder-e2e-build
+ retention-days: 1
+ path: |
+ apps/builder/build/server
+ apps/builder/build/client/assets
+ packages/*/lib
+ .cache/builder-e2e/schema-*.sql
+
builder-e2e:
name: builder-e2e (${{ matrix.shard }})
# Run on push, regular PR (for repo branches), or labeled PR with safe-to-deploy (for forks)
@@ -172,17 +234,13 @@ jobs:
timeout-minutes: 40
+ needs: builder-e2e-build
+
runs-on: ubuntu-24.04
strategy:
fail-fast: false
matrix:
- # Builder e2e shards are assigned by filename tags, for example
- # `pages-actions.[shard-3].e2e.ts`. Use one of these shard names in
- # each e2e filename. If one workflow module gets too slow, split it
- # into same-base files with different shard tags, such as
- # `pages-actions.[shard-1].e2e.ts` and
- # `pages-actions.[shard-2].e2e.ts`.
- shard: [shard-1, shard-2, shard-3, shard-4]
+ shard: ${{ fromJSON(needs.builder-e2e-build.outputs.shards) }}
environment:
name: development
@@ -215,8 +273,15 @@ jobs:
path: ~/.cache/ms-playwright
key: builder-e2e-playwright-${{ runner.os }}-${{ hashFiles('apps/builder/package.json', 'pnpm-lock.yaml') }}
+ - name: Download builder e2e build
+ uses: actions/download-artifact@v4
+ with:
+ name: builder-e2e-build
+ path: .
+
- name: Run builder e2e
env:
+ E2E_SKIP_BUILDER_BUILD: true
E2E_TEST_SHARD: ${{ matrix.shard }}
run: |
run_builder_e2e() {
diff --git a/apps/builder/app/builder/features/assets/assets.tsx b/apps/builder/app/builder/features/assets/assets.tsx
index 992ae1c4aa..b85fcd8573 100644
--- a/apps/builder/app/builder/features/assets/assets.tsx
+++ b/apps/builder/app/builder/features/assets/assets.tsx
@@ -12,12 +12,20 @@ import { AssetUpload, type AssetUploadHandle } from "~/builder/shared/assets";
import { openDeleteUnusedAssetsDialog } from "~/builder/shared/asset-manager/delete-unused-assets";
import { CreateAssetFolderDialog } from "~/builder/shared/asset-manager/asset-folder-dialogs";
import { $authPermit } from "~/shared/nano-states";
+import type { Publish } from "~/shared/pubsub";
+import { useImageAssetCanvasDrag } from "./use-image-asset-canvas-drag";
-export const AssetsPanel = (_props: { onClose: () => void }) => {
+export const AssetsPanel = ({
+ publish,
+}: {
+ publish: Publish;
+ onClose: () => void;
+}) => {
const [folderId, setFolderId] = useState<string>();
const [createFolderOpen, setCreateFolderOpen] = useState(false);
const uploadRef = useRef<AssetUploadHandle>(null);
const authPermit = useStore($authPermit);
+ useImageAssetCanvasDrag(publish);
return (
<>
<PanelTitle
diff --git a/apps/builder/app/builder/features/assets/use-image-asset-canvas-drag.ts b/apps/builder/app/builder/features/assets/use-image-asset-canvas-drag.ts
new file mode 100644
index 0000000000..9c024efe6d
--- /dev/null
+++ b/apps/builder/app/builder/features/assets/use-image-asset-canvas-drag.ts
@@ -0,0 +1,102 @@
+import { useCallback, useEffect, useRef } from "react";
+import { monitorForElements } from "@atlaskit/pragmatic-drag-and-drop/element/adapter";
+import { useDisableCanvasPointerEvents } from "@webstudio-is/design-system";
+import { getAssetManagerDragItems } from "~/builder/shared/asset-manager/asset-manager-drag";
+import { toCanvasCoordinates } from "~/builder/shared/canvas-drag";
+import { $canvasRect, $scale } from "~/builder/shared/nano-states";
+import { type Publish, useSubscribe } from "~/shared/pubsub";
+import { $assets } from "~/shared/sync/data-stores";
+
+const getDraggedImageAssetId = (data: Record<string, unknown>) => {
+ const items = getAssetManagerDragItems(data);
+ if (items.length !== 1 || items[0]?.type !== "asset") {
+ return;
+ }
+ const asset = $assets.get().get(items[0].id);
+ if (asset?.type === "image") {
+ return asset.id;
+ }
+};
+
+export const useImageAssetCanvasDrag = (publish: Publish) => {
+ const isDraggingRef = useRef(false);
+ const isCanvasDragRef = useRef(false);
+ const { disableCanvasPointerEvents, enableCanvasPointerEvents } =
+ useDisableCanvasPointerEvents();
+
+ const finish = useCallback(
+ (isCanceled: boolean) => {
+ if (isCanvasDragRef.current) {
+ isCanvasDragRef.current = false;
+ publish({ type: "dragEnd", payload: { isCanceled } });
+ }
+ isDraggingRef.current = false;
+ enableCanvasPointerEvents();
+ },
+ [enableCanvasPointerEvents, publish]
+ );
+
+ useSubscribe("cancelCurrentDrag", () => finish(true));
+
+ useEffect(() => {
+ const cleanupMonitor = monitorForElements({
+ canMonitor: ({ source }) =>
+ getDraggedImageAssetId(source.data) !== undefined,
+ onDragStart: ({ source }) => {
+ const assetId = getDraggedImageAssetId(source.data);
+ if (assetId === undefined) {
+ return;
+ }
+ isDraggingRef.current = true;
+ disableCanvasPointerEvents();
+ },
+ onDrag: ({ source, location }) => {
+ if (isDraggingRef.current === false) {
+ return;
+ }
+ const { clientX: x, clientY: y } = location.current.input;
+ const rect = $canvasRect.get();
+ const isOverCanvas =
+ rect !== undefined &&
+ x >= rect.left &&
+ x <= rect.right &&
+ y >= rect.top &&
+ y <= rect.bottom;
+ if (isOverCanvas === false) {
+ if (isCanvasDragRef.current) {
+ isCanvasDragRef.current = false;
+ publish({ type: "dragEnd", payload: { isCanceled: true } });
+ }
+ return;
+ }
+ if (isCanvasDragRef.current === false) {
+ const assetId = getDraggedImageAssetId(source.data);
+ if (assetId === undefined) {
+ return;
+ }
+ isCanvasDragRef.current = true;
+ publish({
+ type: "dragStart",
+ payload: { origin: "panel", type: "insertImageAsset", assetId },
+ });
+ }
+ publish({
+ type: "dragMove",
+ payload: {
+ canvasCoordinates: toCanvasCoordinates(
+ { x, y },
+ $scale.get(),
+ $canvasRect.get()
+ ),
+ },
+ });
+ },
+ onDrop: () => finish(false),
+ });
+
+ return () => {
+ cleanupMonitor();
+ finish(true);
+ };
+ }, [disableCanvasPointerEvents, finish, publish]);
+};
diff --git a/apps/builder/app/builder/features/components/use-draggable.tsx b/apps/builder/app/builder/features/components/use-draggable.tsx
index c65f24f257..8a891ed88b 100644
--- a/apps/builder/app/builder/features/components/use-draggable.tsx
+++ b/apps/builder/app/builder/features/components/use-draggable.tsx
@@ -3,8 +3,8 @@ import { useStore } from "@nanostores/react";
import { createPortal } from "react-dom";
import type { Instance } from "@webstudio-is/sdk";
import {
- type Point,
Flex,
+ type Point,
useDrag,
ComponentCard,
useDisableCanvasPointerEvents,
@@ -16,6 +16,7 @@ import {
InstanceIcon,
getInstanceLabel,
} from "~/builder/shared/instance-label";
+import { toCanvasCoordinates } from "~/builder/shared/canvas-drag";
const DragLayer = ({
component,
@@ -50,21 +51,6 @@ const DragLayer = ({
export const dragItemAttribute = "data-drag-component";
-const toCanvasCoordinates = (
- { x, y }: Point,
- scale: number,
- canvasRect?: DOMRect
-) => {
- if (canvasRect === undefined) {
- return { x: 0, y: 0 };
- }
- const scaleFraction = scale / 100;
- return {
- x: (x - canvasRect.x) / scaleFraction,
- y: (y - canvasRect.y) / scaleFraction,
- };
-};
-
const elementToComponentName = (
element: Element,
availableComponents: Set<string>
diff --git a/apps/builder/app/builder/shared/canvas-drag.ts b/apps/builder/app/builder/shared/canvas-drag.ts
new file mode 100644
index 0000000000..fa86da5f0b
--- /dev/null
+++ b/apps/builder/app/builder/shared/canvas-drag.ts
@@ -0,0 +1,16 @@
+import type { Point } from "@webstudio-is/design-system";
+
+export const toCanvasCoordinates = (
+ { x, y }: Point,
+ scale: number,
+ canvasRect?: DOMRect
+) => {
+ if (canvasRect === undefined) {
+ return { x: 0, y: 0 };
+ }
+ const scaleFraction = scale / 100;
+ return {
+ x: (x - canvasRect.x) / scaleFraction,
+ y: (y - canvasRect.y) / scaleFraction,
+ };
+};
diff --git a/apps/builder/app/builder/sidebar-left/sidebar-left.tsx b/apps/builder/app/builder/sidebar-left/sidebar-left.tsx
index 799dfa8ef0..afb448a7ab 100644
--- a/apps/builder/app/builder/sidebar-left/sidebar-left.tsx
+++ b/apps/builder/app/builder/sidebar-left/sidebar-left.tsx
@@ -197,8 +197,10 @@ export const SidebarLeft = ({ publish }: SidebarLeftProps) => {
const tabsWrapperRef = useRef<HTMLDivElement>(null);
const returnTabRef = useRef<SidebarPanelName | undefined>(undefined);
- useSubscribe("dragEnd", () => {
- setActiveSidebarPanel("auto");
+ useSubscribe("dragEnd", ({ isCanceled }) => {
+ if (isCanceled === false) {
+ setActiveSidebarPanel("auto");
+ }
});
useOnDropEffect(() => {
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.test.tsx b/apps/builder/app/canvas/shared/use-drag-drop.test.tsx
index 0d19f60f45..add714bda6 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.test.tsx
+++ b/apps/builder/app/canvas/shared/use-drag-drop.test.tsx
@@ -240,6 +240,37 @@ describe("commitCanvasDragDrop", () => {
expect($instances.get().get("body")?.children[0]?.value).toEqual(buttonId);
});
+ test("inserts an Image with its source bound to the dragged asset", () => {
+ const data = renderData(<$.Body ws:id="body"></$.Body>);
+ $instances.set(data.instances);
+ serverSyncStore.popAll();
+
+ expect(
+ commitCanvasDragDrop({
+ dragPayload: {
+ origin: "panel",
+ type: "insertImageAsset",
+ assetId: "asset-id",
+ },
+ dropTarget: createDropTarget(["body"]),
+ })
+ ).toBe(true);
+
+ const imageId = $instances.get().get("body")?.children[0]?.value;
+ expect($instances.get().get(imageId ?? "")).toMatchObject({
+ component: "Image",
+ });
+ expect(
+ [...$props.get().values()].find(
+ (prop) => prop.instanceId === imageId && prop.name === "src"
+ )
+ ).toMatchObject({ type: "asset", value: "asset-id" });
+
+ serverSyncStore.undo();
+ expect($instances.get()).toEqual(data.instances);
+ expect($props.get()).toEqual(new Map());
+ });
+
test("does not commit incomplete drag state", () => {
const data = renderData(<$.Body ws:id="body"></$.Body>);
$instances.set(data.instances);
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.ts b/apps/builder/app/canvas/shared/use-drag-drop.ts
index 9ffbe2bcc0..d830fe07dc 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.ts
+++ b/apps/builder/app/canvas/shared/use-drag-drop.ts
@@ -1,4 +1,9 @@
-import { insertWebstudioComponentAt } from "~/shared/instance-utils/insert";
+import {
+ getComponentTemplateData,
+ getImageAssetFragment,
+ insertImageAssetAt,
+ insertWebstudioComponentAt,
+} from "~/shared/instance-utils/insert";
import { reparentInstance } from "~/shared/instance-utils/mutation";
import { useLayoutEffect, useRef } from "react";
import { elementComponent, type Instance } from "@webstudio-is/sdk";
@@ -17,7 +22,6 @@ import {
} from "~/shared/nano-states";
import { $instances, $props } from "~/shared/sync/data-stores";
import { publish, useSubscribe } from "~/shared/pubsub";
-import { getComponentTemplateData } from "~/shared/instance-utils/insert";
import {
getElementByInstanceSelector,
getInstanceIdFromElement,
@@ -27,8 +31,8 @@ import {
type InstanceSelector,
areInstanceSelectorsEqual,
findClosestDroppableInstanceSelector,
+ findClosestRichText,
} from "@webstudio-is/project-build/runtime";
-import { findClosestRichText } from "@webstudio-is/project-build/runtime";
declare module "~/shared/pubsub" {
export interface PubsubMap {
@@ -44,6 +48,7 @@ type Origin = "canvas" | "panel";
export type DragStartPayload =
| { origin: Origin; type: "insert"; dragComponent: Instance["component"] }
+ | { origin: Origin; type: "insertImageAsset"; assetId: string }
| {
origin: Origin;
type: "reparent";
@@ -56,6 +61,32 @@ export type DragEndPayload = {
export type DragMovePayload = { canvasCoordinates: Point };
+const getRuntimeDragPayload = (dragPayload: DragStartPayload) => {
+ if (dragPayload.type === "reparent") {
+ return {
+ type: "reparent" as const,
+ instanceSelector: dragPayload.dragInstanceSelector,
+ };
+ }
+
+ if (dragPayload.type === "insertImageAsset") {
+ return {
+ type: "insert" as const,
+ component: "Image",
+ fragment: getImageAssetFragment(dragPayload.assetId),
+ };
+ }
+
+ return {
+ type: "insert" as const,
+ component: dragPayload.dragComponent,
+ fragment:
+ dragPayload.dragComponent === elementComponent
+ ? undefined
+ : getComponentTemplateData(dragPayload.dragComponent),
+ };
+};
+
const findClosestCanvasDroppableInstanceSelector = (
instanceSelector: InstanceSelector,
dragPayload: DragStartPayload
@@ -71,20 +102,7 @@ const findClosestCanvasDroppableInstanceSelector = (
props,
metas,
htmlTagsByInstanceId,
- dragPayload:
- dragPayload.type === "insert"
- ? {
- type: "insert",
- component: dragPayload.dragComponent,
- fragment:
- dragPayload.dragComponent === elementComponent
- ? undefined
- : getComponentTemplateData(dragPayload.dragComponent),
- }
- : {
- type: "reparent",
- instanceSelector: dragPayload.dragInstanceSelector,
- },
+ dragPayload: getRuntimeDragPayload(dragPayload),
});
};
@@ -114,6 +132,9 @@ export const commitCanvasDragDrop = ({
if (dragPayload.type === "insert") {
return insertWebstudioComponentAt(dragPayload.dragComponent, insertable);
}
+ if (dragPayload.type === "insertImageAsset") {
+ return insertImageAssetAt(dragPayload.assetId, insertable);
+ }
if (dragPayload.type === "reparent") {
reparentInstance(dragPayload.dragInstanceSelector, insertable);
return true;
diff --git a/apps/builder/app/shared/instance-utils/insert.test.tsx b/apps/builder/app/shared/instance-utils/insert.test.tsx
index 372b839c60..324ce86d84 100644
--- a/apps/builder/app/shared/instance-utils/insert.test.tsx
+++ b/apps/builder/app/shared/instance-utils/insert.test.tsx
@@ -1,6 +1,7 @@
import {
findClosestInsertable,
getComponentTemplateData,
+ getImageAssetFragment,
insertWebstudioComponentAt,
insertWebstudioFragmentAt,
} from "./insert";
@@ -981,6 +982,50 @@ describe("getComponentTemplateData", () => {
});
});
+test("binds an Image template source to an asset without mutating the template", () => {
+ const template = createFragment({
+ children: [{ type: "id", value: "image" }],
+ instances: [
+ { type: "instance", id: "image", component: "Image", children: [] },
+ ],
+ props: [
+ {
+ id: "source",
+ instanceId: "image",
+ name: "src",
+ type: "string",
+ value: "placeholder.png",
+ },
+ {
+ id: "alt",
+ instanceId: "image",
+ name: "alt",
+ type: "string",
+ value: "Placeholder",
+ },
+ ],
+ });
+ $registeredTemplates.set(
+ new Map([["Image", { category: "media", order: 0, template }]])
+ );
+
+ const fragment = getImageAssetFragment("asset-id");
+
+ expect(fragment.props).toEqual([
+ {
+ id: "source",
+ instanceId: "image",
+ name: "src",
+ type: "asset",
+ value: "asset-id",
+ },
+ template.props[1],
+ ]);
+ expect(template.props[0]).toEqual(
+ expect.objectContaining({ type: "string", value: "placeholder.png" })
+ );
+});
+
test("get undefined instead of instance path when no instances found", () => {
expect(getInstancePath(["boxId"], new Map())).toEqual(undefined);
});
diff --git a/apps/builder/app/shared/instance-utils/insert.ts b/apps/builder/app/shared/instance-utils/insert.ts
index 1deaebf8ed..9276930db3 100644
--- a/apps/builder/app/shared/instance-utils/insert.ts
+++ b/apps/builder/app/shared/instance-utils/insert.ts
@@ -3,8 +3,20 @@
// while fragment cloning stays in fragment.ts and existing-instance moves stay
// in mutation.ts.
import { toast } from "@webstudio-is/design-system";
-import { type WebstudioFragment, elementComponent } from "@webstudio-is/sdk";
-import type { ConflictResolution } from "@webstudio-is/project-build/runtime";
+import invariant from "tiny-invariant";
+import {
+ type Prop,
+ type WebstudioFragment,
+ elementComponent,
+} from "@webstudio-is/sdk";
+import {
+ builderRuntimeContext,
+ createComponentTemplateFragment,
+ type ConflictResolution,
+ resolveComponentInsertTarget,
+ resolveFragmentInsertTarget,
+ type InsertTarget,
+} from "@webstudio-is/project-build/runtime";
import {
$registeredComponentMetas,
$registeredTemplates,
@@ -13,13 +25,6 @@ import {
selectInstance,
} from "../nano-states";
import { $instances, $project, $props } from "../sync/data-stores";
-import {
- resolveComponentInsertTarget,
- resolveFragmentInsertTarget,
- type InsertTarget,
-} from "@webstudio-is/project-build/runtime";
-import { createComponentTemplateFragment } from "@webstudio-is/project-build/runtime";
-import { builderRuntimeContext } from "@webstudio-is/project-build/runtime";
import { getInstanceLabel } from "~/builder/shared/instance-label";
import { executeRuntimeMutation } from "./data";
@@ -225,6 +230,36 @@ export const getComponentTemplateData = (
});
};
+export const getImageAssetFragment = (assetId: string): WebstudioFragment => {
+ const fragment = getComponentTemplateData("Image");
+ const imageInstance = fragment.instances.find(
+ (instance) => instance.component === "Image"
+ );
+ invariant(imageInstance, "Expected the Image template to contain an Image");
+ const sourceIndex = fragment.props.findIndex(
+ (prop) => prop.instanceId === imageInstance.id && prop.name === "src"
+ );
+ const source: Prop = {
+ ...(sourceIndex === -1
+ ? { id: builderRuntimeContext.createId() }
+ : fragment.props[sourceIndex]),
+ instanceId: imageInstance.id,
+ name: "src",
+ type: "asset",
+ value: assetId,
+ };
+ const props = [...fragment.props];
+ if (sourceIndex === -1) {
+ props.push(source);
+ } else {
+ props[sourceIndex] = source;
+ }
+ return { ...fragment, props };
+};
+
+export const insertImageAssetAt = (assetId: string, insertable?: Insertable) =>
+ insertWebstudioFragmentAt(getImageAssetFragment(assetId), insertable);
+
export type Insertable = InsertTarget;
export const findClosestInsertable = (
diff --git a/apps/builder/e2e/README.md b/apps/builder/e2e/README.md
index 58dd36911c..d2ce1b57f9 100644
--- a/apps/builder/e2e/README.md
+++ b/apps/builder/e2e/README.md
@@ -79,6 +79,15 @@ expensive files into the fastest shard, and rebalance later by renaming files.
CI retries a failed shard once because a single shard rerun is cheap enough to
absorb occasional browser/backend flakes.
+CI discovers its shard matrix directly from these filename tags. When one test
+file contains enough serial work to dominate a shard, add more shard tags to
+that filename. Its tests are distributed deterministically across those shards
+without duplicating the file or its helpers:
+
+```txt
+large-workflow.[shard-2].[shard-5].[shard-6].e2e.ts
+```
+
`pnpm e2e:builder:dev` defaults to `E2E_BUILDER_URL=https://127.0.0.1:3000`,
so it runs against the already-running Vite dev server instead of building and
serving the production bundle. Override `E2E_BUILDER_URL` when the dev server is
diff --git a/apps/builder/e2e/fixtures/drag-project.ts b/apps/builder/e2e/fixtures/drag-project.ts
index 550f0d1afb..fe9936e002 100644
--- a/apps/builder/e2e/fixtures/drag-project.ts
+++ b/apps/builder/e2e/fixtures/drag-project.ts
@@ -1,5 +1,5 @@
import type { SerializedPages } from "@webstudio-is/project-migrations/pages";
-import type { Instance } from "@webstudio-is/sdk";
+import type { Instance, Prop } from "@webstudio-is/sdk";
import { loadDevBuild } from "../db";
import { createSeededBuilderProject } from "./builder-project";
@@ -117,11 +117,17 @@ export const createDragProject = async (name: string) => {
});
};
-export const loadInstances = async (projectId: string) => {
+export const loadDragProjectData = async (projectId: string) => {
const build = await loadDevBuild({ projectId });
- return JSON.parse(build.instances) as Instance[];
+ return {
+ instances: JSON.parse(build.instances) as Instance[],
+ props: JSON.parse(build.props) as Prop[],
+ };
};
+export const loadInstances = async (projectId: string) =>
+ (await loadDragProjectData(projectId)).instances;
+
export const getChildIds = (instances: Instance[], parentId: string) =>
instances
.find(({ id }) => id === parentId)
diff --git a/apps/builder/e2e/harness.ts b/apps/builder/e2e/harness.ts
index d397d9708b..76c8fbe554 100644
--- a/apps/builder/e2e/harness.ts
+++ b/apps/builder/e2e/harness.ts
@@ -47,7 +47,7 @@ const suitesByFile = new Map<string, Suite>();
const formatSuiteName = (filePath: string) => {
return basename(filePath, ".e2e.ts")
- .replace(/\.\[shard-\d+\]$/, "")
+ .replace(/(\.\[shard-\d+\])+$/, "")
.replaceAll("-", " ");
};
diff --git a/apps/builder/e2e/print-shards.ts b/apps/builder/e2e/print-shards.ts
new file mode 100644
index 0000000000..1563be127f
--- /dev/null
+++ b/apps/builder/e2e/print-shards.ts
@@ -0,0 +1,6 @@
+import { readdir } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { getE2eShards } from "./test-modules";
+
+const testDirectory = fileURLToPath(new URL("./tests", import.meta.url));
+console.info(JSON.stringify(getE2eShards(await readdir(testDirectory))));
diff --git a/apps/builder/e2e/run-local.sh b/apps/builder/e2e/run-local.sh
index c337205eb1..7aede8110e 100644
--- a/apps/builder/e2e/run-local.sh
+++ b/apps/builder/e2e/run-local.sh
@@ -125,6 +125,17 @@ build_e2e_apps() {
pnpm --dir "$ROOT_DIR" --filter=@webstudio-is/sdk-components-react-router build
}
+verify_e2e_apps_built() {
+ local builder_server="$ROOT_DIR/apps/builder/build/server"
+ local builder_assets="$ROOT_DIR/apps/builder/build/client/assets"
+ local preview_router="$ROOT_DIR/packages/sdk-components-react-router/lib/components.js"
+
+ if [ ! -d "$builder_server" ] || [ ! -d "$builder_assets" ] || [ ! -f "$preview_router" ]; then
+ echo "E2E_SKIP_BUILDER_BUILD requires prebuilt Builder artifacts" >&2
+ return 1
+ fi
+}
+
run_builder_e2e_tests() {
(
cd "$ROOT_DIR/apps/builder"
@@ -169,8 +180,13 @@ if [ "$E2E_RUN_TESTS" = "true" ]; then
install_playwright_chromium
if [ "${E2E_BUILDER_URL:-}" = "" ]; then
- run_step "build builder and generated preview dependencies" "$E2E_BUILDER_BUILD_TIMEOUT_SECONDS" \
- build_e2e_apps
+ if [ "${E2E_SKIP_BUILDER_BUILD:-false}" = "true" ]; then
+ run_step "verify prebuilt builder artifacts" "$E2E_BUILDER_BUILD_TIMEOUT_SECONDS" \
+ verify_e2e_apps_built
+ else
+ run_step "build builder and generated preview dependencies" "$E2E_BUILDER_BUILD_TIMEOUT_SECONDS" \
+ build_e2e_apps
+ fi
fi
run_step "run builder e2e tests" "$E2E_TEST_COMMAND_TIMEOUT_SECONDS" \
diff --git a/apps/builder/e2e/run.ts b/apps/builder/e2e/run.ts
index ca44ed9bc9..89513e3601 100644
--- a/apps/builder/e2e/run.ts
+++ b/apps/builder/e2e/run.ts
@@ -15,7 +15,7 @@ import {
} from "./harness";
import { resetDatabase } from "./db";
import { logPerf, measure, printPerfSummary } from "./perf";
-import { getE2eTestModules } from "./test-modules";
+import { getE2eTestModules, isE2eTestInShard } from "./test-modules";
import { stopChildProcess } from "./process";
import { runWithTimeout } from "./timeout";
@@ -211,9 +211,20 @@ const getRunnableSuites = () => {
}
return suite.fileName.includes(`[${testShard}]`);
})
- .map((suite) => ({
+ .map((suite, suiteIndex) => ({
suite,
- tests: suite.tests.filter((test) => {
+ tests: suite.tests.filter((test, testIndex) => {
+ // Offset each suite so odd test counts do not always give the extra
+ // test to the same worker.
+ if (
+ isE2eTestInShard({
+ fileName: suite.fileName,
+ shard: testShard,
+ distributionIndex: testIndex + suiteIndex,
+ }) === false
+ ) {
+ return false;
+ }
if (testFilters.length === 0) {
return true;
}
diff --git a/apps/builder/e2e/test-modules.test.ts b/apps/builder/e2e/test-modules.test.ts
index d2b9994052..6eb6a2b509 100644
--- a/apps/builder/e2e/test-modules.test.ts
+++ b/apps/builder/e2e/test-modules.test.ts
@@ -1,9 +1,15 @@
import { expect, test } from "vitest";
-import { getE2eTestModules } from "./test-modules";
+import {
+ getE2eFileShards,
+ getE2eShards,
+ getE2eTestModules,
+ isE2eTestInShard,
+} from "./test-modules";
test("discovers every e2e module and filters ownership by shard tag", () => {
const files = [
"asset-folders-selection-actions.[shard-4].e2e.ts",
+ "pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts",
"pages-drag.[shard-3].e2e.ts",
"navigator-drag.[shard-1].e2e.ts",
"helper.ts",
@@ -12,6 +18,7 @@ test("discovers every e2e module and filters ownership by shard tag", () => {
expect(getE2eTestModules(files)).toEqual([
"./tests/asset-folders-selection-actions.[shard-4].e2e.ts",
"./tests/navigator-drag.[shard-1].e2e.ts",
+ "./tests/pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts",
"./tests/pages-drag.[shard-3].e2e.ts",
]);
expect(getE2eTestModules(files, "shard-3")).toEqual([
@@ -20,4 +27,40 @@ test("discovers every e2e module and filters ownership by shard tag", () => {
expect(getE2eTestModules(files, "shard-4")).toEqual([
"./tests/asset-folders-selection-actions.[shard-4].e2e.ts",
]);
+ expect(getE2eTestModules(files, "shard-5")).toEqual([
+ "./tests/pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts",
+ ]);
+});
+
+test("discovers the shard matrix from e2e filenames", () => {
+ expect(
+ getE2eShards([
+ "second.[shard-2].[shard-10].e2e.ts",
+ "first.[shard-1].e2e.ts",
+ "helper.ts",
+ ])
+ ).toEqual(["shard-1", "shard-2", "shard-10"]);
+ expect(() => getE2eShards(["unassigned.e2e.ts"])).toThrow(
+ "Every e2e file must have a shard tag"
+ );
+});
+
+test("partitions a multi-shard file by test registration order", () => {
+ const fileName = "pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts";
+ expect(getE2eFileShards(fileName)).toEqual(["shard-2", "shard-5", "shard-6"]);
+ expect(
+ [0, 1, 2, 3, 4].filter((distributionIndex) =>
+ isE2eTestInShard({ fileName, shard: "shard-2", distributionIndex })
+ )
+ ).toEqual([0, 3]);
+ expect(
+ [0, 1, 2, 3, 4].filter((distributionIndex) =>
+ isE2eTestInShard({ fileName, shard: "shard-5", distributionIndex })
+ )
+ ).toEqual([1, 4]);
+ expect(
+ [0, 1, 2, 3, 4].filter((distributionIndex) =>
+ isE2eTestInShard({ fileName, shard: "shard-6", distributionIndex })
+ )
+ ).toEqual([2]);
});
diff --git a/apps/builder/e2e/test-modules.ts b/apps/builder/e2e/test-modules.ts
index 390a1cb101..673d3f554e 100644
--- a/apps/builder/e2e/test-modules.ts
+++ b/apps/builder/e2e/test-modules.ts
@@ -1,12 +1,54 @@
+const e2eFileSuffix = ".e2e.ts";
+const shardTagPattern = /\[(shard-\d+)\]/g;
+
+export const getE2eFileShards = (fileName: string) =>
+ [...fileName.matchAll(shardTagPattern)].map((match) => match[1]);
+
+export const getE2eShards = (fileNames: readonly string[]) => {
+ const e2eFiles = fileNames.filter((fileName) =>
+ fileName.endsWith(e2eFileSuffix)
+ );
+ const unassignedFiles = e2eFiles.filter(
+ (fileName) => getE2eFileShards(fileName).length === 0
+ );
+ if (unassignedFiles.length > 0) {
+ throw new Error(
+ `Every e2e file must have a shard tag: ${unassignedFiles.join(", ")}`
+ );
+ }
+ return [...new Set(e2eFiles.flatMap(getE2eFileShards))].sort((left, right) =>
+ left.localeCompare(right, undefined, { numeric: true })
+ );
+};
+
export const getE2eTestModules = (
fileNames: readonly string[],
shard?: string
) =>
fileNames
- .filter((fileName) => fileName.endsWith(".e2e.ts"))
+ .filter((fileName) => fileName.endsWith(e2eFileSuffix))
.filter(
(fileName) =>
- shard === undefined || shard === "" || fileName.includes(`[${shard}]`)
+ shard === undefined ||
+ shard === "" ||
+ getE2eFileShards(fileName).includes(shard)
)
.sort()
.map((fileName) => `./tests/${fileName}`);
+
+export const isE2eTestInShard = ({
+ fileName,
+ shard,
+ distributionIndex,
+}: {
+ fileName: string;
+ shard: string | undefined;
+ distributionIndex: number;
+}) => {
+ if (shard === undefined || shard === "") {
+ return true;
+ }
+ const shards = getE2eFileShards(fileName);
+ const shardIndex = shards.indexOf(shard);
+ return shardIndex !== -1 && distributionIndex % shards.length === shardIndex;
+};
diff --git a/apps/builder/e2e/tests/asset-canvas-drag.[shard-4].e2e.ts b/apps/builder/e2e/tests/asset-canvas-drag.[shard-4].e2e.ts
new file mode 100644
index 0000000000..1f224c78a0
--- /dev/null
+++ b/apps/builder/e2e/tests/asset-canvas-drag.[shard-4].e2e.ts
@@ -0,0 +1,48 @@
+import assert from "node:assert/strict";
+import {
+ createDragProject,
+ dragIds,
+ loadDragProjectData,
+} from "../fixtures/drag-project";
+import { openAssetsPanel, uploadAsset } from "../flows/assets-panel";
+import { getCanvasInstance, openProjectBuilder } from "../flows/builder";
+import { dragToCanvas, ensureInteractiveCanvas } from "../flows/drag";
+import { newIsolatedPage, test } from "../harness";
+
+test("Dragging an image asset onto canvas inserts a bound Image", async () => {
+ const fixture = await createDragProject("asset-canvas");
+ const { page, close } = await newIsolatedPage();
+ try {
+ const canvas = await openProjectBuilder({
+ page,
+ projectId: fixture.projectId,
+ authToken: fixture.builderToken,
+ });
+ const container = getCanvasInstance({
+ canvas,
+ instanceSelector: [dragIds.container, dragIds.wrapper, dragIds.body],
+ });
+ await ensureInteractiveCanvas(page, canvas, container);
+ await openAssetsPanel({ page });
+ const assetTitle = await uploadAsset({
+ page,
+ filename: "upload-image.svg",
+ });
+
+ await dragToCanvas(page, canvas, page.getByTitle(assetTitle), container);
+ await page
+ .getByRole("tabpanel", { name: "Assets" })
+ .waitFor({ state: "hidden" });
+
+ const { instances, props } = await loadDragProjectData(fixture.projectId);
+ const image = instances.find(({ component }) => component === "Image");
+ assert(image, "Expected an Image on the canvas");
+ const source = props.find(
+ (prop) => prop.instanceId === image.id && prop.name === "src"
+ );
+ assert(source?.type === "asset", "Expected an asset-bound image source");
+ assert(source.value.length > 0, "Expected the uploaded asset id");
+ } finally {
+ await close();
+ }
+});
diff --git a/apps/builder/e2e/tests/asset-folders.[shard-1].e2e.ts b/apps/builder/e2e/tests/asset-folders.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/asset-folders.[shard-1].e2e.ts
rename to apps/builder/e2e/tests/asset-folders.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/canvas-drag.[shard-2].e2e.ts b/apps/builder/e2e/tests/canvas-drag.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/canvas-drag.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/canvas-drag.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/content-mode-editing.[shard-1].e2e.ts b/apps/builder/e2e/tests/content-mode-assets.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/content-mode-editing.[shard-1].e2e.ts
rename to apps/builder/e2e/tests/content-mode-assets.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/content-mode-editing.[shard-2].e2e.ts b/apps/builder/e2e/tests/content-mode-editing.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/content-mode-editing.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/content-mode-editing.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/data-variables-runtime.[shard-3].e2e.ts b/apps/builder/e2e/tests/data-variables-generated.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/data-variables-runtime.[shard-3].e2e.ts
rename to apps/builder/e2e/tests/data-variables-generated.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/data-variables-runtime.[shard-2].e2e.ts b/apps/builder/e2e/tests/data-variables-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/data-variables-runtime.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/data-variables-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/pages-actions.[shard-1].e2e.ts b/apps/builder/e2e/tests/pages-actions-bridge.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/pages-actions.[shard-1].e2e.ts
rename to apps/builder/e2e/tests/pages-actions-bridge.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/pages-actions.[shard-3].e2e.ts b/apps/builder/e2e/tests/pages-actions-pages.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 98%
rename from apps/builder/e2e/tests/pages-actions.[shard-3].e2e.ts
rename to apps/builder/e2e/tests/pages-actions-pages.[shard-2].[shard-5].[shard-6].e2e.ts
index d4afca249a..154b5d196a 100644
--- a/apps/builder/e2e/tests/pages-actions.[shard-3].e2e.ts
+++ b/apps/builder/e2e/tests/pages-actions-pages.[shard-2].[shard-5].[shard-6].e2e.ts
@@ -403,15 +403,18 @@ test("Builder can copy, duplicate, and delete a folder from the context menu", a
action: "Copy",
});
await waitForCopiedPageTransferData({ page });
+ const pasteSave = waitForChangeToBeSaved({ page });
await selectContextAction({ page, itemName: "Home", action: "Paste" });
- await waitForSyncStatus({ page, status: "idle" });
+ await pasteSave;
await waitForFolderRow({ page, folderName: copiedFolderName });
+ const duplicateSave = waitForChangeToBeSaved({ page });
await selectContextAction({
page,
itemName: renamedFolderName,
action: "Duplicate",
});
+ await duplicateSave;
await waitForFolderRow({ page, folderName: duplicatedFolderName });
await selectContextAction({
@@ -419,7 +422,9 @@ test("Builder can copy, duplicate, and delete a folder from the context menu", a
itemName: duplicatedFolderName,
action: "Delete",
});
+ const deleteSave = waitForChangeToBeSaved({ page });
await confirmDialogAction({ page, action: "Delete" });
+ await deleteSave;
await expectTextHidden({ page, text: duplicatedFolderName });
await measure(
diff --git a/apps/builder/e2e/tests/pages-actions.[shard-2].e2e.ts b/apps/builder/e2e/tests/pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/pages-actions.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/project-settings-runtime.[shard-2].e2e.ts b/apps/builder/e2e/tests/project-settings-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/project-settings-runtime.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/project-settings-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/props-runtime.[shard-2].e2e.ts b/apps/builder/e2e/tests/props-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/props-runtime.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/props-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
diff --git a/apps/builder/e2e/tests/style-panel-runtime.[shard-2].e2e.ts b/apps/builder/e2e/tests/style-panel-runtime.[shard-2].[shard-5].[shard-6].e2e.ts
similarity index 100%
rename from apps/builder/e2e/tests/style-panel-runtime.[shard-2].e2e.ts
rename to apps/builder/e2e/tests/style-panel-runtime.[shard-2].[shard-5].[shard-6].e2e.ts