-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
blank-example.js
230 lines (204 loc) · 6.32 KB
/
blank-example.js
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
import { logError } from '../helpers.js';
/** Class representing Example Queue for MailTime */
class BlankQueue {
/**
* Create a BlankQueue instance
* @param {object} opts - configuration object
* @param {object} opts.requiredOption - Required option description
* @param {string} [opts.prefix] - Optional prefix for scope isolation; use when creating multiple MailTime instances within the single application
*/
constructor (opts) {
this.name = 'queue-name';
if (!opts || typeof opts !== 'object' || opts === null) {
throw new TypeError('[mail-time] Configuration object must be passed into BlankQueue constructor');
}
if (!opts.requiredOption) {
throw new Error('[mail-time] [BlankQueue] required {requiredOption} option is missing');
}
this.prefix = (typeof opts.prefix === 'string') ? opts.prefix : 'default';
this.uniqueName = `mailtime:${this.prefix}`;
this.requiredOption = opts.requiredOption;
// Stored JSON structure:
// uuid {string}
// to {string|[string]}
// tries {number} - qty of send attempts
// sendAt {number} - When letter should be sent
// isSent {boolean} - Email status
// isCancelled {boolean} - `true` if email was cancelled before it was sent
// isFailed {boolean} - `true` if email has failed to send
// template {string} - Template for this email
// transport {number} - Last used transport
// concatSubject {string|boolean} - Email concatenation subject
// ---
// mailOptions {[object]} - Array of nodeMailer's `mailOptions`
// mailOptions.to {string|[string]} - [REQUIRED]
// mailOptions.from {string}
// mailOptions.text {string|boolean}
// mailOptions.html {string}
// mailOptions.subject {string}
// mailOptions.Other nodeMailer `sendMail` options...
}
/**
* @async
* @memberOf BlankQueue
* @name ping
* @description Check connection to Storage
* @returns {Promise<object>}
*/
async ping() {
// LEAVE THIS if BLOCK UNCHANGED
if (!this.mailTimeInstance) {
return {
status: 'Service Unavailable',
code: 503,
statusCode: 503,
error: new Error('MailTime instance not yet assigned to {mailTimeInstance} of Queue Adapter context'),
};
}
try {
const ping = await this.requiredOption.ping();
if (ping === 'PONG') {
return {
status: 'OK',
code: 200,
statusCode: 200,
};
}
throw new Error(`Unexpected response from Storage#ping received: ${ping}`);
} catch (pingError) {
return {
status: 'Internal Server Error',
code: 500,
statusCode: 500,
error: pingError
};
}
}
/**
* @memberOf BlankQueue
* @name iterate
* @description iterate over queued emails passing to `mailTimeInstance.___send` method
* @returns {void 0}
*/
async iterate() {
// GET EMAILS WITHIN this.uniqueName SCOPE!
// AND ONLY WHERE sendAt <= now
// RUN ONE BY ONE VIA this.mailTimeInstance.___send() METHOD
const cursorWithEmails = this.requiredOption.getEmails({
scope: this.uniqueName,
isSent: false,
isFailed: false,
isCancelled: false,
sendAt: {
$lte: Date.now() // Number (timestamp)
}
});
for await (const emailObj of cursorWithEmails) {
await this.mailTimeInstance.___send(emailObj);
}
}
/**
* @async
* @memberOf BlankQueue
* @name getPendingTo
* @description get queued email by `to` field (addressee)
* @param to {string} - email address
* @param sendAt {number} - timestamp
* @returns {Promise<object|null>}
*/
async getPendingTo(to, sendAt) {
if (typeof to !== 'string' || typeof sendAt !== 'number') {
return null;
}
const email = await this.requiredOption.get({
to: to,
isSent: false,
isFailed: false,
isCancelled: false,
sendAt: {
$lte: sendAt // Number (timestamp)
}
});
if (!email || email.isSent === true || email.isCancelled === true || email.isFailed === true) {
return null;
}
return email;
}
/**
* @async
* @memberOf BlankQueue
* @name push
* @description push email to the queue/storage
* @param email {object} - email's object
* @returns {Promise<void 0>}
*/
async push(email) {
if (typeof email !== 'object') {
return;
}
if (email.sendAt instanceof Date) {
email.sendAt = +email.sendAt;
}
await this.requiredOption.save(email);
}
/**
* @async
* @memberOf BlankQueue
* @name cancel
* @description cancel scheduled email
* @param uuid {string} - email's uuid
* @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found, was sent, or was cancelled previously
*/
async cancel(uuid) {
if (typeof uuid !== 'string') {
return false;
}
const email = JSON.parse(await this.requiredOption.get({
uuid: uuid
}));
if (!email || email.isSent === true || email.isCancelled === true) {
return false;
}
if (!this.mailTimeInstance.keepHistory) {
return await this.remove(email);
}
return await this.update(email, {
isCancelled: true,
});
}
/**
* @async
* @memberOf BlankQueue
* @name remove
* @description remove email from queue
* @param email {object} - email's object
* @returns {Promise<boolean>} returns `true` if removed or `false` if not found
*/
async remove(email) {
if (typeof email !== 'object' || typeof email.uuid !== 'string') {
return false;
}
return await this.requiredOption.remove({
uuid: email.uuid
});
}
/**
* @async
* @memberOf BlankQueue
* @name update
* @description remove email from queue
* @param email {object} - email's object
* @param updateObj {object} - fields with new values to update
* @returns {Promise<boolean>} returns `true` if updated or `false` if not found or no changes was made
*/
async update(email, updateObj) {
if (typeof email !== 'object' || typeof email.uuid !== 'string' || typeof updateObj !== 'object') {
return false;
}
const updatedEmail = { ...email, ...updateObj };
return await this.requiredOption.update({
uuid: email.uuid
}, updatedEmail);
}
}
export { BlankQueue };