Add a "View in GitLab" link in notification emails

When an email notification concerns a specific object (issue, note, merge request, etc.), add a link to the footer of the email that opens the item's page in a web browser. Rationale: * The link is predictable: always the same text, always at the same location, like any reliable tool. * It allows to remove the inline-title in many emails, and leave only the actual content of the message.

Add a "View in GitLab" link in notification emails
When an email notification concerns a specific object (issue, note, merge request, etc.), add a link to the footer of the email that opens the item's page in a web browser. Rationale: * The link is predictable: always the same text, always at the same location, like any reliable tool. * It allows to remove the inline-title in many emails, and leave only the actual content of the message.
Pierre de La Morinerie
1 parent 03920b96
Showing 8 changed files with 31 additions and 1 deletions Show diff stats
app/mailers/emails/groups.rb
app/mailers/emails/issues.rb
app/mailers/emails/merge_requests.rb
app/mailers/emails/notes.rb
app/mailers/emails/profile.rb
app/mailers/emails/projects.rb
app/views/layouts/notify.html.haml
spec/mailers/notify_spec.rb
@@ -3,7 +3,7 @@ module Emails
     def group_access_granted_email(user_group_id)
       @membership = UsersGroup.find(user_group_id)
       @group = @membership.group
-
+      @target_url = group_url(@group)
       mail(to: @membership.user.email,
            subject: subject("Access to group was granted"))
     end
@@ -3,6 +3,7 @@ module Emails
     def new_issue_email(recipient_id, issue_id)
       @issue = Issue.find(issue_id)
       @project = @issue.project
+      @target_url = project_issue_url(@project, @issue)
       mail(from: sender(@issue.author_id),
            to: recipient(recipient_id),
            subject: subject("#{@issue.title} (##{@issue.iid})"))
@@ -12,6 +13,7 @@ module Emails
       @issue = Issue.find(issue_id)
       @previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
       @project = @issue.project
+      @target_url = project_issue_url(@project, @issue)
       mail(from: sender(updated_by_user_id),
            to: recipient(recipient_id),
            subject: subject("#{@issue.title} (##{@issue.iid})"))
@@ -21,6 +23,7 @@ module Emails
       @issue = Issue.find issue_id
       @project = @issue.project
       @updated_by = User.find updated_by_user_id
+      @target_url = project_issue_url(@project, @issue)
       mail(from: sender(updated_by_user_id),
            to: recipient(recipient_id),
            subject: subject("#{@issue.title} (##{@issue.iid})"))
@@ -31,6 +34,7 @@ module Emails
       @issue_status = status
       @project = @issue.project
       @updated_by = User.find updated_by_user_id
+      @target_url = project_issue_url(@project, @issue)
       mail(from: sender(updated_by_user_id),
            to: recipient(recipient_id),
            subject: subject("#{@issue.title} (##{@issue.iid})"))
