# frozen_string_literal: true require 'spec_helper' RSpec.describe Gitlab::Graphql::MarkdownField do include Gitlab::Routing describe '.markdown_field' do it 'creates the field with some default attributes' do field = class_with_markdown_field(:test_html, null: true, method: :hello).fields['testHtml'] expect(field.name).to eq('testHtml') expect(field.description).to eq('The GitLab Flavored Markdown rendering of `hello`') expect(field.type).to eq(GraphQL::Types::String) expect(field.to_graphql.complexity).to eq(5) end context 'developer warnings' do let_it_be(:expected_error) { /Only `method` is allowed to specify the markdown field/ } it 'raises when passing a resolver' do expect { class_with_markdown_field(:test_html, null: true, resolver: 'not really') } .to raise_error(expected_error) end # TODO: remove as part of https://gitlab.com/gitlab-org/gitlab/-/merge_requests/27536 # so that until that time, the developer check is there it 'raises when passing a resolve block' do expect { class_with_markdown_field(:test_html, null: true, resolve: -> (_, _, _) { 'not really' } ) } .to raise_error(expected_error) end end context 'resolving markdown' do let_it_be(:note) { build(:note, note: '# Markdown!') } let_it_be(:expected_markdown) { '

Markdown!

' } let_it_be(:query_type) { GraphQL::ObjectType.new } let_it_be(:schema) { GraphQL::Schema.define(query: query_type, mutation: nil)} let_it_be(:query) { GraphQL::Query.new(schema, document: nil, context: {}, variables: {}) } let_it_be(:context) { GraphQL::Query::Context.new(query: query, values: {}, object: nil) } let(:type_class) { class_with_markdown_field(:note_html, null: false) } let(:type_instance) { type_class.authorized_new(note, context) } let(:field) { type_class.fields['noteHtml'] } it 'renders markdown from the same property as the field name without the `_html` suffix' do expect(field.to_graphql.resolve(type_instance, {}, context)).to eq(expected_markdown) end context 'when a `method` argument is passed' do let(:type_class) { class_with_markdown_field(:test_html, null: false, method: :note) } let(:field) { type_class.fields['testHtml'] } it 'renders markdown from a specific property' do expect(field.to_graphql.resolve(type_instance, {}, context)).to eq(expected_markdown) end end describe 'basic verification that references work' do let_it_be(:project) { create(:project, :public) } let(:issue) { create(:issue, project: project) } let(:note) { build(:note, note: "Referencing #{issue.to_reference(full: true)}") } it 'renders markdown correctly' do expect(field.to_graphql.resolve(type_instance, {}, context)).to include(issue_path(issue)) end context 'when the issue is not publicly accessible' do let_it_be(:project) { create(:project, :private) } it 'hides the references from users that are not allowed to see the reference' do expect(field.to_graphql.resolve(type_instance, {}, context)).not_to include(issue_path(issue)) end it 'shows the reference to users that are allowed to see it' do context = GraphQL::Query::Context.new(query: query, values: { current_user: project.owner }, object: nil) type_instance = type_class.authorized_new(note, context) expect(field.to_graphql.resolve(type_instance, {}, context)).to include(issue_path(issue)) end end end end end def class_with_markdown_field(name, **args) Class.new(Types::BaseObject) do prepend Gitlab::Graphql::MarkdownField graphql_name 'MarkdownFieldTest' markdown_field name, **args end end end