jdrouet / catapulte Goto Github PK

View Code? Open in Web Editor NEW

137.0 137.0 6.0 1.56 MB

Rust implementation of catapulte email sender

License: GNU Affero General Public License v3.0

Dockerfile 4.92% Shell 0.21% Rust 94.87%

email hacktoberfest mjml smtp template

catapulte's Introduction

Hi there 👋

Who am I?

My name is Jeremie Drouet, a french 🥖 developer.

I'm a 🦀 software engineer @datadog working on Vector.

What I'm working on, on my free time?

mrml: a Rust 🦀 rewrite of mjml that boosts performances.
git-metrics: a git extension to store metrics related to your project, written in Rust 🦀.

Those projects are motivated by the lack of privacy 👀 or the carbon footprint of the existing alternatives 🌍.

With the current climate changes, it's the developer's duty to build lightweight and energy efficient softwares.

Rust is really lightweight compared to NodeJS (look at mrml compared to mjml).

Some thoughs

Thoughts on gitmoji

catapulte's People

Contributors

Stargazers

Watchers

Forkers

usairimisani zmilan ajunlonglive standardgalactic playfloor rustworks

catapulte's Issues

add usage

Update readme to explain how to use the project

allow to use kafka queue to send messages

instead of doing an http request, we should be able to connect to a Kafka queue

The web service always returns 404 when swagger is enabled

allow to use a rabbitmq queue to send messages

Allow `from` and `to` fields to have complex format

For now, when sending an email, the fields to and from can only be emails ([email protected]).
We should be able to handle User <[email protected]> and {"name": "User", "email": "[email protected]"}.

Add license

Put same license than mrml

Connection refused (os error 111)

I'm getting this when trying to run in Docker:

...
[2021-01-22T18:29:26Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:26Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:29Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:29Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:35Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:35Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:48Z ERROR r2d2] Connection refused (os error 111)
[2021-01-22T18:29:48Z ERROR r2d2] Connection refused (os error 111)
thread 'main' panicked at 'smtp service init: PreconditionFailed("couldn\'t create pool")', src/main.rs:68:41
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Panic in Arbiter thread.

Docker Compose file:

  smtp-server:
    container_name: catapulte
    image: jdrouet/catapulte:latest
    environment:
      - SMTP_HOSTNAME=localhost
      - SMTP_PORT=25
      - SMTP_USERNAME=optional
      - SMTP_PASSWORD=optional
      - TEMPLATE_PROVIDER=local
      - TEMPLATE_ROOT=/templates
    ports:
      - 127.0.0.1:3000:3000
    volumes:
    - ./configs/catapulte/templates:/templates:ro

Is this related to We recommend using Docker if you are on a amd64, i386 or arm64v8 architecture?

My machine: Linux pop-os 5.8.0-7630-generic #32~1609193707~20.10~781bb80-Ubuntu SMP Tue Jan 5 21:29:56 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

build and push docker images for each release and merge on main branch

split unit tests from integration tests

Right now, when running the unit tests, some tests need the smtp server to be up and running. This should be split.

create a prometheus metrics exporter endpoint

in order to properly monitor catapulte, we should monitor some metrics like the number of email sent, the time taken for sending each email, etc

allow to configure catapulte with cli parameters

Add the possibility to specify

catapulte --address 0.0.0.0 --port 3000 --swagger-enabled ...

And all the available environment variables.

try replacing actix-web by axum to improve build time

Multiple recipient

I want to be able to send an email to multiple emails, in to, cc and bcc

catapulte Issue on Mac M2 Architecture: GLIBC Version Not Found

Similar issues occurs on my ubuntu vm as well

/usr/bin/catapulte: /lib/x86_64-linux-gnu/libc.so.6: version GLIBC_2.32' not found (required by /usr/bin/catapulte)`

Description:

I've been encountering an issue with catapulte on a Mac with M2 architecture. This problem seems to be related to the absence of a specific version of the GNU C Library (GLIBC) required by catapulte. I've noticed similar issues in my own Rust projects, indicating that this might not be isolated to catapulte.

Error Message:

/usr/bin/catapulte: /lib/aarch64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by /usr/bin/catapulte)

Steps to Reproduce:

version: '3'

services:
  catapulte:
    image: jdrouet/catapulte:latest
    container_name: catapulte
    environment:
      - SMTP_HOSTNAME=smtp.ethereal.email
      - SMTP_PORT=587
      - [email protected] 
      - SMTP_PASSWORD=nYSncuFYzZ7mMwWRHa
      - SMTP_TLS_ENABLED=false
      - SWAGGER_ENABLED=true
      - TEMPLATE_PROVIDER=local
      - TEMPLATE_ROOT=/templates
    ports:
      - "3000:3000"
    volumes:
      - ./templates:/templates:ro

Expected Behavior:

catapulte should run without encountering the GLIBC_2.32 version not found error.

