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.

fix: support more curl flags (#4750)

Bogdan Chadkin3830b40d2c20
diff --git a/apps/builder/app/builder/features/settings-panel/curl.test.ts b/apps/builder/app/builder/features/settings-panel/curl.test.ts
index f3ee9b22c2..4077554794 100644
--- a/apps/builder/app/builder/features/settings-panel/curl.test.ts
+++ b/apps/builder/app/builder/features/settings-panel/curl.test.ts
@@ -24,6 +24,14 @@ test("support multiline command with backslashes", () => {
});
});
+test("forgive missing closed quotes", () => {
+ expect(parseCurl(`curl "https://my-url/hello-world`)).toEqual({
+ url: "https://my-url/hello-world",
+ method: "get",
+ headers: [],
+ });
+});
+
test("skip when invalid", () => {
expect(parseCurl(``)).toEqual(undefined);
expect(parseCurl(` `)).toEqual(undefined);
@@ -50,6 +58,28 @@ test("support method with --request and -X flags", () => {
).toEqual(result);
});
+test("support --get and -G flags", () => {
+ expect(
+ parseCurl(`curl --get https://my-url --data limit=3 --data first=0`)
+ ).toEqual({
+ url: "https://my-url?limit=3&first=0",
+ method: "get",
+ headers: [],
+ });
+ expect(parseCurl(`curl -G https://my-url -d limit=3 -d first=0`)).toEqual({
+ url: "https://my-url?limit=3&first=0",
+ method: "get",
+ headers: [],
+ });
+ expect(
+ parseCurl(`curl -G https://my-url?filter=1 -d limit=3 -d first=0`)
+ ).toEqual({
+ url: "https://my-url?filter=1&limit=3&first=0",
+ method: "get",
+ headers: [],
+ });
+});
+
test("support headers with --header and -H flags", () => {
expect(
parseCurl(`curl https://my-url/hello-world --header "name: value"`)
@@ -79,34 +109,85 @@ test("support headers with --header and -H flags", () => {
});
});
+test("default to post method and urlencoded header when data is specified", () => {
+ expect(
+ parseCurl(`
+ curl https://my-url \\\
+ -d param=1 \\\
+ --data param=2 \\\
+ --data-ascii param=3 \\\
+ --data-raw param=4
+ `)
+ ).toEqual({
+ url: "https://my-url",
+ method: "post",
+ headers: [
+ { name: "content-type", value: "application/x-www-form-urlencoded" },
+ ],
+ body: `param=1&param=2&param=3&param=4`,
+ });
+});
+
+test("encode data for get request", () => {
+ expect(
+ parseCurl(`curl -G https://my-url --data-urlencode param=привет`)
+ ).toEqual({
+ url: "https://my-url?param=%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82",
+ method: "get",
+ headers: [],
+ });
+});
+
+test("encode data for post request", () => {
+ expect(
+ parseCurl(`curl https://my-url --data-urlencode param=привет`)
+ ).toEqual({
+ url: "https://my-url",
+ method: "post",
+ headers: [
+ { name: "content-type", value: "application/x-www-form-urlencoded" },
+ ],
+ body: `param=%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82`,
+ });
+});
+
test("support text body", () => {
expect(
- parseCurl(`curl https://my-url/hello-world --data '{"param":"value"}'`)
+ parseCurl(`
+ curl https://my-url/hello-world \\
+ -H content-type:plain/text \\
+ --data '{"param":"value"}'
+ `)
).toEqual({
url: "https://my-url/hello-world",
method: "post",
- headers: [],
+ headers: [{ name: "content-type", value: "plain/text" }],
body: `{"param":"value"}`,
});
expect(
- parseCurl(`curl https://my-url/hello-world -d '{"param":"value"}'`)
+ parseCurl(
+ `curl https://my-url/hello-world -H content-type:plain/text -d '{"param":"value"}'`
+ )
).toEqual({
url: "https://my-url/hello-world",
method: "post",
- headers: [],
+ headers: [{ name: "content-type", value: "plain/text" }],
body: `{"param":"value"}`,
});
});
test("support text body with explicit method", () => {
expect(
- parseCurl(
- `curl https://my-url/hello-world -X put --data '{"param":"value"}'`
- )
+ parseCurl(`
+ curl https://my-url/hello-world \\
+ -X put \\
+ -H content-type:plain/text \\
+ --data '{"param":"value"}'
+ `)
).toEqual({
url: "https://my-url/hello-world",
method: "put",
- headers: [],
+ headers: [{ name: "content-type", value: "plain/text" }],
body: `{"param":"value"}`,
});
});
@@ -192,3 +273,16 @@ test("multiline graphql is idempotent", () => {
};
expect(parseCurl(generateCurl(request))).toEqual(request);
});
+
+test("support basic http authentication", () => {
+ expect(parseCurl(`curl https://my-url.com -u "user:password"`)).toEqual({
+ url: "https://my-url.com",
+ method: "get",
+ headers: [
+ {
+ name: "Authorization",
+ value: `Basic ${btoa("user:password")}`,
+ },
+ ],
+ });
+});
diff --git a/apps/builder/app/builder/features/settings-panel/curl.ts b/apps/builder/app/builder/features/settings-panel/curl.ts
index 2238ddc993..40c839b681 100644
--- a/apps/builder/app/builder/features/settings-panel/curl.ts
+++ b/apps/builder/app/builder/features/settings-panel/curl.ts
@@ -29,27 +29,66 @@ export type CurlRequest = Pick<
"url" | "method" | "headers" | "body"
>;
+const encodeSearchParams = (data: string[]) => {
+ return data
+ .map((item) => {
+ if (item.includes("=")) {
+ const [key, value] = item.split("=");
+ return `${key}=${encodeURIComponent(value)}`;
+ }
+ return item;
+ })
+ .join("&");
+};
+
export const parseCurl = (curl: string): undefined | CurlRequest => {
- const argv = tokenizeArgs(curl);
+ const argv = tokenizeArgs(curl, { loose: true });
if (argv.length === 0) {
return;
}
const args = parseArgs(argv, {
alias: {
X: ["request"],
+ G: ["get"],
H: ["header"],
d: ["data"],
+ "data-ascii": ["data"],
+ "data-raw": ["data"],
+ "data-urlencode": ["data"],
+ u: ["user"],
},
- string: ["request", "data"],
- array: ["header", "H"],
+ boolean: ["get", "G"],
+ string: [
+ "request",
+ "X",
+ "data",
+ "d",
+ "data-ascii",
+ "data-raw",
+ "data-urlencode",
+ "user",
+ "u",
+ ],
+ array: [
+ "header",
+ "H",
+ "data",
+ "d",
+ "data-ascii",
+ "data-raw",
+ "data-urlencode",
+ ],
});
// require at least 2 parameters and first is curl command
if (args._.length < 2 || args._[0] !== "curl") {
return;
}
- const [_curl, url] = args._;
+ // curl url
+ let url = args._[1].toString();
const defaultMethod = args.data ? "post" : "get";
- const method = getMethod(args.request ?? defaultMethod);
+ const method: CurlRequest["method"] = args.get
+ ? "get"
+ : getMethod(args.request ?? defaultMethod);
let contentType: undefined | string;
const headers: ResourceRequest["headers"] = (
(args.header as string[]) ?? []
@@ -61,12 +100,29 @@ export const parseCurl = (curl: string): undefined | CurlRequest => {
}
return { name, value };
});
- let body: undefined | unknown = args.data;
- if (args.data && contentType === "application/json") {
- try {
- body = JSON.parse(args.data);
- } catch {
- // empty block
+ if (args.user) {
+ headers.push({ name: "Authorization", value: `Basic ${btoa(args.user)}` });
+ }
+ let body: undefined | unknown;
+ if (args.get && args.data) {
+ const separator = url.includes("?") ? "&" : "?";
+ const search = encodeSearchParams(args.data);
+ url = `${url}${separator}${search}`;
+ } else if (args.data) {
+ body = args.data[0];
+ if (contentType === "application/json") {
+ try {
+ body = JSON.parse(args.data[0]);
+ } catch {
+ // empty block
+ }
+ }
+ if (contentType === undefined) {
+ contentType = "application/x-www-form-urlencoded";
+ headers.push({ name: "content-type", value: contentType });
+ }
+ if (contentType === "application/x-www-form-urlencoded") {
+ body = encodeSearchParams(args.data);
}
}
return {
diff --git a/apps/builder/package.json b/apps/builder/package.json
index a7642fb1d2..ffc3d46c54 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -77,7 +77,7 @@
"@webstudio-is/sdk-components-react-radix": "workspace:*",
"@webstudio-is/template": "workspace:*",
"@webstudio-is/trpc-interface": "workspace:*",
- "args-tokenizer": "^0.1.0",
+ "args-tokenizer": "^0.3.0",
"bcp-47": "^2.1.0",
"change-case": "^5.4.4",
"colord": "^2.9.3",
@@ -114,7 +114,7 @@
"strip-indent": "^4.0.0",
"tiny-invariant": "^1.3.3",
"title-case": "^4.3.2",
- "ultraflag": "^0.1.0",
+ "ultraflag": "^0.2.3",
"untruncate-json": "^0.0.1",
"urlpattern-polyfill": "^10.0.0",
"use-debounce": "^10.0.4",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 411e029c28..b997f46316 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -299,8 +299,8 @@ importers:
specifier: workspace:*
version: link:../../packages/trpc-interface
args-tokenizer:
- specifier: ^0.1.0
- version: 0.1.0
+ specifier: ^0.3.0
+ version: 0.3.0
bcp-47:
specifier: ^2.1.0
version: 2.1.0
@@ -410,8 +410,8 @@ importers:
specifier: ^4.3.2
version: 4.3.2
ultraflag:
- specifier: ^0.1.0
- version: 0.1.0
+ specifier: ^0.2.3
+ version: 0.2.3
untruncate-json:
specifier: ^0.0.1
version: 0.0.1
@@ -5096,8 +5096,8 @@ packages:
resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==}
- resolution: {integrity: sha512-9yDBBeg+2WTmWXJMfdO3efV+VknAL2UlxS7Yxt5e/aYjMW3yDiQhGPuFg+wEuTGN3JxsRL/wjCg0qBDFklyXjw==}
+ resolution: {integrity: sha512-xXAd7G2Mll5W8uo37GETpQ2VrE84M181Z7ugHFGQnJZ50M2mbOv0osSZ9VsSgPfJQ+LVG0prSi0th+ELMsno7Q==}
resolution: {integrity: sha512-RhVWFtKH5BiGMycI72q2RAFMLQi8JP9bLuQXgR5a8Znp7P5KOIADSJeyfI8PCVxLEp067B2HbP5JIiI/PXIZeA==}
@@ -8300,8 +8300,8 @@ packages:
resolution: {integrity: sha512-Y7HYmWaFwPUmkoQCUIAYpKqkOf+SbVj/2fJJZ4RJMCfZp0rTGwRbzQD+HghfnhKOjL9E01okqz+ncJskGYfBNw==}
- resolution: {integrity: sha512-F6J/7SZHkep//Ihd5N63b1ghzBUclZvFuSzsZgurFPS0h0Fj482mNdz8R9REm89ETSPPsPB9eJ3z7E52WkDMQw==}
+ resolution: {integrity: sha512-RC8Q5Y72wbiDfF+LXEaFaF3j+hKt4bU6GJQSuTKJIisNXfviDV3G6UPiC8iKV+idSBshjXZGwoO/2kg7gQvnjQ==}
resolution: {integrity: sha512-XyWQowvP9CKZycKc/Zg9SYWrAWX/gJCE799AUTFqk8yC3tp44K1xWr3LoFF0MNEjClKOo1suCr5ASnoy+KltdA==}
@@ -11827,7 +11827,7 @@ snapshots:
dependencies:
@@ -15615,7 +15615,7 @@ snapshots:
dependencies: