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
|
# frozen_string_literal: true
class NotifyPreview < ActionMailer::Preview
def note_merge_request_email_for_individual_note
note_email(:note_merge_request_email) do
note = <<-MD.strip_heredoc
This is an individual note on a merge request :smiley:
In this notification email, we expect to see:
- The note contents (that's what you're looking at)
- A link to view this note on GitLab
- An explanation for why the user is receiving this notification
MD
create_note(noteable_type: 'merge_request', noteable_id: merge_request.id, note: note)
end
end
def new_user_email
Notify.new_user_email(user.id).message
end
def note_merge_request_email_for_discussion
note_email(:note_merge_request_email) do
note = <<-MD.strip_heredoc
This is a new discussion on a merge request :smiley:
In this notification email, we expect to see:
- A line saying who started this discussion
- The note contents (that's what you're looking at)
- A link to view this discussion on GitLab
- An explanation for why the user is receiving this notification
MD
create_note(noteable_type: 'merge_request', noteable_id: merge_request.id, type: 'DiscussionNote', note: note)
end
end
def note_merge_request_email_for_diff_discussion
note_email(:note_merge_request_email) do
note = <<-MD.strip_heredoc
This is a new discussion on a merge request :smiley:
In this notification email, we expect to see:
- A line saying who started this discussion and on what file
- The diff
- The note contents (that's what you're looking at)
- A link to view this discussion on GitLab
- An explanation for why the user is receiving this notification
MD
position = Gitlab::Diff::Position.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 14,
diff_refs: merge_request.diff_refs
)
create_note(noteable_type: 'merge_request', noteable_id: merge_request.id, type: 'DiffNote', position: position, note: note)
end
end
def resource_access_token_about_to_expire_email
Notify.resource_access_tokens_about_to_expire_email(user, group, ['token_name'])
end
def access_token_created_email
Notify.access_token_created_email(user, 'token_name').message
end
def access_token_expired_email
token_names = []
Notify.access_token_expired_email(user, token_names).message
end
def access_token_revoked_email
Notify.access_token_revoked_email(user, 'token_name').message
end
def access_token_about_to_expire_email
Notify.access_token_about_to_expire_email(user, ['%w', '%w']).message
end
def ssh_key_expired_email
fingerprints = []
Notify.ssh_key_expired_email(user, fingerprints).message
end
def new_mention_in_merge_request_email
Notify.new_mention_in_merge_request_email(user.id, merge_request.id, user.id).message
end
def closed_issue_email
Notify.closed_issue_email(user.id, issue.id, user.id).message
end
def issue_status_changed_email
Notify.issue_status_changed_email(user.id, issue.id, 'closed', user.id).message
end
def removed_milestone_issue_email
Notify.removed_milestone_issue_email(user.id, issue.id, user.id)
end
def changed_milestone_issue_email
Notify.changed_milestone_issue_email(user.id, issue.id, milestone, user.id)
end
def import_issues_csv_email
Notify.import_issues_csv_email(user.id, project.id, { success: 3, errors: [5, 6, 7], valid_file: true })
end
def import_work_items_csv_email
Notify.import_work_items_csv_email(user.id, project.id, { success: 4, error_lines: [2, 3, 4], parse_error: false })
end
def issues_csv_email
Notify.issues_csv_email(user, project, '1997,Ford,E350', { truncated: false, rows_expected: 3, rows_written: 3 }).message
end
def new_issue_email
Notify.new_issue_email(user.id, issue.id).message
end
def new_merge_request_email
Notify.new_merge_request_email(user.id, merge_request.id).message
end
def closed_merge_request_email
Notify.closed_merge_request_email(user.id, merge_request.id, user.id).message
end
def merge_request_status_email
Notify.merge_request_status_email(user.id, merge_request.id, 'reopened', user.id).message
end
def merge_request_unmergeable_email
Notify.merge_request_unmergeable_email(user.id, merge_request.id, 'conflict').message
end
def merged_merge_request_email
Notify.merged_merge_request_email(user.id, merge_request.id, user.id).message
end
def removed_milestone_merge_request_email
Notify.removed_milestone_merge_request_email(user.id, merge_request.id, user.id)
end
def changed_milestone_merge_request_email
Notify.changed_milestone_merge_request_email(user.id, merge_request.id, milestone, user.id)
end
def member_access_denied_email
Notify.member_access_denied_email('project', project.id, user.id).message
end
def member_access_granted_email
Notify.member_access_granted_email(member.source_type, member.id).message
end
def member_access_requested_email
Notify.member_access_requested_email(member.source_type, member.id, user.id).message
end
def member_invite_accepted_email
Notify.member_invite_accepted_email(member.source_type, member.id).message
end
def member_invite_declined_email
Notify.member_invite_declined_email(
'project',
project.id,
'invite@example.com',
user.id
).message
end
def member_invited_email
Notify.member_invited_email('project', member.id, '1234').message
end
def member_about_to_expire_email
cleanup do
member = project.add_member(user, Gitlab::Access::GUEST, expires_at: 7.days.from_now.to_date)
Notify.member_about_to_expire_email('project', member.id).message
end
end
def pages_domain_enabled_email
cleanup do
pages_domain = PagesDomain.new(domain: 'my.example.com', project: project, verified_at: Time.now, enabled_until: 1.week.from_now)
Notify.pages_domain_enabled_email(pages_domain, user).message
end
end
def pipeline_success_email
Notify.pipeline_success_email(pipeline, pipeline.user.try(:email))
end
def pipeline_failed_email
Notify.pipeline_failed_email(pipeline, pipeline.user.try(:email))
end
def pipeline_fixed_email
Notify.pipeline_fixed_email(pipeline, pipeline.user.try(:email))
end
def autodevops_disabled_email
Notify.autodevops_disabled_email(pipeline, user.email).message
end
def remote_mirror_update_failed_email
Notify.remote_mirror_update_failed_email(remote_mirror.id, user.id).message
end
def unknown_sign_in_email
Notify.unknown_sign_in_email(user, '127.0.0.1', Time.current).message
end
def two_factor_otp_attempt_failed_email
Notify.two_factor_otp_attempt_failed_email(user, '127.0.0.1').message
end
def disabled_two_factor_email
Notify.disabled_two_factor_email(user).message
end
def new_email_address_added_email
Notify.new_email_address_added_email(user, 'someone@gitlab.com').message
end
def service_desk_new_note_email
cleanup do
note = create_note(noteable_type: 'Issue', noteable_id: issue.id, note: 'Issue note content')
Notify.service_desk_new_note_email(issue.id, note.id, 'someone@gitlab.com').message
end
end
def service_desk_thank_you_email
Notify.service_desk_thank_you_email(issue.id).message
end
def service_desk_custom_email_verification_email
cleanup do
setup_service_desk_custom_email_objects
Notify.service_desk_custom_email_verification_email(service_desk_setting).message
end
end
def service_desk_verification_triggered_email
cleanup do
setup_service_desk_custom_email_objects
Notify.service_desk_verification_triggered_email(service_desk_setting, 'owner@example.com').message
end
end
def service_desk_verification_result_email_for_verified_state
cleanup do
setup_service_desk_custom_email_objects
custom_email_verification.mark_as_finished!
Notify.service_desk_verification_result_email(service_desk_setting, 'owner@example.com').message
end
end
def service_desk_verification_result_email_for_incorrect_token_error
service_desk_verification_result_email_for_error_state(error: :incorrect_token)
end
def service_desk_verification_result_email_for_incorrect_from_error
service_desk_verification_result_email_for_error_state(error: :incorrect_from)
end
def service_desk_verification_result_email_for_mail_not_received_within_timeframe_error
service_desk_verification_result_email_for_error_state(error: :mail_not_received_within_timeframe)
end
def service_desk_verification_result_email_for_invalid_credentials_error
service_desk_verification_result_email_for_error_state(error: :invalid_credentials)
end
def service_desk_verification_result_email_for_smtp_host_issue_error
service_desk_verification_result_email_for_error_state(error: :smtp_host_issue)
end
def merge_when_pipeline_succeeds_email
Notify.merge_when_pipeline_succeeds_email(user.id, merge_request.id, user.id).message
end
def inactive_project_deletion_warning
Notify.inactive_project_deletion_warning_email(project, user, '2022-04-22').message
end
def verification_instructions_email
Notify.verification_instructions_email(user.email, token: '123456').message
end
def project_was_exported_email
Notify.project_was_exported_email(user, project).message
end
def request_review_merge_request_email
Notify.request_review_merge_request_email(user.id, merge_request.id, user.id).message
end
def new_review_email
review = Review.last
mr_author = review.merge_request.author
Notify.new_review_email(mr_author.id, review.id).message
end
def project_was_moved_email
Notify.project_was_moved_email(project.id, user.id, "gitlab/gitlab").message
end
def github_gists_import_errors_email
Notify.github_gists_import_errors_email(user.id, { '12345' => 'Snippet maximum file count exceeded', '67890' => 'error message 2' }).message
end
private
def project
@project ||= Project.first
end
def service_desk_verification_result_email_for_error_state(error:)
cleanup do
setup_service_desk_custom_email_objects
custom_email_verification.mark_as_failed!(error)
Notify.service_desk_verification_result_email(service_desk_setting, 'owner@example.com').message
end
end
def setup_service_desk_custom_email_objects
# Call accessors to ensure objects have been created
custom_email_credential
custom_email_verification
# Update associations in projects, because we access
# custom_email_credential and custom_email_verification via project
project.reset
end
def custom_email_verification
@custom_email_verification ||= project.service_desk_custom_email_verification || ServiceDesk::CustomEmailVerification.create!(
project: project,
token: 'XXXXXXXXXXXX',
triggerer: user,
triggered_at: Time.current,
state: 'started'
)
end
def custom_email_credential
@custom_email_credential ||= project.service_desk_custom_email_credential || ServiceDesk::CustomEmailCredential.create!(
project: project,
smtp_address: 'smtp.gmail.com', # Use gmail, because Gitlab::UrlBlocker resolves DNS
smtp_port: 587,
smtp_username: 'user@gmail.com',
smtp_password: 'supersecret'
)
end
def service_desk_setting
@service_desk_setting ||= project.service_desk_setting || ServiceDeskSetting.create!(
project: project,
custom_email: 'user@gmail.com'
)
end
def issue
@issue ||= project.issues.first
end
def merge_request
@merge_request ||= project.merge_requests.first
end
def milestone
@milestone ||= issue.milestone
end
def pipeline
@pipeline = Ci::Pipeline.last
end
def remote_mirror
@remote_mirror ||= RemoteMirror.last
end
def user
@user ||= User.last
end
def group
@group ||= Group.last
end
def member
@member ||= Member.last
end
def create_note(params)
Notes::CreateService.new(project, user, params).execute
end
def note_email(method)
cleanup do
note = yield
Notify.public_send(method, user.id, note) # rubocop:disable GitlabSecurity/PublicSend
end
end
def cleanup
email = nil
ApplicationRecord.transaction do
email = yield
raise ActiveRecord::Rollback
end
email
end
end
NotifyPreview.prepend_mod_with('Preview::NotifyPreview')
|