Class: Gitlab::GitalyClient::OperationService

Inherits:
Object
  • Object
show all
Includes:
EncodingHelper
Defined in:
lib/gitlab/gitaly_client/operation_service.rb

Constant Summary collapse

MAX_MSG_SIZE =
128.kilobytes.freeze

Constants included from EncodingHelper

EncodingHelper::ENCODING_CONFIDENCE_THRESHOLD, EncodingHelper::ESCAPED_CHARS, EncodingHelper::UNICODE_REPLACEMENT_CHARACTER

Instance Method Summary collapse

Methods included from EncodingHelper

#binary_io, #detect_binary?, #detect_encoding, #detect_libgit2_binary?, #encode!, #encode_binary, #encode_utf8, #encode_utf8_no_detect, #encode_utf8_with_replacement_character, #unquote_path

Constructor Details

#initialize(repository) ⇒ OperationService

Returns a new instance of OperationService.


10
11
12
13
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 10

def initialize(repository)
  @gitaly_repo = repository.gitaly_repository
  @repository = repository
end

Instance Method Details

#add_tag(tag_name, user, target, message) ⇒ Object


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 29

def add_tag(tag_name, user, target, message)
  request = Gitaly::UserCreateTagRequest.new(
    repository: @gitaly_repo,
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    tag_name: encode_binary(tag_name),
    target_revision: encode_binary(target),
    message: encode_binary(message.to_s),
    timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
  )

  response = GitalyClient.call(@repository.storage, :operation_service, :user_create_tag, request, timeout: GitalyClient.long_timeout)
  if pre_receive_error = response.pre_receive_error.presence
    raise Gitlab::Git::PreReceiveError, pre_receive_error
  elsif response.exists
    raise Gitlab::Git::Repository::TagExistsError
  end

  Gitlab::Git::Tag.new(@repository, response.tag)
rescue GRPC::FailedPrecondition => e
  raise Gitlab::Git::Repository::InvalidRef, e
end

#rebase(user, rebase_id, branch:, branch_sha:, remote_repository:, remote_branch:, push_options: []) ⇒ Object


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
275
276
277
278
279
280
281
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 224

def rebase(user, rebase_id, branch:, branch_sha:, remote_repository:, remote_branch:, push_options: [])
  request_enum = QueueEnumerator.new
  rebase_sha = nil

  response_enum = GitalyClient.call(
    @repository.storage,
    :operation_service,
    :user_rebase_confirmable,
    request_enum.each,
    timeout: GitalyClient.long_timeout,
    remote_storage: remote_repository.storage
  )

  # First request
  request_enum.push(
    Gitaly::UserRebaseConfirmableRequest.new(
      header: Gitaly::UserRebaseConfirmableRequest::Header.new(
        repository: @gitaly_repo,
        user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
        rebase_id: rebase_id.to_s,
        branch: encode_binary(branch),
        branch_sha: branch_sha,
        remote_repository: remote_repository.gitaly_repository,
        remote_branch: encode_binary(remote_branch),
        git_push_options: push_options,
        timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
      )
    )
  )

  perform_next_gitaly_rebase_request(response_enum) do |response|
    rebase_sha = response.rebase_sha
  end

  yield rebase_sha

  # Second request confirms with gitaly to finalize the rebase
  request_enum.push(Gitaly::UserRebaseConfirmableRequest.new(apply: true))

  perform_next_gitaly_rebase_request(response_enum)

  rebase_sha
rescue GRPC::BadStatus => e
  detailed_error = decode_detailed_error(e)

  case detailed_error&.error
  when :access_check
    access_check_error = detailed_error.access_check
    # These messages were returned from internal/allowed API calls
    raise Gitlab::Git::PreReceiveError.new(fallback_message: access_check_error.error_message)
  when :rebase_conflict
    raise Gitlab::Git::Repository::GitError, e.details
  else
    raise e
  end
ensure
  request_enum.close
end

#rm_tag(tag_name, user) ⇒ Object


