Merge branch 'al-205505-fix-snippet-blob-viewers' into 'master'

Fix snippet blob viewers

See merge request gitlab-org/gitlab!25945

app/presenters/snippet_blob_presenter.rb

@@ -3,18 +3,15 @@
 class SnippetBlobPresenter < BlobPresenter
   def rich_data
     return if blob.binary?
+    return unless blob.rich_viewer
 
-    if markup?
-      blob.rendered_markup
-    else
-      highlight(plain: false)
-    end
+    render_rich_partial
   end
 
   def plain_data
     return if blob.binary?
 
-    highlight(plain: !markup?)
+    highlight(plain: false)
   end
 
   def raw_path
@@ -27,10 +24,6 @@ class SnippetBlobPresenter < BlobPresenter
 
   private
 
-  def markup?
-    blob.rich_viewer&.partial_name == 'markup'
-  end
-
   def snippet
     blob.container
   end
@@ -38,4 +31,18 @@ class SnippetBlobPresenter < BlobPresenter
   def language
     nil
   end
+
+  def render_rich_partial
+    renderer.render("projects/blob/viewers/_#{blob.rich_viewer.partial_name}",
+                    locals: { viewer: blob.rich_viewer, blob: blob, blob_raw_path: raw_path },
+                    layout: false)
+  end
+
+  def renderer
+    proxy = Warden::Proxy.new({}, Warden::Manager.new({})).tap do |proxy_instance|
+      proxy_instance.set_user(current_user, scope: :user)
+    end
+
+    ApplicationController.renderer.new('warden' => proxy)
+  end
 end

changelogs/unreleased/al-205505-fix-snippet-blob-viewers.yml

+---
+title: Fix snippet blob viewers for rich and plain data
+merge_request: 25945
+author:
+type: fixed

spec/presenters/snippet_blob_presenter_spec.rb

@@ -4,36 +4,73 @@ require 'spec_helper'
 
 describe SnippetBlobPresenter do
   describe '#rich_data' do
-    let(:snippet) { build(:personal_snippet) }
+    before do
+      allow_next_instance_of(described_class) do |instance|
+        allow(instance).to receive(:current_user).and_return(nil)
+      end
+    end
 
     subject { described_class.new(snippet.blob).rich_data }
 
-    it 'returns nil when the snippet blob is binary' do
-      allow(snippet.blob).to receive(:binary?).and_return(true)
+    context 'with PersonalSnippet' do
+      let(:raw_url) { "http://127.0.0.1:3000/snippets/#{snippet.id}/raw" }
+      let(:snippet) { build(:personal_snippet) }
 
-      expect(subject).to be_nil
-    end
+      it 'returns nil when the snippet blob is binary' do
+        allow(snippet.blob).to receive(:binary?).and_return(true)
 
-    it 'returns markdown content when snippet file is markup' do
-      snippet.file_name = 'test.md'
-      snippet.content = '*foo*'
+        expect(subject).to be_nil
+      end
 
-      expect(subject).to eq '<p data-sourcepos="1:1-1:5" dir="auto"><em>foo</em></p>'
-    end
+      context 'with markdown format' do
+        let(:snippet) { create(:personal_snippet, file_name: 'test.md', content: '*foo*') }
 
-    it 'returns syntax highlighted content' do
-      snippet.file_name = 'test.rb'
-      snippet.content = 'class Foo;end'
+        it 'returns rich markdown content' do
+          expected = <<~HTML
+            <div class="file-content md">
+            <p data-sourcepos="1:1-1:5" dir="auto"><em>foo</em></p>
+            </div>
+          HTML
 
-      expect(subject)
-        .to eq '<span id="LC1" class="line" lang="ruby"><span class="k">class</span> <span class="nc">Foo</span><span class="p">;</span><span class="k">end</span></span>'
-    end
+          expect(subject).to eq(expected)
+        end
+      end
 
-    it 'returns plain text highlighted content' do
-      snippet.file_name = 'test'
-      snippet.content = 'foo'
+      context 'with notebook format' do
+        let(:snippet) { create(:personal_snippet, file_name: 'test.ipynb') }
 
