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.

refactor: migrate dnd to new constraints (#4507)

Bogdan Chadkinb2137c1a7c6b
diff --git a/apps/builder/app/builder/features/navigator/navigator-tree.tsx b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
index 11d912c71a..004552d2cd 100644
--- a/apps/builder/app/builder/features/navigator/navigator-tree.tsx
+++ b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
@@ -51,12 +51,7 @@ import {
import type { InstanceSelector } from "~/shared/tree-utils";
import { serverSyncStore } from "~/shared/sync";
import { MetaIcon } from "~/builder/shared/meta-icon";
-import {
- computeInstancesConstraints,
- findClosestDroppableComponentIndex,
- getInstanceLabel,
- reparentInstance,
-} from "~/shared/instance-utils";
+import { getInstanceLabel, reparentInstance } from "~/shared/instance-utils";
import { emitCommand } from "~/builder/shared/commands";
import { useContentEditable } from "~/shared/dom-hooks";
import {
@@ -64,6 +59,7 @@ import {
getInstanceKey,
selectInstance,
} from "~/shared/awareness";
+import { isTreeMatching } from "~/shared/matcher";
type TreeItem = {
level: number;
@@ -530,17 +526,12 @@ const canDrop = (
return false;
}
- const metas = $registeredComponentMetas.get();
- const insertConstraints = computeInstancesConstraints(metas, instances, [
- dragSelector[0],
- ]);
- const ancestorIndex = findClosestDroppableComponentIndex({
- metas,
- constraints: insertConstraints,
+ return isTreeMatching({
instances,
- instanceSelector: dropSelector,
+ metas: $registeredComponentMetas.get(),
+ // make sure dragging tree can be put inside of drop instance
+ instanceSelector: [dragSelector[0], ...dropSelector],
});
- return ancestorIndex === 0;
};
export const NavigatorTree = () => {
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
index d4455df224..33762b22af 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
@@ -46,10 +46,10 @@ export const CanvasTools = () => {
return;
}
- if (
- dragAndDropState.isDragging &&
- dragAndDropState.placementIndicator !== undefined
- ) {
+ if (dragAndDropState.isDragging) {
+ if (dragAndDropState.placementIndicator === undefined) {
+ return;
+ }
const { dropTarget, placementIndicator } = dragAndDropState;
const dropTargetInstance =
dropTarget === undefined
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.ts b/apps/builder/app/canvas/shared/use-drag-drop.ts
index ef89f277bf..a8897ae012 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.ts
+++ b/apps/builder/app/canvas/shared/use-drag-drop.ts
@@ -15,13 +15,10 @@ import {
} from "~/shared/nano-states";
import { publish, useSubscribe } from "~/shared/pubsub";
import {
- computeInstancesConstraints,
- findClosestDroppableComponentIndex,
findClosestDetachableInstanceSelector,
getComponentTemplateData,
insertTemplateData,
reparentInstance,
- type InsertConstraints,
} from "~/shared/instance-utils";
import {
getElementByInstanceSelector,
@@ -32,6 +29,10 @@ import {
type InstanceSelector,
areInstanceSelectorsEqual,
} from "~/shared/tree-utils";
+import {
+ findClosestInstanceMatchingFragment,
+ isTreeMatching,
+} from "~/shared/matcher";
declare module "~/shared/pubsub" {
export interface PubsubMap {
@@ -66,39 +67,30 @@ const findClosestDroppableInstanceSelector = (
const instances = $instances.get();
const metas = $registeredComponentMetas.get();
- let insertConstraints: undefined | InsertConstraints;
+ let droppableIndex = -1;
if (dragPayload?.type === "insert") {
- const templateData = getComponentTemplateData(dragPayload.dragComponent);
- if (templateData) {
- const { children, instances } = templateData;
- const newInstances = new Map(
- instances.map((instance) => [instance.id, instance])
- );
- const rootInstanceIds = children
- .filter((child) => child.type === "id")
- .map((child) => child.value);
- insertConstraints = computeInstancesConstraints(
+ const fragment = getComponentTemplateData(dragPayload.dragComponent);
+ if (fragment) {
+ droppableIndex = findClosestInstanceMatchingFragment({
+ instances,
metas,
- newInstances,
- rootInstanceIds
- );
+ instanceSelector,
+ fragment,
+ });
}
}
if (dragPayload?.type === "reparent") {
- insertConstraints = computeInstancesConstraints(metas, instances, [
- dragPayload.dragInstanceSelector[0],
- ]);
- }
- if (insertConstraints === undefined) {
- return;
+ const matches = isTreeMatching({
+ instances,
+ metas,
+ instanceSelector: [
+ dragPayload.dragInstanceSelector[0],
+ ...instanceSelector,
+ ],
+ });
+ droppableIndex = matches ? 0 : -1;
}
- const droppableIndex = findClosestDroppableComponentIndex({
- metas: $registeredComponentMetas.get(),
- constraints: insertConstraints,
- instances: $instances.get(),
- instanceSelector,
- });
if (droppableIndex === -1) {
return;
}
diff --git a/apps/builder/app/shared/instance-utils.test.tsx b/apps/builder/app/shared/instance-utils.test.tsx
index b566ea7d16..5b3ad894f9 100644
--- a/apps/builder/app/shared/instance-utils.test.tsx
+++ b/apps/builder/app/shared/instance-utils.test.tsx
@@ -31,11 +31,8 @@ import type {
import { encodeDataSourceVariable, getStyleDeclKey } from "@webstudio-is/sdk";
import type { StyleProperty, StyleValue } from "@webstudio-is/css-engine";
import {
- computeInstancesConstraints,
- findClosestDroppableComponentIndex,
findClosestEditableInstanceSelector,
insertTemplateData,
- type InsertConstraints,
deleteInstanceMutable,
extractWebstudioFragment,
insertWebstudioFragmentCopy,
@@ -189,11 +186,6 @@ const createFontAsset = (id: string, family: string): Asset => {
};
};
-const emptyInsertConstraints: InsertConstraints = {
- requiredAncestors: new Set(),
- invalidAncestors: new Set(),
-};
-
describe("find closest editable instance selector", () => {
test("searches closest container", () => {
const instances: Instances = toMap([
@@ -268,173 +260,6 @@ describe("find closest editable instance selector", () => {
});
});
-describe("compute instances constraints", () => {
- const base = {
- type: "container",
- label: "",
- icon: "",
- } as const;
-
- test("combine required ancestors excluding already resolved ones", () => {
- const metas = new Map<string, WsComponentMeta>([
- ["Button", { ...base, requiredAncestors: ["Form"] }],
- ["Checkbox", { ...base, requiredAncestors: ["Form", "Label"] }],
- ["Label", { ...base, requiredAncestors: ["Body"] }],
- ]);
- // button
- // label
- // checkbox
- const instances = new Map<Instance["id"], Instance>([
- createInstancePair("button", "Button", []),
- createInstancePair("label", "Label", [{ type: "id", value: "checkbox" }]),
- createInstancePair("checkbox", "Checkbox", []),
- ]);
- expect(
- computeInstancesConstraints(metas, instances, ["button", "label"])
- ).toEqual({
- requiredAncestors: new Set(["Body", "Form"]),
- invalidAncestors: new Set(),
- });
- });
-
- test("combine invalid ancestors of all instances", () => {
- const metas = new Map<string, WsComponentMeta>([
- ["Button", { ...base, invalidAncestors: ["Button"] }],
- ["Form", { ...base, invalidAncestors: ["Button", "Form"] }],
- ]);
- // form
- // button
- const instances = new Map<Instance["id"], Instance>([
- createInstancePair("form", "Form", [{ type: "id", value: "button" }]),
- createInstancePair("button", "Button", []),
- ]);
- expect(computeInstancesConstraints(metas, instances, ["form"])).toEqual({
- requiredAncestors: new Set(),
- invalidAncestors: new Set(["Button", "Form"]),
- });
- });
-});
-
-describe("find closest droppable component index", () => {
- test("finds container", () => {
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: emptyInsertConstraints,
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", []),
- ]),
- instanceSelector: ["box", "body"],
- })
- ).toEqual(0);
- });
-
- test("skips non containers", () => {
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: emptyInsertConstraints,
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", [{ type: "id", value: "text" }]),
- createInstancePair("text", "Text", [{ type: "id", value: "italic" }]),
- createInstancePair("italic", "Italic", [
- { type: "id", value: "bold" },
- ]),
- createInstancePair("bold", "Bold", []),
- ]),
- instanceSelector: ["bold", "italic", "text", "box", "body"],
- })
- ).toEqual(2);
- });
-
- test("considers invalid ancestors", () => {
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: {
- requiredAncestors: new Set(),
- invalidAncestors: new Set(["Item"]),
- },
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "item" }]),
- createInstancePair("item", "Item", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", []),
- ]),
- instanceSelector: ["box", "item", "body"],
- })
- ).toEqual(2);
- });
-
- test("requires some ancestor", () => {
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: {
- requiredAncestors: new Set(["Form"]),
- invalidAncestors: new Set(),
- },
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", []),
- ]),
- instanceSelector: ["box", "body"],
- })
- ).toEqual(-1);
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: {
- requiredAncestors: new Set(["Form"]),
- invalidAncestors: new Set(),
- },
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "form" }]),
- createInstancePair("form", "Form", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", []),
- ]),
- instanceSelector: ["box", "form", "body"],
- })
- ).toEqual(0);
- });
-
- test("considers both required and invalid ancestors", () => {
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: {
- requiredAncestors: new Set(["Form"]),
- invalidAncestors: new Set(["Box"]),
- },
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "form" }]),
- createInstancePair("form", "Form", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", [{ type: "id", value: "div" }]),
- createInstancePair("div", "Div", []),
- ]),
- instanceSelector: ["div", "box", "form", "body"],
- })
- ).toEqual(2);
- expect(
- findClosestDroppableComponentIndex({
- metas: createFakeComponentMetas({}),
- constraints: {
- requiredAncestors: new Set(["Form"]),
- invalidAncestors: new Set(["Box"]),
- },
- instances: new Map<Instance["id"], Instance>([
- createInstancePair("body", "Body", [{ type: "id", value: "form" }]),
- createInstancePair("form", "Form", [{ type: "id", value: "box" }]),
- createInstancePair("box", "Box", [{ type: "id", value: "div" }]),
- createInstancePair("div", "Div", []),
- ]),
- instanceSelector: ["div", "form", "box", "body"],
- })
- ).toEqual(-1);
- });
-});
-
describe("insert instance children", () => {
test("insert instance children into empty target", () => {
const instances = toMap([createInstance("body", "Body", [])]);
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index f58f01e540..e105c6d72d 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -293,136 +293,6 @@ export const isInstanceDetachable = (
return meta.detachable ?? true;
};
-const traverseInstancesConstraints = (
- metas: Map<string, WsComponentMeta>,
- instances: Instances,
- instanceId: Instance["id"],
- requiredAncestors: Set<Instance["component"]>,
- invalidAncestors: Set<Instance["component"]>,
- componentSelector: string[] = []
-) => {
- const instance = instances.get(instanceId);
- if (instance === undefined) {
- return;
- }
- const meta = metas.get(instance.component);
- if (meta === undefined) {
- return;
- }
- if (meta.requiredAncestors) {
- for (const requiredAncestor of meta.requiredAncestors) {
- if (componentSelector.includes(requiredAncestor) === false) {
- requiredAncestors.add(requiredAncestor);
- }
- }
- }
- if (meta.invalidAncestors) {
- for (const invalidAncestor of meta.invalidAncestors) {
- invalidAncestors.add(invalidAncestor);
- }
- }
- for (const child of instance.children) {
- if (child.type === "id") {
- traverseInstancesConstraints(
- metas,
- instances,
- child.value,
- requiredAncestors,
- invalidAncestors,
- [instance.component, ...componentSelector]
- );
- }
- }
-};
-
-export type InsertConstraints = {
- requiredAncestors: Set<Instance["component"]>;
- invalidAncestors: Set<Instance["component"]>;
-};
-
-export const computeInstancesConstraints = (
- metas: Map<string, WsComponentMeta>,
- instances: Instances,
- rootInstanceIds: Instance["id"][]
-): InsertConstraints => {
- const requiredAncestors = new Set<string>();
- const invalidAncestors = new Set<string>();
- for (const instanceId of rootInstanceIds) {
- traverseInstancesConstraints(
- metas,
- instances,
- instanceId,
- requiredAncestors,
- invalidAncestors
- );
- }
- return {
- requiredAncestors,
- invalidAncestors,
- };
-};
-
-export const findClosestDroppableComponentIndex = ({
- metas,
- constraints,
- instances,
- instanceSelector,
- allowInsertIntoTextContainer = true,
-}: {
- metas: Map<string, WsComponentMeta>;
- constraints: InsertConstraints;
- instances: Instances;
- instanceSelector: InstanceSelector;
- allowInsertIntoTextContainer?: boolean;
-}) => {
- const { requiredAncestors, invalidAncestors } = constraints;
- const componentSelector: string[] = [];
- for (const instanceId of instanceSelector) {
- const instance = instances.get(instanceId);
- if (instance === undefined) {
- componentSelector.push("Fragment");
- continue;
- }
- // Collection produce fake instances and fragment does not have constraints.
- componentSelector.push(instance.component);
- }
-
- let containerIndex = -1;
- let requiredFound = false;
- for (let index = 0; index < componentSelector.length; index += 1) {
- const ancestorComponent = componentSelector[index];
- if (invalidAncestors.has(ancestorComponent) === true) {
- containerIndex = -1;
- requiredFound = false;
- continue;
- }
- if (allowInsertIntoTextContainer === false) {
- const instance = instances.get(instanceSelector[index]);
- if (instance !== undefined) {
- const hasTextChild = instance.children.some(
- (child) => child.type === "text" || child.type === "expression"
- );
- if (hasTextChild) {
- containerIndex = -1;
- continue;
- }
- }
- }
- if (requiredAncestors.has(ancestorComponent) === true) {
- requiredFound = true;
- }
- const ancestorMeta = metas.get(ancestorComponent);
- if (containerIndex === -1 && ancestorMeta?.type === "container") {
- containerIndex = index;
- }
- }
-
- if (requiredFound || requiredAncestors.size === 0) {
- return containerIndex;
- }
- return -1;
-};
-
export const insertInstanceChildrenMutable = (
data: WebstudioData,
children: Instance["children"],