15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 15

def rm_tag(tag_name, user)
  request = Gitaly::UserDeleteTagRequest.new(
    repository: @gitaly_repo,
    tag_name: encode_binary(tag_name),
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly
  )

  response = GitalyClient.call(@repository.storage, :operation_service, :user_delete_tag, request, timeout: GitalyClient.long_timeout)

  if pre_receive_error = response.pre_receive_error.presence
    raise Gitlab::Git::PreReceiveError, pre_receive_error
  end
end

#user_cherry_pick(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:, dry_run: false) ⇒ Object


202
203
204
205
206
207
208
209
210
211
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 202

def user_cherry_pick(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:, dry_run: false)
  call_cherry_pick_or_revert(:cherry_pick,
                             user: user,
                             commit: commit,
                             branch_name: branch_name,
                             message: message,
                             start_branch_name: start_branch_name,
                             start_repository: start_repository,
                             dry_run: dry_run)
end

#user_commit_files(user, branch_name, commit_message, actions, author_email, author_name, start_branch_name, start_repository, force = false, start_sha = nil) ⇒ Object

rubocop:disable Metrics/ParameterLists


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 358

def user_commit_files(
  user, branch_name, commit_message, actions, author_email, author_name,
  start_branch_name, start_repository, force = false, start_sha = nil)
  req_enum = Enumerator.new do |y|
    header = user_commit_files_request_header(user, branch_name,
    commit_message, actions, author_email, author_name,
    start_branch_name, start_repository, force, start_sha)

    y.yield Gitaly::UserCommitFilesRequest.new(header: header)

    actions.each do |action|
      action_header = user_commit_files_action_header(action)
      y.yield Gitaly::UserCommitFilesRequest.new(
        action: Gitaly::UserCommitFilesAction.new(header: action_header)
      )

      reader = binary_io(action[:content])

      until reader.eof?
        chunk = reader.read(MAX_MSG_SIZE)

        y.yield Gitaly::UserCommitFilesRequest.new(
          action: Gitaly::UserCommitFilesAction.new(content: chunk)
        )
      end
    end
  end

  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_commit_files, req_enum, timeout: GitalyClient.long_timeout,
                               remote_storage: start_repository.storage)

  if (pre_receive_error = response.pre_receive_error.presence)
    raise Gitlab::Git::PreReceiveError, pre_receive_error
  end

  if (index_error = response.index_error.presence)
    raise Gitlab::Git::Index::IndexError, index_error
  end

  Gitlab::Git::OperationService::BranchUpdate.from_gitaly(response.branch_update)
end

#user_commit_patches(user, branch_name, patches) ⇒ Object

rubocop:enable Metrics/ParameterLists


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 402

def user_commit_patches(user, branch_name, patches)
  header = Gitaly::UserApplyPatchRequest::Header.new(
    repository: @gitaly_repo,
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    target_branch: encode_binary(branch_name),
    timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
  )
  reader = binary_io(patches)

  chunks = Enumerator.new do |chunk|
    chunk.yield Gitaly::UserApplyPatchRequest.new(header: header)

    until reader.eof?
      patch_chunk = reader.read(MAX_MSG_SIZE)

      chunk.yield(Gitaly::UserApplyPatchRequest.new(patches: patch_chunk))
    end
  end

  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_apply_patch, chunks, timeout: GitalyClient.long_timeout)

  Gitlab::Git::OperationService::BranchUpdate.from_gitaly(response.branch_update)
end

#user_create_branch(branch_name, user, start_point) ⇒ Object


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 51

def user_create_branch(branch_name, user, start_point)
  request = Gitaly::UserCreateBranchRequest.new(
    repository: @gitaly_repo,
    branch_name: encode_binary(branch_name),
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    start_point: encode_binary(start_point)
  )
  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_create_branch, request, timeout: GitalyClient.long_timeout)

  if response.pre_receive_error.present?
    raise Gitlab::Git::PreReceiveError, response.pre_receive_error
  end

  branch = response.branch
  return unless branch

  target_commit = Gitlab::Git::Commit.decorate(@repository, branch.target_commit)
  Gitlab::Git::Branch.new(@repository, branch.name, target_commit.id, target_commit)