-      expect(subject).to eq '<span id="LC1" class="line" lang="plaintext">foo</span>'
+        it 'returns rich notebook content' do
+          expect(subject.strip).to eq %Q(<div class="file-content" data-endpoint="/snippets/#{snippet.id}/raw" id="js-notebook-viewer"></div>)
+        end
+      end
+
+      context 'with openapi format' do
+        let(:snippet) { create(:personal_snippet, file_name: 'openapi.yml') }
+
+        it 'returns rich openapi content' do
+          expect(subject).to eq %Q(<div class="file-content" data-endpoint="/snippets/#{snippet.id}/raw" id="js-openapi-viewer"></div>\n)
+        end
+      end
+
+      context 'with svg format' do
+        let(:snippet) { create(:personal_snippet, file_name: 'test.svg') }
+
+        it 'returns rich svg content' do
+          result = Nokogiri::HTML::DocumentFragment.parse(subject)
+          image_tag = result.search('img').first
+
+          expect(image_tag.attr('src')).to include("data:#{snippet.blob.mime_type};base64")
+          expect(image_tag.attr('alt')).to eq('test.svg')
+        end
+      end
+
+      context 'with other format' do
+        let(:snippet) { create(:personal_snippet, file_name: 'test') }
+
+        it 'does not return no rich content' do
+          expect(subject).to be_nil
+        end
+      end
     end
   end
 
@@ -55,19 +92,19 @@ describe SnippetBlobPresenter do
       expect(subject).to eq '<span id="LC1" class="line" lang="markdown"><span class="ge">*foo*</span></span>'
     end
 
-    it 'returns plain syntax content' do
+    it 'returns highlighted syntax content' do
       snippet.file_name = 'test.rb'
       snippet.content = 'class Foo;end'
 
       expect(subject)
-        .to eq '<span id="LC1" class="line" lang="">class Foo;end</span>'
+        .to eq '<span id="LC1" class="line" lang="ruby"><span class="k">class</span> <span class="nc">Foo</span><span class="p">;</span><span class="k">end</span></span>'
     end
 
     it 'returns plain text highlighted content' do
       snippet.file_name = 'test'
       snippet.content = 'foo'
 
-      expect(subject).to eq '<span id="LC1" class="line" lang="">foo</span>'
+      expect(subject).to eq '<span id="LC1" class="line" lang="plaintext">foo</span>'
     end
   end
 

spec/requests/api/graphql/mutations/snippets/create_spec.rb

@@ -67,7 +67,7 @@ describe 'Creating a Snippet' do
       it 'returns the created Snippet' do
         post_graphql_mutation(mutation, current_user: current_user)
 
-        expect(mutation_response['snippet']['blob']['richData']).to match(content)
+        expect(mutation_response['snippet']['blob']['richData']).to be_nil
         expect(mutation_response['snippet']['blob']['plainData']).to match(content)
         expect(mutation_response['snippet']['title']).to eq(title)
         expect(mutation_response['snippet']['description']).to eq(description)
@@ -93,7 +93,7 @@ describe 'Creating a Snippet' do
       it 'returns the created Snippet' do
         post_graphql_mutation(mutation, current_user: current_user)
 
-        expect(mutation_response['snippet']['blob']['richData']).to match(content)
+        expect(mutation_response['snippet']['blob']['richData']).to be_nil
         expect(mutation_response['snippet']['blob']['plainData']).to match(content)
         expect(mutation_response['snippet']['title']).to eq(title)
         expect(mutation_response['snippet']['description']).to eq(description)

spec/requests/api/graphql/mutations/snippets/update_spec.rb

@@ -56,7 +56,7 @@ describe 'Updating a Snippet' do
       it 'returns the updated Snippet' do
         post_graphql_mutation(mutation, current_user: current_user)
 
-        expect(mutation_response['snippet']['blob']['richData']).to match(updated_content)
+        expect(mutation_response['snippet']['blob']['richData']).to be_nil
         expect(mutation_response['snippet']['blob']['plainData']).to match(updated_content)
         expect(mutation_response['snippet']['title']).to eq(updated_title)
         expect(mutation_response['snippet']['description']).to eq(updated_description)
@@ -78,7 +78,7 @@ describe 'Updating a Snippet' do
         it 'returns the Snippet with its original values' do
           post_graphql_mutation(mutation, current_user: current_user)
 
-          expect(mutation_response['snippet']['blob']['richData']).to match(original_content)
+          expect(mutation_response['snippet']['blob']['richData']).to be_nil
           expect(mutation_response['snippet']['blob']['plainData']).to match(original_content)
           expect(mutation_response['snippet']['title']).to eq(original_title)
           expect(mutation_response['snippet']['description']).to eq(original_description)