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: drop unused mailchannels form handler (#3347)

Bogdan Chadkin12e00186abca
diff --git a/packages/form-handlers-mailchannels-test/.gitignore b/packages/form-handlers-mailchannels-test/.gitignore
deleted file mode 100644
index f11596098d..0000000000
--- a/packages/form-handlers-mailchannels-test/.gitignore
+++ /dev/null
@@ -1,7 +0,0 @@
-.DS_Store
-/node_modules
-*-lock.*
-*.lock
-*.log
-
-/dist
diff --git a/packages/form-handlers-mailchannels-test/README.md b/packages/form-handlers-mailchannels-test/README.md
deleted file mode 100644
index f27a650fb2..0000000000
--- a/packages/form-handlers-mailchannels-test/README.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# A cloudflare worker to test the `mailchannels` handler from `@webstudio-is/form-handlers` package
-
-We need it because:
-
-As https://blog.cloudflare.com/sending-email-from-workers-with-mailchannels/ says:
-
-> The only constraint currently is that the integration only works when the request comes from a Cloudflare IP address. So it won’t work yet when you are developing on your local machine or running a test on your build server.
-
-So we cannot test mailchannels completely locally, but deploying temporarely via `wrangler dev` works.
-
-To test:
-
-1. `pnpm local-dev`
-2. Open the url in the browser
diff --git a/packages/form-handlers-mailchannels-test/package.json b/packages/form-handlers-mailchannels-test/package.json
deleted file mode 100644
index 2536b77827..0000000000
--- a/packages/form-handlers-mailchannels-test/package.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "name": "@webstudio-is/form-handlers-mailchannels-test",
- "private": true,
- "version": "0.0.0",
- "scripts": {
- "deploy": "wrangler publish src/index.ts",
- "local-dev": "wrangler dev src/index.ts"
- },
- "dependencies": {
- "@webstudio-is/form-handlers": "workspace:*"
- },
- "devDependencies": {
- "@cloudflare/workers-types": "^4.20240405.0",
- "@webstudio-is/tsconfig": "workspace:*",
- "typescript": "5.4.5",
- "wrangler": "^3.48.0"
- }
-}
diff --git a/packages/form-handlers-mailchannels-test/src/index.ts b/packages/form-handlers-mailchannels-test/src/index.ts
deleted file mode 100644
index aeb89d66d9..0000000000
--- a/packages/form-handlers-mailchannels-test/src/index.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import { mailchannelsHandler } from "@webstudio-is/form-handlers";
-
-export default {
- async fetch(request: Request) {
- const url = new URL(request.url);
-
- const to = url.searchParams.get("to");
-
- if (to == null) {
- return new Response(
- `Set "to" query parameter to your email. Example: https://[email protected]`
- );
- }
-
- const formData = new FormData();
- formData.append("ws--form-id", "test-form");
- formData.append("name", "Bob");
- formData.append("time", new Date().toLocaleString("en-US"));
-
- const result = await mailchannelsHandler({
- formInfo: {
- action: "submit",
- method: "post",
- formData,
- projectId: "test-project",
- pageUrl: "https://example.com/some-page",
- toEmail: to,
- fromEmail: "[email protected]",
- },
- });
-
- if (result.success) {
- return new Response(`Email sent to ${to}`);
- }
-
- return new Response(
- `Failed to send email. Errors: ${JSON.stringify(result.errors)}`
- );
- },
-};
diff --git a/packages/form-handlers-mailchannels-test/tsconfig.json b/packages/form-handlers-mailchannels-test/tsconfig.json
deleted file mode 100644
index ea3027c2b3..0000000000
--- a/packages/form-handlers-mailchannels-test/tsconfig.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "extends": "@webstudio-is/tsconfig/base.json",
- "include": ["src"],
- "compilerOptions": {
- "module": "ES2020",
- "target": "ES2020",
- "types": ["@cloudflare/workers-types"]
- }
-}
diff --git a/packages/form-handlers-mailchannels-test/wrangler.toml b/packages/form-handlers-mailchannels-test/wrangler.toml
deleted file mode 100644
index 11bffa90ac..0000000000
--- a/packages/form-handlers-mailchannels-test/wrangler.toml
+++ /dev/null
@@ -1,3 +0,0 @@
-name = "form-handlers-mailchannels-test"
-main = "./src/index.ts"
-compatibility_date = "2022-05-03"
diff --git a/packages/form-handlers/src/index.ts b/packages/form-handlers/src/index.ts
index 01a4e0ea99..27190e8eef 100644
--- a/packages/form-handlers/src/index.ts
+++ b/packages/form-handlers/src/index.ts
@@ -1,10 +1,2 @@
-export {
- formToEmail,
- formIdFieldName,
- formHiddenFieldPrefix,
- getFormId,
- type EmailInfo,
- type FormInfo,
-} from "./shared";
-export { mailchannelsHandler } from "./mailchanels";
+export { formIdFieldName, getFormId } from "./shared";
export { n8nHandler } from "./n8n";
diff --git a/packages/form-handlers/src/mailchanels.ts b/packages/form-handlers/src/mailchanels.ts
deleted file mode 100644
index f19e090d23..0000000000
--- a/packages/form-handlers/src/mailchanels.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-// References:
-// https://api.mailchannels.net/tx/v1/documentation
-// https://github.com/cloudflare/pages-plugins/tree/main/packages/mailchannels
-//
-// To test see `packages/form-handlers-mailchannels-test`
-
-import {
- type FormInfo,
- type Result,
- formToEmail,
- getErrors,
- getResponseBody,
-} from "./shared";
-
-type EmailAddress = {
- email: string;
- name?: string;
-};
-
-type Personalization = {
- to: [EmailAddress, ...EmailAddress[]];
- from?: EmailAddress;
- dkim_domain?: string;
- dkim_private_key?: string;
- dkim_selector?: string;
- reply_to?: EmailAddress;
- cc?: EmailAddress[];
- bcc?: EmailAddress[];
- subject?: string;
- headers?: Record<string, string>;
-};
-
-type ContentItem = {
- type: "text/plain" | "text/html";
- value: string;
-};
-
-type SendEmailPayload = {
- personalizations: [Personalization, ...Personalization[]];
- from: EmailAddress;
- reply_to?: EmailAddress;
- subject: string;
- content: [ContentItem, ...ContentItem[]];
- headers?: Record<string, string>;
-};
-
-const sendEmail = async (payload: SendEmailPayload): Promise<Result> => {
- let response: Response;
- try {
- response = await fetch("https://api.mailchannels.net/tx/v1/send", {
- method: "POST",
- headers: { "Content-Type": "application/json" },
- body: JSON.stringify(payload),
- });
- } catch (error) {
- return { success: false, errors: [(error as Error).message] };
- }
-
- if (response.status >= 200 && response.status < 300) {
- return { success: true };
- }
-
- const { text, json } = await getResponseBody(response);
-
- return { success: false, errors: getErrors(json) ?? [text] };
-};
-
-export const mailchannelsHandler = async ({
- formInfo,
-}: {
- formInfo: FormInfo;
-}) => {
- const email = formToEmail(formInfo);
-
- return sendEmail({
- personalizations: [{ to: [{ email: email.to }] }],
- from: { email: email.from },
- subject: email.subject,
- content: [
- { type: "text/plain", value: email.txt },
- {
- type: "text/html",
- value: `<!DOCTYPE html><html><body>${email.html}</body></html>`,
- },
- ],
- });
-};
diff --git a/packages/form-handlers/src/shared.ts b/packages/form-handlers/src/shared.ts
index a9c37cc7d5..a4de2bb069 100644
--- a/packages/form-handlers/src/shared.ts
+++ b/packages/form-handlers/src/shared.ts
@@ -1,4 +1,4 @@
-export const formHiddenFieldPrefix = "ws--form";
+const formHiddenFieldPrefix = "ws--form";
export const formIdFieldName = `${formHiddenFieldPrefix}-id`;
// Input data common for all handlers
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 985d1eb481..1e3f789c08 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1459,25 +1459,6 @@ importers:
specifier: workspace:*
version: link:../tsconfig
- packages/form-handlers-mailchannels-test:
- dependencies:
- '@webstudio-is/form-handlers':
- specifier: workspace:*
- version: link:../form-handlers
- devDependencies:
- '@cloudflare/workers-types':
- specifier: ^4.20240405.0
- version: 4.20240405.0
- '@webstudio-is/tsconfig':
- specifier: workspace:*
- version: link:../tsconfig
- typescript:
- specifier: 5.4.5
- version: 5.4.5
- wrangler:
- specifier: ^3.48.0
- version: 3.50.0(@cloudflare/[email protected])
-
packages/generate-arg-types:
dependencies:
'@webstudio-is/html-data':
@@ -13941,7 +13922,7 @@ snapshots:
dependencies:
- tslib: 2.6.0
+ tslib: 2.6.2
dependencies: