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: avoid generating unused variables in page components (#2906)

Bogdan Chadkin4c20e2d31793
diff --git a/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx b/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx
index ef530a4639..ae2f7420e6 100644
--- a/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx
+++ b/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx
@@ -57,7 +57,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body
data-ws-id="LW98_-srDnnagkR10lsk4"
diff --git a/fixtures/webstudio-custom-template/app/__generated__/_index.tsx b/fixtures/webstudio-custom-template/app/__generated__/_index.tsx
index 67ea92148e..bf8de4d47e 100644
--- a/fixtures/webstudio-custom-template/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-custom-template/app/__generated__/_index.tsx
@@ -57,7 +57,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body
data-ws-id="ibXgMoi9_ipHx1gVrvii0"
diff --git a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx
index c6caa53d5d..429dda32b3 100644
--- a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx
@@ -41,7 +41,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body
data-ws-id="MMimeobf_zi4ZkRGXapju"
diff --git a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx
index c6caa53d5d..429dda32b3 100644
--- a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx
@@ -41,7 +41,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body
data-ws-id="MMimeobf_zi4ZkRGXapju"
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
index 0d8bb431a7..97dab0e457 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx
@@ -76,7 +76,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body data-ws-id="EDEfpMPRqDejthtwkH7ws" data-ws-component="Body">
<Image
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx
index 70c05fe94d..af8029282c 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx
@@ -85,7 +85,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
let [formState, set$formState] = useState<any>("initial");
let [formState_1, set$formState_1] = useState<any>("initial");
return (
@@ -93,13 +93,13 @@ const Page = ({ params: PageParams }: { params: any }) => {
<Form
data-ws-id="-1RvizaBcVpHsjvnYxn1c"
data-ws-component="Form"
- state={formState_1}
+ state={formState}
onStateChange={(state: any) => {
- formState_1 = state;
- set$formState_1(formState_1);
+ formState = state;
+ set$formState(formState);
}}
>
- {(formState_1 === "initial" || formState_1 === "error") && (
+ {(formState === "initial" || formState === "error") && (
<Box data-ws-id="qhnVrmYGlyrMZi3UzqSQA" data-ws-component="Box">
<Heading
data-ws-id="YdHHf4u3jrdbRIWpB_VfH"
@@ -132,12 +132,12 @@ const Page = ({ params: PageParams }: { params: any }) => {
</Button>
</Box>
)}
- {formState_1 === "success" && (
+ {formState === "success" && (
<Box data-ws-id="966cjxuqP_T99N27-mqWE" data-ws-component="Box">
{"Thank you for getting in touch!"}
</Box>
)}
- {formState_1 === "error" && (
+ {formState === "error" && (
<Box data-ws-id="SYG5hhOz31xFJUN_v9zq6" data-ws-component="Box">
{"Sorry, something went wrong."}
</Box>
@@ -146,15 +146,15 @@ const Page = ({ params: PageParams }: { params: any }) => {
<Form
data-ws-id="isNSM3wXcnHFikwNPlEOL"
data-ws-component="Form"
- state={formState}
+ state={formState_1}
onStateChange={(state: any) => {
- formState = state;
- set$formState(formState);
+ formState_1 = state;
+ set$formState_1(formState_1);
}}
method={"get"}
action={"/custom"}
>
- {(formState === "initial" || formState === "error") && (
+ {(formState_1 === "initial" || formState_1 === "error") && (
<Box data-ws-id="a5YPRc19IJyhTrjjasA_R" data-ws-component="Box">
<Heading
data-ws-id="y4pceTmziuBRIDgUBQNLD"
@@ -187,12 +187,12 @@ const Page = ({ params: PageParams }: { params: any }) => {
</Button>
</Box>
)}
- {formState === "success" && (
+ {formState_1 === "success" && (
<Box data-ws-id="Gw-ta0R4FNFAGBTVRWKep" data-ws-component="Box">
{"Thank you for getting in touch!"}
</Box>
)}
- {formState === "error" && (
+ {formState_1 === "error" && (
<Box data-ws-id="ewk_WKpu4syHLPABMmvUz" data-ws-component="Box">
{"Sorry, something went wrong."}
</Box>
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx
index 9a5fb96785..5354900b4a 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx
@@ -76,7 +76,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body data-ws-id="O-ljaGZQ0iRNTlEshMkgE" data-ws-component="Body">
<Heading
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx
index 4d98dc6d27..efd15b511e 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx
@@ -76,7 +76,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body data-ws-id="L0ZXd5F9xk9Rsl9ORzIkJ" data-ws-component="Body">
<Heading data-ws-id="VFPjLwt6Caq4l9PPJSiyI" data-ws-component="Heading">
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx
index 0ff2cd4629..b8103dc4d0 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx
@@ -88,7 +88,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
let [accordionValue, set$accordionValue] = useState<any>("0");
return (
<Body data-ws-id="uKWGyE9JY3cPwY-xI9vk6" data-ws-component="Body">
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx
index 6b0b96baed..0edd481245 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx
@@ -79,7 +79,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
let list = useResource("list_1");
return (
<Body data-ws-id="AWY2qZfpbykoiWELeJhse" data-ws-component="Body">
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
index afce23e18f..f775349027 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
@@ -91,7 +91,7 @@ export const getPageMeta = ({
};
};
-const Page = ({ params: PageParams }: { params: any }) => {
+const Page = ({}: { params: any }) => {
return (
<Body
data-ws-id="On9cvWCxr5rdZtY9O1Bv0"
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index 1f1c290484..1dc372d446 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -527,7 +527,7 @@ export const prebuild = async (options: {
const pageComponent = generateWebstudioComponent({
scope,
name: "Page",
- rootInstanceId: pageData.page.rootInstanceId,
+ rootInstanceId,
parameters: [
{
id: `params`,
diff --git a/packages/react-sdk/src/component-generator.test.ts b/packages/react-sdk/src/component-generator.test.ts
index e3ffdf4bcf..33baa80919 100644
--- a/packages/react-sdk/src/component-generator.test.ts
+++ b/packages/react-sdk/src/component-generator.test.ts
@@ -17,6 +17,9 @@ import {
const clear = (input: string) =>
stripIndent(input).trimStart().replace(/ +$/, "");
+const toMap = <T extends { id: string }>(list: T[]) =>
+ new Map(list.map((item) => [item.id, item] as const));
+
const createInstance = (
id: Instance["id"],
component: string,
@@ -853,3 +856,73 @@ test("generate resources loading", () => {
`)
);
});
+
+test("avoid generating unused variables", () => {
+ expect(
+ generateWebstudioComponent({
+ classesMap: new Map(),
+ scope: createScope(),
+ name: "Page",
+ rootInstanceId: "body",
+ parameters: [
+ {
+ id: "pathParamsPropId",
+ type: "parameter",
+ instanceId: "",
+ name: "params",
+ value: "unusedParameterId",
+ },
+ ],
+
+ instances: new Map([createInstancePair("body", "Body", [])]),
+ dataSources: toMap([
+ {
+ id: "usedVariableId",
+ scopeInstanceId: "body",
+ name: "Used Variable Name",
+ type: "variable",
+ value: { type: "string", value: "initial" },
+ },
+ {
+ id: "unusedVariableId",
+ scopeInstanceId: "body",
+ name: "Unused Variable Name",
+ type: "variable",
+ value: { type: "string", value: "initial" },
+ },
+ {
+ id: "unusedParameterId",
+ scopeInstanceId: "body",
+ name: "Unused Parameter Name",
+ type: "parameter",
+ },
+ {
+ id: "unusedResourceVariableId",
+ scopeInstanceId: "body",
+ name: "Unused Resource Name",
+ type: "resource",
+ resourceId: "resourceId",
+ },
+ ]),
+ props: toMap([
+ {
+ id: "propId",
+ instanceId: "body",
+ name: "data-data",
+ type: "expression",
+ value: "$ws$dataSource$usedVariableId",
+ },
+ ]),
+ indexesWithinAncestors: new Map(),
+ })
+ ).toMatchInlineSnapshot(`
+"const Page = ({ }: { params: any; }) => {
+let [UsedVariableName, set$UsedVariableName] = useState<any>("initial")
+return <Body
+data-ws-id="body"
+data-ws-component="Body"
+data-data={UsedVariableName} />
+}
+"
+`);
+});
diff --git a/packages/react-sdk/src/component-generator.ts b/packages/react-sdk/src/component-generator.ts
index 952b6806cb..35490db1a1 100644
--- a/packages/react-sdk/src/component-generator.ts
+++ b/packages/react-sdk/src/component-generator.ts
@@ -32,10 +32,12 @@ const generateAction = ({
scope,
prop,
dataSources,
+ usedDataSources,
}: {
scope: Scope;
prop: Extract<Prop, { type: "action" }>;
dataSources: DataSources;
+ usedDataSources?: DataSources;
}) => {
const setters = new Set<DataSource>();
// important to fallback to empty argumets to render empty function
@@ -53,6 +55,7 @@ const generateAction = ({
const depId = decodeDataSourceVariable(identifier);
const dep = depId ? dataSources.get(depId) : undefined;
if (dep) {
+ usedDataSources?.set(dep.id, dep);
if (assignee) {
setters.add(dep);
}
@@ -88,10 +91,12 @@ const generatePropValue = ({
scope,
prop,
dataSources,
+ usedDataSources,
}: {
scope: Scope;
prop: Prop;
dataSources: DataSources;
+ usedDataSources?: DataSources;
}) => {
// ignore asset and page props which are handled by components internally
if (prop.type === "asset" || prop.type === "page") {
@@ -112,6 +117,7 @@ const generatePropValue = ({
if (dataSource === undefined) {
return;
}
+ usedDataSources?.set(dataSource.id, dataSource);
return scope.getName(dataSource.id, dataSource.name);
}
// inline expression to safely use collection item
@@ -119,11 +125,12 @@ const generatePropValue = ({
return generateExpression({
expression: prop.value,
dataSources,
+ usedDataSources,
scope,
});
}
if (prop.type === "action") {
- return generateAction({ scope, prop, dataSources });
+ return generateAction({ scope, prop, dataSources, usedDataSources });
}
prop satisfies never;
};
@@ -133,6 +140,7 @@ export const generateJsxElement = ({
instance,
props,
dataSources,
+ usedDataSources,
indexesWithinAncestors,
children,
classesMap,
@@ -141,6 +149,7 @@ export const generateJsxElement = ({
instance: Instance;
props: Props;
dataSources: DataSources;
+ usedDataSources?: DataSources;
indexesWithinAncestors: IndexesWithinAncestors;
children: string;
classesMap?: Map<string, Array<string>>;
@@ -166,7 +175,12 @@ export const generateJsxElement = ({
if (prop.instanceId !== instance.id) {
continue;
}
- const propValue = generatePropValue({ scope, prop, dataSources });
+ const propValue = generatePropValue({
+ scope,
+ prop,
+ dataSources,
+ usedDataSources,
+ });
// show prop controls conditional rendering and need to be handled separately
if (prop.name === showAttribute) {
// prevent generating unnecessary condition
@@ -253,6 +267,7 @@ export const generateJsxChildren = ({
instances,
props,
dataSources,
+ usedDataSources,
indexesWithinAncestors,
classesMap,
}: {
@@ -261,6 +276,7 @@ export const generateJsxChildren = ({
instances: Instances;
props: Props;
dataSources: DataSources;
+ usedDataSources?: DataSources;
indexesWithinAncestors: IndexesWithinAncestors;
classesMap?: Map<string, Array<string>>;
}) => {
@@ -295,6 +311,7 @@ export const generateJsxChildren = ({
instance,
props,
dataSources,
+ usedDataSources,
indexesWithinAncestors,
classesMap,
children: generateJsxChildren({
@@ -304,6 +321,7 @@ export const generateJsxChildren = ({
instances,
props,
dataSources,
+ usedDataSources,
indexesWithinAncestors,
}),
});
@@ -339,17 +357,39 @@ export const generateWebstudioComponent = ({
if (instance === undefined) {
return "";
}
+
+ const usedDataSources: DataSources = new Map();
+ const generatedJsx = generateJsxElement({
+ scope,
+ instance,
+ props,
+ dataSources,
+ usedDataSources,
+ indexesWithinAncestors,
+ classesMap,
+ children: generateJsxChildren({
+ scope,
+ children: instance.children,
+ instances,
+ props,
+ dataSources,
+ usedDataSources,
+ indexesWithinAncestors,
+ classesMap,
+ }),
+ });
+
let generatedProps = "";
if (parameters.length > 0) {
let generatedPropsValue = "{ ";
let generatedPropsType = "{ ";
for (const parameter of parameters) {
- const dataSource = dataSources.get(parameter.value);
- if (dataSource === undefined) {
- continue;
+ const dataSource = usedDataSources.get(parameter.value);
+ // always generate type and avoid generating value when unused
+ if (dataSource) {
+ const valueName = scope.getName(dataSource.id, dataSource.name);
+ generatedPropsValue += `${parameter.name}: ${valueName}, `;
}
- const valueName = scope.getName(dataSource.id, dataSource.name);
- generatedPropsValue += `${parameter.name}: ${valueName}, `;
generatedPropsType += `${parameter.name}: any; `;
}
generatedPropsValue += `}`;
@@ -358,7 +398,7 @@ export const generateWebstudioComponent = ({
}
let generatedDataSources = "";
- for (const dataSource of dataSources.values()) {
+ for (const dataSource of usedDataSources.values()) {
if (dataSource.type === "variable") {
const valueName = scope.getName(dataSource.id, dataSource.name);
const setterName = scope.getName(
@@ -382,24 +422,6 @@ export const generateWebstudioComponent = ({
}
}
- const generatedJsx = generateJsxElement({
- scope,
- instance,
- props,
- dataSources,
- indexesWithinAncestors,
- classesMap,
- children: generateJsxChildren({
- scope,
- children: instance.children,
- instances,
- props,
- dataSources,
- indexesWithinAncestors,
- classesMap,
- }),
- });
-
let generatedComponent = "";
generatedComponent += `const ${name} = (${generatedProps}) => {\n`;
generatedComponent += `${generatedDataSources}`;