File: alias_resolver.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (274 lines) | stat: -rw-r--r-- 8,216 bytes parent folder | download
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# frozen_string_literal: true

module Import
  module PlaceholderReferences
    module AliasResolver
      extend self

      MissingAlias = Class.new(StandardError)

      NOTE_COLUMNS = { "author_id" => "author_id", "updated_by_id" => "updated_by_id",
                       "resolved_by_id" => "resolved_by_id" }.freeze
      NOTE_EXCLUSIONS = %w[updated_by_id resolved_by_id].freeze

      # A new version for a model should be defined when new entries must be
      # mapped in a different way to data that already exists in the database.
      # Context: https://gitlab.com/gitlab-org/gitlab/-/issues/478501
      ALIASES = {
        "Approval" => {
          1 => {
            model: Approval,
            columns: { "user_id" => "user_id" }
          }
        },
        "AwardEmoji" => {
          1 => {
            model: AwardEmoji,
            columns: { "user_id" => "user_id" }
          }
        },
        "Ci::Bridge" => {
          1 => {
            model: Ci::Bridge,
            columns: { "user_id" => "user_id" }
          }
        },
        "Ci::Build" => {
          1 => {
            model: Ci::Build,
            columns: { "user_id" => "user_id", "erased_by_id" => "erased_by_id" }
          }
        },
        "Ci::Pipeline" => {
          1 => {
            model: Ci::Pipeline,
            columns: { "user_id" => "user_id" }
          }
        },
        "Ci::PipelineSchedule" => {
          1 => {
            model: Ci::PipelineSchedule,
            columns: { "owner_id" => "owner_id" }
          }
        },
        "DesignManagement::Version" => {
          1 => {
            model: DesignManagement::Version,
            columns: { "author_id" => "author_id" }
          }
        },
        "DiffNote" => {
          1 => {
            model: DiffNote,
            columns: NOTE_COLUMNS,
            columns_ignored_on_deletion: NOTE_EXCLUSIONS
          }
        },
        "DiscussionNote" => {
          1 => {
            model: DiscussionNote,
            columns: NOTE_COLUMNS,
            columns_ignored_on_deletion: NOTE_EXCLUSIONS
          }
        },
        "Event" => {
          1 => {
            model: Event,
            columns: { "author_id" => "author_id" }
          }
        },
        "Epic" => {
          1 => {
            model: Epic,
            columns: { "author_id" => "author_id", "assignee_id" => "assignee_id", "updated_by_id" => "updated_by_id",
                       "last_edited_by_id" => "last_edited_by_id", "closed_by_id" => "closed_by_id" },
            columns_ignored_on_deletion: %w[updated_by_id]
          }
        },
        "GenericCommitStatus" => {
          1 => {
            model: GenericCommitStatus,
            columns: { "user_id" => "user_id" }
          }
        },
        "LegacyDiffNote" => {
          1 => {
            model: LegacyDiffNote,
            columns: NOTE_COLUMNS,
            columns_ignored_on_deletion: NOTE_EXCLUSIONS
          }
        },
        "Issue" => {
          1 => {
            model: Issue,
            columns: { "author_id" => "author_id", "updated_by_id" => "updated_by_id",
                       "closed_by_id" => "closed_by_id", "last_edited_by_id" => "last_edited_by_id" }
          }
        },
        "IssueAssignee" => {
          1 => {
            model: IssueAssignee,
            columns: { "user_id" => "user_id", "issue_id" => "issue_id" }
          }
        },
        "List" => {
          1 => {
            model: List,
            columns: { "user_id" => "user_id" }
          }
        },
        "MergeRequest" => {
          1 => {
            model: MergeRequest,
            columns: { "author_id" => "author_id", "updated_by_id" => "updated_by_id",
                       "last_edited_by_id" => "last_edited_by_id", "merge_user_id" => "merge_user_id" },
            columns_ignored_on_deletion: %w[last_edited_by_id]
          }
        },
        "MergeRequest::Metrics" => {
          1 => {
            model: MergeRequest::Metrics,
            columns: { "merged_by_id" => "merged_by_id", "latest_closed_by_id" => "latest_closed_by_id" }
          }
        },
        "MergeRequestAssignee" => {
          1 => {
            model: MergeRequestAssignee,
            columns: { "user_id" => "user_id", "merge_request_id" => "merge_request_id" }
          }
        },
        "MergeRequestReviewer" => {
          1 => {
            model: MergeRequestReviewer,
            columns: { "user_id" => "user_id" }
          }
        },
        "Note" => {
          1 => {
            model: Note,
            columns: NOTE_COLUMNS,
            columns_ignored_on_deletion: NOTE_EXCLUSIONS
          }
        },
        "ProtectedTag::CreateAccessLevel" => {
          1 => {
            model: ProtectedTag::CreateAccessLevel,
            columns: { "user_id" => "user_id" }
          }
        },
        "ProtectedBranch::MergeAccessLevel" => {
          1 => {
            model: ProtectedBranch::MergeAccessLevel,
            columns: { "user_id" => "user_id" }
          }
        },
        "ProtectedBranch::PushAccessLevel" => {
          1 => {
            model: ProtectedBranch::PushAccessLevel,
            columns: { "user_id" => "user_id" }
          }
        },
        "ProjectSnippet" => {
          1 => {
            model: ProjectSnippet,
            columns: { "author_id" => "author_id" }
          }
        },
        "Release" => {
          1 => {
            model: Release,
            columns: { "author_id" => "author_id" }
          }
        },
        "ResourceLabelEvent" => {
          1 => {
            model: ResourceLabelEvent,
            columns: { "user_id" => "user_id" }
          }
        },
        "ResourceMilestoneEvent" => {
          1 => {
            model: ResourceMilestoneEvent,
            columns: { "user_id" => "user_id" }
          }
        },
        "ResourceStateEvent" => {
          1 => {
            model: ResourceStateEvent,
            columns: { "user_id" => "user_id" }
          }
        },
        "Snippet" => {
          1 => {
            model: Snippet,
            columns: { "author_id" => "author_id" }
          }
        },
        "Timelog" => {
          1 => {
            model: Timelog,
            columns: { "user_id" => "user_id" }
          }
        },
        "WorkItem" => {
          1 => {
            model: WorkItem,
            columns: { "author_id" => "author_id", "updated_by_id" => "updated_by_id",
                       "closed_by_id" => "closed_by_id", "last_edited_by_id" => "last_edited_by_id" }
          }
        }
      }.freeze

      private_constant :ALIASES

      def aliases
        ALIASES
      end

      def version_for_model(model)
        return aliases[model].keys.max if aliases[model]

        track_error_for_missing(model: model)

        1
      end

      def aliased_model(model, version:)
        aliased_model = aliases.dig(model, version, :model)
        return aliased_model if aliased_model.present?

        track_error_for_missing(model:, version:)

        model.safe_constantize || (raise missing_alias_error(model:, version:))
      end

      def aliased_column(model, column, version:)
        aliased_column = aliases.dig(model, version, :columns, column)
        return aliased_column if aliased_column.present?

        track_error_for_missing(model: model, column: column, version: version)

        column
      end

      def models_with_data
        aliases.values
          .map { |versions| versions[versions.keys.max] }
          .map { |data| [data[:model], data] }
      end

      private_class_method def self.missing_alias_error(model:, column: nil, version: nil)
        message = "ALIASES must be extended to include #{model}"
        message += ".#{column}" if column
        message += " for version #{version}" if version
        MissingAlias.new(message)
      end

      private_class_method def self.track_error_for_missing(model:, column: nil, version: nil)
        Gitlab::ErrorTracking.track_and_raise_for_dev_exception(missing_alias_error(model:, column:, version:))
      end
    end
  end
end

Import::PlaceholderReferences::AliasResolver.extend_mod