Merge branch '47672-set_inline_content_type_for_ics' into 'master'

Render calendar feed inline when accessed from GitLab

Closes #47672

See merge request gitlab-org/gitlab-ce!19698

app/controllers/concerns/issues_action.rb

@@ -1,6 +1,7 @@
 module IssuesAction
   extend ActiveSupport::Concern
   include IssuableCollections
+  include IssuesCalendar
 
   # rubocop:disable Gitlab/ModuleWithInstanceVariables
   def issues
@@ -17,18 +18,9 @@ module IssuesAction
   end
   # rubocop:enable Gitlab/ModuleWithInstanceVariables
 
-  # rubocop:disable Gitlab/ModuleWithInstanceVariables
   def issues_calendar
-    @issues = issuables_collection
+    render_issues_calendar(issuables_collection)
-                  .non_archived
-                  .with_due_date
-                  .limit(100)
-
-    respond_to do |format|
-      format.ics { response.headers['Content-Disposition'] = 'inline' }
   end
-  end
-  # rubocop:enable Gitlab/ModuleWithInstanceVariables
 
   private
 

app/controllers/concerns/issues_calendar.rb

@@ -0,0 +1,24 @@
+module IssuesCalendar
+  extend ActiveSupport::Concern
+
+  # rubocop:disable Gitlab/ModuleWithInstanceVariables
+  def render_issues_calendar(issuables)
+    @issues = issuables
+                  .non_archived
+                  .with_due_date
+                  .limit(100)
+
+    respond_to do |format|
+      format.ics do
+        # NOTE: with text/calendar as Content-Type, the browser always downloads
+        #       the content as a file (even ignoring the Content-Disposition
+        #       header). We want to display the content inline when accessed
+        #       from GitLab, similarly to the RSS feed.
+        if request.referer&.start_with?(::Settings.gitlab.base_url)
+          response.headers['Content-Type'] = 'text/plain'
+        end
+      end
+    end
+  end
+  # rubocop:enable Gitlab/ModuleWithInstanceVariables
+end

app/controllers/projects/issues_controller.rb

@@ -4,6 +4,7 @@ class Projects::IssuesController < Projects::ApplicationController
   include IssuableActions
   include ToggleAwardEmoji
   include IssuableCollections
+  include IssuesCalendar
   include SpammableActions
 
   prepend_before_action :authenticate_user!, only: [:new]
@@ -40,14 +41,7 @@ class Projects::IssuesController < Projects::ApplicationController
   end
 
   def calendar
-    @issues = @issuables
+    render_issues_calendar(@issuables)
-                  .non_archived
-                  .with_due_date
-                  .limit(100)
-
-    respond_to do |format|
-      format.ics { response.headers['Content-Disposition'] = 'inline' }
-    end
   end
 
   def new

changelogs/unreleased/47672-set_inline_content_type_for_ics.yml

@@ -0,0 +1,5 @@
+---
+title: Render calendar feed inline when accessed from GitLab
+merge_request:
+author:
+type: fixed

spec/features/ics/dashboard_issues_spec.rb

@@ -11,16 +11,28 @@ describe 'Dashboard Issues Calendar Feed'  do
     end
 
     context 'when authenticated' do
+      context 'with no referer' do
         it 'renders calendar feed' do
           sign_in user
           visit issues_dashboard_path(:ics)
 
           expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
           expect(body).to have_text('BEGIN:VCALENDAR')
         end
       end
 
+      context 'with GitLab as the referer' do
+        it 'renders calendar feed as text/plain' do
+          sign_in user
+          page.driver.header('Referer', issues_dashboard_url(host: Settings.gitlab.base_url))
+          visit issues_dashboard_path(:ics)
+
+          expect(response_headers['Content-Type']).to have_content('text/plain')
+          expect(body).to have_text('BEGIN:VCALENDAR')
+        end
+      end
+    end
+
     context 'when authenticated via personal access token' do
       it 'renders calendar feed' do
         personal_access_token = create(:personal_access_token, user: user)
@@ -28,7 +40,6 @@ describe 'Dashboard Issues Calendar Feed'  do
         visit issues_dashboard_path(:ics, private_token: personal_access_token.token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end
@@ -38,7 +49,6 @@ describe 'Dashboard Issues Calendar Feed'  do
         visit issues_dashboard_path(:ics, feed_token: user.feed_token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end

spec/features/ics/group_issues_spec.rb

@@ -13,16 +13,28 @@ describe 'Group Issues Calendar Feed'  do
     end
 
     context 'when authenticated' do
+      context 'with no referer' do
         it 'renders calendar feed' do
           sign_in user
           visit issues_group_path(group, :ics)
 
           expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
           expect(body).to have_text('BEGIN:VCALENDAR')
         end
       end
 
+      context 'with GitLab as the referer' do
+        it 'renders calendar feed as text/plain' do
+          sign_in user
+          page.driver.header('Referer', issues_group_url(group, host: Settings.gitlab.base_url))
+          visit issues_group_path(group, :ics)
+
+          expect(response_headers['Content-Type']).to have_content('text/plain')
+          expect(body).to have_text('BEGIN:VCALENDAR')
+        end
+      end
+    end
+
     context 'when authenticated via personal access token' do
       it 'renders calendar feed' do
         personal_access_token = create(:personal_access_token, user: user)
@@ -30,7 +42,6 @@ describe 'Group Issues Calendar Feed'  do
         visit issues_group_path(group, :ics, private_token: personal_access_token.token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end
@@ -40,7 +51,6 @@ describe 'Group Issues Calendar Feed'  do
         visit issues_group_path(group, :ics, feed_token: user.feed_token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end

spec/features/ics/project_issues_spec.rb

@@ -12,16 +12,28 @@ describe 'Project Issues Calendar Feed'  do
     end
 
     context 'when authenticated' do
+      context 'with no referer' do
         it 'renders calendar feed' do
           sign_in user
           visit project_issues_path(project, :ics)
 
           expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
           expect(body).to have_text('BEGIN:VCALENDAR')
         end
       end
 
+      context 'with GitLab as the referer' do
+        it 'renders calendar feed as text/plain' do
+          sign_in user
+          page.driver.header('Referer', project_issues_url(project, host: Settings.gitlab.base_url))
+          visit project_issues_path(project, :ics)
+
+          expect(response_headers['Content-Type']).to have_content('text/plain')
+          expect(body).to have_text('BEGIN:VCALENDAR')
+        end
+      end
+    end
+
     context 'when authenticated via personal access token' do
       it 'renders calendar feed' do
         personal_access_token = create(:personal_access_token, user: user)
@@ -29,7 +41,6 @@ describe 'Project Issues Calendar Feed'  do
         visit project_issues_path(project, :ics, private_token: personal_access_token.token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end
@@ -39,7 +50,6 @@ describe 'Project Issues Calendar Feed'  do
         visit project_issues_path(project, :ics, feed_token: user.feed_token)
 
         expect(response_headers['Content-Type']).to have_content('text/calendar')
-        expect(response_headers['Content-Disposition']).to have_content('inline')
         expect(body).to have_text('BEGIN:VCALENDAR')
       end
     end