Merge pull request #1334 from codidact/art/email-logs

Add email logs

Author: CodidactBot

Gemfile

@@ -41,6 +41,7 @@ gem 'will_paginate-bootstrap', '~> 1.0'
 
 # AWS for S3 (image storage) and SES (emails).
 gem 'aws-sdk-s3', '~> 1.61', require: false
+gem 'aws-sdk-sns', '~> 1.72'
 gem 'aws-ses-v4', require: 'aws/ses'
 
 # Task scheduler.

Gemfile.lock

@@ -70,12 +70,12 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     awesome_print (1.9.2)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.628.0)
-    aws-sdk-core (3.145.0)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.908.0)
+    aws-sdk-core (3.191.6)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.8)
       jmespath (~> 1, >= 1.6.1)
     aws-sdk-kms (1.58.0)
       aws-sdk-core (~> 3, >= 3.127.0)
@@ -84,12 +84,15 @@ GEM
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
+    aws-sdk-sns (1.72.0)
+      aws-sdk-core (~> 3, >= 3.191.0)
+      aws-sigv4 (~> 1.1)
     aws-ses-v4 (0.8.1)
       builder
       mail (> 2.2.5)
       mime-types
       xml-simple
-    aws-sigv4 (1.5.1)
+    aws-sigv4 (1.8.0)
       aws-eventstream (~> 1, >= 1.0.2)
     bcrypt (3.1.18)
     bindex (0.8.1)
@@ -391,6 +394,7 @@ PLATFORMS
 DEPENDENCIES
   awesome_print (~> 1.9)
   aws-sdk-s3 (~> 1.61)
+  aws-sdk-sns (~> 1.72)
   aws-ses-v4
   byebug (~> 11.1)
   capybara (~> 3.38)
@@ -452,4 +456,4 @@ RUBY VERSION
    ruby 2.7.6p219
 
 BUNDLED WITH
-   2.4.15
+   2.4.13

app/controllers/email_logs_controller.rb

@@ -0,0 +1,24 @@
+class EmailLogsController < ApplicationController
+  skip_forgery_protection only: [:log]
+  skip_before_action :set_globals, only: [:log]
+  skip_before_action :distinguish_fake_community, only: [:log]
+  skip_before_action :enforce_signed_in, only: [:log]
+
+  def log
+    message_type = request.headers['X-Amz-SNS-Message-Type']
+    if ['SubscriptionConfirmation', 'Notification'].include? message_type
+      verifier = Aws::SNS::MessageVerifier.new
+      body = request.body.read
+      if verifier.authentic? body
+        aws_data = JSON.parse body
+        message_data = JSON.parse aws_data['Message']
+        log_type = message_data['notificationType']
+        destination = message_data['mail']['destination'].join(', ')
+        EmailLog.create(log_type: log_type, destination: destination, data: aws_data['Message'])
+        render plain: 'OK'
+      else
+        render plain: "You're not AWS. Go away.", status: 401
+      end
+    end
+  end
+end

app/helpers/email_logs_helper.rb

@@ -0,0 +1,2 @@
+module EmailLogsHelper
+end

app/models/email_log.rb

@@ -0,0 +1,2 @@
+class EmailLog < ApplicationRecord
+end

config/environments/development.rb

@@ -34,6 +34,9 @@
   # Store uploaded files on the local file system (see config/storage.yml for options).
   config.active_storage.service = :local
 
+  # Allow ngrok connections to dev server
+  config.hosts << /[a-z0-9-.]+\.ngrok-free\.app/
+
   # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
   config.action_mailer.delivery_method = :ses

config/routes.rb

@@ -348,6 +348,10 @@
     end
   end
 
+  scope 'emails' do
+    post   'log', to: 'email_logs#log', as: :create_email_log
+  end
+
   get   '403',                             to: 'errors#forbidden'
   get   '404',                             to: 'errors#not_found'
   get   '409',                             to: 'errors#conflict'

config/schedule.rb

@@ -9,3 +9,7 @@
 every 6.hours do
   runner 'scripts/recalc_abilities.rb'
 end
+
+every 1.day, at: '02:10' do
+  runner 'scripts/prune_email_logs.rb'
+end

db/migrate/20240405113618_create_email_logs.rb

@@ -0,0 +1,11 @@
+class CreateEmailLogs < ActiveRecord::Migration[7.0]
+  def change
+    create_table :email_logs do |t|
+      t.string :log_type
+      t.string :destination
+      t.text :data
+
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_08_17_213150) do
+ActiveRecord::Schema[7.0].define(version: 2024_04_05_113618) do
   create_table "abilities", charset: "utf8mb4", collation: "utf8mb4_0900_ai_ci", force: :cascade do |t|
     t.bigint "community_id"
     t.string "name"
@@ -231,6 +231,14 @@
     t.index ["user_id"], name: "index_community_users_on_user_id"
   end
 
+  create_table "email_logs", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
+    t.string "log_type"
+    t.string "destination"
+    t.text "data"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "error_logs", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
     t.bigint "community_id"
     t.bigint "user_id"