rescue GRPC::FailedPrecondition => ex
  raise Gitlab::Git::Repository::InvalidRef, ex
end

#user_delete_branch(branch_name, user) ⇒ Object


91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 91

def user_delete_branch(branch_name, user)
  request = Gitaly::UserDeleteBranchRequest.new(
    repository: @gitaly_repo,
    branch_name: encode_binary(branch_name),
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly
  )

  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_delete_branch, request, timeout: GitalyClient.long_timeout)

  if pre_receive_error = response.pre_receive_error.presence
    raise Gitlab::Git::PreReceiveError, pre_receive_error
  end
end

#user_ff_branch(user, source_sha, target_branch) ⇒ Object


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 177

def user_ff_branch(user, source_sha, target_branch)
  request = Gitaly::UserFFBranchRequest.new(
    repository: @gitaly_repo,
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    commit_id: source_sha,
    branch: encode_binary(target_branch)
  )

  response = GitalyClient.call(
    @repository.storage,
    :operation_service,
    :user_ff_branch,
    request,
    timeout: GitalyClient.long_timeout
  )

  if response.pre_receive_error.present?
    raise Gitlab::Git::PreReceiveError.new(response.pre_receive_error, fallback_message: "pre-receive hook failed.")
  end

  Gitlab::Git::OperationService::BranchUpdate.from_gitaly(response.branch_update)
rescue GRPC::FailedPrecondition => e
  raise Gitlab::Git::CommitError, e
end

#user_merge_branch(user, source_sha, target_branch, message) ⇒ Object


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
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 125

def user_merge_branch(user, source_sha, target_branch, message)
  request_enum = QueueEnumerator.new
  response_enum = GitalyClient.call(
    @repository.storage,
    :operation_service,
    :user_merge_branch,
    request_enum.each,
    timeout: GitalyClient.long_timeout
  )

  request_enum.push(
    Gitaly::UserMergeBranchRequest.new(
      repository: @gitaly_repo,
      user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
      commit_id: source_sha,
      branch: encode_binary(target_branch),
      message: encode_binary(message),
      timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
    )
  )

  yield response_enum.next.commit_id

  request_enum.push(Gitaly::UserMergeBranchRequest.new(apply: true))

  second_response = response_enum.next

  branch_update = second_response.branch_update
  return if branch_update.nil?
  raise Gitlab::Git::CommitError, 'failed to apply merge to branch' unless branch_update.commit_id.present?

  Gitlab::Git::OperationService::BranchUpdate.from_gitaly(branch_update)

rescue GRPC::BadStatus => e
  detailed_error = decode_detailed_error(e)

  case detailed_error&.error
  when :access_check
    access_check_error = detailed_error.access_check
    # These messages were returned from internal/allowed API calls
    raise Gitlab::Git::PreReceiveError.new(fallback_message: access_check_error.error_message)
  when :reference_update
    # We simply ignore any reference update errors which are typically an
    # indicator of multiple RPC calls trying to update the same reference
    # at the same point in time.
  else
    raise
  end
ensure
  request_enum.close
end

#user_merge_to_ref(user, source_sha:, branch:, target_ref:, message:, first_parent_ref:, allow_conflicts: false) ⇒ Object


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 106

def user_merge_to_ref(user, source_sha:, branch:, target_ref:, message:, first_parent_ref:, allow_conflicts: false)
  request = Gitaly::UserMergeToRefRequest.new(
    repository: @gitaly_repo,
    source_sha: source_sha,
    branch: encode_binary(branch),
    target_ref: encode_binary(target_ref),
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    message: encode_binary(message),
    first_parent_ref: encode_binary(first_parent_ref),
    allow_conflicts: allow_conflicts,
    timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
  )

  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_merge_to_ref, request, timeout: GitalyClient.long_timeout)

  response.commit_id
