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: check literals with parser (#2950)

Bogdan Chadkin8722b15ab221
diff --git a/apps/builder/app/builder/features/settings-panel/controls/json.tsx b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
index 52aa2b35ec..d16220727a 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/json.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
@@ -1,4 +1,5 @@
import { useStore } from "@nanostores/react";
+import { isLiteralExpression } from "@webstudio-is/react-sdk";
import {
type ControlProps,
getLabel,
@@ -17,6 +18,7 @@ import {
BindingControl,
BindingPopover,
} from "~/builder/shared/binding-popover";
+import { useState } from "react";
export const JsonControl = ({
meta,
@@ -27,8 +29,15 @@ export const JsonControl = ({
onChange,
onDelete,
}: ControlProps<"json">) => {
+ const [error, setError] = useState<boolean>(false);
const valueString = formatValue(computedValue ?? "");
const localValue = useLocalValue(valueString, (value) => {
+ const isLiteral = isLiteralExpression(value);
+ setError(isLiteral ? false : true);
+ // prevent executing expressions which depends on global variables
+ if (isLiteral === false) {
+ return;
+ }
try {
// wrap into parens to treat object expression as value instead of block
const parsedValue = eval(`(${value})`);
@@ -61,6 +70,7 @@ export const JsonControl = ({
>
<BindingControl>
<ExpressionEditor
+ color={error ? "error" : undefined}
readOnly={overwritable === false}
value={localValue.value}
onChange={localValue.set}
diff --git a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx b/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
index d8d6b7386e..f9f04a6399 100644
--- a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
+++ b/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
@@ -9,7 +9,10 @@ import {
} from "react";
import { useStore } from "@nanostores/react";
import type { DataSource, Resource } from "@webstudio-is/sdk";
-import { encodeDataSourceVariable } from "@webstudio-is/react-sdk";
+import {
+ encodeDataSourceVariable,
+ isLiteralExpression,
+} from "@webstudio-is/react-sdk";
import {
Box,
Button,
@@ -37,7 +40,6 @@ import {
BindingControl,
BindingPopover,
evaluateExpressionWithinScope,
- isLiteralExpression,
} from "~/builder/shared/binding-popover";
import {
type Field,
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/custom-metadata.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/custom-metadata.tsx
index 615b30e9d2..e5ff326cd4 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/custom-metadata.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/custom-metadata.tsx
@@ -12,10 +12,10 @@ import {
} from "@webstudio-is/design-system";
import { DeleteIcon, PlusIcon } from "@webstudio-is/icons";
import { isFeatureEnabled } from "@webstudio-is/feature-flags";
+import { isLiteralExpression } from "@webstudio-is/react-sdk";
import {
BindingControl,
BindingPopover,
- isLiteralExpression,
} from "~/builder/shared/binding-popover";
import { computeExpression } from "~/shared/nano-states";
import { $pageRootScope } from "./page-utils";
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
index 8623e1ac47..3dba25877e 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
@@ -50,6 +50,7 @@ import {
HelpIcon,
UploadIcon,
} from "@webstudio-is/icons";
+import { isLiteralExpression } from "@webstudio-is/react-sdk";
import { useIds } from "~/shared/form-utils";
import { Header, HeaderSuffixSpacer } from "../../header";
import { updateWebstudioData } from "~/shared/instance-utils";
@@ -65,7 +66,6 @@ import {
import {
BindingControl,
BindingPopover,
- isLiteralExpression,
} from "~/builder/shared/binding-popover";
import { serverSyncStore } from "~/shared/sync";
import { SearchPreview } from "./search-preview";
diff --git a/apps/builder/app/builder/shared/binding-popover.tsx b/apps/builder/app/builder/shared/binding-popover.tsx
index 91a29b0632..a9f2a64405 100644
--- a/apps/builder/app/builder/shared/binding-popover.tsx
+++ b/apps/builder/app/builder/shared/binding-popover.tsx
@@ -60,20 +60,6 @@ export const evaluateExpressionWithinScope = (
}
};
-/**
- * execute valid expression without scope
- * to check any variable usage
- */
-export const isLiteralExpression = (expression: string) => {
- try {
- const fn = new Function(`return (${expression})`);
- fn();
- return true;
- } catch {
- return false;
- }
-};
-
const getUsedIdentifiers = (expression: string) => {
const identifiers = new Set<string>();
// prevent parsing empty expression
diff --git a/apps/builder/app/builder/shared/code-editor.tsx b/apps/builder/app/builder/shared/code-editor.tsx
index 43f6757e10..fcfde80494 100644
--- a/apps/builder/app/builder/shared/code-editor.tsx
+++ b/apps/builder/app/builder/shared/code-editor.tsx
@@ -251,16 +251,14 @@ const codeEditorStyle = css({
});
export const CodeEditor = ({
- className,
title,
...editorContentProps
}: EditorContentProps & {
- className?: string;
title?: ReactNode;
}) => {
const content = <EditorContent {...editorContentProps} />;
return (
- <div className={codeEditorStyle({ className })}>
+ <div className={codeEditorStyle()}>
{content}
<CodeEditorDialog title={title} content={content}>
<SmallIconButton
diff --git a/apps/builder/app/builder/shared/expression-editor.tsx b/apps/builder/app/builder/shared/expression-editor.tsx
index 255f2bf803..edf1dea500 100644
--- a/apps/builder/app/builder/shared/expression-editor.tsx
+++ b/apps/builder/app/builder/shared/expression-editor.tsx
@@ -348,10 +348,6 @@ const wrapperStyle = css({
},
});
-const errorStyle = css({
- borderColor: theme.colors.borderDestructiveMain,
-});
-
export const ExpressionEditor = ({
scope = emptyScope,
aliases = emptyAliases,
@@ -417,7 +413,7 @@ export const ExpressionEditor = ({
<div className={wrapperStyle.toString()}>
<CodeEditor
extensions={extensions}
- className={color === "error" ? errorStyle.toString() : undefined}
+ invalid={color === "error"}
readOnly={readOnly}
autoFocus={autoFocus}
value={value}
diff --git a/packages/react-sdk/src/expression.test.ts b/packages/react-sdk/src/expression.test.ts
index 278b70d981..8bcdd3ab8f 100644
--- a/packages/react-sdk/src/expression.test.ts
+++ b/packages/react-sdk/src/expression.test.ts
@@ -3,6 +3,7 @@ import {
decodeDataSourceVariable,
encodeDataSourceVariable,
executeExpression,
+ isLiteralExpression,
validateExpression,
} from "./expression";
@@ -88,6 +89,28 @@ test("allow indexed member expressions with identifiers", () => {
expect(ids).toEqual(["a", "b"]);
});
+test("check simple literals", () => {
+ expect(isLiteralExpression(`""`)).toEqual(true);
+ expect(isLiteralExpression(`''`)).toEqual(true);
+ expect(isLiteralExpression(`0`)).toEqual(true);
+ expect(isLiteralExpression(`true`)).toEqual(true);
+ expect(isLiteralExpression(`[]`)).toEqual(true);
+ expect(isLiteralExpression(`{}`)).toEqual(true);
+ expect(isLiteralExpression(`"" + ""`)).toEqual(false);
+ expect(isLiteralExpression(`{}.field`)).toEqual(false);
+ expect(isLiteralExpression(`variable`)).toEqual(false);
+});
+
+test("check complex objects and arrays", () => {
+ expect(isLiteralExpression(`[1, 2, 3]`)).toEqual(true);
+ expect(isLiteralExpression(`[1, 2, variable]`)).toEqual(false);
+ expect(isLiteralExpression(`{ param: 0 }`)).toEqual(true);
+ expect(isLiteralExpression(`{ "param": 0 }`)).toEqual(true);
+ expect(isLiteralExpression(`{ param: variable }`)).toEqual(false);
+ expect(isLiteralExpression(`{ ["param"]: 0 }`)).toEqual(true);
+ expect(isLiteralExpression(`{ [variable]: 0 }`)).toEqual(false);
+});
+
test("optionally transpile all member expressions into optional chaining", () => {
expect(validateExpression(`a.b["c"][1]`, { optional: true })).toEqual(
`a?.b?.["c"]?.[1]`
diff --git a/packages/react-sdk/src/expression.ts b/packages/react-sdk/src/expression.ts
index 9150939dc1..1af14f35ab 100644
--- a/packages/react-sdk/src/expression.ts
+++ b/packages/react-sdk/src/expression.ts
@@ -168,6 +168,43 @@ export const validateExpression = (
});
};
+const isLiteralNode = (node: Node): boolean => {
+ if (node.type === "Literal") {
+ return true;
+ }
+ if (node.type === "ArrayExpression") {
+ return (node.elements as Node[]).every(isLiteralNode);
+ }
+ if (node.type === "ObjectExpression") {
+ return node.properties.every((property) => {
+ const key = property.key as Node;
+ const isIdentifierKey =
+ key.type === "Identifier" && property.computed === false;
+ const isLiteralKey = key.type === "Literal";
+ return (
+ (isLiteralKey || isIdentifierKey) &&
+ isLiteralNode(property.value as Node)
+ );
+ });
+ }
+ return false;
+};
+
+/**
+ * check whether provided expression is a literal value
+ * like "", 0 or { param: "value" }
+ * which does not depends on any variable
+ */
+export const isLiteralExpression = (expression: string) => {
+ try {
+ const node = jsep(expression) as Node;
+ return isLiteralNode(node);
+ } catch {
+ // treat invalid expression as non-literal
+ return false;
+ }
+};
+
const dataSourceVariablePrefix = "$ws$dataSource$";
// data source id is generated with nanoid which has "-" in alphabeta
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 8599fa6d75..06bd45fa62 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -17,12 +17,7 @@ export {
export * from "./embed-template";
export * from "./props";
export * from "./context";
-export {
- validateExpression,
- encodeDataSourceVariable,
- decodeDataSourceVariable,
- executeExpression,
-} from "./expression";
+export * from "./expression";
export { getIndexesWithinAncestors } from "./instance-utils";
export * from "./hook";
export { generateUtilsExport } from "./generator";