406808583c
This adds a `markdown_field` to our types.
Using this helper will render a model's markdown field using the
existing `MarkupHelper` with the context of the GraphQL query
available to the helper.
Having the context available to the helper is needed for redacting
links to resources that the current user is not allowed to see.
Because rendering the HTML can cause queries, the complexity of a
these fields is raised by 5 above the default.
The markdown field helper can be used as follows:
```
markdown_field :note_html, null: false
```
This would generate a field that will render the markdown field `note`
of the model. This could be overridden by adding the `method:`
argument. Passing a symbol for the method name:
```
markdown_field :body_html, null: false, method: :note
```
It will have this description by default:
> The GitLab Flavored Markdown rendering of `note`
This could be overridden by passing a `description:` argument.
The type of a `markdown_field` is always `GraphQL::STRING_TYPE`.
26 lines
849 B
Ruby
26 lines
849 B
Ruby
# frozen_string_literal: true
|
|
|
|
module Gitlab
|
|
module Graphql
|
|
module MarkdownField
|
|
extend ActiveSupport::Concern
|
|
|
|
prepended do
|
|
def self.markdown_field(name, **kwargs)
|
|
if kwargs[:resolver].present? || kwargs[:resolve].present?
|
|
raise ArgumentError, 'Only `method` is allowed to specify the markdown field'
|
|
end
|
|
|
|
method_name = kwargs.delete(:method) || name.to_s.sub(/_html$/, '')
|
|
kwargs[:resolve] = Gitlab::Graphql::MarkdownField::Resolver.new(method_name.to_sym).proc
|
|
|
|
kwargs[:description] ||= "The GitLab Flavored Markdown rendering of `#{method_name}`"
|
|
# Adding complexity to rendered notes since that could cause queries.
|
|
kwargs[:complexity] ||= 5
|
|
|
|
field name, GraphQL::STRING_TYPE, **kwargs
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|