@@ -3,6 +3,7 @@ module Emails
     def new_merge_request_email(recipient_id, merge_request_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @project = @merge_request.project
+      @target_url = project_merge_request_url(@project, @merge_request)
       mail(from: sender(@merge_request.author_id),
            to: recipient(recipient_id),
            subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
@@ -12,6 +13,7 @@ module Emails
       @merge_request = MergeRequest.find(merge_request_id)
       @previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
       @project = @merge_request.project
+      @target_url = project_merge_request_url(@project, @merge_request)
       mail(from: sender(updated_by_user_id),
            to: recipient(recipient_id),
            subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
@@ -21,6 +23,7 @@ module Emails
       @merge_request = MergeRequest.find(merge_request_id)
       @updated_by = User.find updated_by_user_id
       @project = @merge_request.project
+      @target_url = project_merge_request_url(@project, @merge_request)
       mail(from: sender(updated_by_user_id),
            to: recipient(recipient_id),
            subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
@@ -29,6 +32,7 @@ module Emails
     def merged_merge_request_email(recipient_id, merge_request_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @project = @merge_request.project
+      @target_url = project_merge_request_url(@project, @merge_request)
       mail(from: sender(@merge_request.author_id_of_changes),
            to: recipient(recipient_id),
            subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
@@ -4,6 +4,7 @@ module Emails
       @note = Note.find(note_id)
       @commit = @note.noteable
       @project = @note.project
+      @target_url = project_commit_url(@project, @commit, anchor: "note_#{@note.id}")
       mail(from: sender(@note.author_id),
            to: recipient(recipient_id),
            subject: subject("#{@commit.title} (#{@commit.short_id})"))
@@ -13,6 +14,7 @@ module Emails
       @note = Note.find(note_id)
       @issue = @note.noteable
       @project = @note.project
+      @target_url = project_issue_url(@project, @issue)
       mail(from: sender(@note.author_id),
            to: recipient(recipient_id),
            subject: subject("#{@issue.title} (##{@issue.iid})"))
@@ -22,6 +24,7 @@ module Emails
       @note = Note.find(note_id)
       @merge_request = @note.noteable
       @project = @note.project
+      @target_url = project_merge_request_url(@project, @merge_request, anchor: "note_#{@note.id}")
       mail(from: sender(@note.author_id),
            to: recipient(recipient_id),
            subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
@@ -30,6 +33,7 @@ module Emails
     def note_wall_email(recipient_id, note_id)
       @note = Note.find(note_id)
       @project = @note.project
+      @target_url = project_wall_url(@note.project, anchor: "note_#{@note.id}")
       mail(from: sender(@note.author_id),
            to: recipient(recipient_id),
            subject: subject("Note on wall"))
@@ -3,6 +3,7 @@ module Emails
     def new_user_email(user_id, password)
       @user = User.find(user_id)
       @password = password
+      @target_url = user_url(@user)
       mail(to: @user.email, subject: subject("Account was created for you"))
     end
  
@@ -15,6 +16,7 @@ module Emails
     def new_ssh_key_email(key_id)
       @key = Key.find(key_id)
       @user = @key.user
+      @target_url = user_url(@user)
       mail(to: @user.email, subject: subject("SSH key was added to your account"))
     end
   end
@@ -3,6 +3,7 @@ module Emails
     def project_access_granted_email(user_project_id)
       @users_project = UsersProject.find user_project_id
       @project = @users_project.project
+      @target_url = project_url(@project)
       mail(to: @users_project.user.email,
            subject: subject("Access to project was granted"))
     end
@@ -10,6 +11,7 @@ module Emails
     def project_was_moved_email(project_id, user_id)
       @user = User.find user_id
       @project = Project.find project_id
+      @target_url = project_url(@project)
       mail(to: @user.email,
            subject: subject("Project was moved"))
     end
@@ -21,6 +23,11 @@ module Emails
       @commits = Commit.decorate(compare.commits)
       @diffs   = compare.diffs
       @branch  = branch
+      if @commits.length > 1
+        @target_url = project_compare_url(@project, from: @commits.first, to: @commits.last)
+      else
+        @target_url = project_commit_url(@project, @compare.commit)
+      end
  
       mail(from: sender(author_id),
            to: recipient,
@@ -20,3 +20,6 @@
           %p{style: "font-size:small;color:#777"}
             - if @project
               You're receiving this notification because you are a member of the #{@project.name_with_namespace} project team.
+              %br
+            - if @target_url
+              #{link_to "View in GitLab", @target_url}
@@ -468,6 +468,8 @@ describe Notify do
     let(:example_site_path) { root_path }
     let(:user) { create(:user) }
     let(:compare) { Gitlab::Git::Compare.new(project.repository.raw_repository, 'cd5c4bac', 'b1e6a9db') }
+    let(:commits) { Commit.decorate(compare.commits) }
+    let(:diff_path) { project_compare_path(project, from: commits.first, to: commits.last) }
  
     subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }
  
@@ -492,5 +494,9 @@ describe Notify do
     it 'includes diffs' do
       should have_body_text /Checkout wiki pages for installation information/
     end
+
+    it 'contains a link to the diff' do
+      should have_body_text /#{diff_path}/
+    end
   end
 end
...	...	@@ -3,7 +3,7 @@ module Emails
3	3	def group_access_granted_email(user_group_id)
4	4	@membership = UsersGroup.find(user_group_id)
5	5	@group = @membership.group
6		-
	6	+ @target_url = group_url(@group)
7	7	mail(to: @membership.user.email,
8	8	subject: subject("Access to group was granted"))
9	9	end
...	...
...	...	@@ -3,6 +3,7 @@ module Emails
3	3	def new_issue_email(recipient_id, issue_id)
4	4	@issue = Issue.find(issue_id)
5	5	@project = @issue.project
	6	+ @target_url = project_issue_url(@project, @issue)
6	7	mail(from: sender(@issue.author_id),
7	8	to: recipient(recipient_id),
8	9	subject: subject("#{@issue.title} (##{@issue.iid})"))
...	...	@@ -12,6 +13,7 @@ module Emails
12	13	@issue = Issue.find(issue_id)
13	14	@previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
14	15	@project = @issue.project
	16	+ @target_url = project_issue_url(@project, @issue)
15	17	mail(from: sender(updated_by_user_id),
16	18	to: recipient(recipient_id),
17	19	subject: subject("#{@issue.title} (##{@issue.iid})"))
...	...	@@ -21,6 +23,7 @@ module Emails
21	23	@issue = Issue.find issue_id
22	24	@project = @issue.project
23	25	@updated_by = User.find updated_by_user_id
	26	+ @target_url = project_issue_url(@project, @issue)
24	27	mail(from: sender(updated_by_user_id),
25	28	to: recipient(recipient_id),
26	29	subject: subject("#{@issue.title} (##{@issue.iid})"))
...	...	@@ -31,6 +34,7 @@ module Emails
31	34	@issue_status = status
32	35	@project = @issue.project
33	36	@updated_by = User.find updated_by_user_id
	37	+ @target_url = project_issue_url(@project, @issue)
34	38	mail(from: sender(updated_by_user_id),
35	39	to: recipient(recipient_id),
36	40	subject: subject("#{@issue.title} (##{@issue.iid})"))
...	...
...	...	@@ -3,6 +3,7 @@ module Emails
3	3	def new_merge_request_email(recipient_id, merge_request_id)
4	4	@merge_request = MergeRequest.find(merge_request_id)
5	5	@project = @merge_request.project
	6	+ @target_url = project_merge_request_url(@project, @merge_request)
6	7	mail(from: sender(@merge_request.author_id),
7	8	to: recipient(recipient_id),
8	9	subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
...	...	@@ -12,6 +13,7 @@ module Emails
12	13	@merge_request = MergeRequest.find(merge_request_id)
13	14	@previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
14	15	@project = @merge_request.project
	16	+ @target_url = project_merge_request_url(@project, @merge_request)
15	17	mail(from: sender(updated_by_user_id),
16	18	to: recipient(recipient_id),
17	19	subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
...	...	@@ -21,6 +23,7 @@ module Emails
21	23	@merge_request = MergeRequest.find(merge_request_id)
22	24	@updated_by = User.find updated_by_user_id
23	25	@project = @merge_request.project
	26	+ @target_url = project_merge_request_url(@project, @merge_request)
24	27	mail(from: sender(updated_by_user_id),
25	28	to: recipient(recipient_id),
26	29	subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
...	...	@@ -29,6 +32,7 @@ module Emails
29	32	def merged_merge_request_email(recipient_id, merge_request_id)
30	33	@merge_request = MergeRequest.find(merge_request_id)
31	34	@project = @merge_request.project
	35	+ @target_url = project_merge_request_url(@project, @merge_request)
32	36	mail(from: sender(@merge_request.author_id_of_changes),
33	37	to: recipient(recipient_id),
34	38	subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
...	...
...	...	@@ -4,6 +4,7 @@ module Emails
4	4	@note = Note.find(note_id)
5	5	@commit = @note.noteable
6	6	@project = @note.project
	7	+ @target_url = project_commit_url(@project, @commit, anchor: "note_#{@note.id}")
7	8	mail(from: sender(@note.author_id),
8	9	to: recipient(recipient_id),
9	10	subject: subject("#{@commit.title} (#{@commit.short_id})"))
...	...	@@ -13,6 +14,7 @@ module Emails
13	14	@note = Note.find(note_id)
14	15	@issue = @note.noteable
15	16	@project = @note.project
	17	+ @target_url = project_issue_url(@project, @issue)
16	18	mail(from: sender(@note.author_id),
17	19	to: recipient(recipient_id),
18	20	subject: subject("#{@issue.title} (##{@issue.iid})"))
...	...	@@ -22,6 +24,7 @@ module Emails
22	24	@note = Note.find(note_id)
23	25	@merge_request = @note.noteable
24	26	@project = @note.project
	27	+ @target_url = project_merge_request_url(@project, @merge_request, anchor: "note_#{@note.id}")
25	28	mail(from: sender(@note.author_id),
26	29	to: recipient(recipient_id),
27	30	subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
...	...	@@ -30,6 +33,7 @@ module Emails
30	33	def note_wall_email(recipient_id, note_id)
31	34	@note = Note.find(note_id)
32	35	@project = @note.project
	36	+ @target_url = project_wall_url(@note.project, anchor: "note_#{@note.id}")
33	37	mail(from: sender(@note.author_id),
34	38	to: recipient(recipient_id),
35	39	subject: subject("Note on wall"))
...	...
...	...	@@ -3,6 +3,7 @@ module Emails
3	3	def new_user_email(user_id, password)
4	4	@user = User.find(user_id)
5	5	@password = password
	6	+ @target_url = user_url(@user)
6	7	mail(to: @user.email, subject: subject("Account was created for you"))
7	8	end
8	9
...	...	@@ -15,6 +16,7 @@ module Emails
15	16	def new_ssh_key_email(key_id)
16	17	@key = Key.find(key_id)
17	18	@user = @key.user
	19	+ @target_url = user_url(@user)
18	20	mail(to: @user.email, subject: subject("SSH key was added to your account"))
19	21	end
20	22	end
...	...
...	...	@@ -3,6 +3,7 @@ module Emails
3	3	def project_access_granted_email(user_project_id)
4	4	@users_project = UsersProject.find user_project_id
5	5	@project = @users_project.project
	6	+ @target_url = project_url(@project)
6	7	mail(to: @users_project.user.email,
7	8	subject: subject("Access to project was granted"))
8	9	end
...	...	@@ -10,6 +11,7 @@ module Emails
10	11	def project_was_moved_email(project_id, user_id)
11	12	@user = User.find user_id
12	13	@project = Project.find project_id
	14	+ @target_url = project_url(@project)
13	15	mail(to: @user.email,
14	16	subject: subject("Project was moved"))
15	17	end
...	...	@@ -21,6 +23,11 @@ module Emails
21	23	@commits = Commit.decorate(compare.commits)
22	24	@diffs = compare.diffs
23	25	@branch = branch
	26	+ if @commits.length > 1
	27	+ @target_url = project_compare_url(@project, from: @commits.first, to: @commits.last)
	28	+ else
	29	+ @target_url = project_commit_url(@project, @compare.commit)
	30	+ end
24	31
25	32	mail(from: sender(author_id),
26	33	to: recipient,
...	...
...	...	@@ -20,3 +20,6 @@
20	20	%p{style: "font-size:small;color:#777"}
21	21	- if @project
22	22	You're receiving this notification because you are a member of the #{@project.name_with_namespace} project team.
	23	+ %br
	24	+ - if @target_url
	25	+ #{link_to "View in GitLab", @target_url}
...	...
...	...	@@ -468,6 +468,8 @@ describe Notify do
468	468	let(:example_site_path) { root_path }
469	469	let(:user) { create(:user) }
470	470	let(:compare) { Gitlab::Git::Compare.new(project.repository.raw_repository, 'cd5c4bac', 'b1e6a9db') }
	471	+ let(:commits) { Commit.decorate(compare.commits) }
	472	+ let(:diff_path) { project_compare_path(project, from: commits.first, to: commits.last) }
471	473
472	474	subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }
473	475
...	...	@@ -492,5 +494,9 @@ describe Notify do
492	494	it 'includes diffs' do
493	495	should have_body_text /Checkout wiki pages for installation information/
494	496	end
	497	+
	498	+ it 'contains a link to the diff' do
	499	+ should have_body_text /#{diff_path}/
	500	+ end
495	501	end
496	502	end
...	...