Actual Behavior:

The application fails to start due to the missing GLIBC_2.32 version.

Additional Context:

This issue does not seem to be specific to catapulte, as I've encountered similar problems in my Rust projects. It appears to be related to the compatibility of certain libraries with the M2 architecture.

Potential Solution:

If I manage to find a workaround or solution, I will update this issue accordingly.

jdrouet/catapulte:master does not exist

The documentation mentions to run the docker image jdrouet/catapulte:master which does not exist. I think actually jdrouet/catapulte:latest is what has been ment.

Pass options to mrml renderer

Mrml can take options like keep_comments and we should be able to pass them to catapulte through variables.
We should also be able to override in the requests.

add an environment variable to disable logging in color

Is there an option to disable certificate validation when sending SMTP

I am getting

{"name":"Internal Server Error","message":"internal client error: timed out waiting for connection: network error: invalid certificate: UnknownIssuer"}

since the certificates ca certificate in unknown in the container.

Missing components in swagger file

Issue Description:

Severity: Low

Description:
When obtaining the Swagger file from http://0.0.0.0:3000/openapi.json and importing it into Swagger Editor, I encountered some errors.

Steps to Reproduce:

Access the Swagger file from http://0.0.0.0:3000/openapi.json.
Copy the contents.
Open Swagger Editor.
Import the Swagger file.

Expected Behavior:
The Swagger file should be imported without any errors.

Actual Behavior:
Encountered errors during the import process.

Additional Information:

The version of Swagger Editor used - v3
Any specific error messages received
Reference Error - In: JSON Pointer evaluation failed while evaluating token "super.Recipient" against an ObjectElement at "/components/schemas/super.Recipient"

Endpoint fails with (Failed to deserialize) when building the source

Compiled docker image from main:

Then ran the image with this command

docker run -d \
  --name catapulte \
  -e SMTP_HOSTNAME=smtp.ethereal.email \
  -e SMTP_PORT=587 \
  -e [email protected] \
  -e SMTP_PASSWORD=nYSncuFYzZ7mMwWRHa \
  -e SMTP_TLS_ENABLED=false \
  -e SWAGGER_ENABLED=true \
  -e TEMPLATE_PROVIDER=local \
  -e TEMPLATE_ROOT=/templates \
  -p 3000:3000 \
  -v ./template:/templates:ro \
  catapulte:latest

I attached the existing template (not templates) folder

Then when i try curl, i get an error
Failed to deserialize the JSON body into the target type: missing field fromat line 18 column 1%

user-login/metadata.json looks like this. please note there is no from field in the json file

{
  "name": "user-login",
  "description": "Template for login with magic link",
  "template": {
    "path": "user-login/template.mjml"
  },
  "attributes": {
    "type": "object",
    "properties": {
      "token": {
        "type": "string"
      }
    },
    "required": [
      "token"
    ]
  }
}

curl -X POST -v \
  -H "Content-Type: application/json" \
  --data '{
  "name": "user-login",
  "description": "Template for login with magic link",
  "template": {
    "path": "user-login/template.mjml"
  },
  "attributes": {
    "type": "object",
    "properties": {
      "token": {
        "type": "string"
      }
    },
    "required": [
      "token"
    ]
  }
}' \  
  http://localhost:3000/templates/user-login/json
Note: Unnecessary use of -X or --request, POST is already inferred.
*   Trying [::1]:3000...
* Connected to localhost (::1) port 3000
> POST /templates/user-login/json HTTP/1.1
> Host: localhost:3000
> User-Agent: curl/8.4.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 301
> 
< HTTP/1.1 422 Unprocessable Entity
< content-type: text/plain; charset=utf-8
< content-length: 98
< date: Thu, 02 May 2024 17:00:47 GMT
< 
* Connection #0 to host localhost left intact
Failed to deserialize the JSON body into the target type: missing field `from` at line 18 column 1%

Gibbon-mail is email sender like Catapulte implemented in NodeJS + ReactJS SPA Frontend.

Best regards,
Stéphane

Error r2d2 - No compatible auth mechanism

Hi,

When trying out catapulte using docker, I'm getting the following error message:

catapulte_1  | [2021-05-04T11:35:41Z ERROR r2d2] No compatible authentication mechanism was found

I'm using Office365 (smtp.office365.com) as SMTP server with a valid account. It uses STARTTLS for encryption/auth.

Any idea of how to solve this?

Thanks!

create openapi documentation

Please explain how the Dockerfile works

You have a two stage build in the Dockerfile.

In stage one you copy the template folder to /code/template and run the cargo command.

Then, in stage two, you only copy the binary file to /usr/bin/catapulte.

You set the env variable TEMPLATE_ROOT to /templates.

Of course there is no such /templates folder.

I guess the templates folder from stage one is gone now.

Create a proper logo

For now, there is no logo for this service and I don't have the time nor the skills to do it.