Class: Ci::Runner
- Inherits:
-
ApplicationRecord
show all
- Extended by:
- Gitlab::Utils::Override
- Includes:
- ChronicDurationAttribute, BulkInsertableTags, HasRunnerExecutor, EachBatch, FeatureGate, FromUnion, Gitlab::SQL::Pattern, Gitlab::Utils::StrongMemoize, Presentable, RedisCacheable, TaggableQueries, TokenAuthenticatable
- Defined in:
- app/models/ci/runner.rb
Constant Summary
collapse
- CREATED_RUNNER_TOKEN_PREFIX =
Prefix assigned to runners created from the UI, instead of registered via the command line
'glrt-'
- ONLINE_CONTACT_TIMEOUT =
This ‘ONLINE_CONTACT_TIMEOUT` needs to be larger than
`RUNNER_QUEUE_EXPIRY_TIME+UPDATE_CONTACT_COLUMN_EVERY`
2.hours
- RUNNER_QUEUE_EXPIRY_TIME =
The ‘RUNNER_QUEUE_EXPIRY_TIME` indicates the longest interval that
Runner request needs to be refreshed by Rails instead of being handled
by Workhorse
1.hour
- UPDATE_CONTACT_COLUMN_EVERY =
The ‘UPDATE_CONTACT_COLUMN_EVERY` defines how often the Runner DB entry can be updated
(40.minutes..55.minutes)
- STALE_TIMEOUT =
The ‘STALE_TIMEOUT` constant defines the how far past the last contact or creation date a runner will be considered stale
3.months
- REGISTRATION_AVAILABILITY_TIME =
Only allow authentication token to be visible for a short while
1.hour
- AVAILABLE_TYPES_LEGACY =
%w[specific shared].freeze
- AVAILABLE_TYPES =
runner_types.keys.freeze
- AVAILABLE_STATUSES =
%w[active paused online offline never_contacted stale].freeze
- AVAILABLE_SCOPES =
(AVAILABLE_TYPES_LEGACY + AVAILABLE_TYPES + AVAILABLE_STATUSES).freeze
- FORM_EDITABLE =
%i[description tag_list active run_untagged locked access_level maximum_timeout_human_readable].freeze
- MINUTES_COST_FACTOR_FIELDS =
%i[public_projects_minutes_cost_factor private_projects_minutes_cost_factor].freeze
- TAG_LIST_MAX_LENGTH =
50
TaggableQueries::MAX_TAGS_IDS, TaggableQueries::TooManyTagsError
RedisCacheable::CACHED_ATTRIBUTES_EXPIRY_TIME
Gitlab::SQL::Pattern::MIN_CHARS_FOR_PARTIAL_MATCHING, Gitlab::SQL::Pattern::REGEX_QUOTED_TERM
BulkInsertableTags::BULK_INSERT_TAG_THREAD_KEY
ApplicationRecord::MAX_PLUCK
ResetOnUnionError::MAX_RESET_PERIOD
Class Method Summary
collapse
Instance Method Summary
collapse
extended, extensions, included, method_added, override, prepended, queue_verification, verify!
#present
#tags_ids
#flipper_id
#chronic_duration_attributes, #output_chronic_duration_attribute
#cache_attributes, #cached_attribute, #merge_cache_attributes
split_query_to_search_terms
#save_tags, with_bulk_insert_tags
model_name, table_name_prefix
cached_column_list, #create_or_load_association, declarative_enum, default_select_columns, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, #readable_by?, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, #to_ability_name, underscore, where_exists, where_not_exists, with_fast_read_statement_timeout, without_order
#serializable_hash
Class Method Details
253
254
255
|
# File 'app/models/ci/runner.rb', line 253
def self.online_contact_time_deadline
ONLINE_CONTACT_TIMEOUT.ago
end
|
.order_by(order) ⇒ Object
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
# File 'app/models/ci/runner.rb', line 269
def self.order_by(order)
case order
when 'contacted_asc'
order_contacted_at_asc
when 'contacted_desc'
order_contacted_at_desc
when 'created_at_asc'
order_created_at_asc
when 'token_expires_at_asc'
order_token_expires_at_asc
when 'token_expires_at_desc'
order_token_expires_at_desc
else
order_created_at_desc
end
end
|
.recent_queue_deadline ⇒ Object
.runner_matchers ⇒ Object
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
# File 'app/models/ci/runner.rb', line 286
def self.runner_matchers
unique_params = [
:runner_type,
:public_projects_minutes_cost_factor,
:private_projects_minutes_cost_factor,
:run_untagged,
:access_level,
Arel.sql("(#{arel_tag_names_array.to_sql})")
]
group(*unique_params).pluck('array_agg(ci_runners.id)', *unique_params).map do |values|
Gitlab::Ci::Matching::RunnerMatcher.new({
runner_ids: values[0],
runner_type: values[1],
public_projects_minutes_cost_factor: values[2],
private_projects_minutes_cost_factor: values[3],
run_untagged: values[4],
access_level: values[5],
tag_list: values[6]
})
end
end
|
.search(query) ⇒ Object
Searches for runners matching the given query.
This method uses ILIKE on PostgreSQL for the description field and performs a full match on tokens.
query - The search query as a String.
Returns an ActiveRecord::Relation.
249
250
251
|
# File 'app/models/ci/runner.rb', line 249
def self.search(query)
where(token: query).or(fuzzy_search(query, [:description]))
end
|
.stale_deadline ⇒ Object
257
258
259
|
# File 'app/models/ci/runner.rb', line 257
def self.stale_deadline
STALE_TIMEOUT.ago
end
|
Instance Method Details
#assign_to(project, current_user = nil) ⇒ Object
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
# File 'app/models/ci/runner.rb', line 323
def assign_to(project, current_user = nil)
if instance_type?
raise ArgumentError, 'Transitioning an instance runner to a project runner is not supported'
elsif group_type?
raise ArgumentError, 'Transitioning a group runner to a project runner is not supported'
end
begin
transaction do
self.runner_projects << ::Ci::RunnerProject.new(project: project, runner: self)
self.save!
end
rescue ActiveRecord::RecordInvalid => e
self.errors.add(:assign_to, e.message)
false
end
end
|
#belongs_to_more_than_one_project? ⇒ Boolean
388
389
390
|
# File 'app/models/ci/runner.rb', line 388
def belongs_to_more_than_one_project?
runner_projects.limit(2).count(:all) > 1
end
|
#belongs_to_one_project? ⇒ Boolean
384
385
386
|
# File 'app/models/ci/runner.rb', line 384
def belongs_to_one_project?
runner_projects.count == 1
end
|
#compute_token_expiration ⇒ Object
492
493
494
495
496
497
498
499
500
501
|
# File 'app/models/ci/runner.rb', line 492
def compute_token_expiration
case runner_type
when 'instance_type'
compute_token_expiration_instance
when 'group_type'
compute_token_expiration_group
when 'project_type'
compute_token_expiration_project
end
end
|
#deprecated_rest_status ⇒ Object
366
367
368
369
370
371
372
373
374
375
376
|
# File 'app/models/ci/runner.rb', line 366
def deprecated_rest_status
return :stale if stale?
if contacted_at.nil?
:never_contacted
elsif active?
online? ? :online : :offline
else
:paused
end
end
|
#display_name ⇒ Object
341
342
343
344
345
|
# File 'app/models/ci/runner.rb', line 341
def display_name
return short_sha if description.blank?
description
end
|
#ensure_manager(system_xid, &blk) ⇒ Object
503
504
505
|
# File 'app/models/ci/runner.rb', line 503
def ensure_manager(system_xid, &blk)
RunnerManager.safe_find_or_create_by!(runner_id: id, system_xid: system_xid.to_s, &blk) end
|
#ensure_runner_queue_value ⇒ Object
#gitlab_hosted? ⇒ Boolean
513
514
515
|
# File 'app/models/ci/runner.rb', line 513
def gitlab_hosted?
Gitlab.com? && instance_type?
end
|
415
416
417
|
# File 'app/models/ci/runner.rb', line 415
def has_tags?
tag_list.any?
end
|
#heartbeat(values, update_contacted_at: true) ⇒ Object
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
# File 'app/models/ci/runner.rb', line 451
def heartbeat(values, update_contacted_at: true)
::Gitlab::Database::LoadBalancing::Session.without_sticky_writes do
values = values&.slice(:version, :revision, :platform, :architecture, :ip_address, :config, :executor) || {}
values[:contacted_at] = Time.current if update_contacted_at
if values.include?(:executor)
values[:executor_type] = EXECUTOR_NAME_TO_TYPES.fetch(values.delete(:executor), :unknown)
end
new_version = values[:version]
schedule_runner_version_update(new_version) if new_version && new_version != version
merge_cache_attributes(values)
update_columns(values) if persist_cached_data?
end
end
|
#match_build_if_online?(build) ⇒ Boolean
392
393
394
|
# File 'app/models/ci/runner.rb', line 392
def match_build_if_online?(build)
active? && online? && matches_build?(build)
end
|
#matches_build?(build) ⇒ Boolean
478
479
480
|
# File 'app/models/ci/runner.rb', line 478
def matches_build?(build)
runner_matcher.matches?(build.build_matcher)
end
|
#namespace_ids ⇒ Object
486
487
488
489
490
|
# File 'app/models/ci/runner.rb', line 486
def namespace_ids
strong_memoize(:namespace_ids) do
runner_namespaces.pluck(:namespace_id).compact
end
end
|
#online? ⇒ Boolean
347
348
349
|
# File 'app/models/ci/runner.rb', line 347
def online?
contacted_at && contacted_at > self.class.online_contact_time_deadline
end
|
#only_for?(project) ⇒ Boolean
396
397
398
|
# File 'app/models/ci/runner.rb', line 396
def only_for?(project)
!runner_projects.where.not(project_id: project.id).exists?
end
|
#owner_project ⇒ Object
378
379
380
381
382
|
# File 'app/models/ci/runner.rb', line 378
def owner_project
return unless project_type?
runner_projects.order(:id).first.project
end
|
#pick_build!(build) ⇒ Object
474
475
476
|
# File 'app/models/ci/runner.rb', line 474
def pick_build!(build)
tick_runner_queue if matches_build?(build)
end
|
#predefined_variables ⇒ Object
419
420
421
422
423
424
|
# File 'app/models/ci/runner.rb', line 419
def predefined_variables
Gitlab::Ci::Variables::Collection.new
.append(key: 'CI_RUNNER_ID', value: id.to_s)
.append(key: 'CI_RUNNER_DESCRIPTION', value: description)
.append(key: 'CI_RUNNER_TAGS', value: tag_list.to_s)
end
|
#registration_available? ⇒ Boolean
507
508
509
510
511
|
# File 'app/models/ci/runner.rb', line 507
def registration_available?
authenticated_user_registration_type? &&
created_at > REGISTRATION_AVAILABILITY_TIME.ago &&
!runner_managers.any?
end
|
#runner_matcher ⇒ Object
309
310
311
312
313
314
315
316
317
318
319
320
321
|
# File 'app/models/ci/runner.rb', line 309
def runner_matcher
strong_memoize(:runner_matcher) do
Gitlab::Ci::Matching::RunnerMatcher.new({
runner_ids: [id],
runner_type: runner_type,
public_projects_minutes_cost_factor: public_projects_minutes_cost_factor,
private_projects_minutes_cost_factor: private_projects_minutes_cost_factor,
run_untagged: run_untagged,
access_level: access_level,
tag_list: tag_list
})
end
end
|
#runner_queue_value_latest?(value) ⇒ Boolean
447
448
449
|
# File 'app/models/ci/runner.rb', line 447
def runner_queue_value_latest?(value)
ensure_runner_queue_value == value if value.present?
end
|
#short_sha ⇒ Object
400
401
402
403
404
405
|
# File 'app/models/ci/runner.rb', line 400
def short_sha
return unless token
start_index = authenticated_user_registration_type? ? CREATED_RUNNER_TOKEN_PREFIX.length : 0
token[start_index..start_index + 8]
end
|
#stale? ⇒ Boolean
351
352
353
354
355
|
# File 'app/models/ci/runner.rb', line 351
def stale?
return false unless created_at
[created_at, contacted_at].compact.max <= self.class.stale_deadline
end
|
#status ⇒ Object
357
358
359
360
361
362
|
# File 'app/models/ci/runner.rb', line 357
def status
return :stale if stale?
return :never_contacted unless contacted_at
online? ? :online : :offline
end
|
#tag_list ⇒ Object
407
408
409
410
411
412
413
|
# File 'app/models/ci/runner.rb', line 407
def tag_list
if tags.loaded?
tags.map(&:name)
else
super
end
end
|
#tick_runner_queue ⇒ Object
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
# File 'app/models/ci/runner.rb', line 426
def tick_runner_queue
::Ci::Runner.sticking.stick(:runner, id)
SecureRandom.hex.tap do |new_update|
::Gitlab::Workhorse.set_key_and_notify(runner_queue_key, new_update,
expire: RUNNER_QUEUE_EXPIRY_TIME, overwrite: true)
end
end
|
482
483
484
|
# File 'app/models/ci/runner.rb', line 482
def uncached_contacted_at
read_attribute(:contacted_at)
end
|