chore: update return type for send and batch-send to also return the error

Author: borisnliscool

Cargo.lock

@@ -80,7 +80,7 @@ diesel migration run
 - [x] Templating engine
     - [ ] Component system
     - [ ] i18n
-    - [ ] simple if and for logic
+    - [x] simple if and for logic
 - API Routes
     - [x] Sending mail
         - [x] Send to mailing list

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "meel"
-version = "0.0.5"
+version = "0.0.6"
 edition = "2021"
 
 [dependencies]

backend/Cargo.toml

@@ -9,9 +9,9 @@ use std::sync::Arc;
 use std::time::SystemTime;
 
 use crate::database::models::{Mail, NewMail};
+use crate::templating::TemplateDataMap;
 use crate::utils::api_error::{ApiError, ApiErrorCode};
 use crate::{database, templating, utils};
-use crate::templating::TemplateDataMap;
 
 #[derive(Deserialize)]
 pub struct SendMailRequest {
@@ -126,7 +126,8 @@ pub async fn send_mail(
         // Setting allow_html to true here is a bit of a hack, as if we don't it will replace spaces
         // and special characters with html equivalents, which we don't want.
         true,
-    ).map_err(|err| {
+    )
+    .map_err(|err| {
         ApiError::new(
             StatusCode::BAD_REQUEST,
             ApiErrorCode::Unknown,
@@ -180,15 +181,23 @@ pub async fn send_mail(
 pub async fn send_mails(
     pool: Extension<Arc<database::ConnectionPool>>,
     Json(payload): Json<Vec<SendMailRequest>>,
-) -> Result<Json<Vec<SendMailResponse>>, ApiError> {
-    let mut mails: Vec<Mail> = vec![];
+) -> Result<Json<Vec<Result<SendMailResponse, ApiError>>>, ApiError> {
+    let mut mails: Vec<Result<Mail, ApiError>> = vec![];
 
     for mail_payload in payload {
-        let created_mail = send_mail(pool.clone(), mail_payload).await?;
+        let created_mail = send_mail(pool.clone(), mail_payload).await;
         mails.push(created_mail);
     }
 
-    Ok(Json(mails.into_iter().map(SendMailResponse::new).collect()))
+    Ok(Json(
+        mails
+            .into_iter()
+            .map(|mail| match mail {
+                Ok(mail) => Ok(SendMailResponse::new(mail)),
+                Err(err) => Err(err),
+            })
+            .collect(),
+    ))
 }
 
 pub async fn get_mail_status(

backend/src/routes/mails.rs

@@ -11,9 +11,9 @@ pub enum ApiErrorCode {
     NotFound,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Serialize)]
 pub struct ApiError {
-    pub status_code: StatusCode,
+    pub status_code: u16,
     pub error_code: ApiErrorCode,
     pub message: String,
     pub details: HashMap<String, String>,
@@ -22,7 +22,7 @@ pub struct ApiError {
 impl ApiError {
     pub fn new(status_code: StatusCode, error_code: ApiErrorCode, message: String, details: HashMap<String, String>) -> Self {
         Self {
-            status_code,
+            status_code: status_code.as_u16(),
             error_code,
             message,
             details,
@@ -33,12 +33,13 @@ impl ApiError {
 impl IntoResponse for ApiError {
     fn into_response(self) -> Response {
         let body = json!({
-            "status_code": self.status_code.as_u16(),
+            "status_code": self.status_code,
             "error_code": self.error_code,
             "message": self.message,
             "details": self.details
         });
 
-        (self.status_code, body.to_string()).into_response()
+        // this unwrap should be safe, as we have a valid status code
+        (StatusCode::from_u16(self.status_code).unwrap(), body.to_string()).into_response()
     }
 }

backend/src/utils/api_error.rs

@@ -1,7 +1,7 @@
 {
 	"name": "meel",
 	"description": "Typescript wrapper for the Meel project",
-	"version": "0.0.12",
+	"version": "0.0.13",
 	"author": {
 		"name": "borisnliscool",
 		"url": "https://github.com/borisnliscool"
@@ -20,7 +20,8 @@
 		"build": "rimraf dist && bun build.ts",
 		"prepublish": "bun run build",
 		"lint": "bun run prettier src/ --check && bun run eslint",
-		"format": "bun run prettier . --write"
+		"format": "bun run prettier . --write",
+		"test": "bun test"
 	},
 	"peerDependencies": {
 		"typescript": "^5.0.0"

sdk/node/package.json

@@ -1,11 +1,22 @@
+export interface MeelErrorConstructor {
+	status_code: number;
+	error_code: number;
+	message: string;
+	details: object;
+}
+
 export class MeelError extends Error {
 	public readonly message: string;
 	public readonly code: number;
+	public readonly details: object;
+	public readonly error_code: number;
 
-	public constructor(message: string, code: number) {
-		super(message);
-		this.message = message;
-		this.code = code;
+	public constructor(data: MeelErrorConstructor) {
+		super(data.message);
+		this.message = data.message;
+		this.code = data.status_code;
+		this.details = data.details;
+		this.error_code = data.error_code;
 	}
 
 	public toString(): string {

sdk/node/src/classes/meel-error.ts

@@ -1,6 +1,6 @@
-import Try from '@borisnl/tried';
+import { Try } from '@borisnl/tried';
 import ky from 'ky';
-import { Meel, MeelError, SentMeel, SentMeelConstructor } from '.';
+import { Meel, MeelError, MeelErrorConstructor, SentMeel, SentMeelConstructor } from '.';
 
 /**
  * MeelSender is a class that sends Meel instances to a specified base url.
@@ -36,7 +36,7 @@ export class MeelSender {
 	 * @return {Promise<SentMeel>} SentMeel instance
 	 * @throws {MeelError} If the mail could not be sent
 	 */
-	public async send(mail: Meel): Promise<SentMeel> {
+	public async send(mail: Meel): Promise<(SentMeel | MeelError)> {
 		return this.batchSend([mail]).then(data => data[0]);
 	}
 
@@ -47,10 +47,14 @@ export class MeelSender {
 	 * @returns {Promise<SentMeel>} SentMeel instance
 	 * @throws {MeelError} If the mail could not be sent
 	 */
-	public async batchSend(mails: Meel[]): Promise<SentMeel[]> {
+	public async batchSend(mails: Meel[]): Promise<(SentMeel | MeelError)[]> {
 		const response = await Try(() =>
 			ky
-				.post<SentMeelConstructor[]>(`${this.baseUrl}/mails/send`, {
+				.post<({
+					Ok: SentMeelConstructor
+				} | {
+					Err: MeelErrorConstructor
+				})[]>(`${this.baseUrl}/mails/send`, {
 					body: JSON.stringify(
 						mails.map(mail => mail.toPlainObject()),
 					),
@@ -62,9 +66,14 @@ export class MeelSender {
 		);
 
 		if (!response) {
-			throw new MeelError('Failed to send mail', 500);
+			throw new MeelError({
+				status_code: 500,
+				error_code: 0,
+				message: 'Failed to send mail',
+				details: {},
+			});
 		}
 
-		return response.map((data: SentMeelConstructor) => new SentMeel(data));
+		return response.map((data) => ('Ok' in data) ? new SentMeel(data.Ok) : new MeelError(data.Err));
 	}
 }

sdk/node/src/classes/meel-sender.ts

@@ -0,0 +1,22 @@
+import { test, expect } from "bun:test";
+
+import { Meel, MeelSender, SentMeel } from '../src';
+
+const baseUrl = 'http://localhost:8080'
+
+test('send email', async () => {
+	const sender = new MeelSender({ baseUrl });
+
+	const meel = new Meel({
+		subject: "Hello world",
+		recipient: "Boris <boris@example.com>",
+		sender: "me@example.com",
+		template: "test",
+		data: {
+			names: ["john doe", "jane doe"],
+			redacted: false
+		},
+	});
+
+	expect(await sender.send(meel)).toBeInstanceOf(SentMeel)
+})