EmCoTe - Email Compatibility Tester

Application based on Node.js framework and Nest.js framework. Captures submissions from users to get a visual display of a given email (html code) on different devices such as browsers, mobile devices, etc.

User API

1. View Jobs. Просмотр существующих в очереди Задач.

##

Пользовательские данные:

Маршрут: GET /job?filter
Возможен дополнительный запрос filter, например:
/job?from=2024-04-18T13:09:40&to=2024-10-20T00:00:00&theme=тест&page_size=20&page=1
т.е. найти первые 20 задач с темой "тест" за определённый период.
Если фильтр не указан, то вернуться первые 30 задач, отсортированные по времени от новых к старым.

{
  "from": Date,
  "to": Date,
  "theme": string,
  "page_size: number,
  "page": number,
}

Ответ Сервера:

{
  "totalCount": 43,
  "documents": [
    {
      "_id": "5fa2d97d6a2710293a623414",
      "task_status": "waiting",
      "html": "<p>fsdfsd</p>",
      "theme": "тест8",
      "devices": {
        "yandex": {
          "status": "done",
          "image_url":"https://emcdn.ru//emailscreenshots/screenshot_67d44cf3-63ca-447d-8388-031eb27d5ae1.png"
        },
        "mailru": {
          "status": "waiting"
        },
        "android": {
          "status": "failed"
        },
        "windows_outlook": {
          "status": "waiting"
        }
      },
      "theme_counter": 128,
      "_created": "2024-05-07T17:50:36.489Z",
      "_modified": "2024-05-07T17:50:36.489Z",
    },
    {...}
  ]
}

2. Create Job. Постановка новой задачи.

Пользовательские данные:

Маршрут: POST /jobs

body:

  { 
    "html": "<p>привет</p>", 
    "theme": "приветствие", 
    "devices": ["yandex_chrome", "mailru_chrome", "gmail_android11", "outlook16_windows11", "gmail_chrome"]
  }

где devices состоит из <почтовый клиент>_<устройство или браузер>
т.е. "yandex_chrome" - это почта яндекса в браузере chrome
"mailru_chrome" - почта mail.ru в браузере chrome
"gmail_chrome" - почта на gmail.com в браузере chrome
"gmail_android11" - приложение gmail на устройстве android
"outlook16_windows11" - почтовый клиент outlook 2016 на windows 11

Затем, внутри запрос дополняется статусами и сохраняем в RACS:

На первом этапе задача фиксируется в БД со статусом "set".

data: {
  "task_status": "set",
  "html": "<p>привет</p>",
  "theme": "приветствие",
  "theme_counter": 129,
  "devices": {
    "yandex_chrome": { "status": "set" },
    "mailru_chrome": { "status": "set" },
    //. . .
  }
},

Затем внутри приложения происходит отправка письма на указанные в конфигурации адреса Электронной почты и запрос в БД меняется на "waiting"

{
  "task_status":"waiting",
  "html":"<p>привет</p>",
  "theme":"приветствие",
  "theme_counter": 129,
  "devices":{
    "yandex_chrome":{"status":"waiting"},
    "mailru_chrome":{"status":"waiting"},
    //. . .
  },
  "_created":"2024-04-25T13:38:04.943Z",
  "_modified":"2024-04-25T13:38:04.943Z",
  "_id":"6ec0783fd733cee35b43de1e"
}

Наконец, происходит отправка задачи в Брокер Сообщений в виде:

{
    "racs_id": "6ec0783fd733cee35b43de1e",
    "task_status": "waiting",
    "theme": "Привет!",
    "theme_counter": 129,
    "devices": {
        "yandex_chrome": {
            "status": "waiting"
        },
        "mailru_chrome": {
            "status": "waiting"
        },
        "gmail_android11": {
            "status": "waiting"
        },
        "outlook16_windows11": {
            "status": "waiting"
        },
        "gmail_chrome": {
            "status": "waiting"
        }
    }
}

Затем на стороне Евгения специальные микросервисы, получая задачи в Брокере сообщений, делают соответствующие скриншоты и обновляют запись в БД. Пример:

{
  "yandex_chrome": {
      "status":"done",
      "image_url":"https://emcdn.ru//emailscreenshots/screenshot_c9dd47ab-799f-4d8b-8c4d-19f193fdd163.png"
    },
    "mailru_chrome": {
      "status":"waiting"
    },
    "gmail_android11": {
      "status":"failed",    
    }
}

3. View one Job. Просмотр одной задачи по ID

Пользовательские данные:

Маршрут: GET /job/{job_id}
Пример: /job/6ec0783fd733cee35b43de1e

Ответ Сервера:

  {
  "task_status":"progress",
  "html":"<p>привет</p>",
  "theme":"приветствие",
  "theme_counter": 129,
  "devices":{
    "yandex_chrome": {
      "status":"done",
      "image_url":"https://emcdn.ru/emailscreenshots/screenshot_c9dd47ab-799f-4d8b-8c4d-19f193fdd163.png"
    },
    "mailru_chrome": {
      "status":"waiting"
    },
    "gmail_android11": {
      "status":"failed",    
    }
    "windows_outlook":{
      "status":"canceled",
    }
  },
  "_created":"2024-04-25T13:38:04.943Z",
  "_modified":"2024-04-25T13:38:04.943Z",
  "_id":"6ec0783fd733cee35b43de1e"
}

4. Delete Job. Удалить задачу.

Пользовательские данные:

Маршрут: DELETE /job/{job_id}

Ответ сервера:

  {deleted_count: 1}

Если не указывать ID, то будут удалены все задачи
Пример:
DELETE /job

Ответ сервера:

  {deleted_count: 120}

Данная опция заблокирована на данный момент

Шпаргалка по фильтрам в RACS

Получить 10 последних задач:

  filter: {},
  sort: { _created: -1 },
  limit: 10,

Получить Задачу по ID:

  filter: { _id: taskId },

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

License

Nest is MIT licensed.

Prettier

# Print a list of invalid files
$ npx prettier -l src/

# Fix all files
$  npx prettier -w src/

GIT

# change all EOLs from \r\n to \n
$ git config core.autocrlf false
$ git rm --cached -r .
$ git reset --hard