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: make resources universal (#2710)

Bogdan Chadkin842c017c115f
diff --git a/fixtures/webstudio-custom-template/app/__generated__/_index.server.tsx b/fixtures/webstudio-custom-template/app/__generated__/_index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-custom-template/app/__generated__/_index.server.tsx
+++ b/fixtures/webstudio-custom-template/app/__generated__/_index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.server.tsx b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.server.tsx
+++ b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.server.tsx b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.server.tsx
+++ b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.server.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.server.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.server.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.server.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.server.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.server.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.server.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.server.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.server.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.server.tsx
index 7603eccb9c..05e605bec5 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.server.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.server.tsx
@@ -1,5 +1,4 @@
type Params = Record<string, string | undefined>;
export const loadResources = async (_props: { params: Params }) => {
- const [] = await Promise.all([]);
return {} as Record<string, unknown>;
};
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index a7934b7d78..b16be6630b 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -305,18 +305,22 @@ export const prebuild = async (options: {
}
}
+ const resourceIds = new Set<Resource["id"]>();
for (const [dataSourceId, dataSource] of siteData.build.dataSources) {
if (
dataSource.scopeInstanceId === undefined ||
pageInstanceSet.has(dataSource.scopeInstanceId)
) {
dataSources.push([dataSourceId, dataSource]);
+ if (dataSource.type === "resource") {
+ resourceIds.add(dataSource.resourceId);
+ }
}
}
const resources: [Resource["id"], Resource][] = [];
for (const [resourceId, resource] of siteData.build.resources ?? []) {
- if (pageInstanceSet.has(resource.instanceId)) {
+ if (resourceIds.has(resourceId)) {
resources.push([resourceId, resource]);
}
}
diff --git a/packages/react-sdk/src/resources-generator.test.ts b/packages/react-sdk/src/resources-generator.test.ts
index b50278aec5..5936d6442b 100644
--- a/packages/react-sdk/src/resources-generator.test.ts
+++ b/packages/react-sdk/src/resources-generator.test.ts
@@ -9,7 +9,7 @@ const clear = (input: string) =>
const toMap = <T extends { id: string }>(list: T[]) =>
new Map(list.map((item) => [item.id, item] as const));
-test("generate getjson resource loader", () => {
+test("generate resources loader", () => {
expect(
generateResourcesLoader({
scope: createScope(),
@@ -19,47 +19,47 @@ test("generate getjson resource loader", () => {
id: "variableResourceId",
scopeInstanceId: "body",
type: "resource",
- name: "resourceName",
+ name: "variableName",
resourceId: "resourceId",
},
]),
resources: toMap([
{
id: "resourceId",
- instanceId: "body",
- type: "getjson",
+ name: "resourceName",
url: `"https://my-json.com"`,
+ method: "post",
+ headers: [{ name: "Content-Type", value: `"application/json"` }],
+ body: `{ body: true }`,
},
]),
})
).toEqual(
clear(`
- const _getjson = async (url: string) => {
- const response = await fetch(url)
- if (response.ok) {
- const data = await response.json()
- return data;
- }
- return {
- error: await response.text()
- }
- }
+ import { loadResource } from "@webstudio-is/sdk";
type Params = Record<string, string | undefined>
export const loadResources = async (_props: { params: Params }) => {
const [
- resourceName,
+ variableName,
] = await Promise.all([
- _getjson("https://my-json.com"),
+ loadResource({
+ url: "https://my-json.com",
+ method: "post",
+ headers: [
+ { name: "Content-Type", value: "application/json" },
+ ],
+ body: {body: true},
+ }),
])
return {
- resourceName,
+ variableName,
} as Record<string, unknown>
}
`)
);
});
-test("generate page params variable and use it resources", () => {
+test("generate variable and use in resources loader", () => {
expect(
generateResourcesLoader({
scope: createScope(),
@@ -71,7 +71,73 @@ test("generate page params variable and use it resources", () => {
{
id: "variableResourceId",
scopeInstanceId: "body",
+ name: "variableName",
+ type: "resource",
+ resourceId: "resourceId",
+ },
+ {
+ id: "variableTokenId",
+ scopeInstanceId: "body",
+ name: "Access Token",
+ type: "variable",
+ value: { type: "string", value: "my-token" },
+ },
+ ]),
+ resources: toMap([
+ {
+ id: "resourceId",
name: "resourceName",
+ url: `"https://my-json.com/"`,
+ method: "post",
+ headers: [
+ {
+ name: "Authorization",
+ value: `"Token " + $ws$dataSource$variableTokenId`,
+ },
+ ],
+ body: `{ body: true }`,
+ },
+ ]),
+ })
+ ).toEqual(
+ clear(`
+ import { loadResource } from "@webstudio-is/sdk";
+ type Params = Record<string, string | undefined>
+ export const loadResources = async (_props: { params: Params }) => {
+ let AccessToken = "my-token"
+ const [
+ variableName,
+ ] = await Promise.all([
+ loadResource({
+ url: "https://my-json.com/",
+ method: "post",
+ headers: [
+ { name: "Authorization", value: "Token " + AccessToken },
+ ],
+ body: {body: true},
+ }),
+ ])
+ return {
+ variableName,
+ } as Record<string, unknown>
+ }
+ `)
+ );
+});
+
+test("generate page params variable and use in resources loader", () => {
+ expect(
+ generateResourcesLoader({
+ scope: createScope(),
+ page: {
+ rootInstanceId: "body",
+ pathVariableId: "variableParamsId",
+ } as Page,
+ dataSources: toMap([
+ {
+ id: "variableResourceId",
+ scopeInstanceId: "body",
+ name: "variableName",
type: "resource",
resourceId: "resourceId",
},
@@ -85,34 +151,34 @@ test("generate page params variable and use it resources", () => {
resources: toMap([
{
id: "resourceId",
- instanceId: "body",
- type: "getjson",
+ name: "resourceName",
url: `"https://my-json.com/" + $ws$dataSource$variableParamsId.slug`,
+ method: "post",
+ headers: [{ name: "Content-Type", value: `"application/json"` }],
+ body: `{ body: true }`,
},
]),
})
).toEqual(
clear(`
- const _getjson = async (url: string) => {
- const response = await fetch(url)
- if (response.ok) {
- const data = await response.json()
- return data;
- }
- return {
- error: await response.text()
- }
- }
+ import { loadResource } from "@webstudio-is/sdk";
type Params = Record<string, string | undefined>
export const loadResources = async (_props: { params: Params }) => {
const Pageparams = _props.params
const [
- resourceName,
+ variableName,
] = await Promise.all([
- _getjson("https://my-json.com/" + Pageparams?.slug),
+ loadResource({
+ url: "https://my-json.com/" + Pageparams?.slug,
+ method: "post",
+ headers: [
+ { name: "Content-Type", value: "application/json" },
+ ],
+ body: {body: true},
+ }),
])
return {
- resourceName,
+ variableName,
} as Record<string, unknown>
}
`)
@@ -131,9 +197,6 @@ test("generate empty resources loader", () => {
clear(`
type Params = Record<string, string | undefined>
export const loadResources = async (_props: { params: Params }) => {
- const [
- ] = await Promise.all([
- ])
return {
} as Record<string, unknown>
}
diff --git a/packages/react-sdk/src/resources-generator.ts b/packages/react-sdk/src/resources-generator.ts
index fc739d8028..f1e2be0118 100644
--- a/packages/react-sdk/src/resources-generator.ts
+++ b/packages/react-sdk/src/resources-generator.ts
@@ -1,19 +1,6 @@
import type { DataSources, Page, Resources, Scope } from "@webstudio-is/sdk";
import { generateExpression } from "./expression";
-const getjsonCode = `
-const _getjson = async (url: string) => {
- const response = await fetch(url)
- if (response.ok) {
- const data = await response.json()
- return data;
- }
- return {
- error: await response.text()
- }
-}
-`.trimStart();
-
export const generateResourcesLoader = ({
scope,
page,
@@ -25,55 +12,84 @@ export const generateResourcesLoader = ({
dataSources: DataSources;
resources: Resources;
}) => {
- let generatedStores = "";
+ let generatedVariables = "";
+ let generatedOutput = "";
let generatedLoaders = "";
- let hasGetjson = false;
+ let hasResources = false;
for (const dataSource of dataSources.values()) {
- if (dataSource.type !== "resource") {
- continue;
+ if (dataSource.type === "variable") {
+ const name = scope.getName(dataSource.id, dataSource.name);
+ const value = JSON.stringify(dataSource.value.value);
+ generatedVariables += `let ${name} = ${value}\n`;
}
- const resource = resources.get(dataSource.resourceId);
- if (resource === undefined) {
- continue;
+
+ if (dataSource.type === "parameter") {
+ // support only page path params parameter
+ if (dataSource.id !== page.pathVariableId) {
+ continue;
+ }
+ const name = scope.getName(dataSource.id, dataSource.name);
+ generatedVariables += `const ${name} = _props.params\n`;
}
- // call resource by bound variable name
- const resourceName = scope.getName(resource.id, dataSource.name);
- if (resource.type === "getjson") {
- hasGetjson = true;
+
+ if (dataSource.type === "resource") {
+ const resource = resources.get(dataSource.resourceId);
+ if (resource === undefined) {
+ continue;
+ }
+ hasResources = true;
+ // call resource by bound variable name
+ const resourceName = scope.getName(resource.id, dataSource.name);
+ generatedOutput += `${resourceName},\n`;
+ generatedLoaders += `loadResource({\n`;
const url = generateExpression({
expression: resource.url,
dataSources,
scope,
});
- generatedStores += `${resourceName},\n`;
- generatedLoaders += `_getjson(${url}),\n`;
+ generatedLoaders += `url: ${url},\n`;
+ generatedLoaders += `method: "${resource.method}",\n`;
+ if (resource.headers.length > 0) {
+ generatedLoaders += `headers: [\n`;
+ for (const header of resource.headers) {
+ const value = generateExpression({
+ expression: header.value,
+ dataSources,
+ scope,
+ });
+ generatedLoaders += `{ name: "${header.name}", value: ${value} },\n`;
+ }
+ generatedLoaders += `],\n`;
+ }
+ if (resource.body !== undefined) {
+ const body = generateExpression({
+ expression: resource.body,
+ dataSources,
+ scope,
+ });
+ generatedLoaders += `body: ${body},\n`;
+ }
+ generatedLoaders += `}),\n`;
}
}
- const paramsVariable = page.pathVariableId
- ? dataSources.get(page.pathVariableId)
- : undefined;
- const paramsName = paramsVariable
- ? scope.getName(paramsVariable.id, paramsVariable.name)
- : undefined;
-
let generated = "";
- if (hasGetjson) {
- generated += getjsonCode;
+ if (hasResources) {
+ generated += `import { loadResource } from "@webstudio-is/sdk";\n`;
}
generated += `type Params = Record<string, string | undefined>\n`;
generated += `export const loadResources = async (_props: { params: Params }) => {\n`;
- if (paramsName !== undefined) {
- generated += `const ${paramsName} = _props.params\n`;
+ if (hasResources) {
+ generated += generatedVariables;
+ generated += `const [\n`;
+ generated += generatedOutput;
+ generated += `] = await Promise.all([\n`;
+ generated += generatedLoaders;
+ generated += `])\n`;
}
- generated += `const [\n`;
- generated += generatedStores;
- generated += `] = await Promise.all([\n`;
- generated += generatedLoaders;
- generated += `])\n`;
generated += `return {\n`;
- generated += generatedStores;
+ generated += generatedOutput;
generated += `} as Record<string, unknown>\n`;
generated += `}\n`;
return generated;
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
index 86c6d7998a..82faa124a5 100644
--- a/packages/sdk/src/index.ts
+++ b/packages/sdk/src/index.ts
@@ -12,3 +12,4 @@ export * from "./schema/deployment";
export * from "./instances-utils";
export * from "./scope";
+export * from "./resource-loader";
diff --git a/packages/sdk/src/resource-loader.ts b/packages/sdk/src/resource-loader.ts
new file mode 100644
index 0000000000..c8ffae1ee7
--- /dev/null
+++ b/packages/sdk/src/resource-loader.ts
@@ -0,0 +1,32 @@
+import type { Resource } from "./schema/resources";
+
+export const loadResource = async (resourceData: Resource) => {
+ const { url, method, headers, body } = resourceData;
+ const requestHeaders = new Headers(
+ headers.map(({ name, value }): [string, string] => [name, value])
+ );
+ const requestInit: RequestInit = {
+ method,
+ headers: requestHeaders,
+ };
+ if (method !== "get" && body !== undefined) {
+ requestInit.body = body;
+ }
+ const response = await fetch(url, requestInit);
+ let data;
+ if (
+ response.ok &&
+ // accept json by default and when specified explicitly
+ (requestHeaders.has("accept") === false ||
+ requestHeaders.get("accept") === "application/json")
+ ) {
+ data = await response.json();
+ } else {
+ data = await response.text();
+ }
+ return {
+ data,
+ status: response.status,
+ statusText: response.statusText,
+ };
+};
diff --git a/packages/sdk/src/schema/resources.ts b/packages/sdk/src/schema/resources.ts
index 6a36163242..0c0dc38ae9 100644
--- a/packages/sdk/src/schema/resources.ts
+++ b/packages/sdk/src/schema/resources.ts
@@ -2,19 +2,30 @@ import { z } from "zod";
const ResourceId = z.string();
-export const Resource = z.union([
- // !!! this is prototype only resource type
- // build other resources before exposing to production
- z.object({
- type: z.literal("getjson"),
- id: ResourceId,
- instanceId: z.string(),
- // expression
- url: z.string(),
- }),
- z.never(),
+const Method = z.union([
+ z.literal("get"),
+ z.literal("post"),
+ z.literal("put"),
+ z.literal("delete"),
]);
+const Header = z.object({
+ name: z.string(),
+ // expression
+ value: z.string(),
+});
+
+export const Resource = z.object({
+ id: ResourceId,
+ name: z.string(),
+ method: Method,
+ // expression
+ url: z.string(),
+ headers: z.array(Header),
+ // expression
+ body: z.optional(z.string()),
+});
+
export type Resource = z.infer<typeof Resource>;
export const Resources = z.map(ResourceId, Resource);