end

#user_revert(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:, dry_run: false) ⇒ Object


213
214
215
216
217
218
219
220
221
222
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 213

def user_revert(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:, dry_run: false)
  call_cherry_pick_or_revert(:revert,
                             user: user,
                             commit: commit,
                             branch_name: branch_name,
                             message: message,
                             start_branch_name: start_branch_name,
                             start_repository: start_repository,
                             dry_run: dry_run)
end

#user_squash(user, start_sha, end_sha, author, message, time = Time.now.utc) ⇒ Object


283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 283

def user_squash(user, start_sha, end_sha, author, message, time = Time.now.utc)
  request = Gitaly::UserSquashRequest.new(
    repository: @gitaly_repo,
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    start_sha: start_sha,
    end_sha: end_sha,
    author: Gitlab::Git::User.from_gitlab(author).to_gitaly,
    commit_message: encode_binary(message),
    timestamp: Google::Protobuf::Timestamp.new(seconds: time.to_i)
  )

  response = GitalyClient.call(
    @repository.storage,
    :operation_service,
    :user_squash,
    request,
    timeout: GitalyClient.long_timeout
  )

  if response.git_error.presence
    raise Gitlab::Git::Repository::GitError, response.git_error
  end

  response.squash_sha
rescue GRPC::BadStatus => e
  detailed_error = decode_detailed_error(e)

  case detailed_error&.error
  when :resolve_revision, :rebase_conflict
    # Theoretically, we could now raise specific errors based on the type
    # of the detailed error. Most importantly, we get error details when
    # Gitaly was not able to resolve the `start_sha` or `end_sha` via a
    # ResolveRevisionError, and we get information about which files are
    # conflicting via a MergeConflictError.
    #
    # We don't do this now though such that we can maintain backwards
    # compatibility with the minimum required set of changes during the
    # transitory period where we're migrating UserSquash to use
    # structured errors. We thus continue to just return a GitError, like
    # we previously did.
    raise Gitlab::Git::Repository::GitError, e.details
  else
    raise
  end
end

#user_update_branch(branch_name, user, newrev, oldrev) ⇒ Object


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 74

def user_update_branch(branch_name, user, newrev, oldrev)
  request = Gitaly::UserUpdateBranchRequest.new(
    repository: @gitaly_repo,
    branch_name: encode_binary(branch_name),
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    newrev: encode_binary(newrev),
    oldrev: encode_binary(oldrev)
  )

  response = GitalyClient.call(@repository.storage, :operation_service,
                               :user_update_branch, request, timeout: GitalyClient.long_timeout)

  if pre_receive_error = response.pre_receive_error.presence
    raise Gitlab::Git::PreReceiveError, pre_receive_error
  end
end

#user_update_submodule(user:, submodule:, commit_sha:, branch:, message:) ⇒ Object


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/gitlab/gitaly_client/operation_service.rb', line 329

def user_update_submodule(user:, submodule:, commit_sha:, branch:, message:)
  request = Gitaly::UserUpdateSubmoduleRequest.new(
    repository: @gitaly_repo,
    user: Gitlab::Git::User.from_gitlab(user).to_gitaly,
    commit_sha: commit_sha,
    branch: encode_binary(branch),
    submodule: encode_binary(submodule),
    commit_message: encode_binary(message),
    timestamp: Google::Protobuf::Timestamp.new(seconds: Time.now.utc.to_i)
  )

  response = GitalyClient.call(
    @repository.storage,
    :operation_service,
    :user_update_submodule,
    request,
    timeout: GitalyClient.long_timeout
  )

  if response.pre_receive_error.present?
    raise Gitlab::Git::PreReceiveError, response.pre_receive_error
  elsif response.commit_error.present?
    raise Gitlab::Git::CommitError, response.commit_error
  else
    Gitlab::Git::OperationService::BranchUpdate.from_gitaly(response.branch_update)
  end
end