package sihl
The modular functional web framework
Install
Dune Dependency
Authors
Maintainers
Sources
sihl-0.1.1.tbz
sha256=eac58e5ee9c869aa3b0f0bcee936b01c53bf7fe1febb42edd607268dfb11f4e9
sha512=012b6cf1cf6af0966059761b4916ea8aa590aa8d5809a6f480cb17e23ee10c3b9245062c4f0cf9ad98ab950391c0827c9780999d39fa16a93f7aab4b12f9ab8c
doc/src/sihl.email/email_service.ml.html
Source file email_service.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
open Lwt.Syntax module Sig = Email_service_sig module EnvConfigProvider (Config : Configuration.Service.Sig.SERVICE) : Sig.CONFIG_PROVIDER_SMTP = struct let sender _ = Lwt.return @@ Config.read_string "SMTP_SENDER" let host _ = Lwt.return @@ Config.read_string "SMTP_HOST" let username _ = Lwt.return @@ Config.read_string "SMTP_USERNAME" let password _ = Lwt.return @@ Config.read_string "SMTP_PASSWORD" let port _ = Config.read_int_opt "SMTP_PORT" |> Lwt.return let start_tls _ = Lwt.return @@ Config.read_bool "SMTP_START_TLS" let ca_path _ = Config.read_string_opt "SMTP_CA_PATH" |> Lwt.return let ca_cert _ = Config.read_string_opt "SMTP_CA_CERT" |> Lwt.return end module Template = struct module Make (Log : Log.Service.Sig.SERVICE) (Repo : Sig.TEMPLATE_REPO) : Sig.TEMPLATE_SERVICE = struct let lifecycle = Core.Container.Lifecycle.make "template" ~dependencies:[ Log.lifecycle ] (fun ctx -> Repo.register_migration (); Repo.register_cleaner (); Lwt.return ctx) (fun _ -> Lwt.return ()) let get ctx ~id = Repo.get ctx ~id let get_by_name ctx ~name = Repo.get_by_name ctx ~name let create ctx ~name ~html ~text = let template = Email_core.Template.make ~text ~html name in let* () = Repo.insert ctx ~template in let id = Email_core.Template.id template in let* created = Repo.get ctx ~id in match created with | None -> Log.err (fun m -> m "EMAIL: Could not create template %a" Email_core.Template.pp template); raise (Email_core.Exception "Could not create email template") | Some created -> Lwt.return created let update ctx ~template = let* () = Repo.update ctx ~template in let id = Email_core.Template.id template in let* created = Repo.get ctx ~id in match created with | None -> Log.err (fun m -> m "EMAIL: Could not update template %a" Email_core.Template.pp template); raise (Email_core.Exception "Could not create email template") | Some created -> Lwt.return created let render ctx email = let template_id = Email_core.template_id email in let template_data = Email_core.template_data email in let text_content = Email_core.text_content email in let html_content = Email_core.html_content email in let* text_content, html_content = match template_id with | Some template_id -> let* template = Repo.get ctx ~id:template_id in let* template = match template with | None -> raise (Email_core.Exception (Printf.sprintf "Template with id %s not found" template_id)) | Some template -> Lwt.return template in Email_core.Template.render template_data template |> Lwt.return | None -> Lwt.return (text_content, html_content) in email |> Email_core.set_text_content text_content |> Email_core.set_html_content html_content |> Lwt.return end module Repo = struct module MakeMariaDb (DbService : Data.Db.Service.Sig.SERVICE) (RepoService : Data.Repo.Service.Sig.SERVICE) (MigrationService : Data.Migration.Service.Sig.SERVICE) : Sig.TEMPLATE_REPO = struct module Sql = struct module Model = Email_core.Template let get_request = Caqti_request.find_opt Caqti_type.string Model.t {sql| SELECT LOWER(CONCAT( SUBSTR(HEX(uuid), 1, 8), '-', SUBSTR(HEX(uuid), 9, 4), '-', SUBSTR(HEX(uuid), 13, 4), '-', SUBSTR(HEX(uuid), 17, 4), '-', SUBSTR(HEX(uuid), 21) )), name, content_text, content_html, created_at FROM email_templates WHERE email_templates.uuid = UNHEX(REPLACE(?, '-', '')) |sql} let get ctx ~id = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.find_opt get_request id) let get_by_name_request = Caqti_request.find_opt Caqti_type.string Model.t {sql| SELECT LOWER(CONCAT( SUBSTR(HEX(uuid), 1, 8), '-', SUBSTR(HEX(uuid), 9, 4), '-', SUBSTR(HEX(uuid), 13, 4), '-', SUBSTR(HEX(uuid), 17, 4), '-', SUBSTR(HEX(uuid), 21) )), name, content_text, content_html, created_at FROM email_templates WHERE email_templates.name = ? |sql} let get_by_name ctx ~name = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.find_opt get_by_name_request name) let insert_request = Caqti_request.exec Model.t {sql| INSERT INTO email_templates ( uuid, name, content_text, content_html, created_at ) VALUES ( UNHEX(REPLACE(?, '-', '')), ?, ?, ?, ? ) |sql} let insert ctx ~template = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec insert_request template) let update_request = Caqti_request.exec Model.t {sql| UPDATE email_templates SET name = $2, content_text = $3, content_html = $4, created_at = $5 WHERE email_templates.uuid = UNHEX(REPLACE($1, '-', '')) |sql} let update ctx ~template = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec update_request template) let clean_request = Caqti_request.exec Caqti_type.unit {sql| TRUNCATE TABLE email_templates; |sql} let clean ctx = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec clean_request ()) end module Migration = struct let fix_collation = Data.Migration.create_step ~label:"fix collation" "SET collation_server = 'utf8mb4_unicode_ci'" let create_templates_table = Data.Migration.create_step ~label:"create templates table" {sql| CREATE TABLE IF NOT EXISTS email_templates ( id BIGINT UNSIGNED AUTO_INCREMENT, uuid BINARY(16) NOT NULL, name VARCHAR(128) NOT NULL, content_text TEXT NOT NULL, content_html TEXT NOT NULL, created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (id), CONSTRAINT unique_uuid UNIQUE KEY (uuid), CONSTRAINT unique_name UNIQUE KEY (name) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci; |sql} let migration () = Data.Migration.( empty "email" |> add_step fix_collation |> add_step create_templates_table) end let register_migration () = MigrationService.register (Migration.migration ()) let register_cleaner () = RepoService.register_cleaner Sql.clean let get = Sql.get let get_by_name = Sql.get_by_name let insert = Sql.insert let update = Sql.update end module MakePostgreSql (DbService : Data.Db.Service.Sig.SERVICE) (RepoService : Data.Repo.Service.Sig.SERVICE) (MigrationService : Data.Migration.Service.Sig.SERVICE) : Sig.TEMPLATE_REPO = struct module Sql = struct module Model = Email_core.Template let get_request = Caqti_request.find_opt Caqti_type.string Model.t {sql| SELECT uuid, name, content_text, content_html, created_at FROM email_templates WHERE email_templates.uuid = ? |sql} let get ctx ~id = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.find_opt get_request id) let get_by_name_request = Caqti_request.find_opt Caqti_type.string Model.t {sql| SELECT uuid, name, content_text, content_html, created_at FROM email_templates WHERE email_templates.name = ? |sql} let get_by_name ctx ~name = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.find_opt get_by_name_request name) let insert_request = Caqti_request.exec Model.t {sql| INSERT INTO email_templates ( uuid, name, content_text, content_html, created_at ) VALUES ( ?, ?, ?, ?, ? ) |sql} let insert ctx ~template = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec insert_request template) let update_request = Caqti_request.exec Model.t {sql| UPDATE email_templates SET name = $2, content_text = $3, content_html = $4, created_at = $5 WHERE email_templates.uuid = $1 |sql} let update ctx ~template = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec update_request template) let clean_request = Caqti_request.exec Caqti_type.unit "TRUNCATE TABLE email_templates CASCADE;" let clean ctx = DbService.query ctx (fun (module Connection : Caqti_lwt.CONNECTION) -> Connection.exec clean_request ()) end module Migration = struct let create_templates_table = Data.Migration.create_step ~label:"create templates table" {sql| CREATE TABLE IF NOT EXISTS email_templates ( id SERIAL, uuid UUID NOT NULL, name VARCHAR(128) NOT NULL, content_text TEXT NOT NULL, content_html TEXT NOT NULL, created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), PRIMARY KEY (id), UNIQUE (uuid), UNIQUE (name) ); |sql} let migration () = Data.Migration.(empty "email" |> add_step create_templates_table) end let register_migration () = MigrationService.register (Migration.migration ()) let register_cleaner () = RepoService.register_cleaner Sql.clean let get = Sql.get let get_by_name = Sql.get_by_name let insert = Sql.insert let update = Sql.update end end end module Make = struct module Console (TemplateService : Sig.TEMPLATE_SERVICE) : Sig.SERVICE = struct module Template = TemplateService let lifecycle = Core.Container.Lifecycle.make "email" ~dependencies:[ TemplateService.lifecycle ] (fun ctx -> Lwt.return ctx) (fun _ -> Lwt.return ()) let show email = let sender = Email_core.sender email in let recipient = Email_core.recipient email in let subject = Email_core.subject email in let text_content = Email_core.text_content email in let html_content = Email_core.html_content email in Printf.sprintf {| ----------------------- Email sent by: %s Recpient: %s Subject: %s ----------------------- Text: %s ----------------------- Html: %s ----------------------- |} sender recipient subject text_content html_content let send ctx email = let* email = TemplateService.render ctx email in let to_print = email |> show in Lwt.return (Caml.print_endline to_print) let bulk_send ctx emails = let rec loop emails = match emails with | email :: emails -> Lwt.bind (send ctx email) (fun _ -> loop emails) | [] -> Lwt.return () in loop emails end module Smtp (Log : Log.Service.Sig.SERVICE) (TemplateService : Sig.TEMPLATE_SERVICE) (ConfigProvider : Sig.CONFIG_PROVIDER_SMTP) : Sig.SERVICE = struct module Template = TemplateService let lifecycle = Core.Container.Lifecycle.make "email" ~dependencies:[ TemplateService.lifecycle ] (fun ctx -> Lwt.return ctx) (fun _ -> Lwt.return ()) let send ctx email = (* TODO: how to get config for sending emails? *) let* rendered = TemplateService.render ctx email in let recipients = List.concat [ [ Letters.To rendered.recipient ]; List.map (fun address -> Letters.Cc address) rendered.cc; List.map (fun address -> Letters.Bcc address) rendered.bcc; ] in let body = match rendered.html with | true -> Letters.Html rendered.html_content | false -> Letters.Plain rendered.text_content in let* sender = ConfigProvider.sender ctx in let* username = ConfigProvider.username ctx in let* password = ConfigProvider.password ctx in let* hostname = ConfigProvider.host ctx in let* port = ConfigProvider.port ctx in let* with_starttls = ConfigProvider.start_tls ctx in let* ca_path = ConfigProvider.ca_path ctx in let* ca_cert = ConfigProvider.ca_cert ctx in let config = Letters.Config.make ~username ~password ~hostname ~with_starttls |> Letters.Config.set_port port |> fun conf -> match (ca_cert, ca_path) with | Some path, _ -> Letters.Config.set_ca_cert path conf | None, Some path -> Letters.Config.set_ca_path path conf | None, None -> conf in Letters.build_email ~from:email.sender ~recipients ~subject:email.subject ~body |> function | Ok message -> Letters.send ~config ~sender ~recipients ~message | Error msg -> raise (Email_core.Exception msg) let bulk_send _ _ = Lwt.return () end module SendGrid (Log : Log.Service.Sig.SERVICE) (TemplateService : Sig.TEMPLATE_SERVICE) (ConfigProvider : Sig.CONFIG_PROVIDER_SENDGRID) : Sig.SERVICE = struct module Template = TemplateService let lifecycle = Core.Container.Lifecycle.make "email" ~dependencies:[ TemplateService.lifecycle ] (fun ctx -> Lwt.return ctx) (fun _ -> Lwt.return ()) let body ~recipient ~subject ~sender ~content = Printf.sprintf {| { "personalizations": [ { "to": [ { "email": "%s" } ], "subject": "%s" } ], "from": { "email": "%s" }, "content": [ { "type": "text/plain", "value": "%s" } ] } |} recipient subject sender content let sendgrid_send_url = "https://api.sendgrid.com/v3/mail/send" |> Uri.of_string let send ctx email = let* token = ConfigProvider.api_key ctx in let headers = Cohttp.Header.of_list [ ("authorization", "Bearer " ^ token); ("content-type", "application/json"); ] in let* email = TemplateService.render ctx email in let sender = Email_core.sender email in let recipient = Email_core.recipient email in let subject = Email_core.subject email in let text_content = Email_core.text_content email in (* TODO support html content *) (* let html_content = Email_core.text_content email in *) let req_body = body ~recipient ~subject ~sender ~content:text_content in let* resp, resp_body = Cohttp_lwt_unix.Client.post ~body:(Cohttp_lwt.Body.of_string req_body) ~headers sendgrid_send_url in let status = Cohttp.Response.status resp |> Cohttp.Code.code_of_status in match status with | 200 | 202 -> Log.info (fun m -> m "EMAIL: Successfully sent email using sendgrid"); Lwt.return () | _ -> let* body = Cohttp_lwt.Body.to_string resp_body in Log.err (fun m -> m "EMAIL: Sending email using sendgrid failed with http status \ %i and body %s" status body); raise (Email_core.Exception "EMAIL: Failed to send email") let bulk_send _ _ = Lwt.return () end module Memory (TemplateService : Sig.TEMPLATE_SERVICE) : Sig.SERVICE = struct module Template = TemplateService let lifecycle = Core.Container.Lifecycle.make "email" ~dependencies:[ TemplateService.lifecycle ] (fun ctx -> Lwt.return ctx) (fun _ -> Lwt.return ()) let send ctx email = let* email = TemplateService.render ctx email in Email_core.DevInbox.set email; Lwt.return () let bulk_send ctx emails = let rec loop emails = match emails with | email :: emails -> Lwt.bind (send ctx email) (fun _ -> loop emails) | [] -> Lwt.return () in loop emails end end (** Use this functor to create an email service that sends emails using the job queue. This is useful if you need to answer a request quickly while sending the email in the background *) module MakeDelayed (Log : Log.Service.Sig.SERVICE) (EmailService : Sig.SERVICE) (DbService : Data.Db.Service.Sig.SERVICE) (QueueService : Queue.Service.Sig.SERVICE) : Sig.SERVICE = struct module Template = EmailService.Template module Job = struct let input_to_string email = email |> Email_core.to_yojson |> Yojson.Safe.to_string |> Option.some let string_to_input email = match email with | None -> Log.err (fun m -> m "DELAYED_EMAIL: Serialized email string was NULL, can not \ deserialize email. Please fix the string manually and reset \ the job instance."); Error "Invalid serialized email string received" | Some email -> Result.bind (email |> Utils.Json.parse) Email_core.of_yojson let handle ctx ~input = EmailService.send ctx input |> Lwt.map Result.ok (** Nothing to clean up, sending emails is a side effect *) let failed _ = Lwt_result.return () let job = Queue.create_job ~name:"send_email" ~with_context:DbService.add_pool ~input_to_string ~string_to_input ~handle ~failed () |> Queue.set_max_tries 10 |> Queue.set_retry_delay Utils.Time.OneHour end let lifecycle = Core.Container.Lifecycle.make "delayed-email" ~dependencies: [ Log.lifecycle; EmailService.lifecycle; DbService.lifecycle; QueueService.lifecycle; ] (fun ctx -> QueueService.register_jobs ctx ~jobs:[ Job.job ] |> Lwt.map (fun () -> ctx)) (fun _ -> Lwt.return ()) let send ctx email = QueueService.dispatch ctx ~job:Job.job email let bulk_send ctx emails = DbService.atomic ctx (fun ctx -> let rec loop emails = match emails with | email :: emails -> Lwt.bind (send ctx email) (fun () -> loop emails) | [] -> Lwt.return () in loop emails) end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>