summaryrefslogtreecommitdiff
path: root/app/graphql/types/notes/note_type.rb
blob: 05629ea9223e313ced21c4e698100a9c67fec48e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# frozen_string_literal: true

module Types
  module Notes
    class NoteType < BaseObject
      graphql_name 'Note'

      authorize :read_note

      expose_permissions Types::PermissionTypes::Note

      implements(Types::ResolvableInterface)

      field :id, ::Types::GlobalIDType[::Note], null: false,
                                                description: 'ID of the note.'

      field :project, Types::ProjectType,
            null: true,
            description: 'Project associated with the note.'

      field :author, Types::UserType,
            null: false,
            description: 'User who wrote this note.'

      field :system, GraphQL::Types::Boolean,
            null: false,
            description: 'Indicates whether this note was created by the system or by a user.'
      field :system_note_icon_name,
            GraphQL::Types::String,
            null: true,
            description: 'Name of the icon corresponding to a system note.'

      field :body, GraphQL::Types::String,
            null: false,
            method: :note,
            description: 'Content of the note.'

      field :confidential, GraphQL::Types::Boolean, null: true,
                                                    description: 'Indicates if this note is confidential.',
                                                    method: :confidential?,
                                                    deprecated: {
                                                      reason: :renamed,
                                                      replacement: 'internal',
                                                      milestone: '15.5'
                                                    }

      field :internal, GraphQL::Types::Boolean, null: true,
                                                description: 'Indicates if this note is internal.',
                                                method: :confidential?

      field :created_at, Types::TimeType, null: false,
                                          description: 'Timestamp of the note creation.'
      field :discussion, Types::Notes::DiscussionType, null: true,
                                                       description: 'Discussion this note is a part of.'
      field :position, Types::Notes::DiffPositionType, null: true,
                                                       description: 'Position of this note on a diff.'
      field :updated_at, Types::TimeType, null: false,
                                          description: "Timestamp of the note's last activity."
      field :url, GraphQL::Types::String,
            null: true,
            description: 'URL to view this Note in the Web UI.'

      markdown_field :body_html, null: true, method: :note

      def url
        ::Gitlab::UrlBuilder.build(object)
      end

      def system_note_icon_name
        SystemNoteHelper.system_note_icon_name(object) if object.system?
      end

      def project
        Gitlab::Graphql::Loaders::BatchModelLoader.new(Project, object.project_id).find
      end

      def author
        Gitlab::Graphql::Loaders::BatchModelLoader.new(User, object.author_id).find
      end

      # We now support also SyntheticNote notes as a NoteType, but SyntheticNote does not have a real note ID,
      # as SyntheticNote is generated dynamically from a ResourceEvent instance.
      def id
        return super unless object.is_a?(SyntheticNote)

        ::Gitlab::GlobalId.build(object, model_name: object.class.to_s, id: object.discussion_id)
      end
    end
  end
end