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
Add scope utility for code generation (#2267)
Bogdan Chadkine8c2da7da460
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsxindex 73f3ecfe87..07fed86125 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx@@ -5,24 +5,24 @@ import * as sdk from "@webstudio-is/react-sdk";import type { PageData } from "~/routes/_index";import type { Components } from "@webstudio-is/react-sdk";import type { Asset } from "@webstudio-is/sdk";-import {- Body as Body_0,- Heading as Heading_0,- Box as Box_0,- Paragraph as Paragraph_0,- Image as Image_0,+ Body as Body,+ Heading as Heading,+ Box as Box,+ Paragraph as Paragraph,+ Image as Image,} from "@webstudio-is/sdk-components-react";+import * as remixComponents from "@webstudio-is/sdk-components-react-remix";export const components = new Map(Object.entries(Object.assign({- Body: Body_0,- Heading: Heading_0,- Box: Box_0,- Paragraph: Paragraph_0,- Image: Image_0,+ Body: Body,+ Heading: Heading,+ Box: Box,+ Paragraph: Paragraph,+ Image: Image,},remixComponents)diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex 80a2a41baa..9d53f393c1 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -17,7 +17,7 @@ import type {DataSource,Deployment,} from "@webstudio-is/sdk";-import { findTreeInstanceIds } from "@webstudio-is/sdk";+import { createScope, findTreeInstanceIds } from "@webstudio-is/sdk";import type { Asset, FontAsset } from "@webstudio-is/sdk";import type { Data } from "@webstudio-is/http-client";import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";@@ -284,11 +284,32 @@ export const prebuild = async (options: {spinner.text = "Generating routes and pages";for (const [pathName, pageComponents] of Object.entries(componentsByPage)) {+ const scope = createScope([+ // manually maintained list of occupied identifiers+ "sdk",+ "PageData",+ "Components",+ "Asset",+ "remixComponents",+ "components",+ "fontAssets",+ "pageData",+ "user",+ "projectId",+ "indexesWithinAncestors",+ "rawExecuteComputingExpressions",+ "executeComputingExpressions",+ "generatedEffectfulExpressions",+ "rawExecuteEffectfulExpression",+ "executeEffectfulExpression",+ "utils",+ ]);const components = Array.from(pageComponents);- const namespaces = new Map<string, Set<string>>();+ const namespaces = new Map<+ string,+ Set<[importName: string, componentName: string]>+ >();const DEFAULT_NAMESPACE = "@webstudio-is/sdk-components-react";- let namespaceId = 0;- const namespaceToId = new Map<string, number>();for (const component of components) {const nameArr = component.split(":");@@ -296,44 +317,33 @@ export const prebuild = async (options: {nameArr.length === 1 ? [undefined, nameArr[0]] : nameArr;if (namespaces.has(namespace ?? DEFAULT_NAMESPACE) === false) {- namespaces.set(namespace ?? DEFAULT_NAMESPACE, new Set<string>());- namespaceToId.set(namespace ?? DEFAULT_NAMESPACE, namespaceId);- namespaceId++;+ namespaces.set(+ namespace ?? DEFAULT_NAMESPACE,+ new Set<[importName: string, componentName: string]>()+ );}- namespaces.get(namespace ?? DEFAULT_NAMESPACE)?.add(name);+ namespaces.get(namespace ?? DEFAULT_NAMESPACE)?.add([name, component]);}let componentImports = "";let assignComponent = "";for (const [namespace, componentsSet] of namespaces.entries()) {- componentImports = `${componentImports}-import { ${Array.from(componentsSet)+ const specifiers = Array.from(componentsSet).map(- (component) =>- `${component} as ${component}_${namespaceToId.get(namespace)}`+ ([importName, component]) =>+ `${component} as ${scope.getName(component, importName)}`)- .join(", ")} } from "${namespace}";`;-- if (namespace === DEFAULT_NAMESPACE) {- assignComponent = `${assignComponent}- ${Array.from(componentsSet)- .map(- (component) =>- `"${component}": ${component}_${namespaceToId.get(namespace)}`- )- .join(",")},`;- } else {- assignComponent = `${assignComponent}- ${Array.from(componentsSet)- .map(- (component) =>- `"${namespace}:${component}": ${component}_${namespaceToId.get(- namespace- )}`- )- .join(",")},`;- }+ .join(", ");+ componentImports += `import { ${specifiers} } from "${namespace}";\n`;++ const fields = Array.from(componentsSet)+ .map(+ ([importName, component]) =>+ `"${component}": ${scope.getName(component, importName)}`+ )+ .join(",");+ assignComponent += `${fields},\n`;}const pageData = siteDataByPage[pathName];diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.tsindex 0457309fec..ae74815db0 100644--- a/packages/sdk/src/index.ts+++ b/packages/sdk/src/index.ts@@ -10,3 +10,4 @@ export * from "./schema/styles";export * from "./schema/deployment";export * from "./instances-utils";+export * from "./scope";diff --git a/packages/sdk/src/scope.test.ts b/packages/sdk/src/scope.test.tsnew file mode 100644index 0000000000..02d79bb124--- /dev/null+++ b/packages/sdk/src/scope.test.ts@@ -0,0 +1,17 @@+import { expect, test } from "@jest/globals";+import { createScope } from "./scope";++test("use variable name for specific id and suffix on collision", () => {+ const scope = createScope();+ expect(scope.getName("1", "myName")).toEqual("myName");+ expect(scope.getName("2", "myName")).toEqual("myName_1");+ // reuse already cached one+ expect(scope.getName("1", "myName")).toEqual("myName");+});++test("allow to predefine already occupied identifiers", () => {+ const scope = createScope(["myName", "anotherName"]);+ expect(scope.getName("1", "myName")).toEqual("myName_1");+ expect(scope.getName("2", "anotherName")).toEqual("anotherName_1");+ expect(scope.getName("3", "newName")).toEqual("newName");+});diff --git a/packages/sdk/src/scope.ts b/packages/sdk/src/scope.tsnew file mode 100644index 0000000000..d80c74b30e--- /dev/null+++ b/packages/sdk/src/scope.ts@@ -0,0 +1,42 @@+export type Scope = {+ /**+ * Accepts unique id to identify specific variable+ * and preferred name to use it as variable name+ * or suffix if already used.+ */+ getName(id: string, preferredName: string): string;+};++/**+ * Utility to maintain unique variable when generate code.+ * Single scope is shared for generated module for simplicity.+ *+ * occupiedIdentifiers parameter prevents collision with hardcoded+ * identifiers.+ */+export const createScope = (occupiedIdentifiers: string[] = []): Scope => {+ const freeIndexByPreferredName = new Map<string, number>();+ const scopedNameByIdMap = new Map<string, string>();+ for (const identifier of occupiedIdentifiers) {+ freeIndexByPreferredName.set(identifier, 1);+ }++ const getName = (id: string, preferredName: string) => {+ const cachedName = scopedNameByIdMap.get(id);+ if (cachedName !== undefined) {+ return cachedName;+ }+ const index = freeIndexByPreferredName.get(preferredName);+ freeIndexByPreferredName.set(preferredName, (index ?? 0) + 1);+ let scopedName = preferredName;+ if (index !== undefined) {+ scopedName = `${preferredName}_${index}`;+ }+ scopedNameByIdMap.set(id, scopedName);+ return scopedName;+ };++ return {+ getName,+ };+};